add initatedBy

[kyeotic]

closes #161

Adds initiatedBy to useLocationChange to distinguish between push and pop navigations

[n33pm]

const initiatedBy: NavigationInitiator = (event as any).__method ?? 'pop'

is enough

[n33pm]

should we export RavigerHistory too?

[n33pm]

describe('useLocationChange action', () => {
  function RouteWithLocation({
    onChange,
    onInitial = false,
  }: {
    onChange: (location: RavigerLocation) => void
    onInitial?: boolean
  }) {
    useLocationChange(onChange, { onInitial })
    return null
  }

  test('action is "push" on regular navigate', () => {
    const watcher = jest.fn()
    render(<RouteWithLocation onChange={watcher} />)

    act(() => navigate('/foo'))
    expect(watcher).toHaveBeenCalledWith(expect.objectContaining({ action: 'push' }))
  })

  test('action is "replace" on replace navigate', () => {
    const watcher = jest.fn()
    render(<RouteWithLocation onChange={watcher} />)

    act(() => navigate('/foo', { replace: true }))
    expect(watcher).toHaveBeenCalledWith(expect.objectContaining({ action: 'replace' }))
  })

  test('action is undefined on initial mount (onInitial: true) — not a history navigation', () => {
    const watcher = jest.fn()
    render(<RouteWithLocation onChange={watcher} onInitial />)

    expect(watcher).toHaveBeenCalledWith(expect.objectContaining({ action: undefined }))
  })

  test('action is "push" on subsequent regular navigate after replace', () => {
    const watcher = jest.fn()
    render(<RouteWithLocation onChange={watcher} />)

    act(() => navigate('/foo', { replace: true }))
    act(() => navigate('/bar'))
    expect(watcher).toHaveBeenLastCalledWith(expect.objectContaining({ action: 'push' }))
  })
})

[n33pm]

sry, I forgot to submit my review.