152f51c6bd
Since `useRouter()` can still be used in `pages` alone and should always be a valid instance we shouldn't change the default return type to avoid a breaking type change. Fixes: https://github.com/vercel/next.js/issues/42409 ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have a helpful link attached, see `contributing.md` ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have a helpful link attached, see `contributing.md` ## Documentation / Examples - [ ] Make sure the linting passes by running `pnpm build && pnpm lint` - [ ] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
193 lines
5 KiB
TypeScript
193 lines
5 KiB
TypeScript
/* global window */
|
|
import React from 'react'
|
|
import Router from '../shared/lib/router/router'
|
|
import type { NextRouter } from '../shared/lib/router/router'
|
|
import { RouterContext } from '../shared/lib/router-context'
|
|
import isError from '../lib/is-error'
|
|
|
|
type SingletonRouterBase = {
|
|
router: Router | null
|
|
readyCallbacks: Array<() => any>
|
|
ready(cb: () => any): void
|
|
}
|
|
|
|
export { Router }
|
|
|
|
export type { NextRouter }
|
|
|
|
export type SingletonRouter = SingletonRouterBase & NextRouter
|
|
|
|
const singletonRouter: SingletonRouterBase = {
|
|
router: null, // holds the actual router instance
|
|
readyCallbacks: [],
|
|
ready(cb: () => void) {
|
|
if (this.router) return cb()
|
|
if (typeof window !== 'undefined') {
|
|
this.readyCallbacks.push(cb)
|
|
}
|
|
},
|
|
}
|
|
|
|
// Create public properties and methods of the router in the singletonRouter
|
|
const urlPropertyFields = [
|
|
'pathname',
|
|
'route',
|
|
'query',
|
|
'asPath',
|
|
'components',
|
|
'isFallback',
|
|
'basePath',
|
|
'locale',
|
|
'locales',
|
|
'defaultLocale',
|
|
'isReady',
|
|
'isPreview',
|
|
'isLocaleDomain',
|
|
'domainLocales',
|
|
]
|
|
const routerEvents = [
|
|
'routeChangeStart',
|
|
'beforeHistoryChange',
|
|
'routeChangeComplete',
|
|
'routeChangeError',
|
|
'hashChangeStart',
|
|
'hashChangeComplete',
|
|
] as const
|
|
export type RouterEvent = typeof routerEvents[number]
|
|
|
|
const coreMethodFields = [
|
|
'push',
|
|
'replace',
|
|
'reload',
|
|
'back',
|
|
'prefetch',
|
|
'beforePopState',
|
|
]
|
|
|
|
// Events is a static property on the router, the router doesn't have to be initialized to use it
|
|
Object.defineProperty(singletonRouter, 'events', {
|
|
get() {
|
|
return Router.events
|
|
},
|
|
})
|
|
|
|
function getRouter(): Router {
|
|
if (!singletonRouter.router) {
|
|
const message =
|
|
'No router instance found.\n' +
|
|
'You should only use "next/router" on the client side of your app.\n'
|
|
throw new Error(message)
|
|
}
|
|
return singletonRouter.router
|
|
}
|
|
|
|
urlPropertyFields.forEach((field: string) => {
|
|
// Here we need to use Object.defineProperty because we need to return
|
|
// the property assigned to the actual router
|
|
// The value might get changed as we change routes and this is the
|
|
// proper way to access it
|
|
Object.defineProperty(singletonRouter, field, {
|
|
get() {
|
|
const router = getRouter() as any
|
|
return router[field] as string
|
|
},
|
|
})
|
|
})
|
|
|
|
coreMethodFields.forEach((field: string) => {
|
|
// We don't really know the types here, so we add them later instead
|
|
;(singletonRouter as any)[field] = (...args: any[]) => {
|
|
const router = getRouter() as any
|
|
return router[field](...args)
|
|
}
|
|
})
|
|
|
|
routerEvents.forEach((event) => {
|
|
singletonRouter.ready(() => {
|
|
Router.events.on(event, (...args) => {
|
|
const eventField = `on${event.charAt(0).toUpperCase()}${event.substring(
|
|
1
|
|
)}`
|
|
const _singletonRouter = singletonRouter as any
|
|
if (_singletonRouter[eventField]) {
|
|
try {
|
|
_singletonRouter[eventField](...args)
|
|
} catch (err) {
|
|
console.error(`Error when running the Router event: ${eventField}`)
|
|
console.error(
|
|
isError(err) ? `${err.message}\n${err.stack}` : err + ''
|
|
)
|
|
}
|
|
}
|
|
})
|
|
})
|
|
})
|
|
|
|
// Export the singletonRouter and this is the public API.
|
|
export default singletonRouter as SingletonRouter
|
|
|
|
// Reexport the withRoute HOC
|
|
export { default as withRouter } from './with-router'
|
|
|
|
export function useRouter(throwOnMissing: true): NextRouter
|
|
export function useRouter(): NextRouter
|
|
export function useRouter(throwOnMissing?: boolean) {
|
|
const router = React.useContext(RouterContext)
|
|
if (!router && throwOnMissing) {
|
|
throw new Error('invariant expected pages router to be mounted')
|
|
}
|
|
|
|
return router
|
|
}
|
|
|
|
// INTERNAL APIS
|
|
// -------------
|
|
// (do not use following exports inside the app)
|
|
|
|
/**
|
|
* Create a router and assign it as the singleton instance.
|
|
* This is used in client side when we are initializing the app.
|
|
* This should **not** be used inside the server.
|
|
* @internal
|
|
*/
|
|
export function createRouter(
|
|
...args: ConstructorParameters<typeof Router>
|
|
): Router {
|
|
singletonRouter.router = new Router(...args)
|
|
singletonRouter.readyCallbacks.forEach((cb) => cb())
|
|
singletonRouter.readyCallbacks = []
|
|
|
|
return singletonRouter.router
|
|
}
|
|
|
|
/**
|
|
* This function is used to create the `withRouter` router instance
|
|
* @internal
|
|
*/
|
|
export function makePublicRouterInstance(router: Router): NextRouter {
|
|
const scopedRouter = router as any
|
|
const instance = {} as any
|
|
|
|
for (const property of urlPropertyFields) {
|
|
if (typeof scopedRouter[property] === 'object') {
|
|
instance[property] = Object.assign(
|
|
Array.isArray(scopedRouter[property]) ? [] : {},
|
|
scopedRouter[property]
|
|
) // makes sure query is not stateful
|
|
continue
|
|
}
|
|
|
|
instance[property] = scopedRouter[property]
|
|
}
|
|
|
|
// Events is a static property on the router, the router doesn't have to be initialized to use it
|
|
instance.events = Router.events
|
|
|
|
coreMethodFields.forEach((field) => {
|
|
instance[field] = (...args: any[]) => {
|
|
return scopedRouter[field](...args)
|
|
}
|
|
})
|
|
|
|
return instance
|
|
}
|