@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.
- package/CHANGELOG.md +41 -0
- package/LICENSE +21 -0
- package/README.md +387 -0
- package/dist/RealtimeCounter-BJrjMPSa.js +473 -0
- package/dist/RealtimeCounter-BJrjMPSa.js.map +1 -0
- package/dist/contract-CWZPKWuR.d.ts +83 -0
- package/dist/dist-B6HruP5v.js +4731 -0
- package/dist/dist-B6HruP5v.js.map +1 -0
- package/dist/exports/adapters/ga4.d.ts +20 -0
- package/dist/exports/adapters/ga4.js +177 -0
- package/dist/exports/adapters/ga4.js.map +1 -0
- package/dist/exports/adapters/native.d.ts +22 -0
- package/dist/exports/adapters/native.js +849 -0
- package/dist/exports/adapters/native.js.map +1 -0
- package/dist/exports/adapters/plausible.d.ts +15 -0
- package/dist/exports/adapters/plausible.js +143 -0
- package/dist/exports/adapters/plausible.js.map +1 -0
- package/dist/exports/adapters/posthog.d.ts +17 -0
- package/dist/exports/adapters/posthog.js +119 -0
- package/dist/exports/adapters/posthog.js.map +1 -0
- package/dist/exports/adapters/umami.d.ts +18 -0
- package/dist/exports/adapters/umami.js +139 -0
- package/dist/exports/adapters/umami.js.map +1 -0
- package/dist/exports/client.d.ts +77 -0
- package/dist/exports/client.js +388 -0
- package/dist/exports/client.js.map +1 -0
- package/dist/exports/geo.d.ts +19 -0
- package/dist/exports/geo.js +2 -0
- package/dist/exports/i18n.d.ts +63 -0
- package/dist/exports/i18n.js +3 -0
- package/dist/exports/rsc.d.ts +120 -0
- package/dist/exports/rsc.js +598 -0
- package/dist/exports/rsc.js.map +1 -0
- package/dist/exports/types.d.ts +4 -0
- package/dist/exports/types.js +1 -0
- package/dist/fetchJson-DZb2_Puj.js +36 -0
- package/dist/fetchJson-DZb2_Puj.js.map +1 -0
- package/dist/geoResolver-CasIa4T9.d.ts +12 -0
- package/dist/index-CZdCT0WJ.d.ts +98 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +1081 -0
- package/dist/index.js.map +1 -0
- package/dist/keys-DEqL4LOT.js +57 -0
- package/dist/keys-DEqL4LOT.js.map +1 -0
- package/dist/lib-CE5x1zLQ.js +1058 -0
- package/dist/lib-CE5x1zLQ.js.map +1 -0
- package/dist/maxmindResolver-CXYXXdul.js +99 -0
- package/dist/maxmindResolver-CXYXXdul.js.map +1 -0
- package/dist/presets-CBfq_uJX.d.ts +38 -0
- package/dist/readForWidgetRealtime-D1BD37ST.d.ts +32 -0
- package/dist/series-zytbzPoc.js +17 -0
- package/dist/series-zytbzPoc.js.map +1 -0
- package/dist/server-Cuvhgz-S.js +492 -0
- package/dist/server-Cuvhgz-S.js.map +1 -0
- package/dist/testing/memoryAdapter.d.ts +16 -0
- package/dist/testing/memoryAdapter.js +98 -0
- package/dist/testing/memoryAdapter.js.map +1 -0
- package/dist/translations-keiKtSjF.js +77 -0
- package/dist/translations-keiKtSjF.js.map +1 -0
- package/package.json +156 -0
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { a as AnalyticsFilter, c as AnalyticsRow, d as Granularity, f as MetricKey, i as AnalyticsCapabilities, l as DateRange, n as AnalyticsAdapter, o as AnalyticsQuery, p as RateLimitDescriptor, r as AnalyticsAdapterFactory, s as AnalyticsResult, t as AdapterContext, u as DimensionKey } from "../contract-CWZPKWuR.js";
|
|
2
|
+
import { a as HostnameResolver, n as AnalyticsBinding, o as PathResolver, r as BindingContext, t as TimeframePreset } from "../presets-CBfq_uJX.js";
|
|
3
|
+
import { a as AnalyticsFieldsOptions, c as AnalyticsTabOptions, o as AnalyticsStatOptions, r as AnalyticsPluginOptions, s as AnalyticsStatRowOptions } from "../index-CZdCT0WJ.js";
|
|
4
|
+
export { AdapterContext, AnalyticsAdapter, AnalyticsAdapterFactory, type AnalyticsBinding, AnalyticsCapabilities, type AnalyticsFieldsOptions, AnalyticsFilter, type AnalyticsPluginOptions, AnalyticsQuery, AnalyticsResult, AnalyticsRow, type AnalyticsStatOptions, type AnalyticsStatRowOptions, type AnalyticsTabOptions, type BindingContext, DateRange, DimensionKey, Granularity, type HostnameResolver, MetricKey, type PathResolver, RateLimitDescriptor, type TimeframePreset };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
//#region src/adapters/http/fetchJson.ts
|
|
2
|
+
var ProviderHttpError = class extends Error {
|
|
3
|
+
status;
|
|
4
|
+
provider;
|
|
5
|
+
constructor(status, provider, message) {
|
|
6
|
+
super(message);
|
|
7
|
+
this.name = "ProviderHttpError";
|
|
8
|
+
this.status = status;
|
|
9
|
+
this.provider = provider;
|
|
10
|
+
}
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* Thin JSON fetch used by provider adapters. Throws ProviderHttpError (carrying the
|
|
14
|
+
* status) on a non-2xx response so the surfacing engine's queue can treat it as a
|
|
15
|
+
* failed fetch; the engine owns retry/backoff and caching.
|
|
16
|
+
*/
|
|
17
|
+
const fetchJson = async (url, opts) => {
|
|
18
|
+
const res = await fetch(url, {
|
|
19
|
+
method: opts.method ?? "GET",
|
|
20
|
+
headers: {
|
|
21
|
+
...opts.body === void 0 ? {} : { "content-type": "application/json" },
|
|
22
|
+
...opts.headers
|
|
23
|
+
},
|
|
24
|
+
body: opts.body === void 0 ? void 0 : JSON.stringify(opts.body),
|
|
25
|
+
signal: opts.signal
|
|
26
|
+
});
|
|
27
|
+
if (!res.ok) {
|
|
28
|
+
const detail = await res.text().catch(() => "");
|
|
29
|
+
throw new ProviderHttpError(res.status, opts.provider, `${opts.provider}: HTTP ${res.status} ${detail.slice(0, 200)}`);
|
|
30
|
+
}
|
|
31
|
+
return await res.json();
|
|
32
|
+
};
|
|
33
|
+
//#endregion
|
|
34
|
+
export { fetchJson as t };
|
|
35
|
+
|
|
36
|
+
//# sourceMappingURL=fetchJson-DZb2_Puj.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fetchJson-DZb2_Puj.js","names":[],"sources":["../src/adapters/http/fetchJson.ts"],"sourcesContent":["export class ProviderHttpError extends Error {\n\treadonly status: number\n\treadonly provider: string\n\tconstructor(status: number, provider: string, message: string) {\n\t\tsuper(message)\n\t\tthis.name = 'ProviderHttpError'\n\t\tthis.status = status\n\t\tthis.provider = provider\n\t}\n}\n\nexport interface FetchJsonOptions {\n\tmethod?: 'GET' | 'POST'\n\theaders?: Record<string, string>\n\tbody?: unknown\n\tsignal?: AbortSignal\n\tprovider: string\n}\n\n/**\n * Thin JSON fetch used by provider adapters. Throws ProviderHttpError (carrying the\n * status) on a non-2xx response so the surfacing engine's queue can treat it as a\n * failed fetch; the engine owns retry/backoff and caching.\n */\nexport const fetchJson = async <T>(url: string, opts: FetchJsonOptions): Promise<T> => {\n\tconst res = await fetch(url, {\n\t\tmethod: opts.method ?? 'GET',\n\t\theaders: {\n\t\t\t...(opts.body === undefined ? {} : { 'content-type': 'application/json' }),\n\t\t\t...opts.headers,\n\t\t},\n\t\tbody: opts.body === undefined ? undefined : JSON.stringify(opts.body),\n\t\tsignal: opts.signal,\n\t})\n\tif (!res.ok) {\n\t\tconst detail = await res.text().catch(() => '')\n\t\tthrow new ProviderHttpError(\n\t\t\tres.status,\n\t\t\topts.provider,\n\t\t\t`${opts.provider}: HTTP ${res.status} ${detail.slice(0, 200)}`\n\t\t)\n\t}\n\treturn (await res.json()) as T\n}\n"],"mappings":";AAAA,IAAa,oBAAb,cAAuC,MAAM;CAC5C;CACA;CACA,YAAY,QAAgB,UAAkB,SAAiB;EAC9D,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,SAAS;EACd,KAAK,WAAW;CACjB;AACD;;;;;;AAeA,MAAa,YAAY,OAAU,KAAa,SAAuC;CACtF,MAAM,MAAM,MAAM,MAAM,KAAK;EAC5B,QAAQ,KAAK,UAAU;EACvB,SAAS;GACR,GAAI,KAAK,SAAS,KAAA,IAAY,CAAC,IAAI,EAAE,gBAAgB,mBAAmB;GACxE,GAAG,KAAK;EACT;EACA,MAAM,KAAK,SAAS,KAAA,IAAY,KAAA,IAAY,KAAK,UAAU,KAAK,IAAI;EACpE,QAAQ,KAAK;CACd,CAAC;CACD,IAAI,CAAC,IAAI,IAAI;EACZ,MAAM,SAAS,MAAM,IAAI,KAAK,EAAE,YAAY,EAAE;EAC9C,MAAM,IAAI,kBACT,IAAI,QACJ,KAAK,UACL,GAAG,KAAK,SAAS,SAAS,IAAI,OAAO,GAAG,OAAO,MAAM,GAAG,GAAG,GAC5D;CACD;CACA,OAAQ,MAAM,IAAI,KAAK;AACxB"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
//#region src/native/geo/geoResolver.d.ts
|
|
2
|
+
interface Geo {
|
|
3
|
+
country?: string;
|
|
4
|
+
region?: string;
|
|
5
|
+
city?: string;
|
|
6
|
+
}
|
|
7
|
+
type GeoResolver = (headers: Headers) => Geo | Promise<Geo>;
|
|
8
|
+
declare const platformHeaderResolver: GeoResolver;
|
|
9
|
+
declare const noopResolver: GeoResolver;
|
|
10
|
+
//#endregion
|
|
11
|
+
export { platformHeaderResolver as i, GeoResolver as n, noopResolver as r, Geo as t };
|
|
12
|
+
//# sourceMappingURL=geoResolver-CasIa4T9.d.ts.map
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { f as MetricKey, n as AnalyticsAdapter } from "./contract-CWZPKWuR.js";
|
|
2
|
+
import { n as AnalyticsBinding, s as CapabilityRequirement, t as TimeframePreset } from "./presets-CBfq_uJX.js";
|
|
3
|
+
import { Field, TabsField, UIField, Widget, WidgetInstance, WidgetWidth } from "payload";
|
|
4
|
+
|
|
5
|
+
//#region src/fields/factories.d.ts
|
|
6
|
+
interface BaseFieldOptions {
|
|
7
|
+
timeframe?: TimeframePreset;
|
|
8
|
+
adapter?: string;
|
|
9
|
+
position?: 'sidebar';
|
|
10
|
+
name?: string;
|
|
11
|
+
}
|
|
12
|
+
interface AnalyticsStatOptions extends BaseFieldOptions {
|
|
13
|
+
metric: MetricKey;
|
|
14
|
+
}
|
|
15
|
+
interface AnalyticsStatRowOptions extends BaseFieldOptions {
|
|
16
|
+
metrics?: MetricKey[];
|
|
17
|
+
}
|
|
18
|
+
interface AnalyticsFieldsOptions {
|
|
19
|
+
metrics?: MetricKey[];
|
|
20
|
+
timeframe?: TimeframePreset;
|
|
21
|
+
adapter?: string;
|
|
22
|
+
}
|
|
23
|
+
interface AnalyticsTabOptions {
|
|
24
|
+
metrics?: MetricKey[];
|
|
25
|
+
timeframe?: TimeframePreset;
|
|
26
|
+
adapter?: string;
|
|
27
|
+
}
|
|
28
|
+
declare const analyticsStat: (options: AnalyticsStatOptions) => UIField;
|
|
29
|
+
declare const analyticsStatRow: (options?: AnalyticsStatRowOptions) => UIField;
|
|
30
|
+
declare const analyticsFields: (options?: AnalyticsFieldsOptions) => UIField[];
|
|
31
|
+
declare const analyticsTab: (options?: AnalyticsTabOptions) => TabsField;
|
|
32
|
+
//#endregion
|
|
33
|
+
//#region src/widgets/customWidget.d.ts
|
|
34
|
+
/** App-provided custom dashboard widget. Registered via the `widgets.register` option. */
|
|
35
|
+
interface CustomWidgetDef {
|
|
36
|
+
slug: string;
|
|
37
|
+
/** The app's own RSC import path, e.g. `@/widgets/My#default`. */
|
|
38
|
+
component: string;
|
|
39
|
+
/** A plain label, a locale->label map, or a Payload label function (`Widget['label']`). */
|
|
40
|
+
label: Exclude<Widget['label'], undefined>;
|
|
41
|
+
fields?: Field[];
|
|
42
|
+
/** Capability gate; omit to always register. */
|
|
43
|
+
requires?: CapabilityRequirement;
|
|
44
|
+
minWidth?: WidgetWidth;
|
|
45
|
+
maxWidth?: WidgetWidth;
|
|
46
|
+
}
|
|
47
|
+
//#endregion
|
|
48
|
+
//#region src/core/options.d.ts
|
|
49
|
+
type AnalyticsPluginOptions = {
|
|
50
|
+
disabled?: boolean;
|
|
51
|
+
adapters?: AnalyticsAdapter[];
|
|
52
|
+
defaultAdapter?: string;
|
|
53
|
+
collections?: Record<string, AnalyticsBinding>;
|
|
54
|
+
cache?: {
|
|
55
|
+
ttl?: {
|
|
56
|
+
aggregate?: number;
|
|
57
|
+
realtime?: number;
|
|
58
|
+
};
|
|
59
|
+
warm?: boolean | {
|
|
60
|
+
cron?: string;
|
|
61
|
+
};
|
|
62
|
+
};
|
|
63
|
+
widgets?: boolean | {
|
|
64
|
+
disabled?: string[];
|
|
65
|
+
register?: CustomWidgetDef[];
|
|
66
|
+
};
|
|
67
|
+
/**
|
|
68
|
+
* Opt-in sync tier: a cron job that persists each provider's daily metrics into a
|
|
69
|
+
* queryable collection. Reads go through the surfacing cache, so persisted rows reflect
|
|
70
|
+
* cached values up to `cache.ttl.aggregate` old; keep that TTL below the sync interval
|
|
71
|
+
* for the freshest data.
|
|
72
|
+
*/
|
|
73
|
+
sync?: boolean | {
|
|
74
|
+
collectionSlug?: string;
|
|
75
|
+
cron?: string;
|
|
76
|
+
lookbackDays?: number;
|
|
77
|
+
adapters?: string[];
|
|
78
|
+
};
|
|
79
|
+
};
|
|
80
|
+
//#endregion
|
|
81
|
+
//#region src/widgets/defaults.d.ts
|
|
82
|
+
/**
|
|
83
|
+
* Default analytics widget instances to spread into an app's own
|
|
84
|
+
* `admin.dashboard.defaultLayout`. A plugin must never set `defaultLayout` itself
|
|
85
|
+
* (Payload applies it with `??=`, so any setter would clobber the app's layout).
|
|
86
|
+
*/
|
|
87
|
+
declare const analyticsDefaultWidgets: () => WidgetInstance[];
|
|
88
|
+
//#endregion
|
|
89
|
+
//#region src/index.d.ts
|
|
90
|
+
declare module 'payload' {
|
|
91
|
+
interface RegisteredPlugins {
|
|
92
|
+
'@10x-media/analytics': AnalyticsPluginOptions;
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
declare const analytics: (options: AnalyticsPluginOptions) => import("payload").Plugin;
|
|
96
|
+
//#endregion
|
|
97
|
+
export { AnalyticsFieldsOptions as a, AnalyticsTabOptions as c, analyticsStatRow as d, analyticsTab as f, CustomWidgetDef as i, analyticsFields as l, analyticsDefaultWidgets as n, AnalyticsStatOptions as o, AnalyticsPluginOptions as r, AnalyticsStatRowOptions as s, analytics as t, analyticsStat as u };
|
|
98
|
+
//# sourceMappingURL=index-CZdCT0WJ.d.ts.map
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { a as HostnameResolver, n as AnalyticsBinding, o as PathResolver, r as BindingContext, t as TimeframePreset } from "./presets-CBfq_uJX.js";
|
|
2
|
+
import { a as AnalyticsFieldsOptions, c as AnalyticsTabOptions, d as analyticsStatRow, f as analyticsTab, i as CustomWidgetDef, l as analyticsFields, n as analyticsDefaultWidgets, o as AnalyticsStatOptions, r as AnalyticsPluginOptions, s as AnalyticsStatRowOptions, t as analytics, u as analyticsStat } from "./index-CZdCT0WJ.js";
|
|
3
|
+
export { type AnalyticsBinding, type AnalyticsFieldsOptions, type AnalyticsPluginOptions, type AnalyticsPluginOptions as PluginOptions, type AnalyticsStatOptions, type AnalyticsStatRowOptions, type AnalyticsTabOptions, type BindingContext, type CustomWidgetDef, type HostnameResolver, type PathResolver, type TimeframePreset, analytics, analyticsDefaultWidgets, analyticsFields, analyticsStat, analyticsStatRow, analyticsTab };
|