01ecb60264
x-ref: [slack thread](https://vercel.slack.com/archives/C043ANYDB24/p1663973909118009?thread_ts=1663973783.142799&cid=C043ANYDB24)
77 lines
2.2 KiB
TypeScript
77 lines
2.2 KiB
TypeScript
import React from 'react'
|
|
import type { FocusAndScrollRef } from '../../client/components/reducer'
|
|
import type { FlightRouterState, FlightData } from '../../server/app-render'
|
|
|
|
export type ChildSegmentMap = Map<string, CacheNode>
|
|
|
|
/**
|
|
* Cache node used in app-router / layout-router.
|
|
*/
|
|
export type CacheNode = {
|
|
/**
|
|
* In-flight request for this node.
|
|
*/
|
|
data: ReturnType<
|
|
typeof import('../../client/components/app-router.client').fetchServerResponse
|
|
> | null
|
|
/**
|
|
* React Component for this node.
|
|
*/
|
|
subTreeData: React.ReactNode | null
|
|
/**
|
|
* Child parallel routes.
|
|
*/
|
|
parallelRoutes: Map<string, ChildSegmentMap>
|
|
}
|
|
|
|
interface NavigateOptions {
|
|
forceOptimisticNavigation?: boolean
|
|
}
|
|
|
|
export interface AppRouterInstance {
|
|
/**
|
|
* Reload the current page. Fetches new data from the server.
|
|
*/
|
|
reload(): void
|
|
/**
|
|
* Hard navigate to the provided href. Fetches new data from the server.
|
|
* Pushes a new history entry.
|
|
*/
|
|
push(href: string, options?: NavigateOptions): void
|
|
/**
|
|
* Hard navigate to the provided href. Does not fetch data from the server if it was already fetched.
|
|
* Replaces the current history entry.
|
|
*/
|
|
replace(href: string, options?: NavigateOptions): void
|
|
/**
|
|
* Soft prefetch the provided href. Does not fetch data from the server if it was already fetched.
|
|
*/
|
|
prefetch(href: string): void
|
|
}
|
|
|
|
export const AppRouterContext = React.createContext<AppRouterInstance>(
|
|
null as any
|
|
)
|
|
export const LayoutRouterContext = React.createContext<{
|
|
childNodes: CacheNode['parallelRoutes']
|
|
tree: FlightRouterState
|
|
url: string
|
|
}>(null as any)
|
|
export const GlobalLayoutRouterContext = React.createContext<{
|
|
tree: FlightRouterState
|
|
changeByServerResponse: (
|
|
previousTree: FlightRouterState,
|
|
flightData: FlightData,
|
|
overrideCanonicalUrl: URL | undefined
|
|
) => void
|
|
focusAndScrollRef: FocusAndScrollRef
|
|
}>(null as any)
|
|
|
|
export const TemplateContext = React.createContext<React.ReactNode>(null as any)
|
|
|
|
if (process.env.NODE_ENV !== 'production') {
|
|
AppRouterContext.displayName = 'AppRouterContext'
|
|
LayoutRouterContext.displayName = 'LayoutRouterContext'
|
|
GlobalLayoutRouterContext.displayName = 'GlobalLayoutRouterContext'
|
|
TemplateContext.displayName = 'TemplateContext'
|
|
}
|