@10x-media/analytics 0.1.0-beta.1 → 0.1.0-beta.2

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 (107) hide show
  1. package/CHANGELOG.md +56 -0
  2. package/README.md +1 -0
  3. package/dist/adapters/ga4/ga4.js +17 -7
  4. package/dist/adapters/ga4/ga4.js.map +1 -1
  5. package/dist/adapters/plausible/plausible.js +5 -0
  6. package/dist/adapters/plausible/plausible.js.map +1 -1
  7. package/dist/adapters/posthog/posthog.js +28 -17
  8. package/dist/adapters/posthog/posthog.js.map +1 -1
  9. package/dist/adapters/umami/umami.js +1 -1
  10. package/dist/adapters/umami/umami.js.map +1 -1
  11. package/dist/binding/types.d.ts +9 -7
  12. package/dist/charts/TrendChart.js +17 -8
  13. package/dist/charts/TrendChart.js.map +1 -1
  14. package/dist/charts/bucket.js +31 -24
  15. package/dist/charts/bucket.js.map +1 -1
  16. package/dist/core/cacheKey.js +4 -7
  17. package/dist/core/cacheKey.js.map +1 -1
  18. package/dist/core/contract.d.ts +12 -1
  19. package/dist/core/contract.js.map +1 -1
  20. package/dist/core/options.d.ts +27 -2
  21. package/dist/core/options.js +15 -8
  22. package/dist/core/options.js.map +1 -1
  23. package/dist/exports/rsc.d.ts +6 -3
  24. package/dist/exports/rsc.js +5 -2
  25. package/dist/fields/AnalyticsPanelClient.js +193 -0
  26. package/dist/fields/AnalyticsPanelClient.js.map +1 -0
  27. package/dist/fields/AnalyticsPanelField.d.ts +28 -0
  28. package/dist/fields/AnalyticsPanelField.js +54 -0
  29. package/dist/fields/AnalyticsPanelField.js.map +1 -0
  30. package/dist/fields/AnalyticsStatField.d.ts +1 -1
  31. package/dist/fields/AnalyticsStatField.js +14 -3
  32. package/dist/fields/AnalyticsStatField.js.map +1 -1
  33. package/dist/fields/emptyState.js +46 -0
  34. package/dist/fields/emptyState.js.map +1 -0
  35. package/dist/fields/factories.d.ts +10 -2
  36. package/dist/fields/factories.js +33 -4
  37. package/dist/fields/factories.js.map +1 -1
  38. package/dist/fields/readForDocument.d.ts +57 -0
  39. package/dist/fields/readForDocument.js +50 -10
  40. package/dist/fields/readForDocument.js.map +1 -1
  41. package/dist/index.d.ts +2 -2
  42. package/dist/index.js +29 -4
  43. package/dist/index.js.map +1 -1
  44. package/dist/native/ingest/endpoint.js +5 -2
  45. package/dist/native/ingest/endpoint.js.map +1 -1
  46. package/dist/native/ingest/normalizeEvent.js +3 -2
  47. package/dist/native/ingest/normalizeEvent.js.map +1 -1
  48. package/dist/native/ingest/writeEvent.js +2 -1
  49. package/dist/native/ingest/writeEvent.js.map +1 -1
  50. package/dist/native/nativeAdapter.js +7 -4
  51. package/dist/native/nativeAdapter.js.map +1 -1
  52. package/dist/native/rollupAcc.js +9 -6
  53. package/dist/native/rollupAcc.js.map +1 -1
  54. package/dist/native/rollups/deltas.js +2 -2
  55. package/dist/native/rollups/deltas.js.map +1 -1
  56. package/dist/plugin/documentEndpoint.js +80 -0
  57. package/dist/plugin/documentEndpoint.js.map +1 -0
  58. package/dist/plugin/paths.js +11 -0
  59. package/dist/plugin/paths.js.map +1 -0
  60. package/dist/plugin/runtime.js +2 -1
  61. package/dist/plugin/runtime.js.map +1 -1
  62. package/dist/plugin/warmTask.js +1 -1
  63. package/dist/surfacing/engine.js +5 -5
  64. package/dist/surfacing/engine.js.map +1 -1
  65. package/dist/sync/collection.js +11 -6
  66. package/dist/sync/collection.js.map +1 -1
  67. package/dist/sync/syncTask.js +1 -1
  68. package/dist/timeframe/presets.js +12 -16
  69. package/dist/timeframe/presets.js.map +1 -1
  70. package/dist/timeframe/tz.js +110 -0
  71. package/dist/timeframe/tz.js.map +1 -0
  72. package/dist/translations/de.js +78 -0
  73. package/dist/translations/de.js.map +1 -0
  74. package/dist/translations/en.js +5 -2
  75. package/dist/translations/en.js.map +1 -1
  76. package/dist/translations/index.d.ts +2 -1
  77. package/dist/translations/index.js +6 -2
  78. package/dist/translations/index.js.map +1 -1
  79. package/dist/translations/keys.d.ts +5 -2
  80. package/dist/translations/keys.js +5 -2
  81. package/dist/translations/keys.js.map +1 -1
  82. package/dist/translations/metricKeys.js +0 -2
  83. package/dist/translations/metricKeys.js.map +1 -1
  84. package/dist/widgets/AnalyticsBreakdownWidget.js +1 -1
  85. package/dist/widgets/AnalyticsMetricWidget.js +9 -1
  86. package/dist/widgets/AnalyticsMetricWidget.js.map +1 -1
  87. package/dist/widgets/AnalyticsRealtimeWidget.js +1 -1
  88. package/dist/widgets/AnalyticsTrendWidget.js +10 -2
  89. package/dist/widgets/AnalyticsTrendWidget.js.map +1 -1
  90. package/dist/widgets/ComparisonDelta.js +83 -0
  91. package/dist/widgets/ComparisonDelta.js.map +1 -0
  92. package/dist/widgets/cardChrome.d.ts +8 -0
  93. package/dist/widgets/comparison.js +43 -0
  94. package/dist/widgets/comparison.js.map +1 -0
  95. package/dist/widgets/readForWidget.d.ts +4 -0
  96. package/dist/widgets/readForWidget.js +26 -11
  97. package/dist/widgets/readForWidget.js.map +1 -1
  98. package/dist/widgets/readForWidgetBreakdown.js +13 -8
  99. package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
  100. package/dist/widgets/readForWidgetRealtime.js +1 -1
  101. package/dist/widgets/readForWidgetRealtime.js.map +1 -1
  102. package/dist/widgets/readForWidgetSeries.d.ts +6 -0
  103. package/dist/widgets/readForWidgetSeries.js +60 -40
  104. package/dist/widgets/readForWidgetSeries.js.map +1 -1
  105. package/dist/widgets/registerWidgets.js +148 -169
  106. package/dist/widgets/registerWidgets.js.map +1 -1
  107. package/package.json +6 -6
