vinext 0.1.8 → 0.2.0

package/dist/shims/root-params.d.ts

@@ -3,10 +3,24 @@ type RootParams = Record<string, string | string[] | undefined>;
 type RootParamsState = {
   rootParams: RootParams | null;
 };
+type RootParamsUsage = {
+  kind: "route";
+} | {
+  kind: "server-action";
+} | {
+  kind: "route-handler";
+  routePattern: string;
+};
+type RootParamsUsageController = {
+  transitionToRender(): void;
+};
 declare function pickRootParams(params: RootParams, rootParamNames: readonly string[] | null | undefined): RootParams;
 declare function setRootParams(params: RootParams | null): void;
 declare function getRootParam(name: string): Promise<string | string[] | undefined>;
+declare function runWithRootParamsUsage<T>(usage: RootParamsUsage, fn: () => Promise<T>, controller?: RootParamsUsageController): Promise<T>;
+declare function runWithRootParamsUsage<T>(usage: RootParamsUsage, fn: () => T | Promise<T>, controller?: RootParamsUsageController): T | Promise<T>;
+declare function createRootParamsUsageController(): RootParamsUsageController;
 declare function runWithRootParamsScope<T>(params: RootParams, fn: () => Promise<T>): Promise<T>;
 declare function runWithRootParamsScope<T>(params: RootParams, fn: () => T | Promise<T>): T | Promise<T>;
 //#endregion
-export { RootParams, RootParamsState, getRootParam, pickRootParams, runWithRootParamsScope, setRootParams };
+export { RootParams, RootParamsState, RootParamsUsage, RootParamsUsageController, createRootParamsUsageController, getRootParam, pickRootParams, runWithRootParamsScope, runWithRootParamsUsage, setRootParams };

package/dist/shims/root-params.js

@@ -1,9 +1,13 @@
 import { getOrCreateAls } from "./internal/als-registry.js";
 import { getRequestContext, isInsideUnifiedScope, runWithUnifiedStateMutation } from "./unified-request-context.js";
 //#region src/shims/root-params.ts
+function createRootParamsUsageError(message) {
+	return new Error(message);
+}
 const _FALLBACK_KEY = Symbol.for("vinext.rootParams.fallback");
 const _g = globalThis;
 const _als = getOrCreateAls("vinext.rootParams.als");
+const _usageAls = getOrCreateAls("vinext.rootParams.usage.als");
 const _fallbackState = _g[_FALLBACK_KEY] ??= { rootParams: null };
 function getState() {
 	if (isInsideUnifiedScope()) return getRequestContext();
@@ -18,8 +22,24 @@ function setRootParams(params) {
 	getState().rootParams = params;
 }
 function getRootParam(name) {
+	const usage = _usageAls.getStore();
+	if (usage?.kind === "server-action" && usage.phase === "active") throw createRootParamsUsageError(`\`import('next/root-params').${name}()\` was used inside a Server Action. This is not supported. Functions from 'next/root-params' can only be called in the context of a route.`);
+	if (usage?.kind === "route-handler" && usage.phase === "active") throw createRootParamsUsageError(`Route ${usage.routePattern} used \`import('next/root-params').${name}()\` inside a Route Handler. Support for this API in Route Handlers is planned for a future version of Next.js.`);
 	return Promise.resolve(getState().rootParams?.[name]);
 }
+function runWithRootParamsUsage(usage, fn, controller) {
+	const state = {
+		...usage,
+		phase: "active"
+	};
+	if (controller) controller.transitionToRender = () => {
+		if (usage.kind === "server-action") state.phase = "render";
+	};
+	return _usageAls.run(state, fn);
+}
+function createRootParamsUsageController() {
+	return { transitionToRender() {} };
+}
 function runWithRootParamsScope(params, fn) {
 	if (isInsideUnifiedScope()) return runWithUnifiedStateMutation((ctx) => {
 		ctx.rootParams = params;
@@ -27,4 +47,4 @@ function runWithRootParamsScope(params, fn) {
 	else return _als.run({ rootParams: params }, fn);
 }
 //#endregion
-export { getRootParam, pickRootParams, runWithRootParamsScope, setRootParams };
+export { createRootParamsUsageController, getRootParam, pickRootParams, runWithRootParamsScope, runWithRootParamsUsage, setRootParams };

package/dist/shims/router.d.ts

@@ -1,4 +1,5 @@
 import { VinextNextData } from "../client/vinext-next-data.js";
+import { PagesRouterComponentsMap } from "./internal/pages-router-components.js";
 import { UrlQuery } from "../utils/query.js";
 import { ComponentType, ReactElement } from "react";
 
@@ -25,7 +26,7 @@ type NextRouter = {
   replace(url: string | UrlObject, as?: string, options?: TransitionOptions): Promise<boolean>; /** Go back */
   back(): void; /** Reload the page */
   reload(): void; /** Prefetch a page (injects <link rel="prefetch">) */
-  prefetch(url: string): Promise<void>; /** Register a callback to run before popstate navigation */
+  prefetch(url: string, as?: string): Promise<void>; /** Register a callback to run before popstate navigation */
   beforePopState(cb: BeforePopStateCallback): void; /** Listen for route changes */
   events: RouterEvents;
 };
@@ -174,16 +175,13 @@ type ExcludeRouterProps<P> = Pick<P, Exclude<keyof P, keyof WithRouterProps>>;
  */
 declare function withRouter<P extends WithRouterProps>(ComposedComponent: ComponentType<P>): ComponentType<ExcludeRouterProps<P>>;
 declare const RouterMethods: {
-  /** See `_components` comment above for the dual role this map plays. */components: {
-    [x: string]: {
-      __appRouter: true;
-    } | Record<string, unknown>;
-  };
+  /** See `_components` comment above for the dual role this map plays. */components: PagesRouterComponentsMap;
+  sdc: Record<string, Promise<Response>>;
   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: (url: string, as?: string) => Promise<void>;
   beforePopState: (cb: BeforePopStateCallback) => void;
   events: RouterEvents;
 };