react-fathom 0.1.0 → 0.1.1

package/src/next/NextFathomProviderApp.test.tsx

@@ -1,308 +0,0 @@
-import React from 'react'
-
-import { beforeEach, describe, expect, it, vi } from 'vitest'
-
-import { renderHook, waitFor } from '@testing-library/react'
-
-import NextFathomProviderApp from './NextFathomProviderApp'
-import { useFathom } from '../hooks/useFathom'
-
-// Mock Next.js App Router hooks
-const mockSearchParams = new URLSearchParams('?foo=bar')
-vi.mock('next/navigation', () => ({
-  usePathname: vi.fn(() => '/test-page'),
-  useSearchParams: vi.fn(() => mockSearchParams),
-}))
-
-// Mock fathom-client
-vi.mock('fathom-client', () => {
-  const mockFathomDefault = {
-    trackEvent: vi.fn(),
-    trackPageview: vi.fn(),
-    trackGoal: vi.fn(),
-    load: vi.fn(),
-    setSite: vi.fn(),
-    blockTrackingForMe: vi.fn(),
-    enableTrackingForMe: vi.fn(),
-    isTrackingEnabled: vi.fn(() => true),
-  }
-
-  return {
-    default: mockFathomDefault,
-  }
-})
-
-describe('NextFathomProviderApp', () => {
-  const mockClient = {
-    trackEvent: vi.fn(),
-    trackPageview: vi.fn(),
-    trackGoal: vi.fn(),
-    load: vi.fn(),
-    setSite: vi.fn(),
-    blockTrackingForMe: vi.fn(),
-    enableTrackingForMe: vi.fn(),
-    isTrackingEnabled: vi.fn(() => true),
-  }
-
-  beforeEach(() => {
-    vi.clearAllMocks()
-    // Reset window.location
-    Object.defineProperty(window, 'location', {
-      value: {
-        origin: 'https://example.com',
-        href: 'https://example.com/test-page?foo=bar',
-      },
-      writable: true,
-    })
-  })
-
-  it('should load Fathom on mount when siteId is provided', async () => {
-    const loadSpy = vi.fn()
-    const client = { ...mockClient, load: loadSpy }
-
-    const wrapper = ({ children }: { children: React.ReactNode }) => (
-      <NextFathomProviderApp client={client} siteId="TEST_SITE_ID">
-        {children}
-      </NextFathomProviderApp>
-    )
-
-    renderHook(() => useFathom(), { wrapper })
-
-    await waitFor(() => {
-      expect(loadSpy).toHaveBeenCalledWith('TEST_SITE_ID', undefined)
-    })
-  })
-
-  it('should load Fathom with clientOptions', async () => {
-    const loadSpy = vi.fn()
-    const clientOptions = { honorDNT: true }
-    const client = { ...mockClient, load: loadSpy }
-
-    const wrapper = ({ children }: { children: React.ReactNode }) => (
-      <NextFathomProviderApp
-        client={client}
-        siteId="TEST_SITE_ID"
-        clientOptions={clientOptions}
-      >
-        {children}
-      </NextFathomProviderApp>
-    )
-
-    renderHook(() => useFathom(), { wrapper })
-
-    await waitFor(() => {
-      expect(loadSpy).toHaveBeenCalledWith('TEST_SITE_ID', clientOptions)
-    })
-  })
-
-  it('should track initial pageview on mount', async () => {
-    const trackPageviewSpy = vi.fn()
-    const client = { ...mockClient, trackPageview: trackPageviewSpy }
-
-    const wrapper = ({ children }: { children: React.ReactNode }) => (
-      <NextFathomProviderApp client={client} siteId="TEST_SITE_ID">
-        {children}
-      </NextFathomProviderApp>
-    )
-
-    renderHook(() => useFathom(), { wrapper })
-
-    await waitFor(() => {
-      expect(trackPageviewSpy).toHaveBeenCalled()
-    })
-
-    expect(trackPageviewSpy).toHaveBeenCalledWith({
-      url: 'https://example.com/test-page?foo=bar',
-    })
-  })
-
-  it('should not track pageview when disableAutoTrack is true', async () => {
-    const trackPageviewSpy = vi.fn()
-    const client = { ...mockClient, trackPageview: trackPageviewSpy }
-
-    const wrapper = ({ children }: { children: React.ReactNode }) => (
-      <NextFathomProviderApp
-        client={client}
-        siteId="TEST_SITE_ID"
-        disableAutoTrack
-      >
-        {children}
-      </NextFathomProviderApp>
-    )
-
-    renderHook(() => useFathom(), { wrapper })
-
-    // Wait a bit to ensure no tracking happens
-    await new Promise((resolve) => setTimeout(resolve, 100))
-
-    expect(trackPageviewSpy).not.toHaveBeenCalled()
-  })
-
-  it('should use provided client', () => {
-    const wrapper = ({ children }: { children: React.ReactNode }) => (
-      <NextFathomProviderApp client={mockClient} siteId="TEST_SITE_ID">
-        {children}
-      </NextFathomProviderApp>
-    )
-
-    const { result } = renderHook(() => useFathom(), { wrapper })
-
-    expect(result.current.client).toBe(mockClient)
-  })
-
-  it('should use default Fathom client when no client is provided', async () => {
-    // This test verifies that the component uses the default Fathom client
-    // when no client is provided. The component should still work and provide
-    // a client through the context.
-    // Note: This test may fail if Next.js hooks throw errors, so we wrap in try-catch
-    try {
-      const wrapper = ({ children }: { children: React.ReactNode }) => (
-        <NextFathomProviderApp siteId="TEST_SITE_ID">
-          {children}
-        </NextFathomProviderApp>
-      )
-
-      const { result } = renderHook(() => useFathom(), { wrapper })
-
-      // The client should be available (either default or from parent)
-      await waitFor(() => {
-        expect(result.current.client).toBeDefined()
-        expect(result.current.trackEvent).toBeDefined()
-        expect(result.current.trackPageview).toBeDefined()
-      })
-    } catch (error) {
-      // If there's an error with Next.js hooks, skip this test
-      // The other tests verify the functionality with provided clients
-      expect(error).toBeDefined()
-    }
-  })
-
-  it('should merge defaultPageviewOptions', async () => {
-    const trackPageviewSpy = vi.fn()
-    const client = { ...mockClient, trackPageview: trackPageviewSpy }
-
-    const wrapper = ({ children }: { children: React.ReactNode }) => (
-      <NextFathomProviderApp
-        client={client}
-        siteId="TEST_SITE_ID"
-        defaultPageviewOptions={{ referrer: 'https://example.com' }}
-      >
-        {children}
-      </NextFathomProviderApp>
-    )
-
-    renderHook(() => useFathom(), { wrapper })
-
-    await waitFor(() => {
-      expect(trackPageviewSpy).toHaveBeenCalled()
-    })
-
-    expect(trackPageviewSpy).toHaveBeenCalledWith({
-      referrer: 'https://example.com',
-      url: 'https://example.com/test-page?foo=bar',
-    })
-  })
-
-  it('should support deprecated trackDefaultOptions', async () => {
-    const trackPageviewSpy = vi.fn()
-    const client = { ...mockClient, trackPageview: trackPageviewSpy }
-
-    const wrapper = ({ children }: { children: React.ReactNode }) => (
-      <NextFathomProviderApp
-        client={client}
-        siteId="TEST_SITE_ID"
-        trackDefaultOptions={{ referrer: 'https://example.com' }}
-      >
-        {children}
-      </NextFathomProviderApp>
-    )
-
-    renderHook(() => useFathom(), { wrapper })
-
-    await waitFor(() => {
-      expect(trackPageviewSpy).toHaveBeenCalled()
-    })
-
-    expect(trackPageviewSpy).toHaveBeenCalledWith({
-      referrer: 'https://example.com',
-      url: 'https://example.com/test-page?foo=bar',
-    })
-  })
-
-  it('should prioritize defaultPageviewOptions over trackDefaultOptions', async () => {
-    const trackPageviewSpy = vi.fn()
-    const client = { ...mockClient, trackPageview: trackPageviewSpy }
-
-    const wrapper = ({ children }: { children: React.ReactNode }) => (
-      <NextFathomProviderApp
-        client={client}
-        siteId="TEST_SITE_ID"
-        trackDefaultOptions={{ referrer: 'old' }}
-        defaultPageviewOptions={{ referrer: 'new' }}
-      >
-        {children}
-      </NextFathomProviderApp>
-    )
-
-    renderHook(() => useFathom(), { wrapper })
-
-    await waitFor(() => {
-      expect(trackPageviewSpy).toHaveBeenCalled()
-    })
-
-    expect(trackPageviewSpy).toHaveBeenCalledWith({
-      referrer: 'new',
-      url: 'https://example.com/test-page?foo=bar',
-    })
-  })
-
-  it('should compose with parent FathomProvider', () => {
-    const parentClient = {
-      trackEvent: vi.fn(),
-      trackPageview: vi.fn(),
-      trackGoal: vi.fn(),
-      load: vi.fn(),
-      setSite: vi.fn(),
-      blockTrackingForMe: vi.fn(),
-      enableTrackingForMe: vi.fn(),
-      isTrackingEnabled: vi.fn(() => true),
-    }
-
-    const wrapper = ({ children }: { children: React.ReactNode }) => (
-      <NextFathomProviderApp client={parentClient} siteId="TEST_SITE_ID">
-        {children}
-      </NextFathomProviderApp>
-    )
-
-    const { result } = renderHook(() => useFathom(), { wrapper })
-
-    expect(result.current.client).toBe(parentClient)
-  })
-
-  it('should handle pathname with search params', async () => {
-    // This test verifies the component handles search params correctly
-    const trackPageviewSpy = vi.fn()
-    const client = { ...mockClient, trackPageview: trackPageviewSpy }
-
-    const wrapper = ({ children }: { children: React.ReactNode }) => (
-      <NextFathomProviderApp client={client} siteId="TEST_SITE_ID">
-        {children}
-      </NextFathomProviderApp>
-    )
-
-    renderHook(() => useFathom(), { wrapper })
-
-    await waitFor(() => {
-      expect(trackPageviewSpy).toHaveBeenCalled()
-    })
-
-    // Should include search params from mock
-    expect(trackPageviewSpy).toHaveBeenCalledWith({
-      url: 'https://example.com/test-page?foo=bar',
-    })
-  })
-
-  it('should have displayName', () => {
-    expect(NextFathomProviderApp.displayName).toBe('NextFathomProviderApp')
-  })
-})

