174 lines
7.7 KiB
JavaScript
174 lines
7.7 KiB
JavaScript
import { useContext, useMemo } from "react";
|
|
import { AppRouterContext, GlobalLayoutRouterContext, LayoutRouterContext } from "../../shared/lib/app-router-context.shared-runtime";
|
|
import { SearchParamsContext, PathnameContext, PathParamsContext } from "../../shared/lib/hooks-client-context.shared-runtime";
|
|
import { clientHookInServerComponentError } from "./client-hook-in-server-component-error";
|
|
import { getSegmentValue } from "./router-reducer/reducers/get-segment-value";
|
|
const INTERNAL_URLSEARCHPARAMS_INSTANCE = Symbol("internal for urlsearchparams readonly");
|
|
function readonlyURLSearchParamsError() {
|
|
return new Error("ReadonlyURLSearchParams cannot be modified");
|
|
}
|
|
export class ReadonlyURLSearchParams {
|
|
[Symbol.iterator]() {
|
|
return this[INTERNAL_URLSEARCHPARAMS_INSTANCE][Symbol.iterator]();
|
|
}
|
|
append() {
|
|
throw readonlyURLSearchParamsError();
|
|
}
|
|
delete() {
|
|
throw readonlyURLSearchParamsError();
|
|
}
|
|
set() {
|
|
throw readonlyURLSearchParamsError();
|
|
}
|
|
sort() {
|
|
throw readonlyURLSearchParamsError();
|
|
}
|
|
constructor(urlSearchParams){
|
|
this[INTERNAL_URLSEARCHPARAMS_INSTANCE] = urlSearchParams;
|
|
this.entries = urlSearchParams.entries.bind(urlSearchParams);
|
|
this.forEach = urlSearchParams.forEach.bind(urlSearchParams);
|
|
this.get = urlSearchParams.get.bind(urlSearchParams);
|
|
this.getAll = urlSearchParams.getAll.bind(urlSearchParams);
|
|
this.has = urlSearchParams.has.bind(urlSearchParams);
|
|
this.keys = urlSearchParams.keys.bind(urlSearchParams);
|
|
this.values = urlSearchParams.values.bind(urlSearchParams);
|
|
this.toString = urlSearchParams.toString.bind(urlSearchParams);
|
|
this.size = urlSearchParams.size;
|
|
}
|
|
}
|
|
/**
|
|
* Get a read-only URLSearchParams object. For example searchParams.get('foo') would return 'bar' when ?foo=bar
|
|
* Learn more about URLSearchParams here: https://developer.mozilla.org/docs/Web/API/URLSearchParams
|
|
*/ export function useSearchParams() {
|
|
clientHookInServerComponentError("useSearchParams");
|
|
const searchParams = useContext(SearchParamsContext);
|
|
// In the case where this is `null`, the compat types added in
|
|
// `next-env.d.ts` will add a new overload that changes the return type to
|
|
// include `null`.
|
|
const readonlySearchParams = useMemo(()=>{
|
|
if (!searchParams) {
|
|
// When the router is not ready in pages, we won't have the search params
|
|
// available.
|
|
return null;
|
|
}
|
|
return new ReadonlyURLSearchParams(searchParams);
|
|
}, [
|
|
searchParams
|
|
]);
|
|
if (typeof window === "undefined") {
|
|
// AsyncLocalStorage should not be included in the client bundle.
|
|
const { bailoutToClientRendering } = require("./bailout-to-client-rendering");
|
|
if (bailoutToClientRendering()) {
|
|
// TODO-APP: handle dynamic = 'force-static' here and on the client
|
|
return readonlySearchParams;
|
|
}
|
|
}
|
|
return readonlySearchParams;
|
|
}
|
|
/**
|
|
* Get the current pathname. For example usePathname() on /dashboard?foo=bar would return "/dashboard"
|
|
*/ export function usePathname() {
|
|
clientHookInServerComponentError("usePathname");
|
|
// In the case where this is `null`, the compat types added in `next-env.d.ts`
|
|
// will add a new overload that changes the return type to include `null`.
|
|
return useContext(PathnameContext);
|
|
}
|
|
export { ServerInsertedHTMLContext, useServerInsertedHTML } from "../../shared/lib/server-inserted-html.shared-runtime";
|
|
/**
|
|
* Get the router methods. For example router.push('/dashboard')
|
|
*/ export function useRouter() {
|
|
clientHookInServerComponentError("useRouter");
|
|
const router = useContext(AppRouterContext);
|
|
if (router === null) {
|
|
throw new Error("invariant expected app router to be mounted");
|
|
}
|
|
return router;
|
|
}
|
|
// this function performs a depth-first search of the tree to find the selected
|
|
// params
|
|
function getSelectedParams(tree, params) {
|
|
if (params === void 0) params = {};
|
|
const parallelRoutes = tree[1];
|
|
for (const parallelRoute of Object.values(parallelRoutes)){
|
|
const segment = parallelRoute[0];
|
|
const isDynamicParameter = Array.isArray(segment);
|
|
const segmentValue = isDynamicParameter ? segment[1] : segment;
|
|
if (!segmentValue || segmentValue.startsWith("__PAGE__")) continue;
|
|
// Ensure catchAll and optional catchall are turned into an array
|
|
const isCatchAll = isDynamicParameter && (segment[2] === "c" || segment[2] === "oc");
|
|
if (isCatchAll) {
|
|
params[segment[0]] = segment[1].split("/");
|
|
} else if (isDynamicParameter) {
|
|
params[segment[0]] = segment[1];
|
|
}
|
|
params = getSelectedParams(parallelRoute, params);
|
|
}
|
|
return params;
|
|
}
|
|
/**
|
|
* Get the current parameters. For example useParams() on /dashboard/[team]
|
|
* where pathname is /dashboard/nextjs would return { team: 'nextjs' }
|
|
*/ export function useParams() {
|
|
clientHookInServerComponentError("useParams");
|
|
const globalLayoutRouter = useContext(GlobalLayoutRouterContext);
|
|
const pathParams = useContext(PathParamsContext);
|
|
return useMemo(()=>{
|
|
// When it's under app router
|
|
if (globalLayoutRouter == null ? void 0 : globalLayoutRouter.tree) {
|
|
return getSelectedParams(globalLayoutRouter.tree);
|
|
}
|
|
// When it's under client side pages router
|
|
return pathParams;
|
|
}, [
|
|
globalLayoutRouter == null ? void 0 : globalLayoutRouter.tree,
|
|
pathParams
|
|
]);
|
|
}
|
|
// TODO-APP: handle parallel routes
|
|
/**
|
|
* Get the canonical parameters from the current level to the leaf node.
|
|
*/ function getSelectedLayoutSegmentPath(tree, parallelRouteKey, first, segmentPath) {
|
|
if (first === void 0) first = true;
|
|
if (segmentPath === void 0) segmentPath = [];
|
|
let node;
|
|
if (first) {
|
|
// Use the provided parallel route key on the first parallel route
|
|
node = tree[1][parallelRouteKey];
|
|
} else {
|
|
// After first parallel route prefer children, if there's no children pick the first parallel route.
|
|
const parallelRoutes = tree[1];
|
|
var _parallelRoutes_children;
|
|
node = (_parallelRoutes_children = parallelRoutes.children) != null ? _parallelRoutes_children : Object.values(parallelRoutes)[0];
|
|
}
|
|
if (!node) return segmentPath;
|
|
const segment = node[0];
|
|
const segmentValue = getSegmentValue(segment);
|
|
if (!segmentValue || segmentValue.startsWith("__PAGE__")) return segmentPath;
|
|
segmentPath.push(segmentValue);
|
|
return getSelectedLayoutSegmentPath(node, parallelRouteKey, false, segmentPath);
|
|
}
|
|
// TODO-APP: Expand description when the docs are written for it.
|
|
/**
|
|
* Get the canonical segment path from the current level to the leaf node.
|
|
*/ export function useSelectedLayoutSegments(parallelRouteKey) {
|
|
if (parallelRouteKey === void 0) parallelRouteKey = "children";
|
|
clientHookInServerComponentError("useSelectedLayoutSegments");
|
|
const { tree } = useContext(LayoutRouterContext);
|
|
return getSelectedLayoutSegmentPath(tree, parallelRouteKey);
|
|
}
|
|
// TODO-APP: Expand description when the docs are written for it.
|
|
/**
|
|
* Get the segment below the current level
|
|
*/ export function useSelectedLayoutSegment(parallelRouteKey) {
|
|
if (parallelRouteKey === void 0) parallelRouteKey = "children";
|
|
clientHookInServerComponentError("useSelectedLayoutSegment");
|
|
const selectedLayoutSegments = useSelectedLayoutSegments(parallelRouteKey);
|
|
if (selectedLayoutSegments.length === 0) {
|
|
return null;
|
|
}
|
|
return selectedLayoutSegments[0];
|
|
}
|
|
export { redirect, permanentRedirect, RedirectType } from "./redirect";
|
|
export { notFound } from "./not-found";
|
|
|
|
//# sourceMappingURL=navigation.js.map
|