102 lines
2.9 KiB
TypeScript
102 lines
2.9 KiB
TypeScript
|
import type { FocusAndScrollRef, PrefetchKind, ThenableRecord } from '../../client/components/router-reducer/router-reducer-types';
|
||
|
|
import type { FetchServerResponseResult } from '../../client/components/router-reducer/fetch-server-response';
|
||
|
|
import type { FlightRouterState, FlightData } from '../../server/app-render/types';
|
||
|
|
import React from 'react';
|
||
|
|
export type ChildSegmentMap = Map<string, CacheNode>;
|
||
|
|
export declare enum CacheStates {
|
||
|
|
LAZY_INITIALIZED = "LAZYINITIALIZED",
|
||
|
|
DATA_FETCH = "DATAFETCH",
|
||
|
|
READY = "READY"
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Cache node used in app-router / layout-router.
|
||
|
|
*/
|
||
|
|
export type CacheNode = {
|
||
|
|
status: CacheStates.DATA_FETCH;
|
||
|
|
/**
|
||
|
|
* In-flight request for this node.
|
||
|
|
*/
|
||
|
|
data: ThenableRecord<FetchServerResponseResult> | null;
|
||
|
|
head?: React.ReactNode;
|
||
|
|
/**
|
||
|
|
* React Component for this node.
|
||
|
|
*/
|
||
|
|
subTreeData: null;
|
||
|
|
/**
|
||
|
|
* Child parallel routes.
|
||
|
|
*/
|
||
|
|
parallelRoutes: Map<string, ChildSegmentMap>;
|
||
|
|
} | {
|
||
|
|
status: CacheStates.READY;
|
||
|
|
/**
|
||
|
|
* In-flight request for this node.
|
||
|
|
*/
|
||
|
|
data: null;
|
||
|
|
head?: React.ReactNode;
|
||
|
|
/**
|
||
|
|
* React Component for this node.
|
||
|
|
*/
|
||
|
|
subTreeData: React.ReactNode;
|
||
|
|
/**
|
||
|
|
* Child parallel routes.
|
||
|
|
*/
|
||
|
|
parallelRoutes: Map<string, ChildSegmentMap>;
|
||
|
|
} | {
|
||
|
|
status: CacheStates.LAZY_INITIALIZED;
|
||
|
|
data: null;
|
||
|
|
head?: React.ReactNode;
|
||
|
|
subTreeData: null;
|
||
|
|
/**
|
||
|
|
* Child parallel routes.
|
||
|
|
*/
|
||
|
|
parallelRoutes: Map<string, ChildSegmentMap>;
|
||
|
|
};
|
||
|
|
export interface NavigateOptions {
|
||
|
|
scroll?: boolean;
|
||
|
|
}
|
||
|
|
export interface PrefetchOptions {
|
||
|
|
kind: PrefetchKind;
|
||
|
|
}
|
||
|
|
export interface AppRouterInstance {
|
||
|
|
/**
|
||
|
|
* Navigate to the previous history entry.
|
||
|
|
*/
|
||
|
|
back(): void;
|
||
|
|
/**
|
||
|
|
* Navigate to the next history entry.
|
||
|
|
*/
|
||
|
|
forward(): void;
|
||
|
|
/**
|
||
|
|
* Refresh the current page.
|
||
|
|
*/
|
||
|
|
refresh(): void;
|
||
|
|
/**
|
||
|
|
* Navigate to the provided href.
|
||
|
|
* Pushes a new history entry.
|
||
|
|
*/
|
||
|
|
push(href: string, options?: NavigateOptions): void;
|
||
|
|
/**
|
||
|
|
* Navigate to the provided href.
|
||
|
|
* Replaces the current history entry.
|
||
|
|
*/
|
||
|
|
replace(href: string, options?: NavigateOptions): void;
|
||
|
|
/**
|
||
|
|
* Prefetch the provided href.
|
||
|
|
*/
|
||
|
|
prefetch(href: string, options?: PrefetchOptions): void;
|
||
|
|
}
|
||
|
|
export declare const AppRouterContext: React.Context<AppRouterInstance | null>;
|
||
|
|
export declare const LayoutRouterContext: React.Context<{
|
||
|
|
childNodes: CacheNode['parallelRoutes'];
|
||
|
|
tree: FlightRouterState;
|
||
|
|
url: string;
|
||
|
|
}>;
|
||
|
|
export declare const GlobalLayoutRouterContext: React.Context<{
|
||
|
|
buildId: string;
|
||
|
|
tree: FlightRouterState;
|
||
|
|
changeByServerResponse: (previousTree: FlightRouterState, flightData: FlightData, overrideCanonicalUrl: URL | undefined) => void;
|
||
|
|
focusAndScrollRef: FocusAndScrollRef;
|
||
|
|
nextUrl: string | null;
|
||
|
|
}>;
|
||
|
|
export declare const TemplateContext: React.Context<React.ReactNode>;
|