@enjoys/context-engine 1.2.0 → 1.4.1

package/data/definition/nextjs.json

@@ -0,0 +1,439 @@
+{
+  "language": "nextjs",
+  "definitions": {
+    "useRouter": {
+      "signature": "function useRouter(): AppRouterInstance",
+      "description": "Returns a router instance for programmatic navigation in Client Components. Provides push, replace, refresh, prefetch, back, and forward methods.",
+      "type": "function",
+      "module": "next/navigation",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/use-router"
+    },
+    "usePathname": {
+      "signature": "function usePathname(): string",
+      "description": "Returns the current URL pathname as a string. Automatically re-renders when the pathname changes.",
+      "type": "function",
+      "module": "next/navigation",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/use-pathname"
+    },
+    "useSearchParams": {
+      "signature": "function useSearchParams(): ReadonlyURLSearchParams",
+      "description": "Returns a read-only URLSearchParams object for the current URL's query string parameters.",
+      "type": "function",
+      "module": "next/navigation",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/use-search-params"
+    },
+    "useParams": {
+      "signature": "function useParams<T extends Record<string, string | string[]>>(): T",
+      "description": "Returns an object containing the current route's dynamic parameters filled in by the URL.",
+      "type": "function",
+      "module": "next/navigation",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/use-params"
+    },
+    "useSelectedLayoutSegment": {
+      "signature": "function useSelectedLayoutSegment(parallelRoutesKey?: string): string | null",
+      "description": "Returns the active route segment one level below the Layout it is called from. Useful for active navigation styling.",
+      "type": "function",
+      "module": "next/navigation",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/use-selected-layout-segment"
+    },
+    "useSelectedLayoutSegments": {
+      "signature": "function useSelectedLayoutSegments(parallelRoutesKey?: string): string[]",
+      "description": "Returns an array of all active route segments below the Layout it is called from.",
+      "type": "function",
+      "module": "next/navigation",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/use-selected-layout-segments"
+    },
+    "redirect": {
+      "signature": "function redirect(url: string, type?: RedirectType): never",
+      "description": "Redirects the user to another URL. Can be used in Server Components, Route Handlers, and Server Actions. Throws NEXT_REDIRECT internally.",
+      "type": "function",
+      "module": "next/navigation",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/redirect"
+    },
+    "permanentRedirect": {
+      "signature": "function permanentRedirect(url: string, type?: RedirectType): never",
+      "description": "Redirects the user with a 308 permanent redirect status. Can be used in Server Components, Route Handlers, and Server Actions.",
+      "type": "function",
+      "module": "next/navigation",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/permanentRedirect"
+    },
+    "notFound": {
+      "signature": "function notFound(): never",
+      "description": "Throws NEXT_NOT_FOUND error rendering the not-found.tsx UI for the route segment. Terminates rendering of the component tree.",
+      "type": "function",
+      "module": "next/navigation",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/not-found"
+    },
+    "NextRequest": {
+      "signature": "class NextRequest extends Request",
+      "description": "Extends the Web Request API with convenience methods for cookies, geo, ip, and nextUrl. Used in Middleware and Route Handlers.",
+      "type": "class",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/next-request"
+    },
+    "NextResponse": {
+      "signature": "class NextResponse extends Response",
+      "description": "Extends the Web Response API with static methods json(), redirect(), rewrite(), and next() for Middleware and Route Handlers.",
+      "type": "class",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/next-response"
+    },
+    "NextResponse.json": {
+      "signature": "static NextResponse.json(body: any, init?: ResponseInit): NextResponse",
+      "description": "Creates a JSON response with the given body and optional ResponseInit options including status, headers.",
+      "type": "method",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/next-response#json"
+    },
+    "NextResponse.redirect": {
+      "signature": "static NextResponse.redirect(url: string | URL, status?: number): NextResponse",
+      "description": "Creates a redirect response to the specified URL with an optional status code (defaults to 307).",
+      "type": "method",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/next-response#redirect"
+    },
+    "NextResponse.rewrite": {
+      "signature": "static NextResponse.rewrite(url: string | URL, init?: MiddlewareResponseInit): NextResponse",
+      "description": "Rewrites the request to a different URL while preserving the original URL in the browser.",
+      "type": "method",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/next-response#rewrite"
+    },
+    "NextResponse.next": {
+      "signature": "static NextResponse.next(init?: MiddlewareResponseInit): NextResponse",
+      "description": "Continues the middleware chain. Can optionally modify request headers for downstream processing.",
+      "type": "method",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/next-response#next"
+    },
+    "cookies": {
+      "signature": "function cookies(): ReadonlyRequestCookies",
+      "description": "Returns a read-only cookies store for incoming request cookies. Supports get(), getAll(), has() in Server Components; set(), delete() in Server Actions and Route Handlers.",
+      "type": "function",
+      "module": "next/headers",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/cookies"
+    },
+    "headers": {
+      "signature": "function headers(): ReadonlyHeaders",
+      "description": "Returns a read-only Headers object for the incoming request. Supports get(), has(), entries(), forEach(), keys(), values() methods.",
+      "type": "function",
+      "module": "next/headers",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/headers"
+    },
+    "revalidatePath": {
+      "signature": "function revalidatePath(path: string, type?: 'page' | 'layout'): void",
+      "description": "Purges cached data for a specific path. The type parameter determines if only the page or the entire layout tree is revalidated.",
+      "type": "function",
+      "module": "next/cache",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/revalidatePath"
+    },
+    "revalidateTag": {
+      "signature": "function revalidateTag(tag: string): void",
+      "description": "Purges all cached data associated with a specific cache tag. Used for on-demand revalidation with fetch's next.tags option.",
+      "type": "function",
+      "module": "next/cache",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/revalidateTag"
+    },
+    "unstable_cache": {
+      "signature": "function unstable_cache<T>(fn: (...args: any[]) => Promise<T>, keyParts?: string[], options?: { revalidate?: number; tags?: string[] }): (...args: any[]) => Promise<T>",
+      "description": "Wraps an async function to cache its return value. Supports revalidation period and cache tags for on-demand revalidation.",
+      "type": "function",
+      "module": "next/cache",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/unstable_cache"
+    },
+    "generateMetadata": {
+      "signature": "async function generateMetadata(props: { params: Params; searchParams: SearchParams }, parent: ResolvingMetadata): Promise<Metadata>",
+      "description": "Generates dynamic metadata for a page based on route params and search params. Can access parent metadata for composition.",
+      "type": "function",
+      "module": "next",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/generate-metadata"
+    },
+    "generateStaticParams": {
+      "signature": "async function generateStaticParams(): Promise<Array<Record<string, string>>>",
+      "description": "Defines the list of route segment parameters to statically generate at build time. Used with dynamic route segments.",
+      "type": "function",
+      "module": "next",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/generate-static-params"
+    },
+    "generateViewport": {
+      "signature": "function generateViewport(props: { params: Params; searchParams: SearchParams }): Viewport | Promise<Viewport>",
+      "description": "Generates dynamic viewport configuration for a page. Returns viewport-related meta tags.",
+      "type": "function",
+      "module": "next",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/generate-viewport"
+    },
+    "Image": {
+      "signature": "function Image(props: ImageProps): JSX.Element",
+      "description": "Optimized image component extending HTML <img> with automatic optimization, lazy loading, blur placeholders, and responsive image support.",
+      "type": "component",
+      "module": "next/image",
+      "url": "https://nextjs.org/docs/app/api-reference/components/image"
+    },
+    "Link": {
+      "signature": "function Link(props: LinkProps & React.AnchorHTMLAttributes<HTMLAnchorElement>): JSX.Element",
+      "description": "Client-side navigation component extending HTML <a> with prefetching, soft navigation, and back/forward cache support.",
+      "type": "component",
+      "module": "next/link",
+      "url": "https://nextjs.org/docs/app/api-reference/components/link"
+    },
+    "Script": {
+      "signature": "function Script(props: ScriptProps): JSX.Element",
+      "description": "Optimized third-party script loading component supporting beforeInteractive, afterInteractive, lazyOnload, and worker strategies.",
+      "type": "component",
+      "module": "next/script",
+      "url": "https://nextjs.org/docs/app/api-reference/components/script"
+    },
+    "Font": {
+      "signature": "function Font(options: FontOptions): NextFont",
+      "description": "Font optimization with automatic self-hosting, zero layout shift, and built-in CSS variable support. Supports Google Fonts and local fonts.",
+      "type": "function",
+      "module": "next/font",
+      "url": "https://nextjs.org/docs/app/api-reference/components/font"
+    },
+    "dynamic": {
+      "signature": "function dynamic<P>(loader: () => Promise<React.ComponentType<P>>, options?: DynamicOptions): React.ComponentType<P>",
+      "description": "Lazy loads a component with optional SSR control and custom loading component. Useful for code splitting and reducing initial bundle size.",
+      "type": "function",
+      "module": "next/dynamic",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/dynamic"
+    },
+    "ImageResponse": {
+      "signature": "class ImageResponse extends Response",
+      "description": "Generates dynamic Open Graph images using JSX and CSS. Supports Edge runtime and Satori rendering engine.",
+      "type": "class",
+      "module": "next/og",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/image-response"
+    },
+    "middleware": {
+      "signature": "function middleware(request: NextRequest): NextResponse | Response | void",
+      "description": "Runs before every route match. Used for authentication, redirects, rewrites, header modification, and request interception.",
+      "type": "function",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/building-your-application/routing/middleware"
+    },
+    "GET": {
+      "signature": "async function GET(request: NextRequest, context: { params: Params }): Response | NextResponse",
+      "description": "Route Handler for HTTP GET requests. Supports Web Request/Response API with Next.js extensions.",
+      "type": "function",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/file-conventions/route"
+    },
+    "POST": {
+      "signature": "async function POST(request: NextRequest, context: { params: Params }): Response | NextResponse",
+      "description": "Route Handler for HTTP POST requests. Can parse JSON, FormData, and other request body formats.",
+      "type": "function",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/file-conventions/route"
+    },
+    "PUT": {
+      "signature": "async function PUT(request: NextRequest, context: { params: Params }): Response | NextResponse",
+      "description": "Route Handler for HTTP PUT requests. Used for full resource replacement operations.",
+      "type": "function",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/file-conventions/route"
+    },
+    "DELETE": {
+      "signature": "async function DELETE(request: NextRequest, context: { params: Params }): Response | NextResponse",
+      "description": "Route Handler for HTTP DELETE requests. Used for resource deletion operations.",
+      "type": "function",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/file-conventions/route"
+    },
+    "PATCH": {
+      "signature": "async function PATCH(request: NextRequest, context: { params: Params }): Response | NextResponse",
+      "description": "Route Handler for HTTP PATCH requests. Used for partial resource update operations.",
+      "type": "function",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/file-conventions/route"
+    },
+    "HEAD": {
+      "signature": "async function HEAD(request: NextRequest): Response | NextResponse",
+      "description": "Route Handler for HTTP HEAD requests. Returns only headers without response body.",
+      "type": "function",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/file-conventions/route"
+    },
+    "OPTIONS": {
+      "signature": "async function OPTIONS(request: NextRequest): Response | NextResponse",
+      "description": "Route Handler for HTTP OPTIONS requests. Used for CORS preflight requests.",
+      "type": "function",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/api-reference/file-conventions/route"
+    },
+    "getServerSideProps": {
+      "signature": "const getServerSideProps: GetServerSideProps<Props> = async (context) => { return { props } }",
+      "description": "Pages Router function that fetches data on each request for server-side rendering. Receives context with params, req, res, query.",
+      "type": "function",
+      "module": "next",
+      "url": "https://nextjs.org/docs/pages/api-reference/functions/get-server-side-props"
+    },
+    "getStaticProps": {
+      "signature": "const getStaticProps: GetStaticProps<Props> = async (context) => { return { props, revalidate? } }",
+      "description": "Pages Router function that fetches data at build time for static generation. Supports ISR with revalidate option.",
+      "type": "function",
+      "module": "next",
+      "url": "https://nextjs.org/docs/pages/api-reference/functions/get-static-props"
+    },
+    "getStaticPaths": {
+      "signature": "const getStaticPaths: GetStaticPaths = async () => { return { paths, fallback } }",
+      "description": "Pages Router function that defines dynamic routes to statically generate at build time. Used with getStaticProps.",
+      "type": "function",
+      "module": "next",
+      "url": "https://nextjs.org/docs/pages/api-reference/functions/get-static-paths"
+    },
+    "useRouter_pages": {
+      "signature": "function useRouter(): NextRouter",
+      "description": "Pages Router hook returning router object with pathname, query, asPath, locale, push, replace, prefetch, back, events.",
+      "type": "function",
+      "module": "next/router",
+      "url": "https://nextjs.org/docs/pages/api-reference/functions/use-router"
+    },
+    "NextPage": {
+      "signature": "type NextPage<P = {}, IP = P> = React.ComponentType<P> & { getInitialProps?(context: NextPageContext): IP | Promise<IP> }",
+      "description": "Type for page components in Pages Router. Generic type accepting props and initial props type parameters.",
+      "type": "type",
+      "module": "next",
+      "url": "https://nextjs.org/docs/pages/building-your-application/routing/pages-and-layouts"
+    },
+    "Metadata": {
+      "signature": "type Metadata = { title?: string | { absolute?: string; default?: string; template?: string }; description?: string; ... }",
+      "description": "Type for static and dynamic metadata configuration. Supports title, description, openGraph, twitter, icons, robots, and more.",
+      "type": "type",
+      "module": "next",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/generate-metadata#metadata-object"
+    },
+    "Viewport": {
+      "signature": "type Viewport = { themeColor?: string | ThemeColorDescriptor[]; width?: string | number; initialScale?: number; ... }",
+      "description": "Type for viewport configuration exported from pages and layouts.",
+      "type": "type",
+      "module": "next",
+      "url": "https://nextjs.org/docs/app/api-reference/functions/generate-viewport"
+    },
+    "NextConfig": {
+      "signature": "type NextConfig = { reactStrictMode?: boolean; images?: ImagesConfig; rewrites?: () => Promise<Rewrite[]>; ... }",
+      "description": "Type for next.config.js/ts configuration object. Controls build, runtime, and feature settings.",
+      "type": "type",
+      "module": "next",
+      "url": "https://nextjs.org/docs/app/api-reference/next-config-js"
+    },
+    "GetServerSideProps_type": {
+      "signature": "type GetServerSideProps<P = { [key: string]: any }> = (context: GetServerSidePropsContext) => Promise<GetServerSidePropsResult<P>>",
+      "description": "Type for the getServerSideProps function in Pages Router.",
+      "type": "type",
+      "module": "next",
+      "url": "https://nextjs.org/docs/pages/api-reference/functions/get-server-side-props"
+    },
+    "GetStaticProps_type": {
+      "signature": "type GetStaticProps<P = { [key: string]: any }> = (context: GetStaticPropsContext) => Promise<GetStaticPropsResult<P>>",
+      "description": "Type for the getStaticProps function in Pages Router.",
+      "type": "type",
+      "module": "next",
+      "url": "https://nextjs.org/docs/pages/api-reference/functions/get-static-props"
+    },
+    "GetStaticPaths_type": {
+      "signature": "type GetStaticPaths<P extends ParsedUrlQuery = ParsedUrlQuery> = () => Promise<{ paths: Array<string | { params: P }>; fallback: boolean | 'blocking' }>",
+      "description": "Type for the getStaticPaths function in Pages Router.",
+      "type": "type",
+      "module": "next",
+      "url": "https://nextjs.org/docs/pages/api-reference/functions/get-static-paths"
+    },
+    "ImageProps": {
+      "signature": "interface ImageProps extends Omit<ImgHTMLAttributes<HTMLImageElement>, 'src' | 'srcSet' | 'ref' | 'width' | 'height' | ...>",
+      "description": "Props for the Image component including src, alt, width, height, fill, sizes, quality, priority, placeholder, blurDataURL, loader.",
+      "type": "interface",
+      "module": "next/image",
+      "url": "https://nextjs.org/docs/app/api-reference/components/image#props"
+    },
+    "LinkProps": {
+      "signature": "interface LinkProps { href: string | URL; as?: string | URL; replace?: boolean; scroll?: boolean; shallow?: boolean; prefetch?: boolean; locale?: string | false; }",
+      "description": "Props for the Link component including href, replace, scroll, shallow, prefetch, and locale.",
+      "type": "interface",
+      "module": "next/link",
+      "url": "https://nextjs.org/docs/app/api-reference/components/link#props"
+    },
+    "ScriptProps": {
+      "signature": "interface ScriptProps { src?: string; strategy?: 'beforeInteractive' | 'afterInteractive' | 'lazyOnload' | 'worker'; onLoad?: () => void; onReady?: () => void; onError?: () => void; }",
+      "description": "Props for the Script component with loading strategy control and lifecycle callbacks.",
+      "type": "interface",
+      "module": "next/script",
+      "url": "https://nextjs.org/docs/app/api-reference/components/script#props"
+    },
+    "NextFont": {
+      "signature": "type NextFont = { className: string; style: { fontFamily: string; fontWeight?: number; fontStyle?: string }; variable: string; }",
+      "description": "Return type of next/font font loaders. Provides className and CSS variable for applying the font.",
+      "type": "type",
+      "module": "next/font",
+      "url": "https://nextjs.org/docs/app/api-reference/components/font"
+    },
+    "MiddlewareConfig": {
+      "signature": "type MiddlewareConfig = { matcher: string | string[] }",
+      "description": "Configuration object exported from middleware.ts to define which routes the middleware applies to.",
+      "type": "type",
+      "module": "next/server",
+      "url": "https://nextjs.org/docs/app/building-your-application/routing/middleware#matching-paths"
+    },
+    "PageProps": {
+      "signature": "type PageProps = { params: Record<string, string>; searchParams: Record<string, string | string[] | undefined> }",
+      "description": "Props received by App Router page components including dynamic route params and URL search parameters.",
+      "type": "type",
+      "module": "next",
+      "url": "https://nextjs.org/docs/app/api-reference/file-conventions/page"
+    },
+    "LayoutProps": {
+      "signature": "type LayoutProps = { children: React.ReactNode; params: Record<string, string> }",
+      "description": "Props received by App Router layout components including children and dynamic route params.",
+      "type": "type",
+      "module": "next",
+      "url": "https://nextjs.org/docs/app/api-reference/file-conventions/layout"
+    },
+    "MetadataRoute.Sitemap": {
+      "signature": "type Sitemap = Array<{ url: string; lastModified?: string | Date; changeFrequency?: ChangeFrequency; priority?: number; alternates?: { languages?: Record<string, string> } }>",
+      "description": "Return type for sitemap.ts file that generates XML sitemaps.",
+      "type": "type",
+      "module": "next",
+      "url": "https://nextjs.org/docs/app/api-reference/file-conventions/metadata/sitemap"
+    },
+    "MetadataRoute.Robots": {
+      "signature": "type Robots = { rules: RobotsRule | RobotsRule[]; sitemap?: string | string[]; host?: string }",
+      "description": "Return type for robots.ts file that generates robots.txt.",
+      "type": "type",
+      "module": "next",
+      "url": "https://nextjs.org/docs/app/api-reference/file-conventions/metadata/robots"
+    },
+    "NextApiRequest": {
+      "signature": "interface NextApiRequest extends IncomingMessage { query: Partial<Record<string, string | string[]>>; cookies: Partial<Record<string, string>>; body: any; }",
+      "description": "Pages Router API route request object extending Node.js IncomingMessage with parsed query, cookies, and body.",
+      "type": "interface",
+      "module": "next",
+      "url": "https://nextjs.org/docs/pages/building-your-application/routing/api-routes"
+    },
+    "NextApiResponse": {
+      "signature": "interface NextApiResponse<Data = any> extends ServerResponse { send(body: Data): void; json(body: Data): void; status(statusCode: number): NextApiResponse<Data>; redirect(url: string): NextApiResponse<Data>; }",
+      "description": "Pages Router API route response object with convenience methods for sending responses.",
+      "type": "interface",
+      "module": "next",
+      "url": "https://nextjs.org/docs/pages/building-your-application/routing/api-routes"
+    },
+    "useFormStatus": {
+      "signature": "function useFormStatus(): { pending: boolean; data: FormData | null; method: string | null; action: string | null }",
+      "description": "Returns the status of the parent form's last submission. Must be rendered inside a <form>. Works with Server Actions.",
+      "type": "function",
+      "module": "react-dom",
+      "url": "https://nextjs.org/docs/app/building-your-application/data-fetching/server-actions-and-mutations"
+    },
+    "useFormState": {
+      "signature": "function useFormState<State>(action: (state: State, payload: FormData) => State | Promise<State>, initialState: State): [State, (payload: FormData) => void]",
+      "description": "Manages form state based on the result of a Server Action. Returns current state and a dispatch function.",
+      "type": "function",
+      "module": "react-dom",
+      "url": "https://nextjs.org/docs/app/building-your-application/data-fetching/server-actions-and-mutations"
+    },
+    "useOptimistic": {
+      "signature": "function useOptimistic<State, Action>(state: State, updateFn: (currentState: State, optimisticValue: Action) => State): [State, (action: Action) => void]",
+      "description": "Enables optimistic UI updates while an async action (such as a Server Action) is in progress.",
+      "type": "function",
+      "module": "react",
+      "url": "https://nextjs.org/docs/app/building-your-application/data-fetching/server-actions-and-mutations"
+    }
+  }
+}