src/hooks/use-docs-route.ts

import { Route, RouteContext } from '@lib/docs/page';

const getRouteContext = (
  routes: Route[],
  currentRoute?: Route,
  ctx: RouteContext = {}
): RouteContext => {
  const path = currentRoute?.path;
  const { parent } = ctx;
  for (let i = 0; i < routes?.length; i += 1) {
    const route = routes[i];
    if (route.routes) {
      ctx.parent = route;
      ctx = getRouteContext(route.routes, currentRoute, ctx);
      // If the active route and the next route was found in nested routes, return it
      if (ctx.nextRoute) return ctx;
    }
    if (!route.path) continue;
    if (ctx.route) {
      ctx.nextRoute =
        parent && i === 0
          ? { ...route, title: `${parent.title}: ${route.title}` }
          : route;

      return ctx;
    }
    if (route.path === path) {
      ctx.route = {
        ...currentRoute,
        title:
          parent && !parent.heading
            ? `${parent.title}: ${currentRoute?.title}` || ''
            : currentRoute?.title || ''
      };
      // Continue the loop until we know the next route
      continue;
    }
    ctx.prevRoute =
      parent && !parent.heading && !routes[i + 1]?.path
        ? { ...route, title: `${parent.title}: ${route.title}` }
        : route;
  }
  return ctx;
};

/**
 * Returns the siblings of a specific route (that is the previous and next routes).
 */
const useDocsRoute = (
  routes: Route[],
  currentRoute?: Route,
  ctx: RouteContext = {}
): RouteContext => {
  getRouteContext(routes, currentRoute, ctx);
  // The loop ended and the previous route was found, or nothing
  return ctx;
};

export default useDocsRoute;