@@ -1 +1 @@
1
- {"version":3,"file":"registerWidgets.js","names":[],"sources":["../../src/widgets/registerWidgets.ts"],"sourcesContent":["import type { Config, Field, Widget, WidgetWidth } from 'payload'\nimport { type CapabilityRequirement, satisfiesCapabilities } from '../core/capabilities'\nimport type { AnalyticsAdapter } from '../core/contract'\nimport { dateRangeField } from '../fields/dateRange/field'\nimport { TIMEFRAME_PRESETS } from '../timeframe/presets'\nimport { en } from '../translations/en'\nimport type { TranslationKey } from '../translations/keys'\nimport { keys } from '../translations/keys'\nimport { METRIC_KEYS, TIMEFRAME_KEYS } from '../translations/metricKeys'\nimport { labelForKey } from '../translations/server'\nimport { BREAKDOWN_SPECS, type BreakdownSpec } from './breakdownTypes'\nimport { buildCustomWidgets, type CustomWidgetDef } from './customWidget'\nimport { WIDGET_METRICS } from './types'\n\nexport interface RegisterWidgetsArgs {\n\tadapters: AnalyticsAdapter[]\n\tmultiProvider: boolean\n\tdisabled: string[]\n\tregister: CustomWidgetDef[]\n\tlocalizeText?: boolean\n}\n\ninterface WidgetDef {\n\tslug: string\n\tcomponent: string\n\tlabel: TranslationKey\n\trequires?: CapabilityRequirement\n\tminWidth?: WidgetWidth\n\tmaxWidth?: WidgetWidth\n\tfields: (args: RegisterWidgetsArgs) => Field[]\n}\n\nexport const widgetIsSupported = (\n\trequires: CapabilityRequirement | undefined,\n\tadapters: AnalyticsAdapter[]\n): boolean => !requires || adapters.some((a) => satisfiesCapabilities(a.capabilities, requires))\n\nconst titleField = (args: RegisterWidgetsArgs, placeholder: string): Field => ({\n\tname: 'title',\n\ttype: 'text',\n\tlabel: labelForKey(keys.widgetFieldTitle),\n\t...(args.localizeText ? { localized: true } : {}),\n\tadmin: { placeholder },\n})\n\nconst metricWidgetFields = (args: RegisterWidgetsArgs): Field[] => {\n\tconst fields: Field[] = [\n\t\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\t\t{\n\t\t\tname: 'metric',\n\t\t\ttype: 'select',\n\t\t\trequired: true,\n\t\t\tdefaultValue: 'pageviews',\n\t\t\tlabel: labelForKey(keys.widgetFieldMetric),\n\t\t\toptions: WIDGET_METRICS.map((m) => ({ value: m, label: labelForKey(METRIC_KEYS[m]) })),\n\t\t},\n\t\t{\n\t\t\tname: 'timeframe',\n\t\t\ttype: 'select',\n\t\t\trequired: true,\n\t\t\tdefaultValue: 'last30days',\n\t\t\tlabel: labelForKey(keys.widgetFieldTimeframe),\n\t\t\toptions: [\n\t\t\t\t...TIMEFRAME_PRESETS.map((p) => ({ value: p, label: labelForKey(TIMEFRAME_KEYS[p]) })),\n\t\t\t\t{ value: 'custom', label: labelForKey(keys.widgetTimeframeCustom) },\n\t\t\t],\n\t\t},\n\t\tdateRangeField({\n\t\t\tname: 'range',\n\t\t\tlabel: labelForKey(keys.widgetFieldRange),\n\t\t\tpickerAppearance: 'dayOnly',\n\t\t\toverrides: (f) => ({\n\t\t\t\t...f,\n\t\t\t\tadmin: {\n\t\t\t\t\t...f.admin,\n\t\t\t\t\tcondition: (_data, siblingData) => siblingData?.timeframe === 'custom',\n\t\t\t\t},\n\t\t\t}),\n\t\t}),\n\t]\n\tif (args.multiProvider) {\n\t\tfields.push({\n\t\t\tname: 'dataSource',\n\t\t\ttype: 'select',\n\t\t\tlabel: labelForKey(keys.widgetFieldDataSource),\n\t\t\tdefaultValue: args.adapters[0]?.id,\n\t\t\toptions: args.adapters.map((a) => ({ value: a.id, label: a.label })),\n\t\t})\n\t}\n\treturn fields\n}\n\nconst breakdownWidgetFields = (args: RegisterWidgetsArgs, spec: BreakdownSpec): Field[] => {\n\tconst fields: Field[] = [\n\t\ttitleField(args, en[spec.label]),\n\t\t{\n\t\t\tname: 'metric',\n\t\t\ttype: 'select',\n\t\t\trequired: true,\n\t\t\tdefaultValue: 'pageviews',\n\t\t\tlabel: labelForKey(keys.widgetFieldMetric),\n\t\t\toptions: WIDGET_METRICS.map((m) => ({ value: m, label: labelForKey(METRIC_KEYS[m]) })),\n\t\t},\n\t\t{\n\t\t\tname: 'timeframe',\n\t\t\ttype: 'select',\n\t\t\trequired: true,\n\t\t\tdefaultValue: 'last30days',\n\t\t\tlabel: labelForKey(keys.widgetFieldTimeframe),\n\t\t\toptions: [\n\t\t\t\t...TIMEFRAME_PRESETS.map((p) => ({ value: p, label: labelForKey(TIMEFRAME_KEYS[p]) })),\n\t\t\t\t{ value: 'custom', label: labelForKey(keys.widgetTimeframeCustom) },\n\t\t\t],\n\t\t},\n\t\tdateRangeField({\n\t\t\tname: 'range',\n\t\t\tlabel: labelForKey(keys.widgetFieldRange),\n\t\t\tpickerAppearance: 'dayOnly',\n\t\t\toverrides: (f) => ({\n\t\t\t\t...f,\n\t\t\t\tadmin: {\n\t\t\t\t\t...f.admin,\n\t\t\t\t\tcondition: (_data, siblingData) => siblingData?.timeframe === 'custom',\n\t\t\t\t},\n\t\t\t}),\n\t\t}),\n\t\t{\n\t\t\tname: 'limit',\n\t\t\ttype: 'number',\n\t\t\tdefaultValue: 5,\n\t\t\tmin: 1,\n\t\t\tmax: 20,\n\t\t\tlabel: labelForKey(keys.widgetFieldLimit),\n\t\t},\n\t]\n\tif (args.multiProvider) {\n\t\tfields.push({\n\t\t\tname: 'dataSource',\n\t\t\ttype: 'select',\n\t\t\tlabel: labelForKey(keys.widgetFieldDataSource),\n\t\t\tdefaultValue: args.adapters[0]?.id,\n\t\t\toptions: args.adapters.map((a) => ({ value: a.id, label: a.label })),\n\t\t})\n\t}\n\treturn fields\n}\n\nconst realtimeWidgetFields = (args: RegisterWidgetsArgs): Field[] => {\n\tconst fields: Field[] = [\n\t\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\t\t{\n\t\t\tname: 'metric',\n\t\t\ttype: 'select',\n\t\t\trequired: true,\n\t\t\tdefaultValue: 'visitors',\n\t\t\tlabel: labelForKey(keys.widgetFieldMetric),\n\t\t\toptions: [\n\t\t\t\t{ value: 'visitors', label: labelForKey(METRIC_KEYS.visitors) },\n\t\t\t\t{ value: 'pageviews', label: labelForKey(METRIC_KEYS.pageviews) },\n\t\t\t],\n\t\t},\n\t\t{\n\t\t\tname: 'windowMinutes',\n\t\t\ttype: 'select',\n\t\t\tdefaultValue: '30',\n\t\t\tlabel: labelForKey(keys.widgetFieldWindow),\n\t\t\toptions: [\n\t\t\t\t{ value: '5', label: '5 min' },\n\t\t\t\t{ value: '15', label: '15 min' },\n\t\t\t\t{ value: '30', label: '30 min' },\n\t\t\t\t{ value: '60', label: '60 min' },\n\t\t\t],\n\t\t},\n\t]\n\tif (args.multiProvider) {\n\t\tfields.push({\n\t\t\tname: 'dataSource',\n\t\t\ttype: 'select',\n\t\t\tlabel: labelForKey(keys.widgetFieldDataSource),\n\t\t\tdefaultValue: args.adapters[0]?.id,\n\t\t\toptions: args.adapters.map((a) => ({ value: a.id, label: a.label })),\n\t\t})\n\t}\n\treturn fields\n}\n\nconst WIDGET_DEFS: WidgetDef[] = [\n\t{\n\t\tslug: 'analytics-metric',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsMetricWidget',\n\t\tlabel: keys.widgetMetricLabel,\n\t\tminWidth: 'x-small',\n\t\tmaxWidth: 'medium',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-trend',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsTrendWidget',\n\t\tlabel: keys.widgetTrendLabel,\n\t\trequires: { metrics: ['pageviews'] },\n\t\tminWidth: 'small',\n\t\tmaxWidth: 'full',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-realtime',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsRealtimeWidget',\n\t\tlabel: keys.widgetRealtimeLabel,\n\t\trequires: { realtime: true },\n\t\tminWidth: 'small' as WidgetWidth,\n\t\tmaxWidth: 'medium' as WidgetWidth,\n\t\tfields: realtimeWidgetFields,\n\t},\n\t...BREAKDOWN_SPECS.map(\n\t\t(spec): WidgetDef => ({\n\t\t\tslug: spec.slug,\n\t\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsBreakdownWidget',\n\t\t\tlabel: spec.label,\n\t\t\trequires: { dimensions: [spec.dimension] },\n\t\t\tminWidth: 'small' as WidgetWidth,\n\t\t\tmaxWidth: 'large' as WidgetWidth,\n\t\t\tfields: (args) => breakdownWidgetFields(args, spec),\n\t\t})\n\t),\n]\n\nexport const registerWidgets = (config: Config, args: RegisterWidgetsArgs): void => {\n\tconst built: Widget[] = []\n\tfor (const def of WIDGET_DEFS) {\n\t\tif (args.disabled.includes(def.slug)) {\n\t\t\tcontinue\n\t\t}\n\t\tif (!widgetIsSupported(def.requires, args.adapters)) {\n\t\t\tcontinue\n\t\t}\n\t\tbuilt.push({\n\t\t\tslug: def.slug,\n\t\t\tComponent: def.component,\n\t\t\tlabel: labelForKey(def.label),\n\t\t\tfields: def.fields(args),\n\t\t\tminWidth: def.minWidth,\n\t\t\tmaxWidth: def.maxWidth,\n\t\t})\n\t}\n\tbuilt.push(...buildCustomWidgets(args.register, args.adapters, args.disabled))\n\tif (!built.length) {\n\t\treturn\n\t}\n\tconfig.admin ??= {}\n\tconfig.admin.dashboard ??= { widgets: [] }\n\tconfig.admin.dashboard.widgets ??= []\n\tconfig.admin.dashboard.widgets.push(...built)\n}\n"],"mappings":";;;;;;;;;;;AAgCA,MAAa,qBACZ,UACA,aACa,CAAC,YAAY,SAAS,MAAM,MAAM,sBAAsB,EAAE,cAAc,QAAQ,CAAC;AAE/F,MAAM,cAAc,MAA2B,iBAAgC;CAC9E,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,GAAI,KAAK,eAAe,EAAE,WAAW,KAAK,IAAI,CAAC;CAC/C,OAAO,EAAE,YAAY;AACtB;AAEA,MAAM,sBAAsB,SAAuC;CAClE,MAAM,SAAkB;EACvB,WAAW,MAAM,GAAG,KAAK,4BAA4B;EACrD;GACC,MAAM;GACN,MAAM;GACN,UAAU;GACV,cAAc;GACd,OAAO,YAAY,KAAK,iBAAiB;GACzC,SAAS,eAAe,KAAK,OAAO;IAAE,OAAO;IAAG,OAAO,YAAY,YAAY,EAAE;GAAE,EAAE;EACtF;EACA;GACC,MAAM;GACN,MAAM;GACN,UAAU;GACV,cAAc;GACd,OAAO,YAAY,KAAK,oBAAoB;GAC5C,SAAS,CACR,GAAG,kBAAkB,KAAK,OAAO;IAAE,OAAO;IAAG,OAAO,YAAY,eAAe,EAAE;GAAE,EAAE,GACrF;IAAE,OAAO;IAAU,OAAO,YAAY,KAAK,qBAAqB;GAAE,CACnE;EACD;EACA,eAAe;GACd,MAAM;GACN,OAAO,YAAY,KAAK,gBAAgB;GACxC,kBAAkB;GAClB,YAAY,OAAO;IAClB,GAAG;IACH,OAAO;KACN,GAAG,EAAE;KACL,YAAY,OAAO,gBAAgB,aAAa,cAAc;IAC/D;GACD;EACD,CAAC;CACF;CACA,IAAI,KAAK,eACR,OAAO,KAAK;EACX,MAAM;EACN,MAAM;EACN,OAAO,YAAY,KAAK,qBAAqB;EAC7C,cAAc,KAAK,SAAS,IAAI;EAChC,SAAS,KAAK,SAAS,KAAK,OAAO;GAAE,OAAO,EAAE;GAAI,OAAO,EAAE;EAAM,EAAE;CACpE,CAAC;CAEF,OAAO;AACR;AAEA,MAAM,yBAAyB,MAA2B,SAAiC;CAC1F,MAAM,SAAkB;EACvB,WAAW,MAAM,GAAG,KAAK,MAAM;EAC/B;GACC,MAAM;GACN,MAAM;GACN,UAAU;GACV,cAAc;GACd,OAAO,YAAY,KAAK,iBAAiB;GACzC,SAAS,eAAe,KAAK,OAAO;IAAE,OAAO;IAAG,OAAO,YAAY,YAAY,EAAE;GAAE,EAAE;EACtF;EACA;GACC,MAAM;GACN,MAAM;GACN,UAAU;GACV,cAAc;GACd,OAAO,YAAY,KAAK,oBAAoB;GAC5C,SAAS,CACR,GAAG,kBAAkB,KAAK,OAAO;IAAE,OAAO;IAAG,OAAO,YAAY,eAAe,EAAE;GAAE,EAAE,GACrF;IAAE,OAAO;IAAU,OAAO,YAAY,KAAK,qBAAqB;GAAE,CACnE;EACD;EACA,eAAe;GACd,MAAM;GACN,OAAO,YAAY,KAAK,gBAAgB;GACxC,kBAAkB;GAClB,YAAY,OAAO;IAClB,GAAG;IACH,OAAO;KACN,GAAG,EAAE;KACL,YAAY,OAAO,gBAAgB,aAAa,cAAc;IAC/D;GACD;EACD,CAAC;EACD;GACC,MAAM;GACN,MAAM;GACN,cAAc;GACd,KAAK;GACL,KAAK;GACL,OAAO,YAAY,KAAK,gBAAgB;EACzC;CACD;CACA,IAAI,KAAK,eACR,OAAO,KAAK;EACX,MAAM;EACN,MAAM;EACN,OAAO,YAAY,KAAK,qBAAqB;EAC7C,cAAc,KAAK,SAAS,IAAI;EAChC,SAAS,KAAK,SAAS,KAAK,OAAO;GAAE,OAAO,EAAE;GAAI,OAAO,EAAE;EAAM,EAAE;CACpE,CAAC;CAEF,OAAO;AACR;AAEA,MAAM,wBAAwB,SAAuC;CACpE,MAAM,SAAkB;EACvB,WAAW,MAAM,GAAG,KAAK,4BAA4B;EACrD;GACC,MAAM;GACN,MAAM;GACN,UAAU;GACV,cAAc;GACd,OAAO,YAAY,KAAK,iBAAiB;GACzC,SAAS,CACR;IAAE,OAAO;IAAY,OAAO,YAAY,YAAY,QAAQ;GAAE,GAC9D;IAAE,OAAO;IAAa,OAAO,YAAY,YAAY,SAAS;GAAE,CACjE;EACD;EACA;GACC,MAAM;GACN,MAAM;GACN,cAAc;GACd,OAAO,YAAY,KAAK,iBAAiB;GACzC,SAAS;IACR;KAAE,OAAO;KAAK,OAAO;IAAQ;IAC7B;KAAE,OAAO;KAAM,OAAO;IAAS;IAC/B;KAAE,OAAO;KAAM,OAAO;IAAS;IAC/B;KAAE,OAAO;KAAM,OAAO;IAAS;GAChC;EACD;CACD;CACA,IAAI,KAAK,eACR,OAAO,KAAK;EACX,MAAM;EACN,MAAM;EACN,OAAO,YAAY,KAAK,qBAAqB;EAC7C,cAAc,KAAK,SAAS,IAAI;EAChC,SAAS,KAAK,SAAS,KAAK,OAAO;GAAE,OAAO,EAAE;GAAI,OAAO,EAAE;EAAM,EAAE;CACpE,CAAC;CAEF,OAAO;AACR;AAEA,MAAM,cAA2B;CAChC;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,SAAS,CAAC,WAAW,EAAE;EACnC,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,UAAU,KAAK;EAC3B,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA,GAAG,gBAAgB,KACjB,UAAqB;EACrB,MAAM,KAAK;EACX,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE;EACzC,UAAU;EACV,UAAU;EACV,SAAS,SAAS,sBAAsB,MAAM,IAAI;CACnD,EACD;AACD;AAEA,MAAa,mBAAmB,QAAgB,SAAoC;CACnF,MAAM,QAAkB,CAAC;CACzB,KAAK,MAAM,OAAO,aAAa;EAC9B,IAAI,KAAK,SAAS,SAAS,IAAI,IAAI,GAClC;EAED,IAAI,CAAC,kBAAkB,IAAI,UAAU,KAAK,QAAQ,GACjD;EAED,MAAM,KAAK;GACV,MAAM,IAAI;GACV,WAAW,IAAI;GACf,OAAO,YAAY,IAAI,KAAK;GAC5B,QAAQ,IAAI,OAAO,IAAI;GACvB,UAAU,IAAI;GACd,UAAU,IAAI;EACf,CAAC;CACF;CACA,MAAM,KAAK,GAAG,mBAAmB,KAAK,UAAU,KAAK,UAAU,KAAK,QAAQ,CAAC;CAC7E,IAAI,CAAC,MAAM,QACV;CAED,OAAO,UAAU,CAAC;CAClB,OAAO,MAAM,cAAc,EAAE,SAAS,CAAC,EAAE;CACzC,OAAO,MAAM,UAAU,YAAY,CAAC;CACpC,OAAO,MAAM,UAAU,QAAQ,KAAK,GAAG,KAAK;AAC7C"}
1
+ {"version":3,"file":"registerWidgets.js","names":[],"sources":["../../src/widgets/registerWidgets.ts"],"sourcesContent":["import type { Config, Field, SelectField, Widget, WidgetWidth } from 'payload'\nimport { type CapabilityRequirement, satisfiesCapabilities } from '../core/capabilities'\nimport type { AnalyticsAdapter, MetricKey } from '../core/contract'\nimport { dateRangeField } from '../fields/dateRange/field'\nimport { TIMEFRAME_PRESETS } from '../timeframe/presets'\nimport { de } from '../translations/de'\nimport { en } from '../translations/en'\nimport type { TranslationKey } from '../translations/keys'\nimport { keys } from '../translations/keys'\nimport { METRIC_KEYS, TIMEFRAME_KEYS } from '../translations/metricKeys'\nimport { labelForKey } from '../translations/server'\nimport { BREAKDOWN_SPECS, type BreakdownSpec } from './breakdownTypes'\nimport { buildCustomWidgets, type CustomWidgetDef } from './customWidget'\nimport { WIDGET_METRICS } from './types'\n\n/**\n * Select options must carry static labels: `filterOptions` results are serialized\n * into client form state at request time, where a label function cannot cross the\n * server/client boundary.\n */\nconst staticLabel = (key: TranslationKey): Record<string, string> => ({\n\tde: de[key],\n\ten: en[key],\n})\n\nexport interface RegisterWidgetsArgs {\n\tadapters: AnalyticsAdapter[]\n\tmultiProvider: boolean\n\tdisabled: string[]\n\tregister: CustomWidgetDef[]\n\tlocalizeText?: boolean\n}\n\ninterface WidgetDef {\n\tslug: string\n\tcomponent: string\n\tlabel: TranslationKey\n\trequires?: CapabilityRequirement\n\tminWidth?: WidgetWidth\n\tmaxWidth?: WidgetWidth\n\tfields: (args: RegisterWidgetsArgs) => Field[]\n}\n\nexport const widgetIsSupported = (\n\trequires: CapabilityRequirement | undefined,\n\tadapters: AnalyticsAdapter[]\n): boolean => !requires || adapters.some((a) => satisfiesCapabilities(a.capabilities, requires))\n\n/**\n * The widget metric select. Options are limited to metrics at least one configured\n * adapter can serve, mirroring the OR-across-adapters gating used to hide whole widgets;\n * `extra` layers on further requirements (a breakdown widget's dimension, realtime) so\n * the picker never offers a metric the read path would report as unavailable. In\n * multi-provider installs `filterOptions` additionally narrows the picker to the selected\n * `dataSource`'s capabilities; an id not known at config time (a runtime/DB provider)\n * keeps the union. The default clamps to the first option when the preferred metric is\n * not servable, and options can come out empty for exotic adapter sets, which\n * {@link registerWidgets} treats as \"skip this widget\".\n */\nconst metricSelectField = (\n\tcandidates: MetricKey[],\n\targs: RegisterWidgetsArgs,\n\topts: {\n\t\textra?: Omit<CapabilityRequirement, 'metrics'>\n\t\tpreferredDefault?: MetricKey\n\t} = {}\n): Field => {\n\tconst { extra, preferredDefault = 'pageviews' } = opts\n\tconst supports = (adapter: AnalyticsAdapter, metric: MetricKey): boolean =>\n\t\tsatisfiesCapabilities(adapter.capabilities, { ...extra, metrics: [metric] })\n\tconst options = candidates\n\t\t.filter((m) => args.adapters.some((a) => supports(a, m)))\n\t\t.map((m) => ({ value: m, label: staticLabel(METRIC_KEYS[m]) }))\n\tconst defaultValue = options.some((o) => o.value === preferredDefault)\n\t\t? preferredDefault\n\t\t: options[0]?.value\n\tconst filterOptions: SelectField['filterOptions'] = ({ options: opts, siblingData }) => {\n\t\tconst sourceId = (siblingData as { dataSource?: unknown } | undefined)?.dataSource\n\t\tconst adapter =\n\t\t\ttypeof sourceId === 'string' ? args.adapters.find((a) => a.id === sourceId) : undefined\n\t\tif (!adapter) {\n\t\t\treturn opts\n\t\t}\n\t\treturn opts.filter((o) => typeof o === 'object' && supports(adapter, o.value as MetricKey))\n\t}\n\treturn {\n\t\tname: 'metric',\n\t\ttype: 'select',\n\t\trequired: true,\n\t\t...(defaultValue !== undefined ? { defaultValue } : {}),\n\t\tlabel: labelForKey(keys.widgetFieldMetric),\n\t\toptions,\n\t\t// A required metric has no meaningful cleared state.\n\t\tadmin: { isClearable: false },\n\t\t...(args.multiProvider ? { filterOptions } : {}),\n\t}\n}\n\nconst titleField = (args: RegisterWidgetsArgs, placeholder: string): Field => ({\n\tname: 'title',\n\ttype: 'text',\n\tlabel: labelForKey(keys.widgetFieldTitle),\n\t...(args.localizeText ? { localized: true } : {}),\n\tadmin: { placeholder },\n})\n\nconst timeframeSelectField = (): Field => ({\n\tname: 'timeframe',\n\ttype: 'select',\n\trequired: true,\n\tdefaultValue: 'last30days',\n\tlabel: labelForKey(keys.widgetFieldTimeframe),\n\tadmin: { isClearable: false },\n\toptions: [\n\t\t...TIMEFRAME_PRESETS.map((p) => ({ value: p, label: labelForKey(TIMEFRAME_KEYS[p]) })),\n\t\t{ value: 'custom', label: labelForKey(keys.widgetTimeframeCustom) },\n\t],\n})\n\nconst dataSourceField = (args: RegisterWidgetsArgs): Field => ({\n\tname: 'dataSource',\n\ttype: 'select',\n\tlabel: labelForKey(keys.widgetFieldDataSource),\n\tdefaultValue: args.adapters[0]?.id,\n\t// Clearing would leave no source; the widget always reads through one.\n\tadmin: { isClearable: false },\n\toptions: args.adapters.map((a) => ({ value: a.id, label: a.label })),\n})\n\nconst customRangeField = (): Field =>\n\tdateRangeField({\n\t\tname: 'range',\n\t\tlabel: labelForKey(keys.widgetFieldRange),\n\t\tpickerAppearance: 'dayOnly',\n\t\toverrides: (f) => ({\n\t\t\t...f,\n\t\t\tadmin: {\n\t\t\t\t...f.admin,\n\t\t\t\tcondition: (_data, siblingData) => siblingData?.timeframe === 'custom',\n\t\t\t},\n\t\t}),\n\t})\n\n/** The metric select in a widget's field list. */\nexport const findMetricField = (fields: Field[]): Field | undefined =>\n\tfields.find((field) => 'name' in field && field.name === 'metric')\n\nconst metricWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(WIDGET_METRICS, args),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst breakdownWidgetFields = (args: RegisterWidgetsArgs, spec: BreakdownSpec): Field[] => [\n\ttitleField(args, en[spec.label]),\n\tmetricSelectField(WIDGET_METRICS, args, { extra: { dimensions: [spec.dimension] } }),\n\ttimeframeSelectField(),\n\tcustomRangeField(),\n\t{\n\t\tname: 'limit',\n\t\ttype: 'number',\n\t\tdefaultValue: 5,\n\t\tmin: 1,\n\t\tmax: 20,\n\t\tlabel: labelForKey(keys.widgetFieldLimit),\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst realtimeWidgetFields = (args: RegisterWidgetsArgs): Field[] => [\n\ttitleField(args, en[keys.widgetFieldTitlePlaceholder]),\n\tmetricSelectField(['visitors', 'pageviews'], args, {\n\t\textra: { realtime: true },\n\t\tpreferredDefault: 'visitors',\n\t}),\n\t{\n\t\tname: 'windowMinutes',\n\t\ttype: 'select',\n\t\tdefaultValue: '30',\n\t\tlabel: labelForKey(keys.widgetFieldWindow),\n\t\tadmin: { isClearable: false },\n\t\toptions: [\n\t\t\t{ value: '5', label: '5 min' },\n\t\t\t{ value: '15', label: '15 min' },\n\t\t\t{ value: '30', label: '30 min' },\n\t\t\t{ value: '60', label: '60 min' },\n\t\t],\n\t},\n\t...(args.multiProvider ? [dataSourceField(args)] : []),\n]\n\nconst WIDGET_DEFS: WidgetDef[] = [\n\t{\n\t\tslug: 'analytics-metric',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsMetricWidget',\n\t\tlabel: keys.widgetMetricLabel,\n\t\tminWidth: 'x-small',\n\t\tmaxWidth: 'medium',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-trend',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsTrendWidget',\n\t\tlabel: keys.widgetTrendLabel,\n\t\trequires: { metrics: ['pageviews'] },\n\t\tminWidth: 'small',\n\t\tmaxWidth: 'full',\n\t\tfields: metricWidgetFields,\n\t},\n\t{\n\t\tslug: 'analytics-realtime',\n\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsRealtimeWidget',\n\t\tlabel: keys.widgetRealtimeLabel,\n\t\trequires: { realtime: true },\n\t\tminWidth: 'small' as WidgetWidth,\n\t\tmaxWidth: 'medium' as WidgetWidth,\n\t\tfields: realtimeWidgetFields,\n\t},\n\t...BREAKDOWN_SPECS.map(\n\t\t(spec): WidgetDef => ({\n\t\t\tslug: spec.slug,\n\t\t\tcomponent: '@10x-media/analytics/rsc#AnalyticsBreakdownWidget',\n\t\t\tlabel: spec.label,\n\t\t\trequires: { dimensions: [spec.dimension] },\n\t\t\tminWidth: 'small' as WidgetWidth,\n\t\t\tmaxWidth: 'large' as WidgetWidth,\n\t\t\tfields: (args) => breakdownWidgetFields(args, spec),\n\t\t})\n\t),\n]\n\nexport const registerWidgets = (config: Config, args: RegisterWidgetsArgs): void => {\n\tconst built: Widget[] = []\n\tfor (const def of WIDGET_DEFS) {\n\t\tif (args.disabled.includes(def.slug)) {\n\t\t\tcontinue\n\t\t}\n\t\tif (!widgetIsSupported(def.requires, args.adapters)) {\n\t\t\tcontinue\n\t\t}\n\t\tconst fields = def.fields(args)\n\t\t// A required metric select with no servable option would make the widget\n\t\t// impossible to configure; skip it like an unsupported widget.\n\t\tconst metricField = findMetricField(fields)\n\t\tif (metricField && 'options' in metricField && metricField.options.length === 0) {\n\t\t\tcontinue\n\t\t}\n\t\tbuilt.push({\n\t\t\tslug: def.slug,\n\t\t\tComponent: def.component,\n\t\t\tlabel: labelForKey(def.label),\n\t\t\tfields,\n\t\t\tminWidth: def.minWidth,\n\t\t\tmaxWidth: def.maxWidth,\n\t\t})\n\t}\n\tbuilt.push(...buildCustomWidgets(args.register, args.adapters, args.disabled))\n\tif (!built.length) {\n\t\treturn\n\t}\n\tconfig.admin ??= {}\n\tconfig.admin.dashboard ??= { widgets: [] }\n\tconfig.admin.dashboard.widgets ??= []\n\tconfig.admin.dashboard.widgets.push(...built)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAoBA,MAAM,eAAe,SAAiD;CACrE,IAAI,GAAG;CACP,IAAI,GAAG;AACR;AAoBA,MAAa,qBACZ,UACA,aACa,CAAC,YAAY,SAAS,MAAM,MAAM,sBAAsB,EAAE,cAAc,QAAQ,CAAC;;;;;;;;;;;;AAa/F,MAAM,qBACL,YACA,MACA,OAGI,CAAC,MACM;CACX,MAAM,EAAE,OAAO,mBAAmB,gBAAgB;CAClD,MAAM,YAAY,SAA2B,WAC5C,sBAAsB,QAAQ,cAAc;EAAE,GAAG;EAAO,SAAS,CAAC,MAAM;CAAE,CAAC;CAC5E,MAAM,UAAU,WACd,QAAQ,MAAM,KAAK,SAAS,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,CAAC,EACvD,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,YAAY,EAAE;CAAE,EAAE;CAC/D,MAAM,eAAe,QAAQ,MAAM,MAAM,EAAE,UAAU,gBAAgB,IAClE,mBACA,QAAQ,IAAI;CACf,MAAM,iBAA+C,EAAE,SAAS,MAAM,kBAAkB;EACvF,MAAM,WAAY,aAAsD;EACxE,MAAM,UACL,OAAO,aAAa,WAAW,KAAK,SAAS,MAAM,MAAM,EAAE,OAAO,QAAQ,IAAI,KAAA;EAC/E,IAAI,CAAC,SACJ,OAAO;EAER,OAAO,KAAK,QAAQ,MAAM,OAAO,MAAM,YAAY,SAAS,SAAS,EAAE,KAAkB,CAAC;CAC3F;CACA,OAAO;EACN,MAAM;EACN,MAAM;EACN,UAAU;EACV,GAAI,iBAAiB,KAAA,IAAY,EAAE,aAAa,IAAI,CAAC;EACrD,OAAO,YAAY,KAAK,iBAAiB;EACzC;EAEA,OAAO,EAAE,aAAa,MAAM;EAC5B,GAAI,KAAK,gBAAgB,EAAE,cAAc,IAAI,CAAC;CAC/C;AACD;AAEA,MAAM,cAAc,MAA2B,iBAAgC;CAC9E,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,GAAI,KAAK,eAAe,EAAE,WAAW,KAAK,IAAI,CAAC;CAC/C,OAAO,EAAE,YAAY;AACtB;AAEA,MAAM,8BAAqC;CAC1C,MAAM;CACN,MAAM;CACN,UAAU;CACV,cAAc;CACd,OAAO,YAAY,KAAK,oBAAoB;CAC5C,OAAO,EAAE,aAAa,MAAM;CAC5B,SAAS,CACR,GAAG,kBAAkB,KAAK,OAAO;EAAE,OAAO;EAAG,OAAO,YAAY,eAAe,EAAE;CAAE,EAAE,GACrF;EAAE,OAAO;EAAU,OAAO,YAAY,KAAK,qBAAqB;CAAE,CACnE;AACD;AAEA,MAAM,mBAAmB,UAAsC;CAC9D,MAAM;CACN,MAAM;CACN,OAAO,YAAY,KAAK,qBAAqB;CAC7C,cAAc,KAAK,SAAS,IAAI;CAEhC,OAAO,EAAE,aAAa,MAAM;CAC5B,SAAS,KAAK,SAAS,KAAK,OAAO;EAAE,OAAO,EAAE;EAAI,OAAO,EAAE;CAAM,EAAE;AACpE;AAEA,MAAM,yBACL,eAAe;CACd,MAAM;CACN,OAAO,YAAY,KAAK,gBAAgB;CACxC,kBAAkB;CAClB,YAAY,OAAO;EAClB,GAAG;EACH,OAAO;GACN,GAAG,EAAE;GACL,YAAY,OAAO,gBAAgB,aAAa,cAAc;EAC/D;CACD;AACD,CAAC;;AAGF,MAAa,mBAAmB,WAC/B,OAAO,MAAM,UAAU,UAAU,SAAS,MAAM,SAAS,QAAQ;AAElE,MAAM,sBAAsB,SAAuC;CAClE,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,gBAAgB,IAAI;CACtC,qBAAqB;CACrB,iBAAiB;CACjB,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,yBAAyB,MAA2B,SAAiC;CAC1F,WAAW,MAAM,GAAG,KAAK,MAAM;CAC/B,kBAAkB,gBAAgB,MAAM,EAAE,OAAO,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE,EAAE,CAAC;CACnF,qBAAqB;CACrB,iBAAiB;CACjB;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,KAAK;EACL,KAAK;EACL,OAAO,YAAY,KAAK,gBAAgB;CACzC;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,wBAAwB,SAAuC;CACpE,WAAW,MAAM,GAAG,KAAK,4BAA4B;CACrD,kBAAkB,CAAC,YAAY,WAAW,GAAG,MAAM;EAClD,OAAO,EAAE,UAAU,KAAK;EACxB,kBAAkB;CACnB,CAAC;CACD;EACC,MAAM;EACN,MAAM;EACN,cAAc;EACd,OAAO,YAAY,KAAK,iBAAiB;EACzC,OAAO,EAAE,aAAa,MAAM;EAC5B,SAAS;GACR;IAAE,OAAO;IAAK,OAAO;GAAQ;GAC7B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;GAC/B;IAAE,OAAO;IAAM,OAAO;GAAS;EAChC;CACD;CACA,GAAI,KAAK,gBAAgB,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC;AACrD;AAEA,MAAM,cAA2B;CAChC;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,SAAS,CAAC,WAAW,EAAE;EACnC,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA;EACC,MAAM;EACN,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,UAAU,KAAK;EAC3B,UAAU;EACV,UAAU;EACV,QAAQ;CACT;CACA,GAAG,gBAAgB,KACjB,UAAqB;EACrB,MAAM,KAAK;EACX,WAAW;EACX,OAAO,KAAK;EACZ,UAAU,EAAE,YAAY,CAAC,KAAK,SAAS,EAAE;EACzC,UAAU;EACV,UAAU;EACV,SAAS,SAAS,sBAAsB,MAAM,IAAI;CACnD,EACD;AACD;AAEA,MAAa,mBAAmB,QAAgB,SAAoC;CACnF,MAAM,QAAkB,CAAC;CACzB,KAAK,MAAM,OAAO,aAAa;EAC9B,IAAI,KAAK,SAAS,SAAS,IAAI,IAAI,GAClC;EAED,IAAI,CAAC,kBAAkB,IAAI,UAAU,KAAK,QAAQ,GACjD;EAED,MAAM,SAAS,IAAI,OAAO,IAAI;EAG9B,MAAM,cAAc,gBAAgB,MAAM;EAC1C,IAAI,eAAe,aAAa,eAAe,YAAY,QAAQ,WAAW,GAC7E;EAED,MAAM,KAAK;GACV,MAAM,IAAI;GACV,WAAW,IAAI;GACf,OAAO,YAAY,IAAI,KAAK;GAC5B;GACA,UAAU,IAAI;GACd,UAAU,IAAI;EACf,CAAC;CACF;CACA,MAAM,KAAK,GAAG,mBAAmB,KAAK,UAAU,KAAK,UAAU,KAAK,QAAQ,CAAC;CAC7E,IAAI,CAAC,MAAM,QACV;CAED,OAAO,UAAU,CAAC;CAClB,OAAO,MAAM,cAAc,EAAE,SAAS,CAAC,EAAE;CACzC,OAAO,MAAM,UAAU,YAAY,CAAC;CACpC,OAAO,MAAM,UAAU,QAAQ,KAAK,GAAG,KAAK;AAC7C"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@10x-media/analytics",
3
- "version": "0.1.0-beta.1",
3
+ "version": "0.1.0-beta.2",
4
4
  "description": "Adapter-based analytics for Payload: providers, a native engine, dashboard widgets, and portable fields.",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -97,9 +97,9 @@
97
97
  "peerDependencies": {
98
98
  "@google-analytics/data": "^6.0.0",
99
99
  "@payloadcms/db-postgres": "^3.82.0",
100
- "@payloadcms/ui": "^3.82.0",
100
+ "@payloadcms/ui": "^3.83.0",
101
101
  "maxmind": "^4.3.24",
102
- "payload": "^3.82.0",
102
+ "payload": "^3.83.0",
103
103
  "react": "^19.0.0",
104
104
  "react-datepicker": "^7.6.0",
105
105
  "react-dom": "^19.0.0"
@@ -134,10 +134,10 @@
134
134
  "tsdown": "0.22.1",
135
135
  "typescript": "5.9.3",
136
136
  "vitest": "4.1.7",
137
- "@10x-media/payload-test-harness": "0.0.0",
138
- "@10x-media/vitest-config": "0.0.0",
139
137
  "@10x-media/tsconfig": "0.0.0",
140
- "@10x-media/tsdown-config": "0.0.0"
138
+ "@10x-media/tsdown-config": "0.0.0",
139
+ "@10x-media/payload-test-harness": "0.0.0",
140
+ "@10x-media/vitest-config": "0.0.0"
141
141
  },
142
142
  "publishConfig": {
143
143
  "access": "public"