RubyGems - ahoy_analytics - Versions diffs - 0.1.0 - Mend

ahoy_analytics 0.1.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 (198) hide show

data/app/frontend/pages/admin/analytics/show.tsx ADDED Viewed

@@ -0,0 +1,40 @@
+import { Head } from '@inertiajs/react'
+import AnalyticsLayout from '@/layouts/analytics-layout'
+import { LastLoadProvider } from './last-load-context'
+import AnalyticsDashboard from './ui/analytics-dashboard'
+import { QueryProvider } from './query-context'
+import { SiteProvider } from './site-context'
+import { UserProvider } from './user-context'
+import type { AnalyticsPageProps } from './types'
+export default function AnalyticsShow(props: AnalyticsPageProps) {
+  const { site, user, query, topStats, mainGraph, sources, pages, locations, devices, behaviors } = props
+  return (
+    <AnalyticsLayout>
+      <Head title="Analytics Overview" />
+      <SiteProvider value={site}>
+        <UserProvider value={user}>
+          <QueryProvider initialQuery={query}>
+            <LastLoadProvider>
+              <AnalyticsDashboard
+                initialTopStats={topStats}
+                initialGraph={mainGraph}
+                initialSources={sources}
+                initialPages={pages}
+                initialLocations={locations}
+                initialDevices={devices}
+                initialBehaviors={behaviors}
+              />
+              <div className="mt-10 border-t border-white/12 pt-4 text-xs text-muted-foreground/80">
+                This product includes GeoLite2 data created by MaxMind, available from maxmind.com.
+              </div>
+            </LastLoadProvider>
+          </QueryProvider>
+        </UserProvider>
+      </SiteProvider>
+    </AnalyticsLayout>
+  )
+}

data/app/frontend/pages/admin/analytics/site-context.tsx ADDED Viewed

@@ -0,0 +1,22 @@
+import { createContext, useContext, type ReactNode } from 'react'
+import type { SiteContextValue } from './types'
+const SiteContext = createContext<SiteContextValue | null>(null)
+export function SiteProvider({
+  value,
+  children
+}: {
+  value: SiteContextValue
+  children: ReactNode
+}) {
+  return <SiteContext.Provider value={value}>{children}</SiteContext.Provider>
+}
+export function useSiteContext() {
+  const context = useContext(SiteContext)
+  if (!context) {
+    throw new Error('useSiteContext must be used within a SiteProvider')
+  }
+  return context
+}

data/app/frontend/pages/admin/analytics/top-stats-context.tsx ADDED Viewed

@@ -0,0 +1,37 @@
+import { createContext, useContext, useMemo, useState, type ReactNode, type Dispatch, type SetStateAction } from 'react'
+import type { TopStatsPayload } from './types'
+export type TopStatsContextValue = {
+  payload: TopStatsPayload
+  update: Dispatch<SetStateAction<TopStatsPayload>>
+}
+const TopStatsContext = createContext<TopStatsContextValue | null>(null)
+export function TopStatsProvider({
+  initial,
+  children
+}: {
+  initial: TopStatsPayload
+  children: ReactNode
+}) {
+  const [payload, setPayload] = useState<TopStatsPayload>(initial)
+  const value = useMemo(
+    () => ({
+      payload,
+      update: setPayload
+    }),
+    [payload]
+  )
+  return <TopStatsContext.Provider value={value}>{children}</TopStatsContext.Provider>
+}
+export function useTopStatsContext() {
+  const context = useContext(TopStatsContext)
+  if (!context) {
+    throw new Error('useTopStatsContext must be used within a TopStatsProvider')
+  }
+  return context
+}

data/app/frontend/pages/admin/analytics/types.ts ADDED Viewed

