vinext 0.0.49 → 0.0.51

package/dist/shims/router-state.js.map

@@ -1 +1 @@
-{"version":3,"file":"router-state.js","names":[],"sources":["../../src/shims/router-state.ts"],"sourcesContent":["/**\n * Server-only Pages Router state backed by AsyncLocalStorage.\n *\n * Provides request-scoped isolation for SSR context (pathname, query,\n * locale) so concurrent requests on Workers don't share state.\n *\n * This module is server-only — it imports node:async_hooks and must NOT\n * be bundled for the browser.\n */\n\nimport { _registerRouterStateAccessors } from \"./router.js\";\nimport { getOrCreateAls } from \"./internal/als-registry.js\";\nimport {\n  getRequestContext,\n  isInsideUnifiedScope,\n  runWithUnifiedStateMutation,\n} from \"./unified-request-context.js\";\n\n// ---------------------------------------------------------------------------\n// ALS setup\n// ---------------------------------------------------------------------------\n\nexport type SSRContext = {\n  pathname: string;\n  query: Record<string, string | string[]>;\n  asPath: string;\n  locale?: string;\n  locales?: string[];\n  defaultLocale?: string;\n};\n\nexport type RouterState = {\n  ssrContext: SSRContext | null;\n};\n\nconst _FALLBACK_KEY = Symbol.for(\"vinext.router.fallback\");\nconst _g = globalThis as unknown as Record<PropertyKey, unknown>;\nconst _als = getOrCreateAls<RouterState>(\"vinext.router.als\");\n\nconst _fallbackState = (_g[_FALLBACK_KEY] ??= {\n  ssrContext: null,\n} satisfies RouterState) as RouterState;\n\nfunction _getState(): RouterState {\n  if (isInsideUnifiedScope()) {\n    return getRequestContext();\n  }\n  return _als.getStore() ?? _fallbackState;\n}\n\n/**\n * Run a function within a router state ALS scope.\n * Ensures per-request isolation for Pages Router SSR context\n * on concurrent runtimes.\n */\nexport function runWithRouterState<T>(fn: () => Promise<T>): Promise<T>;\nexport function runWithRouterState<T>(fn: () => T | Promise<T>): T | Promise<T>;\nexport function runWithRouterState<T>(fn: () => T | Promise<T>): T | Promise<T> {\n  if (isInsideUnifiedScope()) {\n    return runWithUnifiedStateMutation((uCtx) => {\n      uCtx.ssrContext = null;\n    }, fn);\n  }\n\n  const state: RouterState = {\n    ssrContext: null,\n  };\n  return _als.run(state, fn);\n}\n\n// ---------------------------------------------------------------------------\n// Register ALS-backed accessors into router.ts\n// ---------------------------------------------------------------------------\n\n_registerRouterStateAccessors({\n  getSSRContext(): SSRContext | null {\n    return _getState().ssrContext;\n  },\n\n  setSSRContext(ctx: SSRContext | null): void {\n    _getState().ssrContext = ctx;\n  },\n});\n"],"mappings":";;;;;;;;;;;;;AAmCA,MAAM,gBAAgB,OAAO,IAAI,yBAAyB;AAC1D,MAAM,KAAK;AACX,MAAM,OAAO,eAA4B,oBAAoB;AAE7D,MAAM,iBAAkB,GAAG,mBAAmB,EAC5C,YAAY,MACb;AAED,SAAS,YAAyB;AAChC,KAAI,sBAAsB,CACxB,QAAO,mBAAmB;AAE5B,QAAO,KAAK,UAAU,IAAI;;AAU5B,SAAgB,mBAAsB,IAA0C;AAC9E,KAAI,sBAAsB,CACxB,QAAO,6BAA6B,SAAS;AAC3C,OAAK,aAAa;IACjB,GAAG;AAMR,QAAO,KAAK,IAHe,EACzB,YAAY,MACb,EACsB,GAAG;;AAO5B,8BAA8B;CAC5B,gBAAmC;AACjC,SAAO,WAAW,CAAC;;CAGrB,cAAc,KAA8B;AAC1C,aAAW,CAAC,aAAa;;CAE5B,CAAC"}
+{"version":3,"file":"router-state.js","names":[],"sources":["../../src/shims/router-state.ts"],"sourcesContent":["/**\n * Server-only Pages Router state backed by AsyncLocalStorage.\n *\n * Provides request-scoped isolation for SSR context (pathname, query,\n * locale) so concurrent requests on Workers don't share state.\n *\n * This module is server-only — it imports node:async_hooks and must NOT\n * be bundled for the browser.\n */\n\nimport { _registerRouterStateAccessors } from \"./router.js\";\nimport { getOrCreateAls } from \"./internal/als-registry.js\";\nimport {\n  getRequestContext,\n  isInsideUnifiedScope,\n  runWithUnifiedStateMutation,\n} from \"./unified-request-context.js\";\n\n// ---------------------------------------------------------------------------\n// ALS setup\n// ---------------------------------------------------------------------------\n\nexport type SSRContext = {\n  pathname: string;\n  query: Record<string, string | string[]>;\n  asPath: string;\n  locale?: string;\n  locales?: string[];\n  defaultLocale?: string;\n};\n\nexport type RouterState = {\n  ssrContext: SSRContext | null;\n};\n\nconst _FALLBACK_KEY = Symbol.for(\"vinext.router.fallback\");\nconst _g = globalThis as unknown as Record<PropertyKey, unknown>;\nconst _als = getOrCreateAls<RouterState>(\"vinext.router.als\");\n\nconst _fallbackState = (_g[_FALLBACK_KEY] ??= {\n  ssrContext: null,\n} satisfies RouterState) as RouterState;\n\nfunction _getState(): RouterState {\n  if (isInsideUnifiedScope()) {\n    return getRequestContext();\n  }\n  return _als.getStore() ?? _fallbackState;\n}\n\n/**\n * Run a function within a router state ALS scope.\n * Ensures per-request isolation for Pages Router SSR context\n * on concurrent runtimes.\n */\nexport function runWithRouterState<T>(fn: () => Promise<T>): Promise<T>;\nexport function runWithRouterState<T>(fn: () => T | Promise<T>): T | Promise<T>;\nexport function runWithRouterState<T>(fn: () => T | Promise<T>): T | Promise<T> {\n  if (isInsideUnifiedScope()) {\n    return runWithUnifiedStateMutation((uCtx) => {\n      uCtx.ssrContext = null;\n    }, fn);\n  }\n\n  const state: RouterState = {\n    ssrContext: null,\n  };\n  return _als.run(state, fn);\n}\n\n// ---------------------------------------------------------------------------\n// Register ALS-backed accessors into router.ts\n// ---------------------------------------------------------------------------\n\n_registerRouterStateAccessors({\n  getSSRContext(): SSRContext | null {\n    return _getState().ssrContext;\n  },\n\n  setSSRContext(ctx: SSRContext | null): void {\n    _getState().ssrContext = ctx;\n  },\n});\n"],"mappings":";;;;;;;;;;;;;AAmCA,MAAM,gBAAgB,OAAO,IAAI,yBAAyB;AAC1D,MAAM,KAAK;AACX,MAAM,OAAO,eAA4B,oBAAoB;AAE7D,MAAM,iBAAkB,GAAG,mBAAmB,EAC5C,YAAY,MACb;AAED,SAAS,YAAyB;CAChC,IAAI,sBAAsB,EACxB,OAAO,mBAAmB;CAE5B,OAAO,KAAK,UAAU,IAAI;;AAU5B,SAAgB,mBAAsB,IAA0C;CAC9E,IAAI,sBAAsB,EACxB,OAAO,6BAA6B,SAAS;EAC3C,KAAK,aAAa;IACjB,GAAG;CAMR,OAAO,KAAK,IAAI,EAFd,YAAY,MAEO,EAAE,GAAG;;AAO5B,8BAA8B;CAC5B,gBAAmC;EACjC,OAAO,WAAW,CAAC;;CAGrB,cAAc,KAA8B;EAC1C,WAAW,CAAC,aAAa;;CAE5B,CAAC"}

