vinext 0.1.4 → 0.1.5

package/dist/shims/navigation.d.ts

@@ -2,57 +2,12 @@ import { AppRouterScrollIntent } from "./app-router-scroll-state.js";
 import { NavigationRuntimeVisibleCommitMode } from "../client/navigation-runtime.js";
 import { AppRouterInstance, NavigateOptions, PrefetchOptions as PrefetchOptions$1 } from "./internal/app-router-context.js";
 import { ReadonlyURLSearchParams } from "./readonly-url-search-params.js";
+import { GLOBAL_ACCESSORS_KEY, NavigationContext, NavigationStateAccessors, SegmentMap, ServerInsertedHTMLContext, _registerStateAccessors, clearServerInsertedHTML, flushServerInsertedHTML, getBfcacheIdMapContext, getBfcacheSegmentIdContext, getLayoutSegmentContext, getNavigationContext, renderServerInsertedHTML, setNavigationContext } from "./navigation-context-state.js";
+import { BailoutToCSRError, DynamicServerError, HTTP_ERROR_FALLBACK_ERROR_CODE, RedirectType, decodeRedirectError, forbidden, getAccessFallbackHTTPStatus, isBailoutToCSRError, isDynamicServerError, isHTTPAccessFallbackError, isNextRouterError, isRedirectError, notFound, permanentRedirect, redirect, unauthorized, unstable_rethrow } from "./navigation-errors.js";
 import { UnrecognizedActionError, unstable_isUnrecognizedActionError } from "./unrecognized-action-error.js";
 import * as React$1 from "react";
 
 //#region src/shims/navigation.d.ts
-/**
- * Map of parallel route key → child segments below the current layout.
- * The "children" key is always present (the default parallel route).
- * Named parallel routes add their own keys (e.g., "team", "analytics").
- *
- * Arrays are mutable (`string[]`) to match Next.js's public API return type
- * without requiring `as` casts. The map itself is Readonly — no key addition.
- */
-type SegmentMap = Readonly<Record<string, string[]>> & {
-  readonly children: string[];
-};
-declare const ServerInsertedHTMLContext: React$1.Context<((callback: () => unknown) => void) | null> | null;
-/**
- * Get or create the layout segment context.
- * Returns null in the RSC environment (createContext unavailable).
- */
-declare function getLayoutSegmentContext(): React$1.Context<SegmentMap> | null;
-declare function getBfcacheIdMapContext(): React$1.Context<Readonly<Record<string, string>> | null> | null;
-declare function getBfcacheSegmentIdContext(): React$1.Context<string | null> | null;
-type NavigationContext = {
-  pathname: string;
-  searchParams: URLSearchParams;
-  params: Record<string, string | string[]>;
-};
-type _StateAccessors = {
-  getServerContext: () => NavigationContext | null;
-  setServerContext: (ctx: NavigationContext | null) => void;
-  getInsertedHTMLCallbacks: () => Array<() => unknown>;
-  clearInsertedHTMLCallbacks: () => void;
-};
-declare const GLOBAL_ACCESSORS_KEY: unique symbol;
-/**
- * Register ALS-backed state accessors. Called by navigation-state.ts on import.
- * @internal
- */
-declare function _registerStateAccessors(accessors: _StateAccessors): void;
-/**
- * Get the navigation context for the current SSR/RSC render.
- * Reads from AsyncLocalStorage when available (concurrent-safe),
- * otherwise falls back to module-level state.
- */
-declare function getNavigationContext(): NavigationContext | null;
-/**
- * Set the navigation context for the current SSR/RSC render.
- * Called by the framework entry before rendering each request.
- */
-declare function setNavigationContext(ctx: NavigationContext | null): void;
 /** basePath from next.config.js, injected by the plugin at build time */
 declare const __basePath: string;
 /** Maximum number of entries in the RSC prefetch cache. */
@@ -327,248 +282,5 @@ declare function useSelectedLayoutSegments(parallelRoutesKey?: string): string[]
  *   });
  */
 declare function useServerInsertedHTML(callback: () => unknown): void;