@@ -0,0 +1,161 @@
+export type AnalyticsQuery = {
+  period: 'realtime' | 'day' | '7d' | '28d' | '30d' | '91d' | 'month' | 'year' | '12mo' | 'all' | 'custom'
+  comparison?: 'previous_period' | 'year_over_year' | 'custom' | null
+  filters: Record<string, string>
+  // Optional human-readable labels for some filter keys (country/region/city)
+  labels?: Record<string, string>
+  // Advanced filters encoded as Plausible-style tuples, serialized into repeated f= entries.
+  // Each entry: [operation, dimension, clause]
+  // Supported operations client-side: 'is_not', 'contains'.
+  advancedFilters?: Array<[string, string, string]>
+  withImported: boolean
+  metric?: string
+  interval?: string
+  mode?: string
+  funnel?: string
+  // Date helpers for month/year/custom periods
+  date?: string | null
+  from?: string | null
+  to?: string | null
+  // Compare helpers
+  compareFrom?: string | null
+  compareTo?: string | null
+  matchDayOfWeek?: boolean
+  // Optional UI-only hint so dialogs can deep-link and restore open state
+  dialog?: string
+}
+export type SiteContextValue = {
+  domain: string
+  timezone: string
+  hasGoals: boolean
+  hasProps: boolean
+  funnelsAvailable: boolean
+  propsAvailable: boolean
+  segments: Array<{ id: string; name: string }>
+  flags: { dbip: boolean }
+}
+export type UserContextValue = {
+  role: 'super_admin' | 'owner' | 'admin' | 'editor' | 'viewer'
+  email: string
+}
+export type TopStat = {
+  name: string
+  value: number
+  graphMetric?: string
+  change?: number | null
+  comparisonValue?: number | null
+}
+export type TopStatsPayload = {
+  topStats: TopStat[]
+  graphableMetrics: string[]
+  meta: {
+    metricWarnings: Record<string, { code: string; message?: string }>
+    importsIncluded: boolean
+  }
+  interval: string
+  includesImported: boolean
+  withImportedSwitch: {
+    visible: boolean
+    togglable: boolean
+    tooltipMsg: string | null
+  }
+  samplePercent: number
+  from: string
+  to: string
+  comparingFrom?: string | null
+  comparingTo?: string | null
+}
+export type MainGraphPayload = {
+  metric: string
+  plot: number[]
+  labels: string[]
+  comparisonPlot?: number[] | null
+  comparisonLabels?: string[] | null
+  presentIndex?: number | null
+  interval: string
+  fullIntervals?: Record<string, boolean> | null
+}
+export type ListMetricKey =
+  | 'visitors'
+  | 'visits'
+  | 'percentage'
+  | 'uniques'
+  | 'total'
+  | 'conversionRate'
+  | 'exitRate'
+  | 'bounceRate'
+  | 'visitDuration'
+  | 'scrollDepth'
+  | 'timeOnPage'
+  | 'pageviews'
+  // Google Search Console style metrics (used by Search Terms dialog)
+  | 'impressions'
+  | 'ctr'
+  | 'position'
+export type ListItem = Record<string, string | number | null | undefined> & {
+  name: string
+}
+export type ListPayload = {
+  results: ListItem[]
+  metrics: ListMetricKey[]
+  meta: {
+    hasMore: boolean
+    skipImportedReason: string | null
+    metricLabels?: Record<string, string>
+  }
+}
+export type MapPayload = {
+  map: {
+    results: Array<{
+      alpha3: string
+      alpha2?: string
+      numeric?: string
+      code?: string
+      name: string
+      visitors: number
+    }>
+    meta: Record<string, unknown>
+  }
+}
+export type DevicesPayload = ListPayload
+export type BehaviorsPayload =
+  | {
+      list: ListPayload
+      goalHighlighted?: string | null
+    }
+  | {
+      funnels: string[]
+      active: {
+        name: string
+        steps: Array<{
+          name: string
+          visitors: number
+          conversionRate: number
+        }>
+      }
+    }
+  | ListPayload
+export type AnalyticsPageProps = {
+  site: SiteContextValue
+  user: UserContextValue
+  query: AnalyticsQuery
+  topStats: TopStatsPayload
+  mainGraph: MainGraphPayload
+  sources: ListPayload
+  pages: ListPayload
+  locations: MapPayload | ListPayload
+  devices: DevicesPayload
+  behaviors: BehaviorsPayload
+}

data/app/frontend/pages/admin/analytics/ui/analytics-dashboard.tsx ADDED Viewed

@@ -0,0 +1,60 @@
+import { useMemo } from 'react'
+import { useQueryContext } from '../query-context'
+import type {
+  BehaviorsPayload,
+  DevicesPayload,
+  ListPayload,
+  MainGraphPayload,
+  MapPayload,
+  TopStatsPayload
+} from '../types'
+import { TopStatsProvider } from '../top-stats-context'
+import TopBar from './top-bar'
+import VisitorGraph from './visitor-graph'
+import SourcesPanel from './sources-panel'
+import PagesPanel from './pages-panel'
+import LocationsPanel from './locations-panel'
+import DevicesPanel from './devices-panel'
+import BehaviorsPanel from './behaviors-panel'
+import { useSiteContext } from '../site-context'
+export type AnalyticsDashboardProps = {
+  initialTopStats: TopStatsPayload
+  initialGraph: MainGraphPayload
+  initialSources: ListPayload
+  initialPages: ListPayload
+  initialLocations: MapPayload | ListPayload
+  initialDevices: DevicesPayload
+  initialBehaviors: BehaviorsPayload
+}
+export default function AnalyticsDashboard(props: AnalyticsDashboardProps) {
+  const { query } = useQueryContext()
+  const site = useSiteContext()
+  const isRealtime = useMemo(() => query.period === 'realtime', [query.period])
+  return (
+    <TopStatsProvider initial={props.initialTopStats}>
+      <div className="flex flex-col gap-6 pb-16">
+      <TopBar showCurrentVisitors={!isRealtime} />
+      <VisitorGraph
+        initialGraph={props.initialGraph}
+      />
+      <section className="grid gap-6 lg:grid-cols-2">
+        <SourcesPanel initialData={props.initialSources} />
+        <PagesPanel initialData={props.initialPages} />
+      </section>
+      <section className="grid gap-6 lg:grid-cols-2">
+        <LocationsPanel initialData={props.initialLocations} />
+        <DevicesPanel initialData={props.initialDevices} />
+      </section>
+      {site.hasGoals ? <BehaviorsPanel initialData={props.initialBehaviors} /> : null}
+    </div>
+    </TopStatsProvider>
+  )
+}