package/dist/shims/router.d.ts

@@ -1,6 +1,6 @@
 import { VinextNextData } from "../client/vinext-next-data.js";
 import { UrlQuery } from "../utils/query.js";
-import { ReactElement } from "react";
+import { ComponentType, ReactElement } from "react";
 
 //#region src/shims/router.d.ts
 type BeforePopStateCallback = (state: {
@@ -75,29 +75,91 @@ declare function _registerRouterStateAccessors(accessors: {
   setSSRContext: (ctx: SSRContext | null) => void;
 }): void;
 declare function setSSRContext(ctx: SSRContext | null): void;
+type PagesNavigationContextShape = {
+  pathname: string;
+  searchParams: URLSearchParams;
+  params: Record<string, string | string[]>;
+};
+/**
+ * Cross-router compat shim source for `next/navigation` hooks.
+ *
+ * Returns the current Pages Router state shaped as a navigation context so
+ * the App Router hooks (useParams/useSearchParams/usePathname) can act as
+ * compat shims when invoked inside a Pages Router render. Mirrors Next.js's
+ * `adaptForPathParams` and `adaptForSearchParams` in
+ * .nextjs-ref/packages/next/src/shared/lib/router/adapters.tsx, which Next.js
+ * uses to populate SearchParamsContext / PathParamsContext for the Pages
+ * Router (see packages/next/src/server/render.tsx and
+ * packages/next/src/client/index.tsx).
+ *
+ * Returns `null` when there is no Pages Router state available — e.g. App
+ * Router pages, RSC-only renders, or pre-router renders. Callers should
+ * treat null as "App Router context, use normal app-router state".
+ */
+declare function getPagesNavigationContext(): PagesNavigationContextShape | null;
+/** Inject a `<link rel="prefetch">` for the target page. */
+declare function prefetchUrl(url: string): Promise<void>;
 /**
  * useRouter hook - Pages Router compatible.
+ *
+ * Ported from Next.js: packages/next/src/client/router.ts
+ * https://github.com/vercel/next.js/blob/canary/packages/next/src/client/router.ts
  */
 declare function useRouter(): NextRouter;
 /**
  * Wrap a React element in a RouterContext.Provider so that
  * next/compat/router's useRouter() returns the real Pages Router value.
  *
- * This is a plain function, NOT a React component — it builds the router
- * value object directly from the current SSR context (server) or
- * window.location + Router singleton (client), avoiding duplicate state
- * that a hook-based component would create.
+ * The provider owns the reactive Pages Router snapshot so next/router and
+ * next/compat/router consumers share one context value instead of each hook
+ * installing its own global URL-change listener.
  */
 declare function wrapWithRouterContext(element: ReactElement): ReactElement;
+/**
+ * Props injected by `withRouter` into the wrapped component.
+ *
+ * Ported from Next.js: packages/next/src/client/with-router.tsx
+ * https://github.com/vercel/next.js/blob/canary/packages/next/src/client/with-router.tsx
+ */
+type WithRouterProps = {
+  router: NextRouter;
+};
+/**
+ * Pick<P, Exclude<keyof P, keyof WithRouterProps>> — the props of the
+ * composed component minus the `router` prop that `withRouter` injects.
+ *
+ * Ported from Next.js: packages/next/src/client/with-router.tsx
+ */
+type ExcludeRouterProps<P> = Pick<P, Exclude<keyof P, keyof WithRouterProps>>;
+/**
+ * Higher-order component that injects the Pages Router `router` instance as
+ * a `router` prop into a wrapped component. Primarily used by class
+ * components (which cannot call hooks) to access the router. The wrapped
+ * component receives the same props as the original, minus `router`, which
+ * is filled in by the HOC.
+ *
+ * Ported from Next.js: packages/next/src/client/with-router.tsx
+ * https://github.com/vercel/next.js/blob/canary/packages/next/src/client/with-router.tsx
+ *
+ * Differences from Next.js:
+ * - We type the composed component as `ComponentType<P>` instead of
+ *   `NextComponentType<C, any, P>` because vinext does not expose
+ *   `NextComponentType` from this shim. The runtime shape (and the props
+ *   the wrapper forwards) is identical.
+ * - We forward `getInitialProps` and `origGetInitialProps` from the
+ *   composed component so `_app` parity holds for class components that
+ *   define `getInitialProps`.
+ */
+declare function withRouter<P extends WithRouterProps>(ComposedComponent: ComponentType<P>): ComponentType<ExcludeRouterProps<P>>;
 declare const Router: {
   push: (url: string | UrlObject, as?: string, options?: TransitionOptions) => Promise<boolean>;
   replace: (url: string | UrlObject, as?: string, options?: TransitionOptions) => Promise<boolean>;
   back: () => void;
   reload: () => void;
-  prefetch: (url: string) => Promise<void>;
+  prefetch: typeof prefetchUrl;
   beforePopState: (cb: BeforePopStateCallback) => void;
   events: RouterEvents;
 };
 //#endregion
-export { NextRouter, _registerRouterStateAccessors, applyNavigationLocale, Router as default, isExternalUrl, isHashOnlyChange, setSSRContext, useRouter, wrapWithRouterContext };
+export { ExcludeRouterProps, NextRouter, WithRouterProps, _registerRouterStateAccessors, applyNavigationLocale, Router as default, getPagesNavigationContext, isExternalUrl, isHashOnlyChange, setSSRContext, useRouter, withRouter, wrapWithRouterContext };
 //# sourceMappingURL=router.d.ts.map