-/**
- * Flush all collected useServerInsertedHTML callbacks.
- * Returns an array of results (React elements or strings).
- * Clears the callback list so the next render starts fresh.
- *
- * Called by the SSR entry after renderToReadableStream completes.
- */
-declare function flushServerInsertedHTML(): unknown[];
-/**
- * Render collected useServerInsertedHTML callbacks without unregistering them.
- *
- * Streaming SSR needs to invoke the same style-registry callbacks after each
- * Fizz flush. Libraries such as styled-components and Emotion clear their own
- * per-flush buffers inside the callback; the registration itself must survive
- * until the request stream is closed.
- */
-declare function renderServerInsertedHTML(): unknown[];
-/**
- * Clear all collected useServerInsertedHTML callbacks without flushing.
- * Used for cleanup between requests.
- */
-declare function clearServerInsertedHTML(): void;
-/**
- * HTTP Access Fallback error code — shared prefix for notFound/forbidden/unauthorized.
- * Matches Next.js 16's unified error handling approach.
- */
-declare const HTTP_ERROR_FALLBACK_ERROR_CODE = "NEXT_HTTP_ERROR_FALLBACK";
-/**
- * Check if an error is an HTTP Access Fallback error (notFound, forbidden, unauthorized).
- */
-declare function isHTTPAccessFallbackError(error: unknown): boolean;
-/**
- * Extract the HTTP status code from an HTTP Access Fallback error.
- * Returns 404 for legacy NEXT_NOT_FOUND errors.
- */
-declare function getAccessFallbackHTTPStatus(error: unknown): number;
-/**
- * Enum matching Next.js RedirectType for type-safe redirect calls.
- */
-declare enum RedirectType {
-  push = "push",
-  replace = "replace"
-}
-/**
- * Throw a redirect. Caught by the framework to send a redirect response.
- *
- * When `type` is omitted, the digest carries an empty sentinel so the
- * catch site can resolve the default based on context:
- * - Server Action context → "push"  (Back button works after form submission)
- * - SSR render context    → "replace"
- *
- * This matches Next.js behavior where `redirect()` checks
- * `actionAsyncStorage.getStore()?.isAction` at call time.
- *
- * @see https://github.com/vercel/next.js/blob/canary/packages/next/src/client/components/redirect.ts
- */
-declare function redirect(url: string, type?: "replace" | "push" | RedirectType): never;
-/**
- * Trigger a permanent redirect (308).
- *
- * Accepts an optional `type` parameter matching Next.js's signature.
- * Defaults to "replace" (not context-dependent like `redirect()`).
- *
- * @see https://github.com/vercel/next.js/blob/canary/packages/next/src/client/components/redirect.ts
- */
-declare function permanentRedirect(url: string, type?: "replace" | "push" | RedirectType): never;
-/**
- * Trigger a not-found response (404). Caught by the framework.
- */
-declare function notFound(): never;
-/**
- * Trigger a forbidden response (403). Caught by the framework.
- * In Next.js, this is gated behind experimental.authInterrupts — we
- * support it unconditionally for maximum compatibility.
- */
-declare function forbidden(): never;
-/**
- * Trigger an unauthorized response (401). Caught by the framework.
- * In Next.js, this is gated behind experimental.authInterrupts — we
- * support it unconditionally for maximum compatibility.
- */
-declare function unauthorized(): never;
-type _RedirectErrorShape = Error & {
-  digest: string;
-};
-/**
- * Check whether an error was produced by `redirect()` or `permanentRedirect()`.
- *
- * **Note on vinext public surface:** Next.js does NOT expose `isRedirectError`
- * from `next/navigation` — it's an internal predicate. vinext exposes it for
- * symmetry with the already-public `isHTTPAccessFallbackError` and because
- * `unstable_rethrow` consumers benefit from being able to narrow types.
- * Treat it as a vinext-only extension.
- *
- * **Divergence from Next.js:** Next.js's internal `isRedirectError` performs
- * full 4-segment validation — it splits the digest on `;`, checks `type` ∈
- * {push, replace}, requires a non-empty destination, and validates the
- * status code (303, 307, 308). See:
- *   https://github.com/vercel/next.js/blob/canary/packages/next/src/client/components/redirect-error.ts
- *
- * vinext instead uses a simple prefix check (`startsWith("NEXT_REDIRECT;")`).
- * Reasons:
- *   1. vinext emits two digest shapes — 3-part for `redirect()`
- *      (`NEXT_REDIRECT;{type};{encoded-url}`) and 4-part for
- *      `permanentRedirect()` (`NEXT_REDIRECT;{type};{encoded-url};308`).
- *      Strict validation would have to special-case both, and Next.js's
- *      validator (tuned to its 5-part canary digests) rejects them.
- *   2. The `type` field is sometimes empty in vinext's redirect digests
- *      (context-dependent resolution; see `redirect()` above), which the
- *      strict check disallows.
- *
- * **Consequence:** A malformed digest such as `"NEXT_REDIRECT;garbage"`
- * returns `true` here, whereas Next.js would return `false`. In practice,
- * the only callers of this predicate are vinext-internal code paths
- * (`unstable_rethrow`, `unstable_catchError`, the redirect error boundary)
- * that see digests vinext itself emits — so the divergence does not surface
- * in normal use. Maintainers extending the prefix logic should keep this
- * predicate in lockstep with the corresponding `decode*` helpers in
- * `shims/error-boundary.tsx`.
- */
-declare function isRedirectError(error: unknown): error is _RedirectErrorShape;
-/**
- * Parse a redirect error digest into its URL and type components.
- *
- * Supports two formats:
- *   - vinext's 3-part: `NEXT_REDIRECT;{type};{encoded-url}`
- *   - Next.js's 5-part: `NEXT_REDIRECT;{type};{url};{status};{isClient}`
- *
- * The URL segment is always percent-encoded on the write side
- * (encodeURIComponent is used), so re-joining with ";" for the 5-part
- * format is defensive — it correctly handles any unencoded ";" that
- * might appear in an externally-sourced digest.
- *
- * Returns null for malformed digests that have an empty URL segment, or
- * when the URL contains invalid percent-encoding.
- */
-declare function decodeRedirectError(digest: string): {
-  url: string;
-  type: "push" | "replace";
-} | null;
-/**
- * Returns true if the error is a Next.js navigation signal — either a redirect
- * or an HTTP access fallback (notFound / forbidden / unauthorized).
- *
- * **Note on vinext public surface:** Like `isRedirectError`, Next.js does NOT
- * expose this from `next/navigation`. vinext exposes it for symmetry — treat
- * it as a vinext-only extension.
- *
- * Ported from Next.js:
- *   https://github.com/vercel/next.js/blob/canary/packages/next/src/client/components/is-next-router-error.ts
- */
-declare function isNextRouterError(error: unknown): boolean;
-declare const _BAILOUT_TO_CSR_DIGEST = "BAILOUT_TO_CLIENT_SIDE_RENDERING";
-/**
- * Error thrown to bail out of server rendering and fall back to client-side
- * rendering. Used by `next/dynamic` with `ssr: false`.
- *
- * vinext does not yet emit this error itself — it's exposed so user code and
- * third-party libraries that mimic `next/dynamic`'s bailout semantics can
- * construct an error with the canonical digest that `unstable_rethrow`
- * recognises.
- *
- * Ported 1:1 from Next.js:
- *   https://github.com/vercel/next.js/blob/canary/packages/next/src/shared/lib/lazy-dynamic/bailout-to-csr.ts
- */
-declare class BailoutToCSRError extends Error {
-  readonly digest: typeof _BAILOUT_TO_CSR_DIGEST;
-  readonly reason: string;
-  constructor(reason: string);
-}
-/**
- * Returns true if the error is a `BailoutToCSRError`. Matches Next.js's
- * digest-based predicate, so any error from a foreign module instance of
- * the class (or constructed manually with the canonical digest) is also
- * detected.
- *
- * **Note on vinext public surface:** Next.js does NOT expose this from
- * `next/navigation`. vinext exposes it for symmetry with `isRedirectError`
- * — treat it as a vinext-only extension. The matching producer
- * (`BailoutToCSRError`) is the public detection contract; Next.js exposes
- * neither.
- *
- * Ported from Next.js:
- *   https://github.com/vercel/next.js/blob/canary/packages/next/src/shared/lib/lazy-dynamic/bailout-to-csr.ts
- */
-declare function isBailoutToCSRError(error: unknown): error is BailoutToCSRError;
-declare const _DYNAMIC_SERVER_USAGE_DIGEST = "DYNAMIC_SERVER_USAGE";
-/**
- * Error thrown when dynamic server APIs (`cookies()`, `headers()`, etc.) are
- * used inside a static/prerender context. Carries the `DYNAMIC_SERVER_USAGE`
- * digest so `unstable_rethrow` can recognise and propagate it.
- *
- * vinext does not construct this error itself — exposed for the same
- * "stable detection contract" reason as `BailoutToCSRError` above.
- *
- * Ported 1:1 from Next.js:
- *   https://github.com/vercel/next.js/blob/canary/packages/next/src/client/components/hooks-server-context.ts
- */
-declare class DynamicServerError extends Error {
-  readonly digest: typeof _DYNAMIC_SERVER_USAGE_DIGEST;
-  readonly description: string;
-  constructor(description: string);
-}
-/**
- * Returns true if the error is a `DynamicServerError` (or any error with the
- * canonical `DYNAMIC_SERVER_USAGE` digest).
- *
- * **Note on vinext public surface:** Next.js does NOT expose this from
- * `next/navigation`. vinext exposes it for symmetry — treat it as a
- * vinext-only extension.
- *
- * Ported from Next.js:
- *   https://github.com/vercel/next.js/blob/canary/packages/next/src/client/components/hooks-server-context.ts
- */
-declare function isDynamicServerError(error: unknown): error is DynamicServerError;
-/**
- * Rethrow internal Next.js errors so they're handled by the framework.
- *
- * When wrapping an API that uses errors for control flow (redirect, notFound,
- * cookies in static render, `next/dynamic` SSR bailout, etc.), call this
- * inside `catch` blocks before doing your own error handling. If the error
- * is a Next.js internal error, it's rethrown; otherwise this is a no-op
- * (apart from recursing through `error.cause`).
- *
- * Recognises (matches Next.js's browser build + the subset of the server
- * build that vinext can realistically encounter):
- *   - `isNextRouterError`: redirect / notFound / forbidden / unauthorized
- *   - `isBailoutToCSRError`: `next/dynamic` `ssr: false` bailout
- *   - `isDynamicServerError`: dynamic API used in static render
- *
- * vinext does not yet recognise four additional server-only Next.js
- * categories — `isDynamicPostpone`, `isPostpone`,
- * `isHangingPromiseRejectionError`, `isPrerenderInterruptedError` — because
- * they signal PPR / prerender-controller events that vinext's render
- * pipeline does not generate. User code cannot construct these in normal
- * use; they will be added if/when vinext grows PPR support.
- *
- * Ported from Next.js:
- *   https://github.com/vercel/next.js/blob/canary/packages/next/src/client/components/unstable-rethrow.ts
- *   https://github.com/vercel/next.js/blob/canary/packages/next/src/client/components/unstable-rethrow.server.ts
- *   https://github.com/vercel/next.js/blob/canary/packages/next/src/client/components/unstable-rethrow.browser.ts
- */
-declare function unstable_rethrow(error: unknown): void;
 //#endregion