package/src/next/NextFathomProviderApp.tsx

@@ -1,106 +0,0 @@
-import React, { useCallback, useEffect, useRef, useMemo } from 'react'
-
-import * as Fathom from 'fathom-client'
-import type { PageViewOptions } from 'fathom-client'
-import { usePathname, useSearchParams } from 'next/navigation'
-
-import { FathomProvider } from '../FathomProvider'
-import type { NextFathomProviderProps } from './types'
-import { useFathom } from '../hooks/useFathom'
-
-const NextFathomProviderApp: React.FC<NextFathomProviderProps> = ({
-  children,
-  client: providedClient,
-  clientOptions,
-  disableAutoTrack = false,
-  siteId,
-  trackDefaultOptions,
-  defaultPageviewOptions: providedDefaultPageviewOptions,
-}) => {
-  const pathname = usePathname()
-  const searchParams = useSearchParams()
-  const hasTrackedInitialPageview = useRef(false)
-  const parentContext = useFathom()
-
-  // Use provided client or fall back to parent client or default Fathom
-  const client = useMemo(
-    () => providedClient ?? parentContext.client ?? Fathom,
-    [providedClient, parentContext.client],
-  )
-
-  // Support both deprecated trackDefaultOptions and new defaultPageviewOptions
-  // Priority: providedDefaultPageviewOptions > trackDefaultOptions > parent defaultPageviewOptions
-  const defaultPageviewOptions = useMemo(
-    () =>
-      providedDefaultPageviewOptions ??
-      trackDefaultOptions ??
-      parentContext.defaultPageviewOptions,
-    [
-      providedDefaultPageviewOptions,
-      trackDefaultOptions,
-      parentContext.defaultPageviewOptions,
-    ],
-  )
-
-  const trackPageview = useCallback(
-    (options?: PageViewOptions) => {
-      if (siteId !== undefined && client !== undefined) {
-        client.trackPageview({
-          ...defaultPageviewOptions,
-          ...options,
-        })
-      }
-    },
-    [client, siteId, defaultPageviewOptions],
-  )
-
-  // Initialize Fathom on mount
-  useEffect(() => {
-    if (siteId !== undefined && client !== undefined) {
-      client.load(siteId, clientOptions)
-    }
-  }, [client, clientOptions, siteId])
-
-  // Track pageviews on route changes
-  useEffect(() => {
-    if (siteId === undefined || disableAutoTrack) {
-      return
-    }
-
-    const searchString = searchParams?.toString()
-    const url =
-      pathname +
-      (searchString !== undefined && searchString !== ''
-        ? `?${searchString}`
-        : '')
-
-    // Track initial pageview only once
-    if (!hasTrackedInitialPageview.current) {
-      hasTrackedInitialPageview.current = true
-      trackPageview({
-        url: window.location.origin + url,
-      })
-    } else {
-      // Track subsequent route changes
-      trackPageview({
-        url: window.location.origin + url,
-      })
-    }
-  }, [pathname, searchParams, siteId, disableAutoTrack, trackPageview])
-
-  return (
-    <FathomProvider
-      client={client}
-      clientOptions={clientOptions}
-      siteId={siteId}
-      defaultPageviewOptions={defaultPageviewOptions}
-    >
-      {children}
-    </FathomProvider>
-  )
-}
-
-NextFathomProviderApp.displayName = 'NextFathomProviderApp'
-
-export default NextFathomProviderApp
-export { NextFathomProviderApp }