@10x-media/analytics 0.1.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/LICENSE +21 -0
  3. package/README.md +387 -0
  4. package/dist/RealtimeCounter-BJrjMPSa.js +473 -0
  5. package/dist/RealtimeCounter-BJrjMPSa.js.map +1 -0
  6. package/dist/contract-CWZPKWuR.d.ts +83 -0
  7. package/dist/dist-B6HruP5v.js +4731 -0
  8. package/dist/dist-B6HruP5v.js.map +1 -0
  9. package/dist/exports/adapters/ga4.d.ts +20 -0
  10. package/dist/exports/adapters/ga4.js +177 -0
  11. package/dist/exports/adapters/ga4.js.map +1 -0
  12. package/dist/exports/adapters/native.d.ts +22 -0
  13. package/dist/exports/adapters/native.js +849 -0
  14. package/dist/exports/adapters/native.js.map +1 -0
  15. package/dist/exports/adapters/plausible.d.ts +15 -0
  16. package/dist/exports/adapters/plausible.js +143 -0
  17. package/dist/exports/adapters/plausible.js.map +1 -0
  18. package/dist/exports/adapters/posthog.d.ts +17 -0
  19. package/dist/exports/adapters/posthog.js +119 -0
  20. package/dist/exports/adapters/posthog.js.map +1 -0
  21. package/dist/exports/adapters/umami.d.ts +18 -0
  22. package/dist/exports/adapters/umami.js +139 -0
  23. package/dist/exports/adapters/umami.js.map +1 -0
  24. package/dist/exports/client.d.ts +77 -0
  25. package/dist/exports/client.js +388 -0
  26. package/dist/exports/client.js.map +1 -0
  27. package/dist/exports/geo.d.ts +19 -0
  28. package/dist/exports/geo.js +2 -0
  29. package/dist/exports/i18n.d.ts +63 -0
  30. package/dist/exports/i18n.js +3 -0
  31. package/dist/exports/rsc.d.ts +120 -0
  32. package/dist/exports/rsc.js +598 -0
  33. package/dist/exports/rsc.js.map +1 -0
  34. package/dist/exports/types.d.ts +4 -0
  35. package/dist/exports/types.js +1 -0
  36. package/dist/fetchJson-DZb2_Puj.js +36 -0
  37. package/dist/fetchJson-DZb2_Puj.js.map +1 -0
  38. package/dist/geoResolver-CasIa4T9.d.ts +12 -0
  39. package/dist/index-CZdCT0WJ.d.ts +98 -0
  40. package/dist/index.d.ts +3 -0
  41. package/dist/index.js +1081 -0
  42. package/dist/index.js.map +1 -0
  43. package/dist/keys-DEqL4LOT.js +57 -0
  44. package/dist/keys-DEqL4LOT.js.map +1 -0
  45. package/dist/lib-CE5x1zLQ.js +1058 -0
  46. package/dist/lib-CE5x1zLQ.js.map +1 -0
  47. package/dist/maxmindResolver-CXYXXdul.js +99 -0
  48. package/dist/maxmindResolver-CXYXXdul.js.map +1 -0
  49. package/dist/presets-CBfq_uJX.d.ts +38 -0
  50. package/dist/readForWidgetRealtime-D1BD37ST.d.ts +32 -0
  51. package/dist/series-zytbzPoc.js +17 -0
  52. package/dist/series-zytbzPoc.js.map +1 -0
  53. package/dist/server-Cuvhgz-S.js +492 -0
  54. package/dist/server-Cuvhgz-S.js.map +1 -0
  55. package/dist/testing/memoryAdapter.d.ts +16 -0
  56. package/dist/testing/memoryAdapter.js +98 -0
  57. package/dist/testing/memoryAdapter.js.map +1 -0
  58. package/dist/translations-keiKtSjF.js +77 -0
  59. package/dist/translations-keiKtSjF.js.map +1 -0
  60. package/package.json +156 -0