-export { BailoutToCSRError, CachedRscResponse, ClientNavigationRenderSnapshot, DynamicServerError, GLOBAL_ACCESSORS_KEY, HTTP_ERROR_FALLBACK_ERROR_CODE, MAX_PREFETCH_CACHE_SIZE, NavigationContext, PREFETCH_CACHE_TTL, PrefetchCacheEntry, PrefetchOptions, ReadonlyURLSearchParams, RedirectType, SegmentMap, ServerInsertedHTMLContext, UnrecognizedActionError, __basePath, _registerStateAccessors, activateNavigationSnapshot, appRouterInstance, applyAppRouterScrollFallback, clearPendingPathname, clearServerInsertedHTML, commitClientNavigationState, consumePrefetchResponse, consumePrefetchResponseForNavigation, createCachedRscResponseSnapshot, createClientNavigationRenderSnapshot, createSnapshotPathAndSearch, decodeRedirectError, flushServerInsertedHTML, forbidden, getAccessFallbackHTTPStatus, getBfcacheIdMapContext, getBfcacheSegmentIdContext, getClientNavigationRenderContext, getClientNavigationState, getClientParams, getCurrentInterceptionContext, getCurrentNextUrl, getLayoutSegmentContext, getMountedSlotsHeader, getNavigationContext, getPrefetchCache, getPrefetchInterceptionContext, getPrefetchedUrls, hasPrefetchCacheEntryForNavigation, invalidatePrefetchCache, isBailoutToCSRError, isDynamicServerError, isHTTPAccessFallbackError, isNextRouterError, isRedirectError, navigateClientSide, notFound, permanentRedirect, prefetchRscResponse, pushHistoryStateWithoutNotify, redirect, renderServerInsertedHTML, replaceClientParamsWithoutNotify, replaceHistoryStateWithoutNotify, resolveCachedRscResponseExpiresAt, resolveCachedRscResponseTtlMs, resolvePrefetchCacheEntryMountedSlotsHeader, restoreRscResponse, saveScrollPosition, setClientParams, setMountedSlotsHeader, setNavigationContext, setPendingPathname, snapshotRscResponse, storePrefetchResponse, unauthorized, unstable_isUnrecognizedActionError, unstable_rethrow, useClientNavigationRenderSnapshot, useParams, usePathname, useRouter, useSearchParams, useSelectedLayoutSegment, useSelectedLayoutSegments, useServerInsertedHTML };
+export { BailoutToCSRError, CachedRscResponse, ClientNavigationRenderSnapshot, DynamicServerError, GLOBAL_ACCESSORS_KEY, HTTP_ERROR_FALLBACK_ERROR_CODE, MAX_PREFETCH_CACHE_SIZE, type NavigationContext, type NavigationStateAccessors, PREFETCH_CACHE_TTL, PrefetchCacheEntry, PrefetchOptions, ReadonlyURLSearchParams, RedirectType, type SegmentMap, ServerInsertedHTMLContext, UnrecognizedActionError, __basePath, _registerStateAccessors, activateNavigationSnapshot, appRouterInstance, applyAppRouterScrollFallback, clearPendingPathname, clearServerInsertedHTML, commitClientNavigationState, consumePrefetchResponse, consumePrefetchResponseForNavigation, createCachedRscResponseSnapshot, createClientNavigationRenderSnapshot, createSnapshotPathAndSearch, decodeRedirectError, flushServerInsertedHTML, forbidden, getAccessFallbackHTTPStatus, getBfcacheIdMapContext, getBfcacheSegmentIdContext, getClientNavigationRenderContext, getClientNavigationState, getClientParams, getCurrentInterceptionContext, getCurrentNextUrl, getLayoutSegmentContext, getMountedSlotsHeader, getNavigationContext, getPrefetchCache, getPrefetchInterceptionContext, getPrefetchedUrls, hasPrefetchCacheEntryForNavigation, invalidatePrefetchCache, isBailoutToCSRError, isDynamicServerError, isHTTPAccessFallbackError, isNextRouterError, isRedirectError, navigateClientSide, notFound, permanentRedirect, prefetchRscResponse, pushHistoryStateWithoutNotify, redirect, renderServerInsertedHTML, replaceClientParamsWithoutNotify, replaceHistoryStateWithoutNotify, resolveCachedRscResponseExpiresAt, resolveCachedRscResponseTtlMs, resolvePrefetchCacheEntryMountedSlotsHeader, restoreRscResponse, saveScrollPosition, setClientParams, setMountedSlotsHeader, setNavigationContext, setPendingPathname, snapshotRscResponse, storePrefetchResponse, unauthorized, unstable_isUnrecognizedActionError, unstable_rethrow, useClientNavigationRenderSnapshot, useParams, usePathname, useRouter, useSearchParams, useSelectedLayoutSegment, useSelectedLayoutSegments, useServerInsertedHTML };