next-sanity/src/studio/client-component/createHashHistoryForStudio.ts

Sanity.io toolkit for Next.js

import {createHashHistory, type History, type Listener} from 'history'

/** @internal */
export function createHashHistoryForStudio(): History {
  const history = createHashHistory()
  return {
    get action() {
      return history.action
    },
    get location() {
      return history.location
    },
    get createHref() {
      return history.createHref
    },
    get push() {
      return history.push
    },
    get replace() {
      return history.replace
    },
    get go() {
      return history.go
    },
    get back() {
      return history.back
    },
    get forward() {
      return history.forward
    },
    get block() {
      return history.block
    },
    // Overriding listen to workaround a problem where native history provides history.listen(location => void), but the npm package is history.listen(({action, location}) => void)
    listen(listener: Listener) {
      // return history.listen(({ action, location }) => {
      return history.listen(({location}) => {
        // console.debug('history.listen', action, location)
        // @ts-expect-error -- working around a bug? in studio
        listener(location)
      })
    },
  }
}