@@ -0,0 +1,120 @@
1
+ import { f as MetricKey, l as DateRange, u as DimensionKey } from "../contract-CWZPKWuR.js";
2
+ import { a as readForWidgetRealtime, i as WidgetRealtimeStatus, n as RealtimePoint, r as WidgetRealtimeResult, t as ReadForWidgetRealtimeArgs } from "../readForWidgetRealtime-D1BD37ST.js";
3
+ import { i as BindingDoc, s as CapabilityRequirement, t as TimeframePreset } from "../presets-CBfq_uJX.js";
4
+ import { PayloadRequest, WidgetServerProps } from "payload";
5
+
6
+ //#region src/fields/AnalyticsStatField.d.ts
7
+ interface AnalyticsStatFieldProps {
8
+ req: PayloadRequest;
9
+ data: BindingDoc;
10
+ collectionSlug: string;
11
+ i18n: {
12
+ t: unknown;
13
+ language?: string;
14
+ };
15
+ metrics: MetricKey[];
16
+ timeframe: TimeframePreset;
17
+ variant: 'stat' | 'row';
18
+ adapterId?: string;
19
+ }
20
+ /**
21
+ * Read-only server component for a per-document analytics stat (or row of stats).
22
+ * Resolves the document's bound path, reads through the surfacing engine, and renders
23
+ * static markup. Interactivity (timeframe picker, refresh) is intentionally deferred.
24
+ */
25
+ declare const AnalyticsStatField: (props: AnalyticsStatFieldProps) => Promise<import("react/jsx-runtime").JSX.Element>;
26
+ //#endregion
27
+ //#region src/fields/format.d.ts
28
+ declare const formatMetricValue: (metric: MetricKey, value: number, locale: string) => string;
29
+ //#endregion
30
+ //#region src/widgets/AnalyticsBreakdownWidget.d.ts
31
+ declare function AnalyticsBreakdownWidget(props: WidgetServerProps): Promise<import("react/jsx-runtime").JSX.Element>;
32
+ //#endregion
33
+ //#region src/widgets/AnalyticsMetricWidget.d.ts
34
+ declare function AnalyticsMetricWidget(props: WidgetServerProps): Promise<import("react/jsx-runtime").JSX.Element>;
35
+ //#endregion
36
+ //#region src/widgets/AnalyticsRealtimeWidget.d.ts
37
+ declare function AnalyticsRealtimeWidget(props: WidgetServerProps): Promise<import("react/jsx-runtime").JSX.Element>;
38
+ //#endregion
39
+ //#region src/widgets/AnalyticsTrendWidget.d.ts
40
+ declare function AnalyticsTrendWidget(props: WidgetServerProps): Promise<import("react/jsx-runtime").JSX.Element>;
41
+ //#endregion
42
+ //#region src/widgets/readForWidget.d.ts
43
+ type WidgetReadStatus = 'ok' | 'not-configured' | 'unavailable';
44
+ interface WidgetReadResult {
45
+ status: WidgetReadStatus;
46
+ adapterId: string;
47
+ dateRange: DateRange;
48
+ metrics: Partial<Record<MetricKey, number>>;
49
+ clamped?: boolean;
50
+ }
51
+ interface ReadForWidgetArgs {
52
+ req: PayloadRequest;
53
+ metrics: MetricKey[];
54
+ timeframe: TimeframePreset;
55
+ adapterId?: string;
56
+ now: Date;
57
+ range?: DateRange;
58
+ }
59
+ declare const readForWidget: (args: ReadForWidgetArgs) => Promise<WidgetReadResult>;
60
+ //#endregion
61
+ //#region src/widgets/readForWidgetBreakdown.d.ts
62
+ interface BreakdownRow {
63
+ label: string;
64
+ value: number;
65
+ }
66
+ interface WidgetBreakdownResult {
67
+ status: WidgetReadStatus;
68
+ adapterId: string;
69
+ dateRange: DateRange;
70
+ rows: BreakdownRow[];
71
+ clamped?: boolean;
72
+ }
73
+ interface ReadForWidgetBreakdownArgs {
74
+ req: PayloadRequest;
75
+ metric: MetricKey;
76
+ dimension: DimensionKey;
77
+ timeframe: TimeframePreset;
78
+ limit: number;
79
+ adapterId?: string;
80
+ now: Date;
81
+ range?: DateRange;
82
+ }
83
+ /**
84
+ * Site-wide ranked breakdown of one metric by one dimension, read through the engine.
85
+ * Mirrors `readForWidget` but gates on the dimension too and maps each result row to a
86
+ * `{ label, value }` pair the bar list renders. The adapter owns sorting and limiting.
87
+ */
88
+ declare const readForWidgetBreakdown: (args: ReadForWidgetBreakdownArgs) => Promise<WidgetBreakdownResult>;
89
+ //#endregion
90
+ //#region src/widgets/readForWidgetSeries.d.ts
91
+ interface SeriesPoint {
92
+ date: string;
93
+ value: number;
94
+ }
95
+ interface WidgetSeriesResult {
96
+ status: WidgetReadStatus;
97
+ adapterId: string;
98
+ dateRange: DateRange;
99
+ points: SeriesPoint[];
100
+ total: number;
101
+ clamped?: boolean;
102
+ }
103
+ interface ReadForWidgetSeriesArgs {
104
+ req: PayloadRequest;
105
+ metric: MetricKey;
106
+ timeframe: TimeframePreset;
107
+ adapterId?: string;
108
+ now: Date;
109
+ range?: DateRange;
110
+ }
111
+ /**
112
+ * Site-wide time-series read for a trend widget: resolve the timeframe, pick the
113
+ * adapter, gate on the metric and day-granularity support, read through the engine,
114
+ * then return a zero-filled daily series plus the headline total. Mirrors
115
+ * `readForWidget` but yields points instead of a single value.
116
+ */
117
+ declare const readForWidgetSeries: (args: ReadForWidgetSeriesArgs) => Promise<WidgetSeriesResult>;
118
+ //#endregion
119
+ export { AnalyticsBreakdownWidget, AnalyticsMetricWidget, AnalyticsRealtimeWidget, AnalyticsStatField, AnalyticsTrendWidget, type BreakdownRow, type CapabilityRequirement, type DateRange, type DimensionKey, type MetricKey, type ReadForWidgetArgs, type ReadForWidgetBreakdownArgs, type ReadForWidgetRealtimeArgs, type ReadForWidgetSeriesArgs, type RealtimePoint, type SeriesPoint, type WidgetBreakdownResult, type WidgetReadResult, type WidgetReadStatus, type WidgetRealtimeResult, type WidgetRealtimeStatus, type WidgetSeriesResult, formatMetricValue, readForWidget, readForWidgetBreakdown, readForWidgetRealtime, readForWidgetSeries };
120
+ //# sourceMappingURL=rsc.d.ts.map