@10x-media/analytics 0.1.0-beta.1 → 0.1.0-beta.3
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 +64 -0
- package/README.md +1 -0
- package/dist/adapters/ga4/ga4.js +17 -7
- package/dist/adapters/ga4/ga4.js.map +1 -1
- package/dist/adapters/plausible/plausible.js +5 -0
- package/dist/adapters/plausible/plausible.js.map +1 -1
- package/dist/adapters/posthog/posthog.js +28 -17
- package/dist/adapters/posthog/posthog.js.map +1 -1
- package/dist/adapters/umami/umami.js +1 -1
- package/dist/adapters/umami/umami.js.map +1 -1
- package/dist/binding/types.d.ts +9 -7
- package/dist/charts/TrendChart.js +17 -8
- package/dist/charts/TrendChart.js.map +1 -1
- package/dist/charts/bucket.js +31 -24
- package/dist/charts/bucket.js.map +1 -1
- package/dist/core/cacheKey.js +4 -7
- package/dist/core/cacheKey.js.map +1 -1
- package/dist/core/contract.d.ts +12 -1
- package/dist/core/contract.js.map +1 -1
- package/dist/core/options.d.ts +27 -2
- package/dist/core/options.js +15 -8
- package/dist/core/options.js.map +1 -1
- package/dist/exports/rsc.d.ts +6 -3
- package/dist/exports/rsc.js +5 -2
- package/dist/fields/AnalyticsPanelClient.js +193 -0
- package/dist/fields/AnalyticsPanelClient.js.map +1 -0
- package/dist/fields/AnalyticsPanelField.d.ts +28 -0
- package/dist/fields/AnalyticsPanelField.js +54 -0
- package/dist/fields/AnalyticsPanelField.js.map +1 -0
- package/dist/fields/AnalyticsStatField.d.ts +1 -1
- package/dist/fields/AnalyticsStatField.js +14 -3
- package/dist/fields/AnalyticsStatField.js.map +1 -1
- package/dist/fields/emptyState.js +46 -0
- package/dist/fields/emptyState.js.map +1 -0
- package/dist/fields/factories.d.ts +10 -2
- package/dist/fields/factories.js +33 -4
- package/dist/fields/factories.js.map +1 -1
- package/dist/fields/readForDocument.d.ts +57 -0
- package/dist/fields/readForDocument.js +50 -10
- package/dist/fields/readForDocument.js.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +29 -4
- package/dist/index.js.map +1 -1
- package/dist/native/ingest/endpoint.js +5 -2
- package/dist/native/ingest/endpoint.js.map +1 -1
- package/dist/native/ingest/normalizeEvent.js +3 -2
- package/dist/native/ingest/normalizeEvent.js.map +1 -1
- package/dist/native/ingest/writeEvent.js +2 -1
- package/dist/native/ingest/writeEvent.js.map +1 -1
- package/dist/native/nativeAdapter.js +7 -4
- package/dist/native/nativeAdapter.js.map +1 -1
- package/dist/native/rollupAcc.js +9 -6
- package/dist/native/rollupAcc.js.map +1 -1
- package/dist/native/rollups/bumpRollup.js +17 -1
- package/dist/native/rollups/bumpRollup.js.map +1 -1
- package/dist/native/rollups/deltas.js +2 -2
- package/dist/native/rollups/deltas.js.map +1 -1
- package/dist/plugin/documentEndpoint.js +80 -0
- package/dist/plugin/documentEndpoint.js.map +1 -0
- package/dist/plugin/paths.js +11 -0
- package/dist/plugin/paths.js.map +1 -0
- package/dist/plugin/runtime.js +2 -1
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/plugin/warmTask.js +1 -1
- package/dist/surfacing/engine.js +5 -5
- package/dist/surfacing/engine.js.map +1 -1
- package/dist/sync/collection.js +11 -6
- package/dist/sync/collection.js.map +1 -1
- package/dist/sync/syncTask.js +1 -1
- package/dist/timeframe/presets.js +12 -16
- package/dist/timeframe/presets.js.map +1 -1
- package/dist/timeframe/tz.js +110 -0
- package/dist/timeframe/tz.js.map +1 -0
- package/dist/translations/de.js +78 -0
- package/dist/translations/de.js.map +1 -0
- package/dist/translations/en.js +5 -2
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/index.d.ts +2 -1
- package/dist/translations/index.js +6 -2
- package/dist/translations/index.js.map +1 -1
- package/dist/translations/keys.d.ts +5 -2
- package/dist/translations/keys.js +5 -2
- package/dist/translations/keys.js.map +1 -1
- package/dist/translations/metricKeys.js +0 -2
- package/dist/translations/metricKeys.js.map +1 -1
- package/dist/widgets/AnalyticsBreakdownWidget.js +1 -1
- package/dist/widgets/AnalyticsMetricWidget.js +9 -1
- package/dist/widgets/AnalyticsMetricWidget.js.map +1 -1
- package/dist/widgets/AnalyticsRealtimeWidget.js +1 -1
- package/dist/widgets/AnalyticsTrendWidget.js +10 -2
- package/dist/widgets/AnalyticsTrendWidget.js.map +1 -1
- package/dist/widgets/ComparisonDelta.js +83 -0
- package/dist/widgets/ComparisonDelta.js.map +1 -0
- package/dist/widgets/cardChrome.d.ts +8 -0
- package/dist/widgets/comparison.js +43 -0
- package/dist/widgets/comparison.js.map +1 -0
- package/dist/widgets/readForWidget.d.ts +4 -0
- package/dist/widgets/readForWidget.js +26 -11
- package/dist/widgets/readForWidget.js.map +1 -1
- package/dist/widgets/readForWidgetBreakdown.js +13 -8
- package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
- package/dist/widgets/readForWidgetRealtime.js +1 -1
- package/dist/widgets/readForWidgetRealtime.js.map +1 -1
- package/dist/widgets/readForWidgetSeries.d.ts +6 -0
- package/dist/widgets/readForWidgetSeries.js +60 -40
- package/dist/widgets/readForWidgetSeries.js.map +1 -1
- package/dist/widgets/registerWidgets.js +148 -169
- package/dist/widgets/registerWidgets.js.map +1 -1
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,69 @@
|
|
|
1
1
|
# @10x-media/analytics
|
|
2
2
|
|
|
3
|
+
## 0.1.0-beta.3
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Make the rollup writer's Postgres import opaque to bundlers.
|
|
8
|
+
|
|
9
|
+
The optional `@payloadcms/db-postgres` peer was loaded via a literal dynamic import, which bundlers resolve at build time: a Mongo host on Turbopack fails `next build` with "Module not found" even though the Postgres branch never runs there (and `serverExternalPackages` does not help, since it governs bundling, not resolution). The specifier is now built at runtime, so no bundler resolves it and the package is only touched when the adapter is actually Postgres. Mongo hosts that worked around this with a resolve alias or stub can remove it.
|
|
10
|
+
|
|
11
|
+
## 0.1.0-beta.2
|
|
12
|
+
|
|
13
|
+
### Minor Changes
|
|
14
|
+
|
|
15
|
+
- Add period-over-period comparison to the metric and trend widgets.
|
|
16
|
+
|
|
17
|
+
When the active adapter declares `capabilities.comparison`, the widget read helpers also fetch (in parallel with the current window) the same count of whole reporting-timezone days immediately preceding the current window and return the previous value alongside the current one. The metric and trend widgets render a colored delta (up/down arrow with the percentage change) and a "vs. previous period" caption; metrics where lower is better (bounce rate) invert the coloring, and `allTime` never compares. The comparison is capability-gated, so adapters that cannot answer a second window omit it entirely and existing installs are unchanged; `widgets: { comparison: false }` skips the previous-window read.
|
|
18
|
+
|
|
19
|
+
The previous window aligns to whole days in the reporting timezone so day-stamped rollup stores never lose their first day to a mid-day window start, and every comparison string routes through the typed `keys.ts` translations so it is fully localizable.
|
|
20
|
+
|
|
21
|
+
- Ship built-in German (`de`) translations alongside English. All admin strings (metrics, widgets, timeframes, provider fields, comparison captions) are covered; a project `translations` override still wins per key.
|
|
22
|
+
|
|
23
|
+
- Interactive per-document analytics panel and an authenticated document read endpoint.
|
|
24
|
+
|
|
25
|
+
`analyticsTab` now renders an interactive panel by default: metric cards with period-over-period deltas (capability-gated, mirroring the widgets), a daily trend chart for the first metric, and a timeframe picker that refetches in place. Reads go through the new `GET /api/analytics/document` endpoint, which whitelists timeframes/metrics and enforces read access on the target document before answering, so analytics never leak for content the requester cannot see. Pass `interactive: false` for the previous static stats row. `readForField` (now exported from `/rsc` with `compare`, `series`, and `range` options) backs both paths.
|
|
26
|
+
|
|
27
|
+
Widget config select fields carry `isClearable: false` (required metric/timeframe and the always-present data source/window have no meaningful cleared state), select option labels ship as static locale maps so `filterOptions` results survive form-state serialization, and analytics display fields no longer surface as empty list-view columns.
|
|
28
|
+
|
|
29
|
+
The sync tier's `analytics-daily` collection is now hidden from the admin nav by default (it stays fully API-queryable); pass `sync: { hidden: false }` to surface it.
|
|
30
|
+
|
|
31
|
+
The plugin now installs its runtime before the app's own `onInit` runs, so consumer init code (seeding, warming, sync passes) can already read through the plugin; custom widget authors also get the exported `widgetCardStyle` / `widgetLabelStyle` chrome.
|
|
32
|
+
|
|
33
|
+
- Fixes and improvements across widgets, caching, bindings, and the PostHog adapter.
|
|
34
|
+
|
|
35
|
+
Widget metric selects now list only metrics a configured adapter can actually serve, mirroring the capability gating that already hides whole widgets. On a PostHog-only install the metric picker no longer offers `bounceRate` or other unsupported metrics, and breakdown widgets narrow the picker by both metric and their dimension.
|
|
36
|
+
|
|
37
|
+
`cache.ttl` now overrides the adapter's `recommendedTtl`. Previously an adapter's recommendation always won, so setting `cache.ttl.aggregate` had no effect. An explicit value now wins; leave a value unset to keep each adapter's own recommendation.
|
|
38
|
+
|
|
39
|
+
Binding `hostname` is now applied as a query filter by adapters that support it: PostHog (`properties.$host`), GA4 (`hostName`), and Plausible (`event:hostname`). It previously only partitioned the cache key without filtering. Umami and the native engine still ignore it (native rollups are not yet keyed by hostname).
|
|
40
|
+
|
|
41
|
+
The PostHog adapter gains the `events` metric (total captured events, matching PostHog's own Events definition) and the `event` dimension (per-event-name breakdown). Requesting either switches the read off the `$pageview`-only filter; the pageview-family metrics stay pageview-scoped through conditional aggregation.
|
|
42
|
+
|
|
43
|
+
The dashboard trend chart no longer flashes at a wrong width on first paint: it measures its container before paint and defers rendering the line until measured, removing the initial-load resize jump.
|
|
44
|
+
|
|
45
|
+
- **Breaking:** remove the unsupported `entries` and `exits` metric keys. No adapter ever implemented them and no widget surfaced real data for them, so they only widened the `MetricKey` union without a backing read path. Their translation keys (`metricEntries`, `metricExits`) are dropped as well; code referencing either key or the removed translation keys no longer compiles.
|
|
46
|
+
|
|
47
|
+
- Add `reportingTimezone` so daily analytics boundaries can align to an IANA timezone instead of always UTC.
|
|
48
|
+
|
|
49
|
+
Day boundaries (timeframe windows, the daily series axis, native rollup buckets, and the surfacing cache key) now resolve through a reporting timezone that defaults to `'UTC'`. An install that does not set the option is unchanged.
|
|
50
|
+
|
|
51
|
+
`reportingTimezone` accepts a fixed string (single-site, or forcing one zone) or a resolver `({ req, scope }) => string | null`. The resolver receives the already-resolved scope, so per-tenant (look up by scope), per-user-account (`req.user`), and selector (cookie/preference) strategies are all expressible with one option. Invalid or unresolvable zones fall back to UTC with a warning.
|
|
52
|
+
|
|
53
|
+
Native rollups bucket into the resolved timezone's day at ingest. This keeps reads cheap and correct for a tenant's own zone, at the cost that changing the timezone does not re-bucket existing history, and a per-user selector cannot re-slice already-written native days (documented). External providers that accept a timezone are told the resolved zone: Umami via its `timezone` param, PostHog via `toStartOfDay(timestamp, '<zone>')`. GA4 and Plausible continue to bucket in their own account timezone.
|
|
54
|
+
|
|
55
|
+
Options considered: (1) a fixed string only, rejected because it cannot vary per tenant or user; (2) a resolver only, rejected because it forces single-site consumers to write a function for a constant; (3) the shipped `string | resolver` union, chosen because it mirrors the existing `scopeResolver` pattern and serves every named use case with one familiar, testable option. For bucketing, write-time (per the "go for B, no historical re-bucketing" decision) was chosen over read-time re-bucketing, which would have required storing finer-grained rollups.
|
|
56
|
+
|
|
57
|
+
- Bucket the per-document trend chart in the reporting timezone, and show a "New" state for documents without analytics yet.
|
|
58
|
+
|
|
59
|
+
The comparison windows, cache keys, and daily series already resolved on reporting-timezone day boundaries, but the trend chart still bucketed and labelled on UTC days. Any reporting timezone east of UTC (whose day starts fall on the previous UTC calendar day) therefore shifted every axis label, and the weekly and monthly groupings, back by a day. The chart now buckets and labels in the reporting timezone the read resolved in; the read helpers return that zone and the panel carries it in its endpoint payload for client-side re-bucketing. The default stays UTC, so existing installs are unchanged.
|
|
60
|
+
|
|
61
|
+
A per-document analytics surface with nothing to show now reads as "New" rather than the flat "No analytics yet" line or a row of zeros captioned "No change vs. previous period". That covers both an unsaved or unbound document (no path resolves) and a saved page that has not gathered a single tracked metric yet. Genuine configuration states (not bound, no provider, unavailable) keep their message, since those are setup problems rather than new pages. The "New" label is localized (`keys.stateNew`, English and German) and the `analytics-empty-state` classes are stable hooks for overriding the look.
|
|
62
|
+
|
|
63
|
+
### Patch Changes
|
|
64
|
+
|
|
65
|
+
- Correct `payload` and `@payloadcms/ui` peer ranges to `^3.83.0`. The plugin uses `definePlugin`, which shipped in Payload 3.83.0, so 3.82.x installs satisfied the old range but failed at import.
|
|
66
|
+
|
|
3
67
|
## 0.1.0-beta.1
|
|
4
68
|
|
|
5
69
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -59,6 +59,7 @@ Full documentation at [docs.10xmedia.de](https://docs.10xmedia.de/analytics):
|
|
|
59
59
|
- [Display fields](https://docs.10xmedia.de/analytics/display-fields)
|
|
60
60
|
- [Dashboard widgets](https://docs.10xmedia.de/analytics/widgets)
|
|
61
61
|
- [Caching and warming](https://docs.10xmedia.de/analytics/cache)
|
|
62
|
+
- [Reporting timezone](https://docs.10xmedia.de/analytics/timezone)
|
|
62
63
|
- [Sync tier](https://docs.10xmedia.de/analytics/sync)
|
|
63
64
|
- [i18n](https://docs.10xmedia.de/analytics/i18n)
|
|
64
65
|
|
package/dist/adapters/ga4/ga4.js
CHANGED
|
@@ -91,6 +91,22 @@ function ga4(config) {
|
|
|
91
91
|
}
|
|
92
92
|
return out;
|
|
93
93
|
};
|
|
94
|
+
const filterExprs = [];
|
|
95
|
+
if (q.path) filterExprs.push({ filter: {
|
|
96
|
+
fieldName: "pagePath",
|
|
97
|
+
stringFilter: {
|
|
98
|
+
matchType: "EXACT",
|
|
99
|
+
value: q.path
|
|
100
|
+
}
|
|
101
|
+
} });
|
|
102
|
+
if (q.hostname) filterExprs.push({ filter: {
|
|
103
|
+
fieldName: "hostName",
|
|
104
|
+
stringFilter: {
|
|
105
|
+
matchType: "EXACT",
|
|
106
|
+
value: q.hostname
|
|
107
|
+
}
|
|
108
|
+
} });
|
|
109
|
+
const dimensionFilter = filterExprs.length === 0 ? void 0 : filterExprs.length === 1 ? filterExprs[0] : { andGroup: { expressions: filterExprs } };
|
|
94
110
|
const baseRequest = {
|
|
95
111
|
property: `properties/${config.propertyId}`,
|
|
96
112
|
dateRanges: [{
|
|
@@ -98,13 +114,7 @@ function ga4(config) {
|
|
|
98
114
|
endDate: q.dateRange.end.toISOString().slice(0, 10)
|
|
99
115
|
}],
|
|
100
116
|
metrics: providerMetrics.map((name) => ({ name })),
|
|
101
|
-
...
|
|
102
|
-
fieldName: "pagePath",
|
|
103
|
-
stringFilter: {
|
|
104
|
-
matchType: "EXACT",
|
|
105
|
-
value: q.path
|
|
106
|
-
}
|
|
107
|
-
} } } : {}
|
|
117
|
+
...dimensionFilter ? { dimensionFilter } : {}
|
|
108
118
|
};
|
|
109
119
|
const client = await getClient();
|
|
110
120
|
if (q.granularity === "day" && !dims.length) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ga4.js","names":[],"sources":["../../../src/adapters/ga4/ga4.ts"],"sourcesContent":["import type { BetaAnalyticsDataClient, protos } from '@google-analytics/data'\nimport type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tMetricKey,\n} from '../../core/contract'\nimport { dayIso } from '../series'\n\nexport interface Ga4Config {\n\t/** GA4 property id (numeric), e.g. '123456789'. */\n\tpropertyId: string\n\t/** Service-account credentials. */\n\tcredentials: { client_email: string; private_key: string }\n\t/** GCP project id; inferred from the credentials when omitted. */\n\tprojectId?: string\n\t/** Maximum days of historical data. Defaults to 425 (GA4's rolling-window limit). Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n}\n\nconst METRIC_MAP: Partial<Record<MetricKey, string>> = {\n\tpageviews: 'screenPageViews',\n\tvisitors: 'totalUsers',\n\tvisits: 'sessions',\n\tsessions: 'sessions',\n\tbounceRate: 'bounceRate',\n\tavgDuration: 'averageSessionDuration',\n\tevents: 'eventCount',\n\tconversions: 'keyEvents',\n\trevenue: 'totalRevenue',\n}\n\nconst DIMENSION_MAP: Partial<Record<DimensionKey, string>> = {\n\tpage: 'pagePath',\n\treferrer: 'pageReferrer',\n\tsource: 'sessionSource',\n\tmedium: 'sessionMedium',\n\tcampaign: 'sessionCampaignName',\n\tutmSource: 'sessionSource',\n\tutmMedium: 'sessionMedium',\n\tutmCampaign: 'sessionCampaignName',\n\tdevice: 'deviceCategory',\n\tbrowser: 'browser',\n\tos: 'operatingSystem',\n\tcountry: 'countryId',\n\tregion: 'region',\n\tcity: 'city',\n\tlanguage: 'language',\n\tevent: 'eventName',\n}\n\nconst ga4Metrics: ReadonlySet<MetricKey> = new Set(Object.keys(METRIC_MAP) as MetricKey[])\nconst ga4Dimensions: ReadonlySet<DimensionKey> = new Set(\n\tObject.keys(DIMENSION_MAP) as DimensionKey[]\n)\n\n// GA4 returns bounceRate as a 0..1 ratio and averageSessionDuration in seconds; the\n// contract uses a 0..100 percentage and milliseconds.\nconst toContractValue = (metric: MetricKey, raw: number): number => {\n\tif (metric === 'avgDuration') {\n\t\treturn Math.round(raw * 1000)\n\t}\n\tif (metric === 'bounceRate') {\n\t\treturn Math.round(raw * 100)\n\t}\n\treturn raw\n}\n\nexport function ga4(config: Ga4Config): AnalyticsAdapter {\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 425\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tcomparison: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: ga4Metrics,\n\t\tdimensions: ga4Dimensions,\n\t\tbatchPageReport: true,\n\t\trateLimit: { maxConcurrent: 10, quotaModel: 'tokens', readsCountAsUsage: true },\n\t\trecommendedTtl: { realtime: 300, aggregate: 21600 },\n\t}\n\n\tlet clientPromise: Promise<BetaAnalyticsDataClient> | undefined\n\n\tconst getClient = (): Promise<BetaAnalyticsDataClient> => {\n\t\tif (!clientPromise) {\n\t\t\tclientPromise = (async () => {\n\t\t\t\tlet mod: typeof import('@google-analytics/data')\n\t\t\t\ttry {\n\t\t\t\t\tmod = await import('@google-analytics/data')\n\t\t\t\t} catch {\n\t\t\t\t\tthrow new Error(\n\t\t\t\t\t\t'@10x-media/analytics: the GA4 adapter requires the optional peer dependency \"@google-analytics/data\". Install it with: pnpm add @google-analytics/data'\n\t\t\t\t\t)\n\t\t\t\t}\n\t\t\t\treturn new mod.BetaAnalyticsDataClient({\n\t\t\t\t\tcredentials: config.credentials,\n\t\t\t\t\tprojectId: config.projectId,\n\t\t\t\t})\n\t\t\t})()\n\t\t}\n\t\treturn clientPromise\n\t}\n\n\treturn {\n\t\tid: 'ga4',\n\t\tlabel: 'Google Analytics 4',\n\t\tcapabilities,\n\t\tisConfigured: () =>\n\t\t\tBoolean(\n\t\t\t\tconfig.propertyId && config.credentials?.client_email && config.credentials?.private_key\n\t\t\t),\n\t\t// The gRPC SDK's gax CallOptions has no AbortSignal field, so ctx.signal cannot be\n\t\t// forwarded; gax cancellation uses the call's own handle, not our signal.\n\t\tasync query(q: AnalyticsQuery, _ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst wanted = q.metrics.filter((m) => METRIC_MAP[m])\n\t\t\tconst providerMetrics = [...new Set(wanted.map((m) => METRIC_MAP[m] as string))]\n\t\t\tconst dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d])\n\t\t\tconst providerDims = [...new Set(dims.map((d) => DIMENSION_MAP[d] as string))]\n\n\t\t\tconst readRow = (\n\t\t\t\trow: protos.google.analytics.data.v1beta.IRow\n\t\t\t): Partial<Record<MetricKey, number>> => {\n\t\t\t\tconst out: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of wanted) {\n\t\t\t\t\tconst idx = providerMetrics.indexOf(METRIC_MAP[m] as string)\n\t\t\t\t\tout[m] = toContractValue(m, Number(row.metricValues?.[idx]?.value ?? 0))\n\t\t\t\t}\n\t\t\t\treturn out\n\t\t\t}\n\n\t\t\tconst baseRequest: protos.google.analytics.data.v1beta.IRunReportRequest = {\n\t\t\t\tproperty: `properties/${config.propertyId}`,\n\t\t\t\tdateRanges: [\n\t\t\t\t\t{\n\t\t\t\t\t\tstartDate: q.dateRange.start.toISOString().slice(0, 10),\n\t\t\t\t\t\tendDate: q.dateRange.end.toISOString().slice(0, 10),\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t\tmetrics: providerMetrics.map((name) => ({ name })),\n\t\t\t\t...(q.path\n\t\t\t\t\t? {\n\t\t\t\t\t\t\tdimensionFilter: {\n\t\t\t\t\t\t\t\tfilter: {\n\t\t\t\t\t\t\t\t\tfieldName: 'pagePath',\n\t\t\t\t\t\t\t\t\tstringFilter: { matchType: 'EXACT', value: q.path },\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t}\n\t\t\t\t\t: {}),\n\t\t\t}\n\n\t\t\tconst client = await getClient()\n\n\t\t\tif (q.granularity === 'day' && !dims.length) {\n\t\t\t\tconst [response] = await client.runReport({\n\t\t\t\t\t...baseRequest,\n\t\t\t\t\tdimensions: [{ name: 'date' }],\n\t\t\t\t\tmetricAggregations: [\n\t\t\t\t\t\t'TOTAL',\n\t\t\t\t\t] as unknown as protos.google.analytics.data.v1beta.MetricAggregation[],\n\t\t\t\t\torderBys: [{ dimension: { dimensionName: 'date' } }],\n\t\t\t\t})\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const row of response.rows ?? []) {\n\t\t\t\t\tconst ymd = row.dimensionValues?.[0]?.value ?? ''\n\t\t\t\t\tconst ts = dayIso(`${ymd.slice(0, 4)}-${ymd.slice(4, 6)}-${ymd.slice(6, 8)}`)\n\t\t\t\t\tif (ts) {\n\t\t\t\t\t\trows.push({ timestamp: ts, metrics: readRow(row) })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tconst totalsRow = response.totals?.[0]\n\t\t\t\tconst totals = totalsRow ? readRow(totalsRow) : {}\n\t\t\t\treturn { rows, totals, meta: { provider: 'ga4', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst [response] = await client.runReport({\n\t\t\t\t...baseRequest,\n\t\t\t\t...(providerDims.length ? { dimensions: providerDims.map((name) => ({ name })) } : {}),\n\t\t\t\t...(q.limit ? { limit: q.limit } : {}),\n\t\t\t})\n\n\t\t\tif (!dims.length) {\n\t\t\t\tconst row = response.rows?.[0]\n\t\t\t\tconst totals = row ? readRow(row) : {}\n\t\t\t\treturn { rows: [{ metrics: totals }], totals, meta: { provider: 'ga4', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst rows: AnalyticsRow[] = (response.rows ?? []).map((row) => {\n\t\t\t\tconst dimValues: Partial<Record<DimensionKey, string>> = {}\n\t\t\t\tfor (const d of dims) {\n\t\t\t\t\tconst idx = providerDims.indexOf(DIMENSION_MAP[d] as string)\n\t\t\t\t\tdimValues[d] = row.dimensionValues?.[idx]?.value ?? ''\n\t\t\t\t}\n\t\t\t\treturn { dimensions: dimValues, metrics: readRow(row) }\n\t\t\t})\n\t\t\treturn { rows, totals: undefined, meta: { provider: 'ga4', fetchedAt } }\n\t\t},\n\t}\n}\n"],"mappings":";;AAwBA,MAAM,aAAiD;CACtD,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;CACV,YAAY;CACZ,aAAa;CACb,QAAQ;CACR,aAAa;CACb,SAAS;AACV;AAEA,MAAM,gBAAuD;CAC5D,MAAM;CACN,UAAU;CACV,QAAQ;CACR,QAAQ;CACR,UAAU;CACV,WAAW;CACX,WAAW;CACX,aAAa;CACb,QAAQ;CACR,SAAS;CACT,IAAI;CACJ,SAAS;CACT,QAAQ;CACR,MAAM;CACN,UAAU;CACV,OAAO;AACR;AAEA,MAAM,aAAqC,IAAI,IAAI,OAAO,KAAK,UAAU,CAAgB;AACzF,MAAM,gBAA2C,IAAI,IACpD,OAAO,KAAK,aAAa,CAC1B;AAIA,MAAM,mBAAmB,QAAmB,QAAwB;CACnE,IAAI,WAAW,eACd,OAAO,KAAK,MAAM,MAAM,GAAI;CAE7B,IAAI,WAAW,cACd,OAAO,KAAK,MAAM,MAAM,GAAG;CAE5B,OAAO;AACR;AAEA,SAAgB,IAAI,QAAqC;CAGxD,MAAM,eAAsC;EAC3C,cAAc;EACd,UAAU;EACV,YAAY;EACZ,gBAAgB;EAChB,iBAPuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;EAQvF,SAAS;EACT,YAAY;EACZ,iBAAiB;EACjB,WAAW;GAAE,eAAe;GAAI,YAAY;GAAU,mBAAmB;EAAK;EAC9E,gBAAgB;GAAE,UAAU;GAAK,WAAW;EAAM;CACnD;CAEA,IAAI;CAEJ,MAAM,kBAAoD;EACzD,IAAI,CAAC,eACJ,iBAAiB,YAAY;GAC5B,IAAI;GACJ,IAAI;IACH,MAAM,MAAM,OAAO;GACpB,QAAQ;IACP,MAAM,IAAI,MACT,0JACD;GACD;GACA,OAAO,IAAI,IAAI,wBAAwB;IACtC,aAAa,OAAO;IACpB,WAAW,OAAO;GACnB,CAAC;EACF,GAAG;EAEJ,OAAO;CACR;CAEA,OAAO;EACN,IAAI;EACJ,OAAO;EACP;EACA,oBACC,QACC,OAAO,cAAc,OAAO,aAAa,gBAAgB,OAAO,aAAa,WAC9E;EAGD,MAAM,MAAM,GAAmB,MAAgD;GAC9E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,SAAS,EAAE,QAAQ,QAAQ,MAAM,WAAW,EAAE;GACpD,MAAM,kBAAkB,CAAC,GAAG,IAAI,IAAI,OAAO,KAAK,MAAM,WAAW,EAAY,CAAC,CAAC;GAC/E,MAAM,QAAQ,EAAE,cAAc,CAAC,GAAG,QAAQ,MAAM,cAAc,EAAE;GAChE,MAAM,eAAe,CAAC,GAAG,IAAI,IAAI,KAAK,KAAK,MAAM,cAAc,EAAY,CAAC,CAAC;GAE7E,MAAM,WACL,QACwC;IACxC,MAAM,MAA0C,CAAC;IACjD,KAAK,MAAM,KAAK,QAAQ;KACvB,MAAM,MAAM,gBAAgB,QAAQ,WAAW,EAAY;KAC3D,IAAI,KAAK,gBAAgB,GAAG,OAAO,IAAI,eAAe,MAAM,SAAS,CAAC,CAAC;IACxE;IACA,OAAO;GACR;GAEA,MAAM,cAAqE;IAC1E,UAAU,cAAc,OAAO;IAC/B,YAAY,CACX;KACC,WAAW,EAAE,UAAU,MAAM,YAAY,EAAE,MAAM,GAAG,EAAE;KACtD,SAAS,EAAE,UAAU,IAAI,YAAY,EAAE,MAAM,GAAG,EAAE;IACnD,CACD;IACA,SAAS,gBAAgB,KAAK,UAAU,EAAE,KAAK,EAAE;IACjD,GAAI,EAAE,OACH,EACA,iBAAiB,EAChB,QAAQ;KACP,WAAW;KACX,cAAc;MAAE,WAAW;MAAS,OAAO,EAAE;KAAK;IACnD,EACD,EACD,IACC,CAAC;GACL;GAEA,MAAM,SAAS,MAAM,UAAU;GAE/B,IAAI,EAAE,gBAAgB,SAAS,CAAC,KAAK,QAAQ;IAC5C,MAAM,CAAC,YAAY,MAAM,OAAO,UAAU;KACzC,GAAG;KACH,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC;KAC7B,oBAAoB,CACnB,OACD;KACA,UAAU,CAAC,EAAE,WAAW,EAAE,eAAe,OAAO,EAAE,CAAC;IACpD,CAAC;IACD,MAAM,OAAuB,CAAC;IAC9B,KAAK,MAAM,OAAO,SAAS,QAAQ,CAAC,GAAG;KACtC,MAAM,MAAM,IAAI,kBAAkB,IAAI,SAAS;KAC/C,MAAM,KAAK,OAAO,GAAG,IAAI,MAAM,GAAG,CAAC,EAAE,GAAG,IAAI,MAAM,GAAG,CAAC,EAAE,GAAG,IAAI,MAAM,GAAG,CAAC,GAAG;KAC5E,IAAI,IACH,KAAK,KAAK;MAAE,WAAW;MAAI,SAAS,QAAQ,GAAG;KAAE,CAAC;IAEpD;IACA,MAAM,YAAY,SAAS,SAAS;IAEpC,OAAO;KAAE;KAAM,QADA,YAAY,QAAQ,SAAS,IAAI,CAAC;KAC1B,MAAM;MAAE,UAAU;MAAO;KAAU;IAAE;GAC7D;GAEA,MAAM,CAAC,YAAY,MAAM,OAAO,UAAU;IACzC,GAAG;IACH,GAAI,aAAa,SAAS,EAAE,YAAY,aAAa,KAAK,UAAU,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC;IACpF,GAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;GACrC,CAAC;GAED,IAAI,CAAC,KAAK,QAAQ;IACjB,MAAM,MAAM,SAAS,OAAO;IAC5B,MAAM,SAAS,MAAM,QAAQ,GAAG,IAAI,CAAC;IACrC,OAAO;KAAE,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC;KAAG;KAAQ,MAAM;MAAE,UAAU;MAAO;KAAU;IAAE;GACpF;GAUA,OAAO;IAAE,OARqB,SAAS,QAAQ,CAAC,GAAG,KAAK,QAAQ;KAC/D,MAAM,YAAmD,CAAC;KAC1D,KAAK,MAAM,KAAK,MAAM;MACrB,MAAM,MAAM,aAAa,QAAQ,cAAc,EAAY;MAC3D,UAAU,KAAK,IAAI,kBAAkB,MAAM,SAAS;KACrD;KACA,OAAO;MAAE,YAAY;MAAW,SAAS,QAAQ,GAAG;KAAE;IACvD,CACY;IAAG,QAAQ,KAAA;IAAW,MAAM;KAAE,UAAU;KAAO;IAAU;GAAE;EACxE;CACD;AACD"}
|
|
1
|
+
{"version":3,"file":"ga4.js","names":[],"sources":["../../../src/adapters/ga4/ga4.ts"],"sourcesContent":["import type { BetaAnalyticsDataClient, protos } from '@google-analytics/data'\nimport type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tMetricKey,\n} from '../../core/contract'\nimport { dayIso } from '../series'\n\nexport interface Ga4Config {\n\t/** GA4 property id (numeric), e.g. '123456789'. */\n\tpropertyId: string\n\t/** Service-account credentials. */\n\tcredentials: { client_email: string; private_key: string }\n\t/** GCP project id; inferred from the credentials when omitted. */\n\tprojectId?: string\n\t/** Maximum days of historical data. Defaults to 425 (GA4's rolling-window limit). Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n}\n\nconst METRIC_MAP: Partial<Record<MetricKey, string>> = {\n\tpageviews: 'screenPageViews',\n\tvisitors: 'totalUsers',\n\tvisits: 'sessions',\n\tsessions: 'sessions',\n\tbounceRate: 'bounceRate',\n\tavgDuration: 'averageSessionDuration',\n\tevents: 'eventCount',\n\tconversions: 'keyEvents',\n\trevenue: 'totalRevenue',\n}\n\nconst DIMENSION_MAP: Partial<Record<DimensionKey, string>> = {\n\tpage: 'pagePath',\n\treferrer: 'pageReferrer',\n\tsource: 'sessionSource',\n\tmedium: 'sessionMedium',\n\tcampaign: 'sessionCampaignName',\n\tutmSource: 'sessionSource',\n\tutmMedium: 'sessionMedium',\n\tutmCampaign: 'sessionCampaignName',\n\tdevice: 'deviceCategory',\n\tbrowser: 'browser',\n\tos: 'operatingSystem',\n\tcountry: 'countryId',\n\tregion: 'region',\n\tcity: 'city',\n\tlanguage: 'language',\n\tevent: 'eventName',\n}\n\nconst ga4Metrics: ReadonlySet<MetricKey> = new Set(Object.keys(METRIC_MAP) as MetricKey[])\nconst ga4Dimensions: ReadonlySet<DimensionKey> = new Set(\n\tObject.keys(DIMENSION_MAP) as DimensionKey[]\n)\n\n// GA4 returns bounceRate as a 0..1 ratio and averageSessionDuration in seconds; the\n// contract uses a 0..100 percentage and milliseconds.\nconst toContractValue = (metric: MetricKey, raw: number): number => {\n\tif (metric === 'avgDuration') {\n\t\treturn Math.round(raw * 1000)\n\t}\n\tif (metric === 'bounceRate') {\n\t\treturn Math.round(raw * 100)\n\t}\n\treturn raw\n}\n\nexport function ga4(config: Ga4Config): AnalyticsAdapter {\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 425\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tcomparison: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: ga4Metrics,\n\t\tdimensions: ga4Dimensions,\n\t\tbatchPageReport: true,\n\t\trateLimit: { maxConcurrent: 10, quotaModel: 'tokens', readsCountAsUsage: true },\n\t\trecommendedTtl: { realtime: 300, aggregate: 21600 },\n\t}\n\n\tlet clientPromise: Promise<BetaAnalyticsDataClient> | undefined\n\n\tconst getClient = (): Promise<BetaAnalyticsDataClient> => {\n\t\tif (!clientPromise) {\n\t\t\tclientPromise = (async () => {\n\t\t\t\tlet mod: typeof import('@google-analytics/data')\n\t\t\t\ttry {\n\t\t\t\t\tmod = await import('@google-analytics/data')\n\t\t\t\t} catch {\n\t\t\t\t\tthrow new Error(\n\t\t\t\t\t\t'@10x-media/analytics: the GA4 adapter requires the optional peer dependency \"@google-analytics/data\". Install it with: pnpm add @google-analytics/data'\n\t\t\t\t\t)\n\t\t\t\t}\n\t\t\t\treturn new mod.BetaAnalyticsDataClient({\n\t\t\t\t\tcredentials: config.credentials,\n\t\t\t\t\tprojectId: config.projectId,\n\t\t\t\t})\n\t\t\t})()\n\t\t}\n\t\treturn clientPromise\n\t}\n\n\treturn {\n\t\tid: 'ga4',\n\t\tlabel: 'Google Analytics 4',\n\t\tcapabilities,\n\t\tisConfigured: () =>\n\t\t\tBoolean(\n\t\t\t\tconfig.propertyId && config.credentials?.client_email && config.credentials?.private_key\n\t\t\t),\n\t\t// The gRPC SDK's gax CallOptions has no AbortSignal field, so ctx.signal cannot be\n\t\t// forwarded; gax cancellation uses the call's own handle, not our signal.\n\t\tasync query(q: AnalyticsQuery, _ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst wanted = q.metrics.filter((m) => METRIC_MAP[m])\n\t\t\tconst providerMetrics = [...new Set(wanted.map((m) => METRIC_MAP[m] as string))]\n\t\t\tconst dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d])\n\t\t\tconst providerDims = [...new Set(dims.map((d) => DIMENSION_MAP[d] as string))]\n\n\t\t\tconst readRow = (\n\t\t\t\trow: protos.google.analytics.data.v1beta.IRow\n\t\t\t): Partial<Record<MetricKey, number>> => {\n\t\t\t\tconst out: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of wanted) {\n\t\t\t\t\tconst idx = providerMetrics.indexOf(METRIC_MAP[m] as string)\n\t\t\t\t\tout[m] = toContractValue(m, Number(row.metricValues?.[idx]?.value ?? 0))\n\t\t\t\t}\n\t\t\t\treturn out\n\t\t\t}\n\n\t\t\tconst filterExprs: protos.google.analytics.data.v1beta.IFilterExpression[] = []\n\t\t\tif (q.path) {\n\t\t\t\tfilterExprs.push({\n\t\t\t\t\tfilter: { fieldName: 'pagePath', stringFilter: { matchType: 'EXACT', value: q.path } },\n\t\t\t\t})\n\t\t\t}\n\t\t\tif (q.hostname) {\n\t\t\t\tfilterExprs.push({\n\t\t\t\t\tfilter: {\n\t\t\t\t\t\tfieldName: 'hostName',\n\t\t\t\t\t\tstringFilter: { matchType: 'EXACT', value: q.hostname },\n\t\t\t\t\t},\n\t\t\t\t})\n\t\t\t}\n\t\t\tconst dimensionFilter =\n\t\t\t\tfilterExprs.length === 0\n\t\t\t\t\t? undefined\n\t\t\t\t\t: filterExprs.length === 1\n\t\t\t\t\t\t? filterExprs[0]\n\t\t\t\t\t\t: { andGroup: { expressions: filterExprs } }\n\n\t\t\tconst baseRequest: protos.google.analytics.data.v1beta.IRunReportRequest = {\n\t\t\t\tproperty: `properties/${config.propertyId}`,\n\t\t\t\tdateRanges: [\n\t\t\t\t\t{\n\t\t\t\t\t\tstartDate: q.dateRange.start.toISOString().slice(0, 10),\n\t\t\t\t\t\tendDate: q.dateRange.end.toISOString().slice(0, 10),\n\t\t\t\t\t},\n\t\t\t\t],\n\t\t\t\tmetrics: providerMetrics.map((name) => ({ name })),\n\t\t\t\t...(dimensionFilter ? { dimensionFilter } : {}),\n\t\t\t}\n\n\t\t\tconst client = await getClient()\n\n\t\t\tif (q.granularity === 'day' && !dims.length) {\n\t\t\t\tconst [response] = await client.runReport({\n\t\t\t\t\t...baseRequest,\n\t\t\t\t\tdimensions: [{ name: 'date' }],\n\t\t\t\t\tmetricAggregations: [\n\t\t\t\t\t\t'TOTAL',\n\t\t\t\t\t] as unknown as protos.google.analytics.data.v1beta.MetricAggregation[],\n\t\t\t\t\torderBys: [{ dimension: { dimensionName: 'date' } }],\n\t\t\t\t})\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const row of response.rows ?? []) {\n\t\t\t\t\tconst ymd = row.dimensionValues?.[0]?.value ?? ''\n\t\t\t\t\tconst ts = dayIso(`${ymd.slice(0, 4)}-${ymd.slice(4, 6)}-${ymd.slice(6, 8)}`)\n\t\t\t\t\tif (ts) {\n\t\t\t\t\t\trows.push({ timestamp: ts, metrics: readRow(row) })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tconst totalsRow = response.totals?.[0]\n\t\t\t\tconst totals = totalsRow ? readRow(totalsRow) : {}\n\t\t\t\treturn { rows, totals, meta: { provider: 'ga4', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst [response] = await client.runReport({\n\t\t\t\t...baseRequest,\n\t\t\t\t...(providerDims.length ? { dimensions: providerDims.map((name) => ({ name })) } : {}),\n\t\t\t\t...(q.limit ? { limit: q.limit } : {}),\n\t\t\t})\n\n\t\t\tif (!dims.length) {\n\t\t\t\tconst row = response.rows?.[0]\n\t\t\t\tconst totals = row ? readRow(row) : {}\n\t\t\t\treturn { rows: [{ metrics: totals }], totals, meta: { provider: 'ga4', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst rows: AnalyticsRow[] = (response.rows ?? []).map((row) => {\n\t\t\t\tconst dimValues: Partial<Record<DimensionKey, string>> = {}\n\t\t\t\tfor (const d of dims) {\n\t\t\t\t\tconst idx = providerDims.indexOf(DIMENSION_MAP[d] as string)\n\t\t\t\t\tdimValues[d] = row.dimensionValues?.[idx]?.value ?? ''\n\t\t\t\t}\n\t\t\t\treturn { dimensions: dimValues, metrics: readRow(row) }\n\t\t\t})\n\t\t\treturn { rows, totals: undefined, meta: { provider: 'ga4', fetchedAt } }\n\t\t},\n\t}\n}\n"],"mappings":";;AAwBA,MAAM,aAAiD;CACtD,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;CACV,YAAY;CACZ,aAAa;CACb,QAAQ;CACR,aAAa;CACb,SAAS;AACV;AAEA,MAAM,gBAAuD;CAC5D,MAAM;CACN,UAAU;CACV,QAAQ;CACR,QAAQ;CACR,UAAU;CACV,WAAW;CACX,WAAW;CACX,aAAa;CACb,QAAQ;CACR,SAAS;CACT,IAAI;CACJ,SAAS;CACT,QAAQ;CACR,MAAM;CACN,UAAU;CACV,OAAO;AACR;AAEA,MAAM,aAAqC,IAAI,IAAI,OAAO,KAAK,UAAU,CAAgB;AACzF,MAAM,gBAA2C,IAAI,IACpD,OAAO,KAAK,aAAa,CAC1B;AAIA,MAAM,mBAAmB,QAAmB,QAAwB;CACnE,IAAI,WAAW,eACd,OAAO,KAAK,MAAM,MAAM,GAAI;CAE7B,IAAI,WAAW,cACd,OAAO,KAAK,MAAM,MAAM,GAAG;CAE5B,OAAO;AACR;AAEA,SAAgB,IAAI,QAAqC;CAGxD,MAAM,eAAsC;EAC3C,cAAc;EACd,UAAU;EACV,YAAY;EACZ,gBAAgB;EAChB,iBAPuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;EAQvF,SAAS;EACT,YAAY;EACZ,iBAAiB;EACjB,WAAW;GAAE,eAAe;GAAI,YAAY;GAAU,mBAAmB;EAAK;EAC9E,gBAAgB;GAAE,UAAU;GAAK,WAAW;EAAM;CACnD;CAEA,IAAI;CAEJ,MAAM,kBAAoD;EACzD,IAAI,CAAC,eACJ,iBAAiB,YAAY;GAC5B,IAAI;GACJ,IAAI;IACH,MAAM,MAAM,OAAO;GACpB,QAAQ;IACP,MAAM,IAAI,MACT,0JACD;GACD;GACA,OAAO,IAAI,IAAI,wBAAwB;IACtC,aAAa,OAAO;IACpB,WAAW,OAAO;GACnB,CAAC;EACF,GAAG;EAEJ,OAAO;CACR;CAEA,OAAO;EACN,IAAI;EACJ,OAAO;EACP;EACA,oBACC,QACC,OAAO,cAAc,OAAO,aAAa,gBAAgB,OAAO,aAAa,WAC9E;EAGD,MAAM,MAAM,GAAmB,MAAgD;GAC9E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,SAAS,EAAE,QAAQ,QAAQ,MAAM,WAAW,EAAE;GACpD,MAAM,kBAAkB,CAAC,GAAG,IAAI,IAAI,OAAO,KAAK,MAAM,WAAW,EAAY,CAAC,CAAC;GAC/E,MAAM,QAAQ,EAAE,cAAc,CAAC,GAAG,QAAQ,MAAM,cAAc,EAAE;GAChE,MAAM,eAAe,CAAC,GAAG,IAAI,IAAI,KAAK,KAAK,MAAM,cAAc,EAAY,CAAC,CAAC;GAE7E,MAAM,WACL,QACwC;IACxC,MAAM,MAA0C,CAAC;IACjD,KAAK,MAAM,KAAK,QAAQ;KACvB,MAAM,MAAM,gBAAgB,QAAQ,WAAW,EAAY;KAC3D,IAAI,KAAK,gBAAgB,GAAG,OAAO,IAAI,eAAe,MAAM,SAAS,CAAC,CAAC;IACxE;IACA,OAAO;GACR;GAEA,MAAM,cAAuE,CAAC;GAC9E,IAAI,EAAE,MACL,YAAY,KAAK,EAChB,QAAQ;IAAE,WAAW;IAAY,cAAc;KAAE,WAAW;KAAS,OAAO,EAAE;IAAK;GAAE,EACtF,CAAC;GAEF,IAAI,EAAE,UACL,YAAY,KAAK,EAChB,QAAQ;IACP,WAAW;IACX,cAAc;KAAE,WAAW;KAAS,OAAO,EAAE;IAAS;GACvD,EACD,CAAC;GAEF,MAAM,kBACL,YAAY,WAAW,IACpB,KAAA,IACA,YAAY,WAAW,IACtB,YAAY,KACZ,EAAE,UAAU,EAAE,aAAa,YAAY,EAAE;GAE9C,MAAM,cAAqE;IAC1E,UAAU,cAAc,OAAO;IAC/B,YAAY,CACX;KACC,WAAW,EAAE,UAAU,MAAM,YAAY,EAAE,MAAM,GAAG,EAAE;KACtD,SAAS,EAAE,UAAU,IAAI,YAAY,EAAE,MAAM,GAAG,EAAE;IACnD,CACD;IACA,SAAS,gBAAgB,KAAK,UAAU,EAAE,KAAK,EAAE;IACjD,GAAI,kBAAkB,EAAE,gBAAgB,IAAI,CAAC;GAC9C;GAEA,MAAM,SAAS,MAAM,UAAU;GAE/B,IAAI,EAAE,gBAAgB,SAAS,CAAC,KAAK,QAAQ;IAC5C,MAAM,CAAC,YAAY,MAAM,OAAO,UAAU;KACzC,GAAG;KACH,YAAY,CAAC,EAAE,MAAM,OAAO,CAAC;KAC7B,oBAAoB,CACnB,OACD;KACA,UAAU,CAAC,EAAE,WAAW,EAAE,eAAe,OAAO,EAAE,CAAC;IACpD,CAAC;IACD,MAAM,OAAuB,CAAC;IAC9B,KAAK,MAAM,OAAO,SAAS,QAAQ,CAAC,GAAG;KACtC,MAAM,MAAM,IAAI,kBAAkB,IAAI,SAAS;KAC/C,MAAM,KAAK,OAAO,GAAG,IAAI,MAAM,GAAG,CAAC,EAAE,GAAG,IAAI,MAAM,GAAG,CAAC,EAAE,GAAG,IAAI,MAAM,GAAG,CAAC,GAAG;KAC5E,IAAI,IACH,KAAK,KAAK;MAAE,WAAW;MAAI,SAAS,QAAQ,GAAG;KAAE,CAAC;IAEpD;IACA,MAAM,YAAY,SAAS,SAAS;IAEpC,OAAO;KAAE;KAAM,QADA,YAAY,QAAQ,SAAS,IAAI,CAAC;KAC1B,MAAM;MAAE,UAAU;MAAO;KAAU;IAAE;GAC7D;GAEA,MAAM,CAAC,YAAY,MAAM,OAAO,UAAU;IACzC,GAAG;IACH,GAAI,aAAa,SAAS,EAAE,YAAY,aAAa,KAAK,UAAU,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC;IACpF,GAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;GACrC,CAAC;GAED,IAAI,CAAC,KAAK,QAAQ;IACjB,MAAM,MAAM,SAAS,OAAO;IAC5B,MAAM,SAAS,MAAM,QAAQ,GAAG,IAAI,CAAC;IACrC,OAAO;KAAE,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC;KAAG;KAAQ,MAAM;MAAE,UAAU;MAAO;KAAU;IAAE;GACpF;GAUA,OAAO;IAAE,OARqB,SAAS,QAAQ,CAAC,GAAG,KAAK,QAAQ;KAC/D,MAAM,YAAmD,CAAC;KAC1D,KAAK,MAAM,KAAK,MAAM;MACrB,MAAM,MAAM,aAAa,QAAQ,cAAc,EAAY;MAC3D,UAAU,KAAK,IAAI,kBAAkB,MAAM,SAAS;KACrD;KACA,OAAO;MAAE,YAAY;MAAW,SAAS,QAAQ,GAAG;KAAE;IACvD,CACY;IAAG,QAAQ,KAAA;IAAW,MAAM;KAAE,UAAU;KAAO;IAAU;GAAE;EACxE;CACD;AACD"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plausible.js","names":[],"sources":["../../../src/adapters/plausible/plausible.ts"],"sourcesContent":["import type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tMetricKey,\n} from '../../core/contract'\nimport { fetchJson } from '../http/fetchJson'\nimport { dayIso } from '../series'\n\nexport interface PlausibleConfig {\n\tsiteId: string\n\tapiKey: string\n\t/** Base URL for self-hosted CE. Defaults to Plausible Cloud. */\n\thost?: string\n\t/** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n}\n\nconst METRIC_MAP: Partial<Record<MetricKey, string>> = {\n\tpageviews: 'pageviews',\n\tvisitors: 'visitors',\n\tvisits: 'visits',\n\tsessions: 'visits',\n\tbounceRate: 'bounce_rate',\n\tavgDuration: 'visit_duration',\n\tevents: 'events',\n\tscrollDepth: 'scroll_depth',\n\trevenue: 'total_revenue',\n}\n\nconst DIMENSION_MAP: Partial<Record<DimensionKey, string>> = {\n\tpage: 'event:page',\n\tsource: 'visit:source',\n\treferrer: 'visit:referrer',\n\tdevice: 'visit:device',\n\tbrowser: 'visit:browser',\n\tos: 'visit:os',\n\tcountry: 'visit:country',\n\tregion: 'visit:region',\n\tcity: 'visit:city',\n\tutmSource: 'visit:utm_source',\n\tutmMedium: 'visit:utm_medium',\n\tutmCampaign: 'visit:utm_campaign',\n}\n\nconst plausibleMetrics: ReadonlySet<MetricKey> = new Set(Object.keys(METRIC_MAP) as MetricKey[])\nconst plausibleDimensions: ReadonlySet<DimensionKey> = new Set(\n\tObject.keys(DIMENSION_MAP) as DimensionKey[]\n)\n\ninterface PlausibleResponse {\n\tresults: Array<{ metrics: number[]; dimensions: string[] }>\n}\n\n// visit_duration is reported in seconds; the contract avgDuration is milliseconds.\nconst toContractValue = (metric: MetricKey, raw: number): number =>\n\tmetric === 'avgDuration' ? Math.round(raw * 1000) : raw\n\nexport function plausible(config: PlausibleConfig): AnalyticsAdapter {\n\tconst host = config.host ?? 'https://plausible.io'\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 730\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tcomparison: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: plausibleMetrics,\n\t\tdimensions: plausibleDimensions,\n\t\tbatchPageReport: true,\n\t\trateLimit: { requestsPerHour: 600 },\n\t\trecommendedTtl: { realtime: 300, aggregate: 3600 },\n\t}\n\n\treturn {\n\t\tid: 'plausible',\n\t\tlabel: 'Plausible',\n\t\tcapabilities,\n\t\tisConfigured: () => Boolean(config.siteId && config.apiKey),\n\t\tasync query(q: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst wanted = q.metrics.filter((m) => METRIC_MAP[m])\n\t\t\t// Several contract metrics alias one Plausible metric (sessions and visits both\n\t\t\t// map to \"visits\"), so dedupe before sending and read each contract metric back\n\t\t\t// from its provider key's position rather than the request index.\n\t\t\tconst providerMetrics = [...new Set(wanted.map((m) => METRIC_MAP[m] as string))]\n\t\t\tconst dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d])\n\t\t\tconst filters: Array<[string, string, string[]]> = []\n\t\t\tif (q.path) {\n\t\t\t\tfilters.push(['is', 'event:page', [q.path]])\n\t\t\t}\n\n\t\t\tconst readRow = (row: { metrics: number[] }): Partial<Record<MetricKey, number>> => {\n\t\t\t\tconst out: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of wanted) {\n\t\t\t\t\tconst idx = providerMetrics.indexOf(METRIC_MAP[m] as string)\n\t\t\t\t\tout[m] = toContractValue(m, row.metrics[idx] ?? 0)\n\t\t\t\t}\n\t\t\t\treturn out\n\t\t\t}\n\n\t\t\tconst postQuery = (extra: Record<string, unknown>): Promise<PlausibleResponse> =>\n\t\t\t\tfetchJson<PlausibleResponse>(`${host}/api/v2/query`, {\n\t\t\t\t\tmethod: 'POST',\n\t\t\t\t\theaders: { authorization: `Bearer ${config.apiKey}` },\n\t\t\t\t\tbody: {\n\t\t\t\t\t\tsite_id: config.siteId,\n\t\t\t\t\t\tmetrics: providerMetrics,\n\t\t\t\t\t\tdate_range: [\n\t\t\t\t\t\t\tq.dateRange.start.toISOString().slice(0, 10),\n\t\t\t\t\t\t\tq.dateRange.end.toISOString().slice(0, 10),\n\t\t\t\t\t\t],\n\t\t\t\t\t\t...(filters.length ? { filters } : {}),\n\t\t\t\t\t\t...extra,\n\t\t\t\t\t},\n\t\t\t\t\tsignal: ctx.signal,\n\t\t\t\t\tprovider: 'plausible',\n\t\t\t\t})\n\n\t\t\tconst fetchTotals = async (): Promise<Partial<Record<MetricKey, number>>> => {\n\t\t\t\tconst data = await postQuery({})\n\t\t\t\treturn data.results[0] ? readRow(data.results[0]) : {}\n\t\t\t}\n\n\t\t\tif (q.granularity === 'day' && !dims.length) {\n\t\t\t\tconst [seriesData, totals] = await Promise.all([\n\t\t\t\t\tpostQuery({ dimensions: ['time:day'] }),\n\t\t\t\t\tfetchTotals(),\n\t\t\t\t])\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const row of seriesData.results) {\n\t\t\t\t\tconst ts = dayIso(row.dimensions[0] ?? '')\n\t\t\t\t\tif (ts) {\n\t\t\t\t\t\trows.push({ timestamp: ts, metrics: readRow(row) })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { rows, totals, meta: { provider: 'plausible', fetchedAt } }\n\t\t\t}\n\n\t\t\tif (!dims.length) {\n\t\t\t\tconst totals = await fetchTotals()\n\t\t\t\treturn { rows: [{ metrics: totals }], totals, meta: { provider: 'plausible', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst data = await postQuery({ dimensions: dims.map((d) => DIMENSION_MAP[d] as string) })\n\t\t\tconst rows: AnalyticsRow[] = data.results.map((row) => {\n\t\t\t\tconst dimValues: Partial<Record<DimensionKey, string>> = {}\n\t\t\t\tfor (let i = 0; i < dims.length; i++) {\n\t\t\t\t\tconst d = dims[i]\n\t\t\t\t\tif (d !== undefined) {\n\t\t\t\t\t\tdimValues[d] = row.dimensions[i] ?? ''\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { dimensions: dimValues, metrics: readRow(row) }\n\t\t\t})\n\t\t\treturn { rows, totals: undefined, meta: { provider: 'plausible', fetchedAt } }\n\t\t},\n\t}\n}\n"],"mappings":";;;AAsBA,MAAM,aAAiD;CACtD,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;CACV,YAAY;CACZ,aAAa;CACb,QAAQ;CACR,aAAa;CACb,SAAS;AACV;AAEA,MAAM,gBAAuD;CAC5D,MAAM;CACN,QAAQ;CACR,UAAU;CACV,QAAQ;CACR,SAAS;CACT,IAAI;CACJ,SAAS;CACT,QAAQ;CACR,MAAM;CACN,WAAW;CACX,WAAW;CACX,aAAa;AACd;AAEA,MAAM,mBAA2C,IAAI,IAAI,OAAO,KAAK,UAAU,CAAgB;AAC/F,MAAM,sBAAiD,IAAI,IAC1D,OAAO,KAAK,aAAa,CAC1B;AAOA,MAAM,mBAAmB,QAAmB,QAC3C,WAAW,gBAAgB,KAAK,MAAM,MAAM,GAAI,IAAI;AAErD,SAAgB,UAAU,QAA2C;CACpE,MAAM,OAAO,OAAO,QAAQ;CAgB5B,OAAO;EACN,IAAI;EACJ,OAAO;EACP,cAAA;GAfA,cAAc;GACd,UAAU;GACV,YAAY;GACZ,gBAAgB;GAChB,iBAPuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;GAQvF,SAAS;GACT,YAAY;GACZ,iBAAiB;GACjB,WAAW,EAAE,iBAAiB,IAAI;GAClC,gBAAgB;IAAE,UAAU;IAAK,WAAW;GAAK;EAMtC;EACX,oBAAoB,QAAQ,OAAO,UAAU,OAAO,MAAM;EAC1D,MAAM,MAAM,GAAmB,KAA+C;GAC7E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,SAAS,EAAE,QAAQ,QAAQ,MAAM,WAAW,EAAE;GAIpD,MAAM,kBAAkB,CAAC,GAAG,IAAI,IAAI,OAAO,KAAK,MAAM,WAAW,EAAY,CAAC,CAAC;GAC/E,MAAM,QAAQ,EAAE,cAAc,CAAC,GAAG,QAAQ,MAAM,cAAc,EAAE;GAChE,MAAM,UAA6C,CAAC;GACpD,IAAI,EAAE,MACL,QAAQ,KAAK;IAAC;IAAM;IAAc,CAAC,EAAE,IAAI;GAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"plausible.js","names":[],"sources":["../../../src/adapters/plausible/plausible.ts"],"sourcesContent":["import type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tMetricKey,\n} from '../../core/contract'\nimport { fetchJson } from '../http/fetchJson'\nimport { dayIso } from '../series'\n\nexport interface PlausibleConfig {\n\tsiteId: string\n\tapiKey: string\n\t/** Base URL for self-hosted CE. Defaults to Plausible Cloud. */\n\thost?: string\n\t/** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n}\n\nconst METRIC_MAP: Partial<Record<MetricKey, string>> = {\n\tpageviews: 'pageviews',\n\tvisitors: 'visitors',\n\tvisits: 'visits',\n\tsessions: 'visits',\n\tbounceRate: 'bounce_rate',\n\tavgDuration: 'visit_duration',\n\tevents: 'events',\n\tscrollDepth: 'scroll_depth',\n\trevenue: 'total_revenue',\n}\n\nconst DIMENSION_MAP: Partial<Record<DimensionKey, string>> = {\n\tpage: 'event:page',\n\tsource: 'visit:source',\n\treferrer: 'visit:referrer',\n\tdevice: 'visit:device',\n\tbrowser: 'visit:browser',\n\tos: 'visit:os',\n\tcountry: 'visit:country',\n\tregion: 'visit:region',\n\tcity: 'visit:city',\n\tutmSource: 'visit:utm_source',\n\tutmMedium: 'visit:utm_medium',\n\tutmCampaign: 'visit:utm_campaign',\n}\n\nconst plausibleMetrics: ReadonlySet<MetricKey> = new Set(Object.keys(METRIC_MAP) as MetricKey[])\nconst plausibleDimensions: ReadonlySet<DimensionKey> = new Set(\n\tObject.keys(DIMENSION_MAP) as DimensionKey[]\n)\n\ninterface PlausibleResponse {\n\tresults: Array<{ metrics: number[]; dimensions: string[] }>\n}\n\n// visit_duration is reported in seconds; the contract avgDuration is milliseconds.\nconst toContractValue = (metric: MetricKey, raw: number): number =>\n\tmetric === 'avgDuration' ? Math.round(raw * 1000) : raw\n\nexport function plausible(config: PlausibleConfig): AnalyticsAdapter {\n\tconst host = config.host ?? 'https://plausible.io'\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 730\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tcomparison: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: plausibleMetrics,\n\t\tdimensions: plausibleDimensions,\n\t\tbatchPageReport: true,\n\t\trateLimit: { requestsPerHour: 600 },\n\t\trecommendedTtl: { realtime: 300, aggregate: 3600 },\n\t}\n\n\treturn {\n\t\tid: 'plausible',\n\t\tlabel: 'Plausible',\n\t\tcapabilities,\n\t\tisConfigured: () => Boolean(config.siteId && config.apiKey),\n\t\tasync query(q: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst wanted = q.metrics.filter((m) => METRIC_MAP[m])\n\t\t\t// Several contract metrics alias one Plausible metric (sessions and visits both\n\t\t\t// map to \"visits\"), so dedupe before sending and read each contract metric back\n\t\t\t// from its provider key's position rather than the request index.\n\t\t\tconst providerMetrics = [...new Set(wanted.map((m) => METRIC_MAP[m] as string))]\n\t\t\tconst dims = (q.dimensions ?? []).filter((d) => DIMENSION_MAP[d])\n\t\t\tconst filters: Array<[string, string, string[]]> = []\n\t\t\tif (q.path) {\n\t\t\t\tfilters.push(['is', 'event:page', [q.path]])\n\t\t\t}\n\t\t\tif (q.hostname) {\n\t\t\t\tfilters.push(['is', 'event:hostname', [q.hostname]])\n\t\t\t}\n\n\t\t\tconst readRow = (row: { metrics: number[] }): Partial<Record<MetricKey, number>> => {\n\t\t\t\tconst out: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of wanted) {\n\t\t\t\t\tconst idx = providerMetrics.indexOf(METRIC_MAP[m] as string)\n\t\t\t\t\tout[m] = toContractValue(m, row.metrics[idx] ?? 0)\n\t\t\t\t}\n\t\t\t\treturn out\n\t\t\t}\n\n\t\t\tconst postQuery = (extra: Record<string, unknown>): Promise<PlausibleResponse> =>\n\t\t\t\tfetchJson<PlausibleResponse>(`${host}/api/v2/query`, {\n\t\t\t\t\tmethod: 'POST',\n\t\t\t\t\theaders: { authorization: `Bearer ${config.apiKey}` },\n\t\t\t\t\tbody: {\n\t\t\t\t\t\tsite_id: config.siteId,\n\t\t\t\t\t\tmetrics: providerMetrics,\n\t\t\t\t\t\tdate_range: [\n\t\t\t\t\t\t\tq.dateRange.start.toISOString().slice(0, 10),\n\t\t\t\t\t\t\tq.dateRange.end.toISOString().slice(0, 10),\n\t\t\t\t\t\t],\n\t\t\t\t\t\t...(filters.length ? { filters } : {}),\n\t\t\t\t\t\t...extra,\n\t\t\t\t\t},\n\t\t\t\t\tsignal: ctx.signal,\n\t\t\t\t\tprovider: 'plausible',\n\t\t\t\t})\n\n\t\t\tconst fetchTotals = async (): Promise<Partial<Record<MetricKey, number>>> => {\n\t\t\t\tconst data = await postQuery({})\n\t\t\t\treturn data.results[0] ? readRow(data.results[0]) : {}\n\t\t\t}\n\n\t\t\tif (q.granularity === 'day' && !dims.length) {\n\t\t\t\tconst [seriesData, totals] = await Promise.all([\n\t\t\t\t\tpostQuery({ dimensions: ['time:day'] }),\n\t\t\t\t\tfetchTotals(),\n\t\t\t\t])\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const row of seriesData.results) {\n\t\t\t\t\tconst ts = dayIso(row.dimensions[0] ?? '')\n\t\t\t\t\tif (ts) {\n\t\t\t\t\t\trows.push({ timestamp: ts, metrics: readRow(row) })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { rows, totals, meta: { provider: 'plausible', fetchedAt } }\n\t\t\t}\n\n\t\t\tif (!dims.length) {\n\t\t\t\tconst totals = await fetchTotals()\n\t\t\t\treturn { rows: [{ metrics: totals }], totals, meta: { provider: 'plausible', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst data = await postQuery({ dimensions: dims.map((d) => DIMENSION_MAP[d] as string) })\n\t\t\tconst rows: AnalyticsRow[] = data.results.map((row) => {\n\t\t\t\tconst dimValues: Partial<Record<DimensionKey, string>> = {}\n\t\t\t\tfor (let i = 0; i < dims.length; i++) {\n\t\t\t\t\tconst d = dims[i]\n\t\t\t\t\tif (d !== undefined) {\n\t\t\t\t\t\tdimValues[d] = row.dimensions[i] ?? ''\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { dimensions: dimValues, metrics: readRow(row) }\n\t\t\t})\n\t\t\treturn { rows, totals: undefined, meta: { provider: 'plausible', fetchedAt } }\n\t\t},\n\t}\n}\n"],"mappings":";;;AAsBA,MAAM,aAAiD;CACtD,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;CACV,YAAY;CACZ,aAAa;CACb,QAAQ;CACR,aAAa;CACb,SAAS;AACV;AAEA,MAAM,gBAAuD;CAC5D,MAAM;CACN,QAAQ;CACR,UAAU;CACV,QAAQ;CACR,SAAS;CACT,IAAI;CACJ,SAAS;CACT,QAAQ;CACR,MAAM;CACN,WAAW;CACX,WAAW;CACX,aAAa;AACd;AAEA,MAAM,mBAA2C,IAAI,IAAI,OAAO,KAAK,UAAU,CAAgB;AAC/F,MAAM,sBAAiD,IAAI,IAC1D,OAAO,KAAK,aAAa,CAC1B;AAOA,MAAM,mBAAmB,QAAmB,QAC3C,WAAW,gBAAgB,KAAK,MAAM,MAAM,GAAI,IAAI;AAErD,SAAgB,UAAU,QAA2C;CACpE,MAAM,OAAO,OAAO,QAAQ;CAgB5B,OAAO;EACN,IAAI;EACJ,OAAO;EACP,cAAA;GAfA,cAAc;GACd,UAAU;GACV,YAAY;GACZ,gBAAgB;GAChB,iBAPuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;GAQvF,SAAS;GACT,YAAY;GACZ,iBAAiB;GACjB,WAAW,EAAE,iBAAiB,IAAI;GAClC,gBAAgB;IAAE,UAAU;IAAK,WAAW;GAAK;EAMtC;EACX,oBAAoB,QAAQ,OAAO,UAAU,OAAO,MAAM;EAC1D,MAAM,MAAM,GAAmB,KAA+C;GAC7E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,SAAS,EAAE,QAAQ,QAAQ,MAAM,WAAW,EAAE;GAIpD,MAAM,kBAAkB,CAAC,GAAG,IAAI,IAAI,OAAO,KAAK,MAAM,WAAW,EAAY,CAAC,CAAC;GAC/E,MAAM,QAAQ,EAAE,cAAc,CAAC,GAAG,QAAQ,MAAM,cAAc,EAAE;GAChE,MAAM,UAA6C,CAAC;GACpD,IAAI,EAAE,MACL,QAAQ,KAAK;IAAC;IAAM;IAAc,CAAC,EAAE,IAAI;GAAC,CAAC;GAE5C,IAAI,EAAE,UACL,QAAQ,KAAK;IAAC;IAAM;IAAkB,CAAC,EAAE,QAAQ;GAAC,CAAC;GAGpD,MAAM,WAAW,QAAmE;IACnF,MAAM,MAA0C,CAAC;IACjD,KAAK,MAAM,KAAK,QAAQ;KACvB,MAAM,MAAM,gBAAgB,QAAQ,WAAW,EAAY;KAC3D,IAAI,KAAK,gBAAgB,GAAG,IAAI,QAAQ,QAAQ,CAAC;IAClD;IACA,OAAO;GACR;GAEA,MAAM,aAAa,UAClB,UAA6B,GAAG,KAAK,gBAAgB;IACpD,QAAQ;IACR,SAAS,EAAE,eAAe,UAAU,OAAO,SAAS;IACpD,MAAM;KACL,SAAS,OAAO;KAChB,SAAS;KACT,YAAY,CACX,EAAE,UAAU,MAAM,YAAY,EAAE,MAAM,GAAG,EAAE,GAC3C,EAAE,UAAU,IAAI,YAAY,EAAE,MAAM,GAAG,EAAE,CAC1C;KACA,GAAI,QAAQ,SAAS,EAAE,QAAQ,IAAI,CAAC;KACpC,GAAG;IACJ;IACA,QAAQ,IAAI;IACZ,UAAU;GACX,CAAC;GAEF,MAAM,cAAc,YAAyD;IAC5E,MAAM,OAAO,MAAM,UAAU,CAAC,CAAC;IAC/B,OAAO,KAAK,QAAQ,KAAK,QAAQ,KAAK,QAAQ,EAAE,IAAI,CAAC;GACtD;GAEA,IAAI,EAAE,gBAAgB,SAAS,CAAC,KAAK,QAAQ;IAC5C,MAAM,CAAC,YAAY,UAAU,MAAM,QAAQ,IAAI,CAC9C,UAAU,EAAE,YAAY,CAAC,UAAU,EAAE,CAAC,GACtC,YAAY,CACb,CAAC;IACD,MAAM,OAAuB,CAAC;IAC9B,KAAK,MAAM,OAAO,WAAW,SAAS;KACrC,MAAM,KAAK,OAAO,IAAI,WAAW,MAAM,EAAE;KACzC,IAAI,IACH,KAAK,KAAK;MAAE,WAAW;MAAI,SAAS,QAAQ,GAAG;KAAE,CAAC;IAEpD;IACA,OAAO;KAAE;KAAM;KAAQ,MAAM;MAAE,UAAU;MAAa;KAAU;IAAE;GACnE;GAEA,IAAI,CAAC,KAAK,QAAQ;IACjB,MAAM,SAAS,MAAM,YAAY;IACjC,OAAO;KAAE,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC;KAAG;KAAQ,MAAM;MAAE,UAAU;MAAa;KAAU;IAAE;GAC1F;GAaA,OAAO;IAAE,OAVoB,MADV,UAAU,EAAE,YAAY,KAAK,KAAK,MAAM,cAAc,EAAY,EAAE,CAAC,GACtD,QAAQ,KAAK,QAAQ;KACtD,MAAM,YAAmD,CAAC;KAC1D,KAAK,IAAI,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;MACrC,MAAM,IAAI,KAAK;MACf,IAAI,MAAM,KAAA,GACT,UAAU,KAAK,IAAI,WAAW,MAAM;KAEtC;KACA,OAAO;MAAE,YAAY;MAAW,SAAS,QAAQ,GAAG;KAAE;IACvD,CACY;IAAG,QAAQ,KAAA;IAAW,MAAM;KAAE,UAAU;KAAa;IAAU;GAAE;EAC9E;CACD;AACD"}
|
|
@@ -2,14 +2,25 @@ import { dayIso } from "../series.js";
|
|
|
2
2
|
import { fetchJson } from "../http/fetchJson.js";
|
|
3
3
|
//#region src/adapters/posthog/posthog.ts
|
|
4
4
|
const US_CLOUD = "https://us.posthog.com";
|
|
5
|
-
const
|
|
5
|
+
const METRIC_SQL_PAGEVIEW = {
|
|
6
6
|
pageviews: "count()",
|
|
7
7
|
visitors: "count(DISTINCT person_id)",
|
|
8
8
|
visits: "count(DISTINCT properties.$session_id)",
|
|
9
9
|
sessions: "count(DISTINCT properties.$session_id)"
|
|
10
10
|
};
|
|
11
|
-
const
|
|
12
|
-
|
|
11
|
+
const METRIC_SQL_ALL = {
|
|
12
|
+
pageviews: "countIf(event = '$pageview')",
|
|
13
|
+
visitors: "count(DISTINCT if(event = '$pageview', person_id, NULL))",
|
|
14
|
+
visits: "count(DISTINCT if(event = '$pageview', properties.$session_id, NULL))",
|
|
15
|
+
sessions: "count(DISTINCT if(event = '$pageview', properties.$session_id, NULL))",
|
|
16
|
+
events: "count()"
|
|
17
|
+
};
|
|
18
|
+
const DIMENSION_SQL = {
|
|
19
|
+
page: "properties.$pathname",
|
|
20
|
+
event: "event"
|
|
21
|
+
};
|
|
22
|
+
const posthogMetrics = new Set(Object.keys(METRIC_SQL_ALL));
|
|
23
|
+
const posthogDimensions = new Set(Object.keys(DIMENSION_SQL));
|
|
13
24
|
const sqlString = (value) => `'${value.replace(/\\/g, "\\\\").replace(/'/g, "\\'")}'`;
|
|
14
25
|
const sqlDateTimeLiteral = (d) => sqlString(d.toISOString().slice(0, 19).replace("T", " "));
|
|
15
26
|
function posthog(config) {
|
|
@@ -39,15 +50,15 @@ function posthog(config) {
|
|
|
39
50
|
isConfigured: () => Boolean(config.projectId && config.apiKey),
|
|
40
51
|
async query(q, ctx) {
|
|
41
52
|
const fetchedAt = q.dateRange.end.toISOString();
|
|
42
|
-
const
|
|
43
|
-
const
|
|
44
|
-
const
|
|
45
|
-
const
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
];
|
|
53
|
+
const breakdownDim = (q.dimensions ?? []).find((d) => DIMENSION_SQL[d]);
|
|
54
|
+
const scanAllEvents = q.metrics.includes("events") || breakdownDim === "event";
|
|
55
|
+
const metricSql = scanAllEvents ? METRIC_SQL_ALL : METRIC_SQL_PAGEVIEW;
|
|
56
|
+
const wanted = q.metrics.filter((m) => metricSql[m]);
|
|
57
|
+
const exprs = [...new Set(wanted.map((m) => metricSql[m]))];
|
|
58
|
+
const where = [`timestamp >= toDateTime(${sqlDateTimeLiteral(q.dateRange.start)})`, `timestamp <= toDateTime(${sqlDateTimeLiteral(q.dateRange.end)})`];
|
|
59
|
+
if (!scanAllEvents) where.unshift("event = '$pageview'");
|
|
50
60
|
if (q.path) where.push(`properties.$pathname = ${sqlString(q.path)}`);
|
|
61
|
+
if (q.hostname) where.push(`properties.$host = ${sqlString(q.hostname)}`);
|
|
51
62
|
if (config.scopeProperty && q.scope !== void 0) where.push(`properties[${sqlString(config.scopeProperty)}] = ${sqlString(q.scope)}`);
|
|
52
63
|
const selectMetrics = exprs.map((expr, i) => `${expr} AS m${i}`);
|
|
53
64
|
const runSql = (sql) => fetchJson(`${host}/api/projects/${config.projectId}/query/`, {
|
|
@@ -63,7 +74,7 @@ function posthog(config) {
|
|
|
63
74
|
const readRow = (row, offset) => {
|
|
64
75
|
const out = {};
|
|
65
76
|
for (const m of wanted) {
|
|
66
|
-
const idx = exprs.indexOf(
|
|
77
|
+
const idx = exprs.indexOf(metricSql[m]);
|
|
67
78
|
out[m] = Number(row[offset + idx] ?? 0);
|
|
68
79
|
}
|
|
69
80
|
return out;
|
|
@@ -72,8 +83,8 @@ function posthog(config) {
|
|
|
72
83
|
const row = (await runSql(`SELECT ${selectMetrics.join(", ")} FROM events WHERE ${where.join(" AND ")}`)).results[0];
|
|
73
84
|
return row ? readRow(row, 0) : {};
|
|
74
85
|
};
|
|
75
|
-
if (q.granularity === "day" && !
|
|
76
|
-
const seriesSql = `SELECT toStartOfDay(timestamp) AS day, ${selectMetrics.join(", ")} FROM events WHERE ${where.join(" AND ")} GROUP BY day ORDER BY day`;
|
|
86
|
+
if (q.granularity === "day" && !breakdownDim) {
|
|
87
|
+
const seriesSql = `SELECT ${`toStartOfDay(timestamp, ${sqlString(q.timezone ?? "UTC")})`} AS day, ${selectMetrics.join(", ")} FROM events WHERE ${where.join(" AND ")} GROUP BY day ORDER BY day`;
|
|
77
88
|
const [seriesData, totals] = await Promise.all([runSql(seriesSql), fetchTotals()]);
|
|
78
89
|
const rows = [];
|
|
79
90
|
for (const row of seriesData.results) {
|
|
@@ -92,9 +103,9 @@ function posthog(config) {
|
|
|
92
103
|
}
|
|
93
104
|
};
|
|
94
105
|
}
|
|
95
|
-
if (
|
|
96
|
-
rows: (await runSql(`SELECT
|
|
97
|
-
dimensions: {
|
|
106
|
+
if (breakdownDim) return {
|
|
107
|
+
rows: (await runSql(`SELECT ${DIMENSION_SQL[breakdownDim]} AS dim, ${selectMetrics.join(", ")} FROM events WHERE ${where.join(" AND ")} GROUP BY dim ORDER BY m0 DESC LIMIT ${q.limit ?? 100}`)).results.map((row) => ({
|
|
108
|
+
dimensions: { [breakdownDim]: String(row[0] ?? "") },
|
|
98
109
|
metrics: readRow(row, 1)
|
|
99
110
|
})),
|
|
100
111
|
totals: void 0,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"posthog.js","names":[],"sources":["../../../src/adapters/posthog/posthog.ts"],"sourcesContent":["import type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tMetricKey,\n} from '../../core/contract'\nimport { fetchJson } from '../http/fetchJson'\nimport { dayIso } from '../series'\n\nexport interface PosthogConfig {\n\t/** PostHog project id (numeric). */\n\tprojectId: string\n\t/** Personal API key with the \"Query Read\" scope (phx_...). */\n\tapiKey: string\n\t/** API host. Defaults to US Cloud; EU is https://eu.posthog.com, self-host is your instance URL. */\n\thost?: string\n\t/** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n\t/**\n\t * Event property holding a query's scope (e.g. 'tenant'). Enables scoped queries:\n\t * one platform project captures every scope with this property set, and a scoped\n\t * read filters on it. Both the property name and value are escaped literals.\n\t */\n\tscopeProperty?: string\n}\n\nconst US_CLOUD = 'https://us.posthog.com'\n\n// visits and sessions share the distinct-session expression and are deduped before\n// the SELECT, then read back by the expression's position.\nconst METRIC_SQL: Partial<Record<MetricKey, string>> = {\n\tpageviews: 'count()',\n\tvisitors: 'count(DISTINCT person_id)',\n\tvisits: 'count(DISTINCT properties.$session_id)',\n\tsessions: 'count(DISTINCT properties.$session_id)',\n}\n\nconst posthogMetrics: ReadonlySet<MetricKey> = new Set(Object.keys(METRIC_SQL) as MetricKey[])\nconst posthogDimensions: ReadonlySet<DimensionKey> = new Set<DimensionKey>(['page'])\n\n// The Query API has no parameter binding, so values are inlined as quoted literals.\n// Escape backslashes first, then single quotes, so a crafted path cannot break out.\nconst sqlString = (value: string): string =>\n\t`'${value.replace(/\\\\/g, '\\\\\\\\').replace(/'/g, \"\\\\'\")}'`\n\nconst sqlDateTimeLiteral = (d: Date): string =>\n\tsqlString(d.toISOString().slice(0, 19).replace('T', ' '))\n\ninterface PosthogQueryResponse {\n\tcolumns: string[]\n\ttypes: string[]\n\tresults: unknown[][]\n}\n\nexport function posthog(config: PosthogConfig): AnalyticsAdapter {\n\tconst host = config.host ?? US_CLOUD\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 730\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tcomparison: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: posthogMetrics,\n\t\tdimensions: posthogDimensions,\n\t\tbatchPageReport: true,\n\t\trateLimit: { requestsPerMinute: 240, requestsPerHour: 2400 },\n\t\trecommendedTtl: { realtime: 300, aggregate: 3600 },\n\t\t...(config.scopeProperty ? { scopedQueries: true } : {}),\n\t}\n\n\treturn {\n\t\tid: 'posthog',\n\t\tlabel: 'PostHog',\n\t\tcapabilities,\n\t\tisConfigured: () => Boolean(config.projectId && config.apiKey),\n\t\tasync query(q: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst wanted = q.metrics.filter((m) => METRIC_SQL[m])\n\t\t\tconst exprs = [...new Set(wanted.map((m) => METRIC_SQL[m] as string))]\n\t\t\tconst wantsPageBreakdown = (q.dimensions ?? []).includes('page')\n\n\t\t\tconst where = [\n\t\t\t\t\"event = '$pageview'\",\n\t\t\t\t`timestamp >= toDateTime(${sqlDateTimeLiteral(q.dateRange.start)})`,\n\t\t\t\t`timestamp <= toDateTime(${sqlDateTimeLiteral(q.dateRange.end)})`,\n\t\t\t]\n\t\t\tif (q.path) {\n\t\t\t\twhere.push(`properties.$pathname = ${sqlString(q.path)}`)\n\t\t\t}\n\t\t\tif (config.scopeProperty && q.scope !== undefined) {\n\t\t\t\t// Bracket property access with escaped literals: neither the configured\n\t\t\t\t// property name nor the scope value can break out of the HogQL string.\n\t\t\t\twhere.push(`properties[${sqlString(config.scopeProperty)}] = ${sqlString(q.scope)}`)\n\t\t\t}\n\t\t\tconst selectMetrics = exprs.map((expr, i) => `${expr} AS m${i}`)\n\n\t\t\tconst runSql = (sql: string): Promise<PosthogQueryResponse> =>\n\t\t\t\tfetchJson<PosthogQueryResponse>(`${host}/api/projects/${config.projectId}/query/`, {\n\t\t\t\t\tmethod: 'POST',\n\t\t\t\t\theaders: { authorization: `Bearer ${config.apiKey}` },\n\t\t\t\t\tbody: { query: { kind: 'HogQLQuery', query: sql } },\n\t\t\t\t\tsignal: ctx.signal,\n\t\t\t\t\tprovider: 'posthog',\n\t\t\t\t})\n\n\t\t\tconst readRow = (row: unknown[], offset: number): Partial<Record<MetricKey, number>> => {\n\t\t\t\tconst out: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of wanted) {\n\t\t\t\t\tconst idx = exprs.indexOf(METRIC_SQL[m] as string)\n\t\t\t\t\tout[m] = Number(row[offset + idx] ?? 0)\n\t\t\t\t}\n\t\t\t\treturn out\n\t\t\t}\n\n\t\t\tconst fetchTotals = async (): Promise<Partial<Record<MetricKey, number>>> => {\n\t\t\t\tconst data = await runSql(\n\t\t\t\t\t`SELECT ${selectMetrics.join(', ')} FROM events WHERE ${where.join(' AND ')}`\n\t\t\t\t)\n\t\t\t\tconst row = data.results[0]\n\t\t\t\treturn row ? readRow(row, 0) : {}\n\t\t\t}\n\n\t\t\tif (q.granularity === 'day' && !wantsPageBreakdown) {\n\t\t\t\tconst seriesSql = `SELECT toStartOfDay(timestamp) AS day, ${selectMetrics.join(', ')} FROM events WHERE ${where.join(' AND ')} GROUP BY day ORDER BY day`\n\t\t\t\tconst [seriesData, totals] = await Promise.all([runSql(seriesSql), fetchTotals()])\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const row of seriesData.results) {\n\t\t\t\t\tconst ts = dayIso(String(row[0] ?? ''))\n\t\t\t\t\tif (ts) {\n\t\t\t\t\t\trows.push({ timestamp: ts, metrics: readRow(row, 1) })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { rows, totals, meta: { provider: 'posthog', fetchedAt } }\n\t\t\t}\n\n\t\t\tif (wantsPageBreakdown) {\n\t\t\t\tconst sql = `SELECT properties.$pathname AS path, ${selectMetrics.join(', ')} FROM events WHERE ${where.join(' AND ')} GROUP BY path ORDER BY m0 DESC LIMIT ${q.limit ?? 100}`\n\t\t\t\tconst data = await runSql(sql)\n\t\t\t\tconst rows: AnalyticsRow[] = data.results.map((row) => ({\n\t\t\t\t\tdimensions: { page: String(row[0] ?? '') },\n\t\t\t\t\tmetrics: readRow(row, 1),\n\t\t\t\t}))\n\t\t\t\treturn { rows, totals: undefined, meta: { provider: 'posthog', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst totals = await fetchTotals()\n\t\t\treturn { rows: [{ metrics: totals }], totals, meta: { provider: 'posthog', fetchedAt } }\n\t\t},\n\t}\n}\n"],"mappings":";;;AA8BA,MAAM,WAAW;AAIjB,MAAM,aAAiD;CACtD,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;AACX;AAEA,MAAM,iBAAyC,IAAI,IAAI,OAAO,KAAK,UAAU,CAAgB;AAC7F,MAAM,oBAA+C,IAAI,IAAkB,CAAC,MAAM,CAAC;AAInF,MAAM,aAAa,UAClB,IAAI,MAAM,QAAQ,OAAO,MAAM,EAAE,QAAQ,MAAM,KAAK,EAAE;AAEvD,MAAM,sBAAsB,MAC3B,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,EAAE,EAAE,QAAQ,KAAK,GAAG,CAAC;AAQzD,SAAgB,QAAQ,QAAyC;CAChE,MAAM,OAAO,OAAO,QAAQ;CAiB5B,OAAO;EACN,IAAI;EACJ,OAAO;EACP,cAAA;GAhBA,cAAc;GACd,UAAU;GACV,YAAY;GACZ,gBAAgB;GAChB,iBAPuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;GAQvF,SAAS;GACT,YAAY;GACZ,iBAAiB;GACjB,WAAW;IAAE,mBAAmB;IAAK,iBAAiB;GAAK;GAC3D,gBAAgB;IAAE,UAAU;IAAK,WAAW;GAAK;GACjD,GAAI,OAAO,gBAAgB,EAAE,eAAe,KAAK,IAAI,CAAC;EAM3C;EACX,oBAAoB,QAAQ,OAAO,aAAa,OAAO,MAAM;EAC7D,MAAM,MAAM,GAAmB,KAA+C;GAC7E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,SAAS,EAAE,QAAQ,QAAQ,MAAM,WAAW,EAAE;GACpD,MAAM,QAAQ,CAAC,GAAG,IAAI,IAAI,OAAO,KAAK,MAAM,WAAW,EAAY,CAAC,CAAC;GACrE,MAAM,sBAAsB,EAAE,cAAc,CAAC,GAAG,SAAS,MAAM;GAE/D,MAAM,QAAQ;IACb;IACA,2BAA2B,mBAAmB,EAAE,UAAU,KAAK,EAAE;IACjE,2BAA2B,mBAAmB,EAAE,UAAU,GAAG,EAAE;GAChE;GACA,IAAI,EAAE,MACL,MAAM,KAAK,0BAA0B,UAAU,EAAE,IAAI,GAAG;GAEzD,IAAI,OAAO,iBAAiB,EAAE,UAAU,KAAA,GAGvC,MAAM,KAAK,cAAc,UAAU,OAAO,aAAa,EAAE,MAAM,UAAU,EAAE,KAAK,GAAG;GAEpF,MAAM,gBAAgB,MAAM,KAAK,MAAM,MAAM,GAAG,KAAK,OAAO,GAAG;GAE/D,MAAM,UAAU,QACf,UAAgC,GAAG,KAAK,gBAAgB,OAAO,UAAU,UAAU;IAClF,QAAQ;IACR,SAAS,EAAE,eAAe,UAAU,OAAO,SAAS;IACpD,MAAM,EAAE,OAAO;KAAE,MAAM;KAAc,OAAO;IAAI,EAAE;IAClD,QAAQ,IAAI;IACZ,UAAU;GACX,CAAC;GAEF,MAAM,WAAW,KAAgB,WAAuD;IACvF,MAAM,MAA0C,CAAC;IACjD,KAAK,MAAM,KAAK,QAAQ;KACvB,MAAM,MAAM,MAAM,QAAQ,WAAW,EAAY;KACjD,IAAI,KAAK,OAAO,IAAI,SAAS,QAAQ,CAAC;IACvC;IACA,OAAO;GACR;GAEA,MAAM,cAAc,YAAyD;IAI5E,MAAM,OAAM,MAHO,OAClB,UAAU,cAAc,KAAK,IAAI,EAAE,qBAAqB,MAAM,KAAK,OAAO,GAC3E,GACiB,QAAQ;IACzB,OAAO,MAAM,QAAQ,KAAK,CAAC,IAAI,CAAC;GACjC;GAEA,IAAI,EAAE,gBAAgB,SAAS,CAAC,oBAAoB;IACnD,MAAM,YAAY,0CAA0C,cAAc,KAAK,IAAI,EAAE,qBAAqB,MAAM,KAAK,OAAO,EAAE;IAC9H,MAAM,CAAC,YAAY,UAAU,MAAM,QAAQ,IAAI,CAAC,OAAO,SAAS,GAAG,YAAY,CAAC,CAAC;IACjF,MAAM,OAAuB,CAAC;IAC9B,KAAK,MAAM,OAAO,WAAW,SAAS;KACrC,MAAM,KAAK,OAAO,OAAO,IAAI,MAAM,EAAE,CAAC;KACtC,IAAI,IACH,KAAK,KAAK;MAAE,WAAW;MAAI,SAAS,QAAQ,KAAK,CAAC;KAAE,CAAC;IAEvD;IACA,OAAO;KAAE;KAAM;KAAQ,MAAM;MAAE,UAAU;MAAW;KAAU;IAAE;GACjE;GAEA,IAAI,oBAOH,OAAO;IAAE,OAJoB,MADV,OAAO,wCAD0B,cAAc,KAAK,IAAI,EAAE,qBAAqB,MAAM,KAAK,OAAO,EAAE,wCAAwC,EAAE,SAAS,KAC5I,GACK,QAAQ,KAAK,SAAS;KACvD,YAAY,EAAE,MAAM,OAAO,IAAI,MAAM,EAAE,EAAE;KACzC,SAAS,QAAQ,KAAK,CAAC;IACxB,EACY;IAAG,QAAQ,KAAA;IAAW,MAAM;KAAE,UAAU;KAAW;IAAU;GAAE;GAG5E,MAAM,SAAS,MAAM,YAAY;GACjC,OAAO;IAAE,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC;IAAG;IAAQ,MAAM;KAAE,UAAU;KAAW;IAAU;GAAE;EACxF;CACD;AACD"}
|
|
1
|
+
{"version":3,"file":"posthog.js","names":[],"sources":["../../../src/adapters/posthog/posthog.ts"],"sourcesContent":["import type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tMetricKey,\n} from '../../core/contract'\nimport { fetchJson } from '../http/fetchJson'\nimport { dayIso } from '../series'\n\nexport interface PosthogConfig {\n\t/** PostHog project id (numeric). */\n\tprojectId: string\n\t/** Personal API key with the \"Query Read\" scope (phx_...). */\n\tapiKey: string\n\t/** API host. Defaults to US Cloud; EU is https://eu.posthog.com, self-host is your instance URL. */\n\thost?: string\n\t/** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n\t/**\n\t * Event property holding a query's scope (e.g. 'tenant'). Enables scoped queries:\n\t * one platform project captures every scope with this property set, and a scoped\n\t * read filters on it. Both the property name and value are escaped literals.\n\t */\n\tscopeProperty?: string\n}\n\nconst US_CLOUD = 'https://us.posthog.com'\n\n// Pageview-scoped expressions, used when the read filters the WHERE to `$pageview`.\n// visits and sessions share the distinct-session expression and are deduped before the\n// SELECT, then read back by the expression's position.\nconst METRIC_SQL_PAGEVIEW: Partial<Record<MetricKey, string>> = {\n\tpageviews: 'count()',\n\tvisitors: 'count(DISTINCT person_id)',\n\tvisits: 'count(DISTINCT properties.$session_id)',\n\tsessions: 'count(DISTINCT properties.$session_id)',\n}\n\n// All-event expressions, used when `events` (total captured events, matching PostHog's own\n// Events definition) or an `event`-name breakdown is requested. The WHERE is not filtered to\n// `$pageview`, so the pageview-family metrics scope themselves with conditional aggregates.\nconst METRIC_SQL_ALL: Partial<Record<MetricKey, string>> = {\n\tpageviews: \"countIf(event = '$pageview')\",\n\tvisitors: \"count(DISTINCT if(event = '$pageview', person_id, NULL))\",\n\tvisits: \"count(DISTINCT if(event = '$pageview', properties.$session_id, NULL))\",\n\tsessions: \"count(DISTINCT if(event = '$pageview', properties.$session_id, NULL))\",\n\tevents: 'count()',\n}\n\nconst DIMENSION_SQL: Partial<Record<DimensionKey, string>> = {\n\tpage: 'properties.$pathname',\n\tevent: 'event',\n}\n\nconst posthogMetrics: ReadonlySet<MetricKey> = new Set(Object.keys(METRIC_SQL_ALL) as MetricKey[])\nconst posthogDimensions: ReadonlySet<DimensionKey> = new Set(\n\tObject.keys(DIMENSION_SQL) as DimensionKey[]\n)\n\n// The Query API has no parameter binding, so values are inlined as quoted literals.\n// Escape backslashes first, then single quotes, so a crafted path cannot break out.\nconst sqlString = (value: string): string =>\n\t`'${value.replace(/\\\\/g, '\\\\\\\\').replace(/'/g, \"\\\\'\")}'`\n\nconst sqlDateTimeLiteral = (d: Date): string =>\n\tsqlString(d.toISOString().slice(0, 19).replace('T', ' '))\n\ninterface PosthogQueryResponse {\n\tcolumns: string[]\n\ttypes: string[]\n\tresults: unknown[][]\n}\n\nexport function posthog(config: PosthogConfig): AnalyticsAdapter {\n\tconst host = config.host ?? US_CLOUD\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 730\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tcomparison: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: posthogMetrics,\n\t\tdimensions: posthogDimensions,\n\t\tbatchPageReport: true,\n\t\trateLimit: { requestsPerMinute: 240, requestsPerHour: 2400 },\n\t\trecommendedTtl: { realtime: 300, aggregate: 3600 },\n\t\t...(config.scopeProperty ? { scopedQueries: true } : {}),\n\t}\n\n\treturn {\n\t\tid: 'posthog',\n\t\tlabel: 'PostHog',\n\t\tcapabilities,\n\t\tisConfigured: () => Boolean(config.projectId && config.apiKey),\n\t\tasync query(q: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst breakdownDim = (q.dimensions ?? []).find((d) => DIMENSION_SQL[d])\n\t\t\t// A total-events metric or an event-name breakdown must scan every event, not\n\t\t\t// just pageviews; those reads switch to conditional aggregation.\n\t\t\tconst scanAllEvents = q.metrics.includes('events') || breakdownDim === 'event'\n\t\t\tconst metricSql = scanAllEvents ? METRIC_SQL_ALL : METRIC_SQL_PAGEVIEW\n\t\t\tconst wanted = q.metrics.filter((m) => metricSql[m])\n\t\t\tconst exprs = [...new Set(wanted.map((m) => metricSql[m] as string))]\n\n\t\t\tconst where = [\n\t\t\t\t`timestamp >= toDateTime(${sqlDateTimeLiteral(q.dateRange.start)})`,\n\t\t\t\t`timestamp <= toDateTime(${sqlDateTimeLiteral(q.dateRange.end)})`,\n\t\t\t]\n\t\t\tif (!scanAllEvents) {\n\t\t\t\twhere.unshift(\"event = '$pageview'\")\n\t\t\t}\n\t\t\tif (q.path) {\n\t\t\t\twhere.push(`properties.$pathname = ${sqlString(q.path)}`)\n\t\t\t}\n\t\t\tif (q.hostname) {\n\t\t\t\twhere.push(`properties.$host = ${sqlString(q.hostname)}`)\n\t\t\t}\n\t\t\tif (config.scopeProperty && q.scope !== undefined) {\n\t\t\t\t// Bracket property access with escaped literals: neither the configured\n\t\t\t\t// property name nor the scope value can break out of the HogQL string.\n\t\t\t\twhere.push(`properties[${sqlString(config.scopeProperty)}] = ${sqlString(q.scope)}`)\n\t\t\t}\n\t\t\tconst selectMetrics = exprs.map((expr, i) => `${expr} AS m${i}`)\n\n\t\t\tconst runSql = (sql: string): Promise<PosthogQueryResponse> =>\n\t\t\t\tfetchJson<PosthogQueryResponse>(`${host}/api/projects/${config.projectId}/query/`, {\n\t\t\t\t\tmethod: 'POST',\n\t\t\t\t\theaders: { authorization: `Bearer ${config.apiKey}` },\n\t\t\t\t\tbody: { query: { kind: 'HogQLQuery', query: sql } },\n\t\t\t\t\tsignal: ctx.signal,\n\t\t\t\t\tprovider: 'posthog',\n\t\t\t\t})\n\n\t\t\tconst readRow = (row: unknown[], offset: number): Partial<Record<MetricKey, number>> => {\n\t\t\t\tconst out: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of wanted) {\n\t\t\t\t\tconst idx = exprs.indexOf(metricSql[m] as string)\n\t\t\t\t\tout[m] = Number(row[offset + idx] ?? 0)\n\t\t\t\t}\n\t\t\t\treturn out\n\t\t\t}\n\n\t\t\tconst fetchTotals = async (): Promise<Partial<Record<MetricKey, number>>> => {\n\t\t\t\tconst data = await runSql(\n\t\t\t\t\t`SELECT ${selectMetrics.join(', ')} FROM events WHERE ${where.join(' AND ')}`\n\t\t\t\t)\n\t\t\t\tconst row = data.results[0]\n\t\t\t\treturn row ? readRow(row, 0) : {}\n\t\t\t}\n\n\t\t\tif (q.granularity === 'day' && !breakdownDim) {\n\t\t\t\t// HogQL buckets in the timezone argument when given; without it PostHog falls back\n\t\t\t\t// to the project's own timezone, so the resolved reporting timezone (UTC included)\n\t\t\t\t// is always passed to keep day buckets deterministic across projects. The window\n\t\t\t\t// literals stay UTC instants (already aligned to the reporting-timezone day\n\t\t\t\t// boundary by the caller).\n\t\t\t\tconst dayExpr = `toStartOfDay(timestamp, ${sqlString(q.timezone ?? 'UTC')})`\n\t\t\t\tconst seriesSql = `SELECT ${dayExpr} AS day, ${selectMetrics.join(', ')} FROM events WHERE ${where.join(' AND ')} GROUP BY day ORDER BY day`\n\t\t\t\tconst [seriesData, totals] = await Promise.all([runSql(seriesSql), fetchTotals()])\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const row of seriesData.results) {\n\t\t\t\t\tconst ts = dayIso(String(row[0] ?? ''))\n\t\t\t\t\tif (ts) {\n\t\t\t\t\t\trows.push({ timestamp: ts, metrics: readRow(row, 1) })\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn { rows, totals, meta: { provider: 'posthog', fetchedAt } }\n\t\t\t}\n\n\t\t\tif (breakdownDim) {\n\t\t\t\tconst dimSql = DIMENSION_SQL[breakdownDim] as string\n\t\t\t\tconst sql = `SELECT ${dimSql} AS dim, ${selectMetrics.join(', ')} FROM events WHERE ${where.join(' AND ')} GROUP BY dim ORDER BY m0 DESC LIMIT ${q.limit ?? 100}`\n\t\t\t\tconst data = await runSql(sql)\n\t\t\t\tconst rows: AnalyticsRow[] = data.results.map((row) => ({\n\t\t\t\t\tdimensions: { [breakdownDim]: String(row[0] ?? '') },\n\t\t\t\t\tmetrics: readRow(row, 1),\n\t\t\t\t}))\n\t\t\t\treturn { rows, totals: undefined, meta: { provider: 'posthog', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst totals = await fetchTotals()\n\t\t\treturn { rows: [{ metrics: totals }], totals, meta: { provider: 'posthog', fetchedAt } }\n\t\t},\n\t}\n}\n"],"mappings":";;;AA8BA,MAAM,WAAW;AAKjB,MAAM,sBAA0D;CAC/D,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;AACX;AAKA,MAAM,iBAAqD;CAC1D,WAAW;CACX,UAAU;CACV,QAAQ;CACR,UAAU;CACV,QAAQ;AACT;AAEA,MAAM,gBAAuD;CAC5D,MAAM;CACN,OAAO;AACR;AAEA,MAAM,iBAAyC,IAAI,IAAI,OAAO,KAAK,cAAc,CAAgB;AACjG,MAAM,oBAA+C,IAAI,IACxD,OAAO,KAAK,aAAa,CAC1B;AAIA,MAAM,aAAa,UAClB,IAAI,MAAM,QAAQ,OAAO,MAAM,EAAE,QAAQ,MAAM,KAAK,EAAE;AAEvD,MAAM,sBAAsB,MAC3B,UAAU,EAAE,YAAY,EAAE,MAAM,GAAG,EAAE,EAAE,QAAQ,KAAK,GAAG,CAAC;AAQzD,SAAgB,QAAQ,QAAyC;CAChE,MAAM,OAAO,OAAO,QAAQ;CAiB5B,OAAO;EACN,IAAI;EACJ,OAAO;EACP,cAAA;GAhBA,cAAc;GACd,UAAU;GACV,YAAY;GACZ,gBAAgB;GAChB,iBAPuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;GAQvF,SAAS;GACT,YAAY;GACZ,iBAAiB;GACjB,WAAW;IAAE,mBAAmB;IAAK,iBAAiB;GAAK;GAC3D,gBAAgB;IAAE,UAAU;IAAK,WAAW;GAAK;GACjD,GAAI,OAAO,gBAAgB,EAAE,eAAe,KAAK,IAAI,CAAC;EAM3C;EACX,oBAAoB,QAAQ,OAAO,aAAa,OAAO,MAAM;EAC7D,MAAM,MAAM,GAAmB,KAA+C;GAC7E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,gBAAgB,EAAE,cAAc,CAAC,GAAG,MAAM,MAAM,cAAc,EAAE;GAGtE,MAAM,gBAAgB,EAAE,QAAQ,SAAS,QAAQ,KAAK,iBAAiB;GACvE,MAAM,YAAY,gBAAgB,iBAAiB;GACnD,MAAM,SAAS,EAAE,QAAQ,QAAQ,MAAM,UAAU,EAAE;GACnD,MAAM,QAAQ,CAAC,GAAG,IAAI,IAAI,OAAO,KAAK,MAAM,UAAU,EAAY,CAAC,CAAC;GAEpE,MAAM,QAAQ,CACb,2BAA2B,mBAAmB,EAAE,UAAU,KAAK,EAAE,IACjE,2BAA2B,mBAAmB,EAAE,UAAU,GAAG,EAAE,EAChE;GACA,IAAI,CAAC,eACJ,MAAM,QAAQ,qBAAqB;GAEpC,IAAI,EAAE,MACL,MAAM,KAAK,0BAA0B,UAAU,EAAE,IAAI,GAAG;GAEzD,IAAI,EAAE,UACL,MAAM,KAAK,sBAAsB,UAAU,EAAE,QAAQ,GAAG;GAEzD,IAAI,OAAO,iBAAiB,EAAE,UAAU,KAAA,GAGvC,MAAM,KAAK,cAAc,UAAU,OAAO,aAAa,EAAE,MAAM,UAAU,EAAE,KAAK,GAAG;GAEpF,MAAM,gBAAgB,MAAM,KAAK,MAAM,MAAM,GAAG,KAAK,OAAO,GAAG;GAE/D,MAAM,UAAU,QACf,UAAgC,GAAG,KAAK,gBAAgB,OAAO,UAAU,UAAU;IAClF,QAAQ;IACR,SAAS,EAAE,eAAe,UAAU,OAAO,SAAS;IACpD,MAAM,EAAE,OAAO;KAAE,MAAM;KAAc,OAAO;IAAI,EAAE;IAClD,QAAQ,IAAI;IACZ,UAAU;GACX,CAAC;GAEF,MAAM,WAAW,KAAgB,WAAuD;IACvF,MAAM,MAA0C,CAAC;IACjD,KAAK,MAAM,KAAK,QAAQ;KACvB,MAAM,MAAM,MAAM,QAAQ,UAAU,EAAY;KAChD,IAAI,KAAK,OAAO,IAAI,SAAS,QAAQ,CAAC;IACvC;IACA,OAAO;GACR;GAEA,MAAM,cAAc,YAAyD;IAI5E,MAAM,OAAM,MAHO,OAClB,UAAU,cAAc,KAAK,IAAI,EAAE,qBAAqB,MAAM,KAAK,OAAO,GAC3E,GACiB,QAAQ;IACzB,OAAO,MAAM,QAAQ,KAAK,CAAC,IAAI,CAAC;GACjC;GAEA,IAAI,EAAE,gBAAgB,SAAS,CAAC,cAAc;IAO7C,MAAM,YAAY,UAAU,2BADe,UAAU,EAAE,YAAY,KAAK,EAAE,GACtC,WAAW,cAAc,KAAK,IAAI,EAAE,qBAAqB,MAAM,KAAK,OAAO,EAAE;IACjH,MAAM,CAAC,YAAY,UAAU,MAAM,QAAQ,IAAI,CAAC,OAAO,SAAS,GAAG,YAAY,CAAC,CAAC;IACjF,MAAM,OAAuB,CAAC;IAC9B,KAAK,MAAM,OAAO,WAAW,SAAS;KACrC,MAAM,KAAK,OAAO,OAAO,IAAI,MAAM,EAAE,CAAC;KACtC,IAAI,IACH,KAAK,KAAK;MAAE,WAAW;MAAI,SAAS,QAAQ,KAAK,CAAC;KAAE,CAAC;IAEvD;IACA,OAAO;KAAE;KAAM;KAAQ,MAAM;MAAE,UAAU;MAAW;KAAU;IAAE;GACjE;GAEA,IAAI,cAQH,OAAO;IAAE,OAJoB,MADV,OAAO,UAFX,cAAc,cACA,WAAW,cAAc,KAAK,IAAI,EAAE,qBAAqB,MAAM,KAAK,OAAO,EAAE,uCAAuC,EAAE,SAAS,KAC/H,GACK,QAAQ,KAAK,SAAS;KACvD,YAAY,GAAG,eAAe,OAAO,IAAI,MAAM,EAAE,EAAE;KACnD,SAAS,QAAQ,KAAK,CAAC;IACxB,EACY;IAAG,QAAQ,KAAA;IAAW,MAAM;KAAE,UAAU;KAAW;IAAU;GAAE;GAG5E,MAAM,SAAS,MAAM,YAAY;GACjC,OAAO;IAAE,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC;IAAG;IAAQ,MAAM;KAAE,UAAU;KAAW;IAAU;GAAE;EACxF;CACD;AACD"}
|
|
@@ -87,7 +87,7 @@ function umami(config) {
|
|
|
87
87
|
if (q.granularity === "day") {
|
|
88
88
|
const p = params(q);
|
|
89
89
|
p.set("unit", "day");
|
|
90
|
-
p.set("timezone", "UTC");
|
|
90
|
+
p.set("timezone", q.timezone ?? "UTC");
|
|
91
91
|
const fetchSeries = () => fetchJson(`${base}/websites/${config.websiteId}/pageviews?${p.toString()}`, {
|
|
92
92
|
headers,
|
|
93
93
|
signal: ctx.signal,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"umami.js","names":[],"sources":["../../../src/adapters/umami/umami.ts"],"sourcesContent":["import type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tMetricKey,\n} from '../../core/contract'\nimport { fetchJson } from '../http/fetchJson'\nimport { dayIso } from '../series'\n\nexport interface UmamiConfig {\n\twebsiteId: string\n\t/** Umami Cloud API key (sent as x-umami-api-key). */\n\tapiKey?: string\n\t/** Self-hosted bearer token (from POST /api/auth/login). */\n\ttoken?: string\n\t/** API base URL. Defaults to Umami Cloud (https://api.umami.is/v1). Self-hosted is e.g. https://site/api. */\n\thost?: string\n\t/** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n}\n\nconst CLOUD_BASE = 'https://api.umami.is/v1'\n\nconst umamiMetrics: ReadonlySet<MetricKey> = new Set<MetricKey>([\n\t'pageviews',\n\t'visitors',\n\t'visits',\n\t'sessions',\n\t'bounceRate',\n\t'avgDuration',\n])\nconst umamiDimensions: ReadonlySet<DimensionKey> = new Set<DimensionKey>(['page'])\n\ninterface UmamiStats {\n\tpageviews: number\n\tvisitors: number\n\tvisits: number\n\tbounces: number\n\ttotaltime: number\n}\n\nexport function umami(config: UmamiConfig): AnalyticsAdapter {\n\tconst base = config.host ?? CLOUD_BASE\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 730\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tcomparison: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: umamiMetrics,\n\t\tdimensions: umamiDimensions,\n\t\tbatchPageReport: true,\n\t\trateLimit: null,\n\t\trecommendedTtl: { realtime: 300, aggregate: 3600 },\n\t}\n\t// Cloud authenticates with x-umami-api-key; self-hosted with a bearer token.\n\t// NOTE: the cloud header name and the per-URL `path` filter (set in params(), also\n\t// sent to /metrics) match the documented v2 shape but are unvalidated against a live\n\t// instance; confirm both before relying on per-URL provider data in production.\n\tconst authHeaders = (): Record<string, string> =>\n\t\tconfig.apiKey\n\t\t\t? { 'x-umami-api-key': config.apiKey }\n\t\t\t: config.token\n\t\t\t\t? { authorization: `Bearer ${config.token}` }\n\t\t\t\t: {}\n\n\tconst params = (q: AnalyticsQuery): URLSearchParams => {\n\t\tconst p = new URLSearchParams({\n\t\t\tstartAt: String(q.dateRange.start.getTime()),\n\t\t\tendAt: String(q.dateRange.end.getTime()),\n\t\t})\n\t\tif (q.path) {\n\t\t\tp.set('path', q.path)\n\t\t}\n\t\treturn p\n\t}\n\n\treturn {\n\t\tid: 'umami',\n\t\tlabel: 'Umami',\n\t\tcapabilities,\n\t\tisConfigured: () => Boolean(config.websiteId && (config.apiKey || config.token)),\n\t\tasync query(q: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst headers = authHeaders()\n\t\t\tconst wantsPageBreakdown = (q.dimensions ?? []).includes('page')\n\n\t\t\tif (wantsPageBreakdown) {\n\t\t\t\tconst p = params(q)\n\t\t\t\tp.set('type', 'url')\n\t\t\t\tconst data = await fetchJson<Array<{ x: string; y: number }>>(\n\t\t\t\t\t`${base}/websites/${config.websiteId}/metrics?${p.toString()}`,\n\t\t\t\t\t{ headers, signal: ctx.signal, provider: 'umami' }\n\t\t\t\t)\n\t\t\t\tconst metric: MetricKey = q.metrics.includes('pageviews') ? 'pageviews' : 'visitors'\n\t\t\t\tconst rows: AnalyticsRow[] = data.map((row) => ({\n\t\t\t\t\tdimensions: { page: row.x },\n\t\t\t\t\tmetrics: { [metric]: row.y } as Partial<Record<MetricKey, number>>,\n\t\t\t\t}))\n\t\t\t\treturn { rows, totals: undefined, meta: { provider: 'umami', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst fetchTotals = async (): Promise<Partial<Record<MetricKey, number>>> => {\n\t\t\t\tconst stats = await fetchJson<UmamiStats>(\n\t\t\t\t\t`${base}/websites/${config.websiteId}/stats?${params(q).toString()}`,\n\t\t\t\t\t{ headers, signal: ctx.signal, provider: 'umami' }\n\t\t\t\t)\n\t\t\t\tconst all: Partial<Record<MetricKey, number>> = {\n\t\t\t\t\tpageviews: stats.pageviews,\n\t\t\t\t\tvisitors: stats.visitors,\n\t\t\t\t\tvisits: stats.visits,\n\t\t\t\t\tsessions: stats.visits,\n\t\t\t\t\t// Derived ratios are omitted (not zeroed) when there are no visits, so the\n\t\t\t\t\t// display layer shows a \"no data\" state instead of a misleading 0.\n\t\t\t\t\tbounceRate:\n\t\t\t\t\t\tstats.visits > 0 ? Math.round((stats.bounces / stats.visits) * 100) : undefined,\n\t\t\t\t\tavgDuration:\n\t\t\t\t\t\tstats.visits > 0 ? Math.round((stats.totaltime / stats.visits) * 1000) : undefined,\n\t\t\t\t}\n\t\t\t\tconst totals: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of q.metrics) {\n\t\t\t\t\tif (all[m] !== undefined) {\n\t\t\t\t\t\ttotals[m] = all[m]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn totals\n\t\t\t}\n\n\t\t\t// Umami's only time-series endpoint reports pageviews and sessions per interval;\n\t\t\t// visitors/bounceRate/avgDuration have no per-day source, so a trend on those\n\t\t\t// metrics keeps a correct headline (from /stats) but an empty series.\n\t\t\tif (q.granularity === 'day') {\n\t\t\t\tconst p = params(q)\n\t\t\t\tp.set('unit', 'day')\n\t\t\t\tp.set('timezone', 'UTC')\n\t\t\t\tconst fetchSeries = () =>\n\t\t\t\t\tfetchJson<{\n\t\t\t\t\t\tpageviews: Array<{ x: string; y: number }>\n\t\t\t\t\t\tsessions: Array<{ x: string; y: number }>\n\t\t\t\t\t}>(`${base}/websites/${config.websiteId}/pageviews?${p.toString()}`, {\n\t\t\t\t\t\theaders,\n\t\t\t\t\t\tsignal: ctx.signal,\n\t\t\t\t\t\tprovider: 'umami',\n\t\t\t\t\t})\n\t\t\t\tconst [series, totals] = await Promise.all([fetchSeries(), fetchTotals()])\n\t\t\t\tconst sessionsByX = new Map(series.sessions.map((s) => [s.x, s.y]))\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const pv of series.pageviews) {\n\t\t\t\t\tconst ts = dayIso(pv.x)\n\t\t\t\t\tif (!ts) {\n\t\t\t\t\t\tcontinue\n\t\t\t\t\t}\n\t\t\t\t\tconst dayMetrics = sessionsByX.get(pv.x) ?? 0\n\t\t\t\t\tconst all: Partial<Record<MetricKey, number>> = {\n\t\t\t\t\t\tpageviews: pv.y,\n\t\t\t\t\t\tvisits: dayMetrics,\n\t\t\t\t\t\tsessions: dayMetrics,\n\t\t\t\t\t}\n\t\t\t\t\tconst metrics: Partial<Record<MetricKey, number>> = {}\n\t\t\t\t\tfor (const m of q.metrics) {\n\t\t\t\t\t\tif (all[m] !== undefined) {\n\t\t\t\t\t\t\tmetrics[m] = all[m]\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\trows.push({ timestamp: ts, metrics })\n\t\t\t\t}\n\t\t\t\treturn { rows, totals, meta: { provider: 'umami', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst totals = await fetchTotals()\n\t\t\treturn { rows: [{ metrics: totals }], totals, meta: { provider: 'umami', fetchedAt } }\n\t\t},\n\t}\n}\n"],"mappings":";;;AAyBA,MAAM,aAAa;AAEnB,MAAM,eAAuC,IAAI,IAAe;CAC/D;CACA;CACA;CACA;CACA;CACA;AACD,CAAC;AACD,MAAM,kBAA6C,IAAI,IAAkB,CAAC,MAAM,CAAC;AAUjF,SAAgB,MAAM,QAAuC;CAC5D,MAAM,OAAO,OAAO,QAAQ;CAG5B,MAAM,eAAsC;EAC3C,cAAc;EACd,UAAU;EACV,YAAY;EACZ,gBAAgB;EAChB,iBAPuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;EAQvF,SAAS;EACT,YAAY;EACZ,iBAAiB;EACjB,WAAW;EACX,gBAAgB;GAAE,UAAU;GAAK,WAAW;EAAK;CAClD;CAKA,MAAM,oBACL,OAAO,SACJ,EAAE,mBAAmB,OAAO,OAAO,IACnC,OAAO,QACN,EAAE,eAAe,UAAU,OAAO,QAAQ,IAC1C,CAAC;CAEN,MAAM,UAAU,MAAuC;EACtD,MAAM,IAAI,IAAI,gBAAgB;GAC7B,SAAS,OAAO,EAAE,UAAU,MAAM,QAAQ,CAAC;GAC3C,OAAO,OAAO,EAAE,UAAU,IAAI,QAAQ,CAAC;EACxC,CAAC;EACD,IAAI,EAAE,MACL,EAAE,IAAI,QAAQ,EAAE,IAAI;EAErB,OAAO;CACR;CAEA,OAAO;EACN,IAAI;EACJ,OAAO;EACP;EACA,oBAAoB,QAAQ,OAAO,cAAc,OAAO,UAAU,OAAO,MAAM;EAC/E,MAAM,MAAM,GAAmB,KAA+C;GAC7E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,UAAU,YAAY;GAG5B,KAF4B,EAAE,cAAc,CAAC,GAAG,SAAS,MAEpC,GAAG;IACvB,MAAM,IAAI,OAAO,CAAC;IAClB,EAAE,IAAI,QAAQ,KAAK;IACnB,MAAM,OAAO,MAAM,UAClB,GAAG,KAAK,YAAY,OAAO,UAAU,WAAW,EAAE,SAAS,KAC3D;KAAE;KAAS,QAAQ,IAAI;KAAQ,UAAU;IAAQ,CAClD;IACA,MAAM,SAAoB,EAAE,QAAQ,SAAS,WAAW,IAAI,cAAc;IAK1E,OAAO;KAAE,MAJoB,KAAK,KAAK,SAAS;MAC/C,YAAY,EAAE,MAAM,IAAI,EAAE;MAC1B,SAAS,GAAG,SAAS,IAAI,EAAE;KAC5B,EACY;KAAG,QAAQ,KAAA;KAAW,MAAM;MAAE,UAAU;MAAS;KAAU;IAAE;GAC1E;GAEA,MAAM,cAAc,YAAyD;IAC5E,MAAM,QAAQ,MAAM,UACnB,GAAG,KAAK,YAAY,OAAO,UAAU,SAAS,OAAO,CAAC,EAAE,SAAS,KACjE;KAAE;KAAS,QAAQ,IAAI;KAAQ,UAAU;IAAQ,CAClD;IACA,MAAM,MAA0C;KAC/C,WAAW,MAAM;KACjB,UAAU,MAAM;KAChB,QAAQ,MAAM;KACd,UAAU,MAAM;KAGhB,YACC,MAAM,SAAS,IAAI,KAAK,MAAO,MAAM,UAAU,MAAM,SAAU,GAAG,IAAI,KAAA;KACvE,aACC,MAAM,SAAS,IAAI,KAAK,MAAO,MAAM,YAAY,MAAM,SAAU,GAAI,IAAI,KAAA;IAC3E;IACA,MAAM,SAA6C,CAAC;IACpD,KAAK,MAAM,KAAK,EAAE,SACjB,IAAI,IAAI,OAAO,KAAA,GACd,OAAO,KAAK,IAAI;IAGlB,OAAO;GACR;GAKA,IAAI,EAAE,gBAAgB,OAAO;IAC5B,MAAM,IAAI,OAAO,CAAC;IAClB,EAAE,IAAI,QAAQ,KAAK;IACnB,EAAE,IAAI,YAAY,KAAK;
|
|
1
|
+
{"version":3,"file":"umami.js","names":[],"sources":["../../../src/adapters/umami/umami.ts"],"sourcesContent":["import type {\n\tAdapterContext,\n\tAnalyticsAdapter,\n\tAnalyticsCapabilities,\n\tAnalyticsQuery,\n\tAnalyticsResult,\n\tAnalyticsRow,\n\tDimensionKey,\n\tMetricKey,\n} from '../../core/contract'\nimport { fetchJson } from '../http/fetchJson'\nimport { dayIso } from '../series'\n\nexport interface UmamiConfig {\n\twebsiteId: string\n\t/** Umami Cloud API key (sent as x-umami-api-key). */\n\tapiKey?: string\n\t/** Self-hosted bearer token (from POST /api/auth/login). */\n\ttoken?: string\n\t/** API base URL. Defaults to Umami Cloud (https://api.umami.is/v1). Self-hosted is e.g. https://site/api. */\n\thost?: string\n\t/** Maximum days of historical data. Defaults to 730. Pass null to disable clamping. */\n\tmaxLookbackDays?: number | null\n}\n\nconst CLOUD_BASE = 'https://api.umami.is/v1'\n\nconst umamiMetrics: ReadonlySet<MetricKey> = new Set<MetricKey>([\n\t'pageviews',\n\t'visitors',\n\t'visits',\n\t'sessions',\n\t'bounceRate',\n\t'avgDuration',\n])\nconst umamiDimensions: ReadonlySet<DimensionKey> = new Set<DimensionKey>(['page'])\n\ninterface UmamiStats {\n\tpageviews: number\n\tvisitors: number\n\tvisits: number\n\tbounces: number\n\ttotaltime: number\n}\n\nexport function umami(config: UmamiConfig): AnalyticsAdapter {\n\tconst base = config.host ?? CLOUD_BASE\n\tconst maxLookbackDays = config.maxLookbackDays !== undefined ? config.maxLookbackDays : 730\n\n\tconst capabilities: AnalyticsCapabilities = {\n\t\tperPageQuery: true,\n\t\trealtime: false,\n\t\tcomparison: false,\n\t\tminGranularity: 'day',\n\t\tmaxLookbackDays,\n\t\tmetrics: umamiMetrics,\n\t\tdimensions: umamiDimensions,\n\t\tbatchPageReport: true,\n\t\trateLimit: null,\n\t\trecommendedTtl: { realtime: 300, aggregate: 3600 },\n\t}\n\t// Cloud authenticates with x-umami-api-key; self-hosted with a bearer token.\n\t// NOTE: the cloud header name and the per-URL `path` filter (set in params(), also\n\t// sent to /metrics) match the documented v2 shape but are unvalidated against a live\n\t// instance; confirm both before relying on per-URL provider data in production.\n\tconst authHeaders = (): Record<string, string> =>\n\t\tconfig.apiKey\n\t\t\t? { 'x-umami-api-key': config.apiKey }\n\t\t\t: config.token\n\t\t\t\t? { authorization: `Bearer ${config.token}` }\n\t\t\t\t: {}\n\n\tconst params = (q: AnalyticsQuery): URLSearchParams => {\n\t\tconst p = new URLSearchParams({\n\t\t\tstartAt: String(q.dateRange.start.getTime()),\n\t\t\tendAt: String(q.dateRange.end.getTime()),\n\t\t})\n\t\tif (q.path) {\n\t\t\tp.set('path', q.path)\n\t\t}\n\t\treturn p\n\t}\n\n\treturn {\n\t\tid: 'umami',\n\t\tlabel: 'Umami',\n\t\tcapabilities,\n\t\tisConfigured: () => Boolean(config.websiteId && (config.apiKey || config.token)),\n\t\tasync query(q: AnalyticsQuery, ctx: AdapterContext): Promise<AnalyticsResult> {\n\t\t\tconst fetchedAt = q.dateRange.end.toISOString()\n\t\t\tconst headers = authHeaders()\n\t\t\tconst wantsPageBreakdown = (q.dimensions ?? []).includes('page')\n\n\t\t\tif (wantsPageBreakdown) {\n\t\t\t\tconst p = params(q)\n\t\t\t\tp.set('type', 'url')\n\t\t\t\tconst data = await fetchJson<Array<{ x: string; y: number }>>(\n\t\t\t\t\t`${base}/websites/${config.websiteId}/metrics?${p.toString()}`,\n\t\t\t\t\t{ headers, signal: ctx.signal, provider: 'umami' }\n\t\t\t\t)\n\t\t\t\tconst metric: MetricKey = q.metrics.includes('pageviews') ? 'pageviews' : 'visitors'\n\t\t\t\tconst rows: AnalyticsRow[] = data.map((row) => ({\n\t\t\t\t\tdimensions: { page: row.x },\n\t\t\t\t\tmetrics: { [metric]: row.y } as Partial<Record<MetricKey, number>>,\n\t\t\t\t}))\n\t\t\t\treturn { rows, totals: undefined, meta: { provider: 'umami', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst fetchTotals = async (): Promise<Partial<Record<MetricKey, number>>> => {\n\t\t\t\tconst stats = await fetchJson<UmamiStats>(\n\t\t\t\t\t`${base}/websites/${config.websiteId}/stats?${params(q).toString()}`,\n\t\t\t\t\t{ headers, signal: ctx.signal, provider: 'umami' }\n\t\t\t\t)\n\t\t\t\tconst all: Partial<Record<MetricKey, number>> = {\n\t\t\t\t\tpageviews: stats.pageviews,\n\t\t\t\t\tvisitors: stats.visitors,\n\t\t\t\t\tvisits: stats.visits,\n\t\t\t\t\tsessions: stats.visits,\n\t\t\t\t\t// Derived ratios are omitted (not zeroed) when there are no visits, so the\n\t\t\t\t\t// display layer shows a \"no data\" state instead of a misleading 0.\n\t\t\t\t\tbounceRate:\n\t\t\t\t\t\tstats.visits > 0 ? Math.round((stats.bounces / stats.visits) * 100) : undefined,\n\t\t\t\t\tavgDuration:\n\t\t\t\t\t\tstats.visits > 0 ? Math.round((stats.totaltime / stats.visits) * 1000) : undefined,\n\t\t\t\t}\n\t\t\t\tconst totals: Partial<Record<MetricKey, number>> = {}\n\t\t\t\tfor (const m of q.metrics) {\n\t\t\t\t\tif (all[m] !== undefined) {\n\t\t\t\t\t\ttotals[m] = all[m]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\treturn totals\n\t\t\t}\n\n\t\t\t// Umami's only time-series endpoint reports pageviews and sessions per interval;\n\t\t\t// visitors/bounceRate/avgDuration have no per-day source, so a trend on those\n\t\t\t// metrics keeps a correct headline (from /stats) but an empty series.\n\t\t\tif (q.granularity === 'day') {\n\t\t\t\tconst p = params(q)\n\t\t\t\tp.set('unit', 'day')\n\t\t\t\tp.set('timezone', q.timezone ?? 'UTC')\n\t\t\t\tconst fetchSeries = () =>\n\t\t\t\t\tfetchJson<{\n\t\t\t\t\t\tpageviews: Array<{ x: string; y: number }>\n\t\t\t\t\t\tsessions: Array<{ x: string; y: number }>\n\t\t\t\t\t}>(`${base}/websites/${config.websiteId}/pageviews?${p.toString()}`, {\n\t\t\t\t\t\theaders,\n\t\t\t\t\t\tsignal: ctx.signal,\n\t\t\t\t\t\tprovider: 'umami',\n\t\t\t\t\t})\n\t\t\t\tconst [series, totals] = await Promise.all([fetchSeries(), fetchTotals()])\n\t\t\t\tconst sessionsByX = new Map(series.sessions.map((s) => [s.x, s.y]))\n\t\t\t\tconst rows: AnalyticsRow[] = []\n\t\t\t\tfor (const pv of series.pageviews) {\n\t\t\t\t\tconst ts = dayIso(pv.x)\n\t\t\t\t\tif (!ts) {\n\t\t\t\t\t\tcontinue\n\t\t\t\t\t}\n\t\t\t\t\tconst dayMetrics = sessionsByX.get(pv.x) ?? 0\n\t\t\t\t\tconst all: Partial<Record<MetricKey, number>> = {\n\t\t\t\t\t\tpageviews: pv.y,\n\t\t\t\t\t\tvisits: dayMetrics,\n\t\t\t\t\t\tsessions: dayMetrics,\n\t\t\t\t\t}\n\t\t\t\t\tconst metrics: Partial<Record<MetricKey, number>> = {}\n\t\t\t\t\tfor (const m of q.metrics) {\n\t\t\t\t\t\tif (all[m] !== undefined) {\n\t\t\t\t\t\t\tmetrics[m] = all[m]\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\trows.push({ timestamp: ts, metrics })\n\t\t\t\t}\n\t\t\t\treturn { rows, totals, meta: { provider: 'umami', fetchedAt } }\n\t\t\t}\n\n\t\t\tconst totals = await fetchTotals()\n\t\t\treturn { rows: [{ metrics: totals }], totals, meta: { provider: 'umami', fetchedAt } }\n\t\t},\n\t}\n}\n"],"mappings":";;;AAyBA,MAAM,aAAa;AAEnB,MAAM,eAAuC,IAAI,IAAe;CAC/D;CACA;CACA;CACA;CACA;CACA;AACD,CAAC;AACD,MAAM,kBAA6C,IAAI,IAAkB,CAAC,MAAM,CAAC;AAUjF,SAAgB,MAAM,QAAuC;CAC5D,MAAM,OAAO,OAAO,QAAQ;CAG5B,MAAM,eAAsC;EAC3C,cAAc;EACd,UAAU;EACV,YAAY;EACZ,gBAAgB;EAChB,iBAPuB,OAAO,oBAAoB,KAAA,IAAY,OAAO,kBAAkB;EAQvF,SAAS;EACT,YAAY;EACZ,iBAAiB;EACjB,WAAW;EACX,gBAAgB;GAAE,UAAU;GAAK,WAAW;EAAK;CAClD;CAKA,MAAM,oBACL,OAAO,SACJ,EAAE,mBAAmB,OAAO,OAAO,IACnC,OAAO,QACN,EAAE,eAAe,UAAU,OAAO,QAAQ,IAC1C,CAAC;CAEN,MAAM,UAAU,MAAuC;EACtD,MAAM,IAAI,IAAI,gBAAgB;GAC7B,SAAS,OAAO,EAAE,UAAU,MAAM,QAAQ,CAAC;GAC3C,OAAO,OAAO,EAAE,UAAU,IAAI,QAAQ,CAAC;EACxC,CAAC;EACD,IAAI,EAAE,MACL,EAAE,IAAI,QAAQ,EAAE,IAAI;EAErB,OAAO;CACR;CAEA,OAAO;EACN,IAAI;EACJ,OAAO;EACP;EACA,oBAAoB,QAAQ,OAAO,cAAc,OAAO,UAAU,OAAO,MAAM;EAC/E,MAAM,MAAM,GAAmB,KAA+C;GAC7E,MAAM,YAAY,EAAE,UAAU,IAAI,YAAY;GAC9C,MAAM,UAAU,YAAY;GAG5B,KAF4B,EAAE,cAAc,CAAC,GAAG,SAAS,MAEpC,GAAG;IACvB,MAAM,IAAI,OAAO,CAAC;IAClB,EAAE,IAAI,QAAQ,KAAK;IACnB,MAAM,OAAO,MAAM,UAClB,GAAG,KAAK,YAAY,OAAO,UAAU,WAAW,EAAE,SAAS,KAC3D;KAAE;KAAS,QAAQ,IAAI;KAAQ,UAAU;IAAQ,CAClD;IACA,MAAM,SAAoB,EAAE,QAAQ,SAAS,WAAW,IAAI,cAAc;IAK1E,OAAO;KAAE,MAJoB,KAAK,KAAK,SAAS;MAC/C,YAAY,EAAE,MAAM,IAAI,EAAE;MAC1B,SAAS,GAAG,SAAS,IAAI,EAAE;KAC5B,EACY;KAAG,QAAQ,KAAA;KAAW,MAAM;MAAE,UAAU;MAAS;KAAU;IAAE;GAC1E;GAEA,MAAM,cAAc,YAAyD;IAC5E,MAAM,QAAQ,MAAM,UACnB,GAAG,KAAK,YAAY,OAAO,UAAU,SAAS,OAAO,CAAC,EAAE,SAAS,KACjE;KAAE;KAAS,QAAQ,IAAI;KAAQ,UAAU;IAAQ,CAClD;IACA,MAAM,MAA0C;KAC/C,WAAW,MAAM;KACjB,UAAU,MAAM;KAChB,QAAQ,MAAM;KACd,UAAU,MAAM;KAGhB,YACC,MAAM,SAAS,IAAI,KAAK,MAAO,MAAM,UAAU,MAAM,SAAU,GAAG,IAAI,KAAA;KACvE,aACC,MAAM,SAAS,IAAI,KAAK,MAAO,MAAM,YAAY,MAAM,SAAU,GAAI,IAAI,KAAA;IAC3E;IACA,MAAM,SAA6C,CAAC;IACpD,KAAK,MAAM,KAAK,EAAE,SACjB,IAAI,IAAI,OAAO,KAAA,GACd,OAAO,KAAK,IAAI;IAGlB,OAAO;GACR;GAKA,IAAI,EAAE,gBAAgB,OAAO;IAC5B,MAAM,IAAI,OAAO,CAAC;IAClB,EAAE,IAAI,QAAQ,KAAK;IACnB,EAAE,IAAI,YAAY,EAAE,YAAY,KAAK;IACrC,MAAM,oBACL,UAGG,GAAG,KAAK,YAAY,OAAO,UAAU,aAAa,EAAE,SAAS,KAAK;KACpE;KACA,QAAQ,IAAI;KACZ,UAAU;IACX,CAAC;IACF,MAAM,CAAC,QAAQ,UAAU,MAAM,QAAQ,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC,CAAC;IACzE,MAAM,cAAc,IAAI,IAAI,OAAO,SAAS,KAAK,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAClE,MAAM,OAAuB,CAAC;IAC9B,KAAK,MAAM,MAAM,OAAO,WAAW;KAClC,MAAM,KAAK,OAAO,GAAG,CAAC;KACtB,IAAI,CAAC,IACJ;KAED,MAAM,aAAa,YAAY,IAAI,GAAG,CAAC,KAAK;KAC5C,MAAM,MAA0C;MAC/C,WAAW,GAAG;MACd,QAAQ;MACR,UAAU;KACX;KACA,MAAM,UAA8C,CAAC;KACrD,KAAK,MAAM,KAAK,EAAE,SACjB,IAAI,IAAI,OAAO,KAAA,GACd,QAAQ,KAAK,IAAI;KAGnB,KAAK,KAAK;MAAE,WAAW;MAAI;KAAQ,CAAC;IACrC;IACA,OAAO;KAAE;KAAM;KAAQ,MAAM;MAAE,UAAU;MAAS;KAAU;IAAE;GAC/D;GAEA,MAAM,SAAS,MAAM,YAAY;GACjC,OAAO;IAAE,MAAM,CAAC,EAAE,SAAS,OAAO,CAAC;IAAG;IAAQ,MAAM;KAAE,UAAU;KAAS;IAAU;GAAE;EACtF;CACD;AACD"}
|
package/dist/binding/types.d.ts
CHANGED
|
@@ -29,13 +29,15 @@ type PathResolver<TSlug extends CollectionSlug = CollectionSlug> = (doc: Binding
|
|
|
29
29
|
/**
|
|
30
30
|
* Maps a document to the hostname its analytics were recorded under, for
|
|
31
31
|
* multi-domain setups where one Payload instance serves several sites. The
|
|
32
|
-
* resolved hostname is passed to the adapter alongside the path
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
32
|
+
* resolved hostname is passed to the adapter alongside the path; adapters that
|
|
33
|
+
* expose a host filter (PostHog `properties.$host`, GA4 `hostName`, Plausible
|
|
34
|
+
* `event:hostname`) narrow the query to that site's traffic, and the hostname
|
|
35
|
+
* always partitions the cache key. Adapters without a native host filter (umami,
|
|
36
|
+
* and the native engine, whose rollups are not yet keyed by hostname) ignore it.
|
|
37
|
+
* Runs on the server right before each per-document adapter read, with the same
|
|
38
|
+
* `(doc, ctx)` as {@link PathResolver}. Return null (or omit `hostname` entirely)
|
|
39
|
+
* to apply no hostname filter. A static string works for single-domain-per-collection
|
|
40
|
+
* setups; sync one-argument functions remain supported.
|
|
39
41
|
*/
|
|
40
42
|
type HostnameResolver<TSlug extends CollectionSlug = CollectionSlug> = (doc: BindingDoc<TSlug>, ctx: BindingContext) => string | null | Promise<string | null>;
|
|
41
43
|
/**
|
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
"use client";
|
|
2
2
|
import { ChartStyles } from "./styles.js";
|
|
3
3
|
import { monotoneAreaPath } from "./spline.js";
|
|
4
|
-
import { useEffect, useId, useRef, useState } from "react";
|
|
4
|
+
import { useEffect, useId, useLayoutEffect, useRef, useState } from "react";
|
|
5
5
|
import { Fragment, jsx, jsxs } from "react/jsx-runtime";
|
|
6
6
|
//#region src/charts/TrendChart.tsx
|
|
7
|
+
const useIsomorphicLayoutEffect = typeof window === "undefined" ? useEffect : useLayoutEffect;
|
|
7
8
|
const MARGIN = {
|
|
8
9
|
top: 8,
|
|
9
10
|
right: 8,
|
|
@@ -34,15 +35,23 @@ function TrendChart({ buckets, ariaLabel, minHeight = 160 }) {
|
|
|
34
35
|
w: 600,
|
|
35
36
|
h: minHeight
|
|
36
37
|
});
|
|
38
|
+
const [measured, setMeasured] = useState(false);
|
|
37
39
|
const [active, setActive] = useState(null);
|
|
38
40
|
const gradientId = useId();
|
|
39
|
-
|
|
41
|
+
useIsomorphicLayoutEffect(() => {
|
|
40
42
|
const el = ref.current;
|
|
41
43
|
if (!el) return;
|
|
42
|
-
const update = () =>
|
|
43
|
-
w
|
|
44
|
-
h
|
|
45
|
-
|
|
44
|
+
const update = () => {
|
|
45
|
+
const w = el.clientWidth;
|
|
46
|
+
const h = el.clientHeight;
|
|
47
|
+
if (w > 0) {
|
|
48
|
+
setSize({
|
|
49
|
+
w,
|
|
50
|
+
h: h || minHeight
|
|
51
|
+
});
|
|
52
|
+
setMeasured(true);
|
|
53
|
+
}
|
|
54
|
+
};
|
|
46
55
|
update();
|
|
47
56
|
const ro = new ResizeObserver(update);
|
|
48
57
|
ro.observe(el);
|
|
@@ -82,7 +91,7 @@ function TrendChart({ buckets, ariaLabel, minHeight = 160 }) {
|
|
|
82
91
|
onPointerLeave: () => setActive(null),
|
|
83
92
|
children: [
|
|
84
93
|
/* @__PURE__ */ jsx(ChartStyles, {}),
|
|
85
|
-
/* @__PURE__ */ jsxs("svg", {
|
|
94
|
+
measured ? /* @__PURE__ */ jsxs("svg", {
|
|
86
95
|
className: "analytics-chart__svg",
|
|
87
96
|
width,
|
|
88
97
|
height,
|
|
@@ -162,7 +171,7 @@ function TrendChart({ buckets, ariaLabel, minHeight = 160 }) {
|
|
|
162
171
|
}, buckets[i]?.label ?? i))
|
|
163
172
|
})
|
|
164
173
|
]
|
|
165
|
-
}),
|
|
174
|
+
}) : null,
|
|
166
175
|
active !== null ? /* @__PURE__ */ jsxs("div", {
|
|
167
176
|
className: "analytics-chart__tooltip",
|
|
168
177
|
style: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TrendChart.js","names":[],"sources":["../../src/charts/TrendChart.tsx"],"sourcesContent":["'use client'\n\nimport { type PointerEvent, useEffect, useId, useRef, useState } from 'react'\nimport { monotoneAreaPath } from './spline'\nimport { ChartStyles } from './styles'\n\nexport interface TrendPoint {\n\tlabel: string\n\tvalue: number\n\tdisplay: string\n}\n\nexport interface TrendChartProps {\n\tbuckets: TrendPoint[]\n\tariaLabel: string\n\tminHeight?: number\n}\n\nconst MARGIN = { top: 8, right: 8, bottom: 18, left: 8 }\nconst MAX_TICKS = 6\nconst PAD = 2\nconst GRID = [0.25, 0.5, 0.75]\n\nconst tickIndices = (n: number): number[] => {\n\tif (n <= MAX_TICKS) {\n\t\treturn Array.from({ length: n }, (_, i) => i)\n\t}\n\tconst step = (n - 1) / (MAX_TICKS - 1)\n\treturn Array.from({ length: MAX_TICKS }, (_, i) => Math.round(i * step))\n}\n\n/**\n * Gradient area trend chart: a monotone-cubic line over a themed gradient fill, with\n * gridlines, dots (when sparse), timeframe-aware x-axis labels, and a pointer-tracked\n * tooltip. Dependency-free; sizes to its container via a ResizeObserver so dots and\n * labels stay crisp (no aspect-ratio distortion).\n */\nexport function TrendChart({ buckets, ariaLabel, minHeight = 160 }: TrendChartProps) {\n\tconst ref = useRef<HTMLDivElement>(null)\n\tconst [size, setSize] = useState({ w: 600, h: minHeight })\n\tconst [active, setActive] = useState<number | null>(null)\n\tconst gradientId = useId()\n\n\tuseEffect(() => {\n\t\tconst el = ref.current\n\t\tif (!el) {\n\t\t\treturn\n\t\t}\n\t\tconst update = () => setSize({ w: el.clientWidth || 600, h: el.clientHeight || minHeight })\n\t\tupdate()\n\t\tconst ro = new ResizeObserver(update)\n\t\tro.observe(el)\n\t\treturn () => ro.disconnect()\n\t}, [minHeight])\n\n\tconst width = size.w\n\tconst height = size.h\n\tconst values = buckets.map((b) => b.value)\n\tconst n = values.length\n\tconst plotW = Math.max(1, width - MARGIN.left - MARGIN.right)\n\tconst plotH = Math.max(1, height - MARGIN.top - MARGIN.bottom)\n\tconst { line, area } = monotoneAreaPath(values, { width: plotW, height: plotH, padding: PAD })\n\n\tconst vmax = n > 0 ? Math.max(...values) : 0\n\tconst vmin = n > 0 ? Math.min(...values) : 0\n\tconst vspan = vmax - vmin || 1\n\tconst px = (i: number): number => (n > 1 ? (i / (n - 1)) * plotW : plotW / 2)\n\tconst py = (v: number): number =>\n\t\tvmax === vmin ? plotH / 2 : PAD + (plotH - PAD * 2) - ((v - vmin) / vspan) * (plotH - PAD * 2)\n\n\tconst onMove = (e: PointerEvent<HTMLDivElement>): void => {\n\t\tif (n === 0) {\n\t\t\treturn\n\t\t}\n\t\tconst rect = e.currentTarget.getBoundingClientRect()\n\t\tconst rel = e.clientX - rect.left - MARGIN.left\n\t\tsetActive(Math.max(0, Math.min(n - 1, Math.round((rel / plotW) * (n - 1)))))\n\t}\n\n\tconst activeValue = active !== null ? (values[active] ?? 0) : 0\n\treturn (\n\t\t<div\n\t\t\tref={ref}\n\t\t\tclassName=\"analytics-chart\"\n\t\t\tstyle={{ flex: '1 1 0', minHeight }}\n\t\t\tonPointerMove={onMove}\n\t\t\tonPointerLeave={() => setActive(null)}\n\t\t>\n\t\t\t<ChartStyles />\n\t\t\t<svg\n\t\t\t\tclassName=\"analytics-chart__svg\"\n\t\t\t\twidth={width}\n\t\t\t\theight={height}\n\t\t\t\trole=\"img\"\n\t\t\t\taria-label={ariaLabel}\n\t\t\t>\n\t\t\t\t<defs>\n\t\t\t\t\t<linearGradient id={gradientId} x1=\"0\" y1=\"0\" x2=\"0\" y2=\"1\">\n\t\t\t\t\t\t<stop offset=\"0%\" stopColor=\"var(--analytics-chart-1)\" stopOpacity=\"0.38\" />\n\t\t\t\t\t\t<stop offset=\"55%\" stopColor=\"var(--analytics-chart-1)\" stopOpacity=\"0.1\" />\n\t\t\t\t\t\t<stop offset=\"100%\" stopColor=\"var(--analytics-chart-1)\" stopOpacity=\"0\" />\n\t\t\t\t\t</linearGradient>\n\t\t\t\t</defs>\n\t\t\t\t<g transform={`translate(${MARGIN.left},${MARGIN.top})`}>\n\t\t\t\t\t{GRID.map((g) => (\n\t\t\t\t\t\t<line\n\t\t\t\t\t\t\tkey={g}\n\t\t\t\t\t\t\tclassName=\"analytics-chart__grid\"\n\t\t\t\t\t\t\tx1={0}\n\t\t\t\t\t\t\tx2={plotW}\n\t\t\t\t\t\t\ty1={g * plotH}\n\t\t\t\t\t\t\ty2={g * plotH}\n\t\t\t\t\t\t/>\n\t\t\t\t\t))}\n\t\t\t\t\t{area ? (\n\t\t\t\t\t\t<path className=\"analytics-chart__area\" d={area} fill={`url(#${gradientId})`} />\n\t\t\t\t\t) : null}\n\t\t\t\t\t{line ? <path className=\"analytics-chart__line\" d={line} /> : null}\n\t\t\t\t\t{n <= 12\n\t\t\t\t\t\t? values.map((v, i) => (\n\t\t\t\t\t\t\t\t<circle\n\t\t\t\t\t\t\t\t\tkey={buckets[i]?.label ?? i}\n\t\t\t\t\t\t\t\t\tclassName=\"analytics-chart__dot\"\n\t\t\t\t\t\t\t\t\tcx={px(i)}\n\t\t\t\t\t\t\t\t\tcy={py(v)}\n\t\t\t\t\t\t\t\t\tr={2.5}\n\t\t\t\t\t\t\t\t/>\n\t\t\t\t\t\t\t))\n\t\t\t\t\t\t: null}\n\t\t\t\t\t{active !== null ? (\n\t\t\t\t\t\t<>\n\t\t\t\t\t\t\t<line\n\t\t\t\t\t\t\t\tclassName=\"analytics-chart__cursor\"\n\t\t\t\t\t\t\t\tx1={px(active)}\n\t\t\t\t\t\t\t\tx2={px(active)}\n\t\t\t\t\t\t\t\ty1={0}\n\t\t\t\t\t\t\t\ty2={plotH}\n\t\t\t\t\t\t\t/>\n\t\t\t\t\t\t\t<circle\n\t\t\t\t\t\t\t\tclassName=\"analytics-chart__active\"\n\t\t\t\t\t\t\t\tcx={px(active)}\n\t\t\t\t\t\t\t\tcy={py(activeValue)}\n\t\t\t\t\t\t\t\tr={3.5}\n\t\t\t\t\t\t\t/>\n\t\t\t\t\t\t</>\n\t\t\t\t\t) : null}\n\t\t\t\t</g>\n\t\t\t\t<g transform={`translate(${MARGIN.left},${height - 4})`}>\n\t\t\t\t\t{tickIndices(n).map((i) => (\n\t\t\t\t\t\t<text\n\t\t\t\t\t\t\tkey={buckets[i]?.label ?? i}\n\t\t\t\t\t\t\tclassName=\"analytics-chart__axis\"\n\t\t\t\t\t\t\tx={px(i)}\n\t\t\t\t\t\t\ttextAnchor={i === 0 ? 'start' : i === n - 1 ? 'end' : 'middle'}\n\t\t\t\t\t\t>\n\t\t\t\t\t\t\t{buckets[i]?.label}\n\t\t\t\t\t\t</text>\n\t\t\t\t\t))}\n\t\t\t\t</g>\n\t\t\t</svg>\n\t\t\t{active !== null ? (\n\t\t\t\t<div\n\t\t\t\t\tclassName=\"analytics-chart__tooltip\"\n\t\t\t\t\tstyle={{ left: MARGIN.left + px(active), top: MARGIN.top + py(activeValue) }}\n\t\t\t\t>\n\t\t\t\t\t<div className=\"analytics-chart__tooltip-label\">{buckets[active]?.label}</div>\n\t\t\t\t\t<div className=\"analytics-chart__tooltip-value\">{buckets[active]?.display}</div>\n\t\t\t\t</div>\n\t\t\t) : null}\n\t\t</div>\n\t)\n}\n"],"mappings":";;;;;;AAkBA,MAAM,SAAS;CAAE,KAAK;CAAG,OAAO;CAAG,QAAQ;CAAI,MAAM;AAAE;AACvD,MAAM,YAAY;AAClB,MAAM,MAAM;AACZ,MAAM,OAAO;CAAC;CAAM;CAAK;AAAI;AAE7B,MAAM,eAAe,MAAwB;CAC5C,IAAI,KAAK,WACR,OAAO,MAAM,KAAK,EAAE,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAC;CAE7C,MAAM,QAAQ,IAAI,MAAM,YAAY;CACpC,OAAO,MAAM,KAAK,EAAE,QAAQ,UAAU,IAAI,GAAG,MAAM,KAAK,MAAM,IAAI,IAAI,CAAC;AACxE;;;;;;;AAQA,SAAgB,WAAW,EAAE,SAAS,WAAW,YAAY,OAAwB;CACpF,MAAM,MAAM,OAAuB,IAAI;CACvC,MAAM,CAAC,MAAM,WAAW,SAAS;EAAE,GAAG;EAAK,GAAG;CAAU,CAAC;CACzD,MAAM,CAAC,QAAQ,aAAa,SAAwB,IAAI;CACxD,MAAM,aAAa,MAAM;CAEzB,gBAAgB;EACf,MAAM,KAAK,IAAI;EACf,IAAI,CAAC,IACJ;EAED,MAAM,eAAe,QAAQ;GAAE,GAAG,GAAG,eAAe;GAAK,GAAG,GAAG,gBAAgB;EAAU,CAAC;EAC1F,OAAO;EACP,MAAM,KAAK,IAAI,eAAe,MAAM;EACpC,GAAG,QAAQ,EAAE;EACb,aAAa,GAAG,WAAW;CAC5B,GAAG,CAAC,SAAS,CAAC;CAEd,MAAM,QAAQ,KAAK;CACnB,MAAM,SAAS,KAAK;CACpB,MAAM,SAAS,QAAQ,KAAK,MAAM,EAAE,KAAK;CACzC,MAAM,IAAI,OAAO;CACjB,MAAM,QAAQ,KAAK,IAAI,GAAG,QAAQ,OAAO,OAAO,OAAO,KAAK;CAC5D,MAAM,QAAQ,KAAK,IAAI,GAAG,SAAS,OAAO,MAAM,OAAO,MAAM;CAC7D,MAAM,EAAE,MAAM,SAAS,iBAAiB,QAAQ;EAAE,OAAO;EAAO,QAAQ;EAAO,SAAS;CAAI,CAAC;CAE7F,MAAM,OAAO,IAAI,IAAI,KAAK,IAAI,GAAG,MAAM,IAAI;CAC3C,MAAM,OAAO,IAAI,IAAI,KAAK,IAAI,GAAG,MAAM,IAAI;CAC3C,MAAM,QAAQ,OAAO,QAAQ;CAC7B,MAAM,MAAM,MAAuB,IAAI,IAAK,KAAK,IAAI,KAAM,QAAQ,QAAQ;CAC3E,MAAM,MAAM,MACX,SAAS,OAAO,QAAQ,IAAI,OAAO,QAAQ,MAAM,MAAO,IAAI,QAAQ,SAAU,QAAQ,MAAM;CAE7F,MAAM,UAAU,MAA0C;EACzD,IAAI,MAAM,GACT;EAED,MAAM,OAAO,EAAE,cAAc,sBAAsB;EACnD,MAAM,MAAM,EAAE,UAAU,KAAK,OAAO,OAAO;EAC3C,UAAU,KAAK,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,MAAO,MAAM,SAAU,IAAI,EAAE,CAAC,CAAC,CAAC;CAC5E;CAEA,MAAM,cAAc,WAAW,OAAQ,OAAO,WAAW,IAAK;CAC9D,OACC,qBAAC,OAAD;EACM;EACL,WAAU;EACV,OAAO;GAAE,MAAM;GAAS;EAAU;EAClC,eAAe;EACf,sBAAsB,UAAU,IAAI;YALrC;GAOC,oBAAC,aAAD,CAAc,CAAA;GACd,qBAAC,OAAD;IACC,WAAU;IACH;IACC;IACR,MAAK;IACL,cAAY;cALb;KAOC,oBAAC,QAAD,EAAA,UACC,qBAAC,kBAAD;MAAgB,IAAI;MAAY,IAAG;MAAI,IAAG;MAAI,IAAG;MAAI,IAAG;gBAAxD;OACC,oBAAC,QAAD;QAAM,QAAO;QAAK,WAAU;QAA2B,aAAY;OAAQ,CAAA;OAC3E,oBAAC,QAAD;QAAM,QAAO;QAAM,WAAU;QAA2B,aAAY;OAAO,CAAA;OAC3E,oBAAC,QAAD;QAAM,QAAO;QAAO,WAAU;QAA2B,aAAY;OAAK,CAAA;MAC3D;QACX,CAAA;KACN,qBAAC,KAAD;MAAG,WAAW,aAAa,OAAO,KAAK,GAAG,OAAO,IAAI;gBAArD;OACE,KAAK,KAAK,MACV,oBAAC,QAAD;QAEC,WAAU;QACV,IAAI;QACJ,IAAI;QACJ,IAAI,IAAI;QACR,IAAI,IAAI;OACR,GANK,CAML,CACD;OACA,OACA,oBAAC,QAAD;QAAM,WAAU;QAAwB,GAAG;QAAM,MAAM,QAAQ,WAAW;OAAK,CAAA,IAC5E;OACH,OAAO,oBAAC,QAAD;QAAM,WAAU;QAAwB,GAAG;OAAO,CAAA,IAAI;OAC7D,KAAK,KACH,OAAO,KAAK,GAAG,MACf,oBAAC,UAAD;QAEC,WAAU;QACV,IAAI,GAAG,CAAC;QACR,IAAI,GAAG,CAAC;QACR,GAAG;OACH,GALK,QAAQ,IAAI,SAAS,CAK1B,CACD,IACA;OACF,WAAW,OACX,qBAAA,UAAA,EAAA,UAAA,CACC,oBAAC,QAAD;QACC,WAAU;QACV,IAAI,GAAG,MAAM;QACb,IAAI,GAAG,MAAM;QACb,IAAI;QACJ,IAAI;OACJ,CAAA,GACD,oBAAC,UAAD;QACC,WAAU;QACV,IAAI,GAAG,MAAM;QACb,IAAI,GAAG,WAAW;QAClB,GAAG;OACH,CAAA,CACA,EAAA,CAAA,IACC;MACF;;KACH,oBAAC,KAAD;MAAG,WAAW,aAAa,OAAO,KAAK,GAAG,SAAS,EAAE;gBACnD,YAAY,CAAC,EAAE,KAAK,MACpB,oBAAC,QAAD;OAEC,WAAU;OACV,GAAG,GAAG,CAAC;OACP,YAAY,MAAM,IAAI,UAAU,MAAM,IAAI,IAAI,QAAQ;iBAErD,QAAQ,IAAI;MACR,GANA,QAAQ,IAAI,SAAS,CAMrB,CACN;KACC,CAAA;IACC;;GACJ,WAAW,OACX,qBAAC,OAAD;IACC,WAAU;IACV,OAAO;KAAE,MAAM,OAAO,OAAO,GAAG,MAAM;KAAG,KAAK,OAAO,MAAM,GAAG,WAAW;IAAE;cAF5E,CAIC,oBAAC,OAAD;KAAK,WAAU;eAAkC,QAAQ,SAAS;IAAW,CAAA,GAC7E,oBAAC,OAAD;KAAK,WAAU;eAAkC,QAAQ,SAAS;IAAa,CAAA,CAC3E;QACF;EACA;;AAEP"}
|
|
1
|
+
{"version":3,"file":"TrendChart.js","names":[],"sources":["../../src/charts/TrendChart.tsx"],"sourcesContent":["'use client'\n\nimport { type PointerEvent, useEffect, useId, useLayoutEffect, useRef, useState } from 'react'\nimport { monotoneAreaPath } from './spline'\nimport { ChartStyles } from './styles'\n\n// useLayoutEffect measures before paint on the client; fall back to useEffect during\n// SSR to avoid React's server-render warning (the chart body is gated on `measured`).\nconst useIsomorphicLayoutEffect = typeof window === 'undefined' ? useEffect : useLayoutEffect\n\nexport interface TrendPoint {\n\tlabel: string\n\tvalue: number\n\tdisplay: string\n}\n\nexport interface TrendChartProps {\n\tbuckets: TrendPoint[]\n\tariaLabel: string\n\tminHeight?: number\n}\n\nconst MARGIN = { top: 8, right: 8, bottom: 18, left: 8 }\nconst MAX_TICKS = 6\nconst PAD = 2\nconst GRID = [0.25, 0.5, 0.75]\n\nconst tickIndices = (n: number): number[] => {\n\tif (n <= MAX_TICKS) {\n\t\treturn Array.from({ length: n }, (_, i) => i)\n\t}\n\tconst step = (n - 1) / (MAX_TICKS - 1)\n\treturn Array.from({ length: MAX_TICKS }, (_, i) => Math.round(i * step))\n}\n\n/**\n * Gradient area trend chart: a monotone-cubic line over a themed gradient fill, with\n * gridlines, dots (when sparse), timeframe-aware x-axis labels, and a pointer-tracked\n * tooltip. Dependency-free; sizes to its container via a ResizeObserver so dots and\n * labels stay crisp (no aspect-ratio distortion).\n */\nexport function TrendChart({ buckets, ariaLabel, minHeight = 160 }: TrendChartProps) {\n\tconst ref = useRef<HTMLDivElement>(null)\n\tconst [size, setSize] = useState({ w: 600, h: minHeight })\n\tconst [measured, setMeasured] = useState(false)\n\tconst [active, setActive] = useState<number | null>(null)\n\tconst gradientId = useId()\n\n\tuseIsomorphicLayoutEffect(() => {\n\t\tconst el = ref.current\n\t\tif (!el) {\n\t\t\treturn\n\t\t}\n\t\tconst update = () => {\n\t\t\tconst w = el.clientWidth\n\t\t\tconst h = el.clientHeight\n\t\t\tif (w > 0) {\n\t\t\t\tsetSize({ w, h: h || minHeight })\n\t\t\t\tsetMeasured(true)\n\t\t\t}\n\t\t}\n\t\tupdate()\n\t\tconst ro = new ResizeObserver(update)\n\t\tro.observe(el)\n\t\treturn () => ro.disconnect()\n\t}, [minHeight])\n\n\tconst width = size.w\n\tconst height = size.h\n\tconst values = buckets.map((b) => b.value)\n\tconst n = values.length\n\tconst plotW = Math.max(1, width - MARGIN.left - MARGIN.right)\n\tconst plotH = Math.max(1, height - MARGIN.top - MARGIN.bottom)\n\tconst { line, area } = monotoneAreaPath(values, { width: plotW, height: plotH, padding: PAD })\n\n\tconst vmax = n > 0 ? Math.max(...values) : 0\n\tconst vmin = n > 0 ? Math.min(...values) : 0\n\tconst vspan = vmax - vmin || 1\n\tconst px = (i: number): number => (n > 1 ? (i / (n - 1)) * plotW : plotW / 2)\n\tconst py = (v: number): number =>\n\t\tvmax === vmin ? plotH / 2 : PAD + (plotH - PAD * 2) - ((v - vmin) / vspan) * (plotH - PAD * 2)\n\n\tconst onMove = (e: PointerEvent<HTMLDivElement>): void => {\n\t\tif (n === 0) {\n\t\t\treturn\n\t\t}\n\t\tconst rect = e.currentTarget.getBoundingClientRect()\n\t\tconst rel = e.clientX - rect.left - MARGIN.left\n\t\tsetActive(Math.max(0, Math.min(n - 1, Math.round((rel / plotW) * (n - 1)))))\n\t}\n\n\tconst activeValue = active !== null ? (values[active] ?? 0) : 0\n\treturn (\n\t\t<div\n\t\t\tref={ref}\n\t\t\tclassName=\"analytics-chart\"\n\t\t\tstyle={{ flex: '1 1 0', minHeight }}\n\t\t\tonPointerMove={onMove}\n\t\t\tonPointerLeave={() => setActive(null)}\n\t\t>\n\t\t\t<ChartStyles />\n\t\t\t{measured ? (\n\t\t\t\t<svg\n\t\t\t\t\tclassName=\"analytics-chart__svg\"\n\t\t\t\t\twidth={width}\n\t\t\t\t\theight={height}\n\t\t\t\t\trole=\"img\"\n\t\t\t\t\taria-label={ariaLabel}\n\t\t\t\t>\n\t\t\t\t\t<defs>\n\t\t\t\t\t\t<linearGradient id={gradientId} x1=\"0\" y1=\"0\" x2=\"0\" y2=\"1\">\n\t\t\t\t\t\t\t<stop offset=\"0%\" stopColor=\"var(--analytics-chart-1)\" stopOpacity=\"0.38\" />\n\t\t\t\t\t\t\t<stop offset=\"55%\" stopColor=\"var(--analytics-chart-1)\" stopOpacity=\"0.1\" />\n\t\t\t\t\t\t\t<stop offset=\"100%\" stopColor=\"var(--analytics-chart-1)\" stopOpacity=\"0\" />\n\t\t\t\t\t\t</linearGradient>\n\t\t\t\t\t</defs>\n\t\t\t\t\t<g transform={`translate(${MARGIN.left},${MARGIN.top})`}>\n\t\t\t\t\t\t{GRID.map((g) => (\n\t\t\t\t\t\t\t<line\n\t\t\t\t\t\t\t\tkey={g}\n\t\t\t\t\t\t\t\tclassName=\"analytics-chart__grid\"\n\t\t\t\t\t\t\t\tx1={0}\n\t\t\t\t\t\t\t\tx2={plotW}\n\t\t\t\t\t\t\t\ty1={g * plotH}\n\t\t\t\t\t\t\t\ty2={g * plotH}\n\t\t\t\t\t\t\t/>\n\t\t\t\t\t\t))}\n\t\t\t\t\t\t{area ? (\n\t\t\t\t\t\t\t<path className=\"analytics-chart__area\" d={area} fill={`url(#${gradientId})`} />\n\t\t\t\t\t\t) : null}\n\t\t\t\t\t\t{line ? <path className=\"analytics-chart__line\" d={line} /> : null}\n\t\t\t\t\t\t{n <= 12\n\t\t\t\t\t\t\t? values.map((v, i) => (\n\t\t\t\t\t\t\t\t\t<circle\n\t\t\t\t\t\t\t\t\t\tkey={buckets[i]?.label ?? i}\n\t\t\t\t\t\t\t\t\t\tclassName=\"analytics-chart__dot\"\n\t\t\t\t\t\t\t\t\t\tcx={px(i)}\n\t\t\t\t\t\t\t\t\t\tcy={py(v)}\n\t\t\t\t\t\t\t\t\t\tr={2.5}\n\t\t\t\t\t\t\t\t\t/>\n\t\t\t\t\t\t\t\t))\n\t\t\t\t\t\t\t: null}\n\t\t\t\t\t\t{active !== null ? (\n\t\t\t\t\t\t\t<>\n\t\t\t\t\t\t\t\t<line\n\t\t\t\t\t\t\t\t\tclassName=\"analytics-chart__cursor\"\n\t\t\t\t\t\t\t\t\tx1={px(active)}\n\t\t\t\t\t\t\t\t\tx2={px(active)}\n\t\t\t\t\t\t\t\t\ty1={0}\n\t\t\t\t\t\t\t\t\ty2={plotH}\n\t\t\t\t\t\t\t\t/>\n\t\t\t\t\t\t\t\t<circle\n\t\t\t\t\t\t\t\t\tclassName=\"analytics-chart__active\"\n\t\t\t\t\t\t\t\t\tcx={px(active)}\n\t\t\t\t\t\t\t\t\tcy={py(activeValue)}\n\t\t\t\t\t\t\t\t\tr={3.5}\n\t\t\t\t\t\t\t\t/>\n\t\t\t\t\t\t\t</>\n\t\t\t\t\t\t) : null}\n\t\t\t\t\t</g>\n\t\t\t\t\t<g transform={`translate(${MARGIN.left},${height - 4})`}>\n\t\t\t\t\t\t{tickIndices(n).map((i) => (\n\t\t\t\t\t\t\t<text\n\t\t\t\t\t\t\t\tkey={buckets[i]?.label ?? i}\n\t\t\t\t\t\t\t\tclassName=\"analytics-chart__axis\"\n\t\t\t\t\t\t\t\tx={px(i)}\n\t\t\t\t\t\t\t\ttextAnchor={i === 0 ? 'start' : i === n - 1 ? 'end' : 'middle'}\n\t\t\t\t\t\t\t>\n\t\t\t\t\t\t\t\t{buckets[i]?.label}\n\t\t\t\t\t\t\t</text>\n\t\t\t\t\t\t))}\n\t\t\t\t\t</g>\n\t\t\t\t</svg>\n\t\t\t) : null}\n\t\t\t{active !== null ? (\n\t\t\t\t<div\n\t\t\t\t\tclassName=\"analytics-chart__tooltip\"\n\t\t\t\t\tstyle={{ left: MARGIN.left + px(active), top: MARGIN.top + py(activeValue) }}\n\t\t\t\t>\n\t\t\t\t\t<div className=\"analytics-chart__tooltip-label\">{buckets[active]?.label}</div>\n\t\t\t\t\t<div className=\"analytics-chart__tooltip-value\">{buckets[active]?.display}</div>\n\t\t\t\t</div>\n\t\t\t) : null}\n\t\t</div>\n\t)\n}\n"],"mappings":";;;;;;AAQA,MAAM,4BAA4B,OAAO,WAAW,cAAc,YAAY;AAc9E,MAAM,SAAS;CAAE,KAAK;CAAG,OAAO;CAAG,QAAQ;CAAI,MAAM;AAAE;AACvD,MAAM,YAAY;AAClB,MAAM,MAAM;AACZ,MAAM,OAAO;CAAC;CAAM;CAAK;AAAI;AAE7B,MAAM,eAAe,MAAwB;CAC5C,IAAI,KAAK,WACR,OAAO,MAAM,KAAK,EAAE,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAC;CAE7C,MAAM,QAAQ,IAAI,MAAM,YAAY;CACpC,OAAO,MAAM,KAAK,EAAE,QAAQ,UAAU,IAAI,GAAG,MAAM,KAAK,MAAM,IAAI,IAAI,CAAC;AACxE;;;;;;;AAQA,SAAgB,WAAW,EAAE,SAAS,WAAW,YAAY,OAAwB;CACpF,MAAM,MAAM,OAAuB,IAAI;CACvC,MAAM,CAAC,MAAM,WAAW,SAAS;EAAE,GAAG;EAAK,GAAG;CAAU,CAAC;CACzD,MAAM,CAAC,UAAU,eAAe,SAAS,KAAK;CAC9C,MAAM,CAAC,QAAQ,aAAa,SAAwB,IAAI;CACxD,MAAM,aAAa,MAAM;CAEzB,gCAAgC;EAC/B,MAAM,KAAK,IAAI;EACf,IAAI,CAAC,IACJ;EAED,MAAM,eAAe;GACpB,MAAM,IAAI,GAAG;GACb,MAAM,IAAI,GAAG;GACb,IAAI,IAAI,GAAG;IACV,QAAQ;KAAE;KAAG,GAAG,KAAK;IAAU,CAAC;IAChC,YAAY,IAAI;GACjB;EACD;EACA,OAAO;EACP,MAAM,KAAK,IAAI,eAAe,MAAM;EACpC,GAAG,QAAQ,EAAE;EACb,aAAa,GAAG,WAAW;CAC5B,GAAG,CAAC,SAAS,CAAC;CAEd,MAAM,QAAQ,KAAK;CACnB,MAAM,SAAS,KAAK;CACpB,MAAM,SAAS,QAAQ,KAAK,MAAM,EAAE,KAAK;CACzC,MAAM,IAAI,OAAO;CACjB,MAAM,QAAQ,KAAK,IAAI,GAAG,QAAQ,OAAO,OAAO,OAAO,KAAK;CAC5D,MAAM,QAAQ,KAAK,IAAI,GAAG,SAAS,OAAO,MAAM,OAAO,MAAM;CAC7D,MAAM,EAAE,MAAM,SAAS,iBAAiB,QAAQ;EAAE,OAAO;EAAO,QAAQ;EAAO,SAAS;CAAI,CAAC;CAE7F,MAAM,OAAO,IAAI,IAAI,KAAK,IAAI,GAAG,MAAM,IAAI;CAC3C,MAAM,OAAO,IAAI,IAAI,KAAK,IAAI,GAAG,MAAM,IAAI;CAC3C,MAAM,QAAQ,OAAO,QAAQ;CAC7B,MAAM,MAAM,MAAuB,IAAI,IAAK,KAAK,IAAI,KAAM,QAAQ,QAAQ;CAC3E,MAAM,MAAM,MACX,SAAS,OAAO,QAAQ,IAAI,OAAO,QAAQ,MAAM,MAAO,IAAI,QAAQ,SAAU,QAAQ,MAAM;CAE7F,MAAM,UAAU,MAA0C;EACzD,IAAI,MAAM,GACT;EAED,MAAM,OAAO,EAAE,cAAc,sBAAsB;EACnD,MAAM,MAAM,EAAE,UAAU,KAAK,OAAO,OAAO;EAC3C,UAAU,KAAK,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,MAAO,MAAM,SAAU,IAAI,EAAE,CAAC,CAAC,CAAC;CAC5E;CAEA,MAAM,cAAc,WAAW,OAAQ,OAAO,WAAW,IAAK;CAC9D,OACC,qBAAC,OAAD;EACM;EACL,WAAU;EACV,OAAO;GAAE,MAAM;GAAS;EAAU;EAClC,eAAe;EACf,sBAAsB,UAAU,IAAI;YALrC;GAOC,oBAAC,aAAD,CAAc,CAAA;GACb,WACA,qBAAC,OAAD;IACC,WAAU;IACH;IACC;IACR,MAAK;IACL,cAAY;cALb;KAOC,oBAAC,QAAD,EAAA,UACC,qBAAC,kBAAD;MAAgB,IAAI;MAAY,IAAG;MAAI,IAAG;MAAI,IAAG;MAAI,IAAG;gBAAxD;OACC,oBAAC,QAAD;QAAM,QAAO;QAAK,WAAU;QAA2B,aAAY;OAAQ,CAAA;OAC3E,oBAAC,QAAD;QAAM,QAAO;QAAM,WAAU;QAA2B,aAAY;OAAO,CAAA;OAC3E,oBAAC,QAAD;QAAM,QAAO;QAAO,WAAU;QAA2B,aAAY;OAAK,CAAA;MAC3D;QACX,CAAA;KACN,qBAAC,KAAD;MAAG,WAAW,aAAa,OAAO,KAAK,GAAG,OAAO,IAAI;gBAArD;OACE,KAAK,KAAK,MACV,oBAAC,QAAD;QAEC,WAAU;QACV,IAAI;QACJ,IAAI;QACJ,IAAI,IAAI;QACR,IAAI,IAAI;OACR,GANK,CAML,CACD;OACA,OACA,oBAAC,QAAD;QAAM,WAAU;QAAwB,GAAG;QAAM,MAAM,QAAQ,WAAW;OAAK,CAAA,IAC5E;OACH,OAAO,oBAAC,QAAD;QAAM,WAAU;QAAwB,GAAG;OAAO,CAAA,IAAI;OAC7D,KAAK,KACH,OAAO,KAAK,GAAG,MACf,oBAAC,UAAD;QAEC,WAAU;QACV,IAAI,GAAG,CAAC;QACR,IAAI,GAAG,CAAC;QACR,GAAG;OACH,GALK,QAAQ,IAAI,SAAS,CAK1B,CACD,IACA;OACF,WAAW,OACX,qBAAA,UAAA,EAAA,UAAA,CACC,oBAAC,QAAD;QACC,WAAU;QACV,IAAI,GAAG,MAAM;QACb,IAAI,GAAG,MAAM;QACb,IAAI;QACJ,IAAI;OACJ,CAAA,GACD,oBAAC,UAAD;QACC,WAAU;QACV,IAAI,GAAG,MAAM;QACb,IAAI,GAAG,WAAW;QAClB,GAAG;OACH,CAAA,CACA,EAAA,CAAA,IACC;MACF;;KACH,oBAAC,KAAD;MAAG,WAAW,aAAa,OAAO,KAAK,GAAG,SAAS,EAAE;gBACnD,YAAY,CAAC,EAAE,KAAK,MACpB,oBAAC,QAAD;OAEC,WAAU;OACV,GAAG,GAAG,CAAC;OACP,YAAY,MAAM,IAAI,UAAU,MAAM,IAAI,IAAI,QAAQ;iBAErD,QAAQ,IAAI;MACR,GANA,QAAQ,IAAI,SAAS,CAMrB,CACN;KACC,CAAA;IACC;QACF;GACH,WAAW,OACX,qBAAC,OAAD;IACC,WAAU;IACV,OAAO;KAAE,MAAM,OAAO,OAAO,GAAG,MAAM;KAAG,KAAK,OAAO,MAAM,GAAG,WAAW;IAAE;cAF5E,CAIC,oBAAC,OAAD;KAAK,WAAU;eAAkC,QAAQ,SAAS;IAAW,CAAA,GAC7E,oBAAC,OAAD;KAAK,WAAU;eAAkC,QAAQ,SAAS;IAAa,CAAA,CAC3E;QACF;EACA;;AAEP"}
|