@uniformdev/next-app-router 20.80.2 → 20.81.1-alpha.10.sha-def425616f

package/dist/middleware.d.mts

@@ -1,17 +1,15 @@
-import { Quirks } from '@uniformdev/context';
+import { Quirks, ManifestV2, Context } from '@uniformdev/context';
 import { RewriteRequestPathResult, PageState } from '@uniformdev/next-app-router-shared';
 import { NextRequest, NextResponse } from 'next/server';
-import { D as DataClient } from './client-BElN_CWD.mjs';
-import '@uniformdev/canvas';
 
 type RewriteOptions = {
     source: 'route' | 'playground';
     /**
-     * The code that was generated from the evaluated composition.
+     * The code the middleware generated for the request.
      */
     code: string;
     /**
-     * The page state that was generated from the evaluated composition.
+     * The page state the code serializes.
      */
     pageState: PageState;
 };
@@ -32,13 +30,12 @@ type HandleOptions = {
      */
     rewriteDestinationPath?: (options: RewriteOptions) => Promise<string>;
     /**
-     * If provided, the middleware will only precompute the runnables for the paths that match the patterns.
+     * Query strings that belong in the route path, keyed by path pattern, for example
+     * `{ '/products/:slug': ['color'] }`. The page resolves the route from the route path, so list
+     * the query strings your project map nodes declare. Other query strings are left out of the
+     * code, so marketing parameters like `utm_campaign` do not create a page per value.
      */
-    pathPatternsWithVariations?: string[];
-    /**
-     * If provided, the middleware will use the data client to retrieve data.
-     */
-    dataClient?: DataClient;
+    queryStrings?: Record<string, string[]>;
     /**
      * Release ID to resolve the route from.
      */
@@ -62,13 +59,63 @@ type HandleOptions = {
      */
     locale?: string;
 };
+type ResolveUniformRequestOptions = HandleOptions & {
+    request: NextRequest;
+    /**
+     * Decides whether a published page renders its personalizations and tests for the edge to
+     * choose from. The answer is stored as `edgeMode` in the page state before the code is built.
+     * Not called for draft requests, which never use edge mode.
+     */
+    edgeMode?: (options: {
+        pageState: PageState;
+    }) => boolean | Promise<boolean>;
+};
+type ResolveUniformRequestResult = {
+    /** The request is answered directly, such as a playground request without an id. */
+    type: 'response';
+    response: NextResponse;
+} | {
+    /** The request should be rewritten to `destination`. */
+    type: 'rewrite';
+    /** Path to rewrite to, relative to the request origin, for example `/uniform/{code}`. */
+    destination: string;
+    pageState: PageState;
+    /** The serialized page state, the `[code]` path segment. */
+    code: string;
+    /** Headers to add to the response, such as the `ufqc` quirk cookie. */
+    headers: Headers;
+    /** Whether Next.js draft mode is on for this request. */
+    draftModeEnabled: boolean;
+    /**
+     * Creates the visitor's Context from the given manifest, updated with the request URL,
+     * cookies and quirks.
+     */
+    createContext: (options: {
+        manifest: ManifestV2;
+    }) => Promise<Context>;
+};
+/**
+ * Returns middleware that rewrites each request to `/uniform/{code}`, where the page resolves the
+ * route. Personalizations, tests and visibility rules are evaluated in the browser.
+ */
 declare const uniformMiddleware: (options?: HandleOptions) => (request: NextRequest) => Promise<NextResponse<unknown>>;
-declare const handleUniformRoute: ({ request, dataClient, ...options }: HandleOptions & {
+/**
+ * Rewrites the request to the page for its code, or answers it directly when
+ * {@link resolveUniformRequest} returns a response.
+ */
+declare const handleUniformRoute: (options: HandleOptions & {
     request: NextRequest;
 }) => Promise<NextResponse<unknown>>;
+/**
+ * Builds the code for the request without producing the final response, so other middleware
+ * (such as the edge middleware) can decide how to serve the rewrite. Makes no network requests:
+ * the code carries the route path and state, and the page resolves the route, including redirects
+ * and not found. Every visitor of a route gets the same code.
+ */
+declare const resolveUniformRequest: ({ request, edgeMode, ...options }: ResolveUniformRequestOptions) => Promise<ResolveUniformRequestResult>;
 declare const determinePreviewMode: ({ searchParams, isDraftModeEnabled, }: {
     searchParams: URLSearchParams;
     isDraftModeEnabled: boolean;
 }) => "preview" | "editor" | undefined;
 
-export { type HandleOptions, type RequestInfo, type RewriteOptions, type RewriteRequestPathOptions, determinePreviewMode, handleUniformRoute, uniformMiddleware };
+export { type HandleOptions, type RequestInfo, type ResolveUniformRequestOptions, type ResolveUniformRequestResult, type RewriteOptions, type RewriteRequestPathOptions, determinePreviewMode, handleUniformRoute, resolveUniformRequest, uniformMiddleware };

package/dist/middleware.d.ts

@@ -1,17 +1,15 @@
-import { Quirks } from '@uniformdev/context';
+import { Quirks, ManifestV2, Context } from '@uniformdev/context';
 import { RewriteRequestPathResult, PageState } from '@uniformdev/next-app-router-shared';
 import { NextRequest, NextResponse } from 'next/server';
-import { D as DataClient } from './client-BElN_CWD.js';
-import '@uniformdev/canvas';
 
 type RewriteOptions = {
     source: 'route' | 'playground';
     /**
-     * The code that was generated from the evaluated composition.
+     * The code the middleware generated for the request.
      */
     code: string;
     /**
-     * The page state that was generated from the evaluated composition.
+     * The page state the code serializes.
      */
     pageState: PageState;
 };
@@ -32,13 +30,12 @@ type HandleOptions = {
      */
     rewriteDestinationPath?: (options: RewriteOptions) => Promise<string>;
     /**
-     * If provided, the middleware will only precompute the runnables for the paths that match the patterns.
+     * Query strings that belong in the route path, keyed by path pattern, for example
+     * `{ '/products/:slug': ['color'] }`. The page resolves the route from the route path, so list
+     * the query strings your project map nodes declare. Other query strings are left out of the
+     * code, so marketing parameters like `utm_campaign` do not create a page per value.
      */
-    pathPatternsWithVariations?: string[];
-    /**
-     * If provided, the middleware will use the data client to retrieve data.
-     */
-    dataClient?: DataClient;
+    queryStrings?: Record<string, string[]>;
     /**
      * Release ID to resolve the route from.
      */
@@ -62,13 +59,63 @@ type HandleOptions = {
      */
     locale?: string;
 };
+type ResolveUniformRequestOptions = HandleOptions & {
+    request: NextRequest;
+    /**
+     * Decides whether a published page renders its personalizations and tests for the edge to
+     * choose from. The answer is stored as `edgeMode` in the page state before the code is built.
+     * Not called for draft requests, which never use edge mode.
+     */
+    edgeMode?: (options: {
+        pageState: PageState;
+    }) => boolean | Promise<boolean>;
+};
+type ResolveUniformRequestResult = {
+    /** The request is answered directly, such as a playground request without an id. */
+    type: 'response';
+    response: NextResponse;
+} | {
+    /** The request should be rewritten to `destination`. */
+    type: 'rewrite';
+    /** Path to rewrite to, relative to the request origin, for example `/uniform/{code}`. */
+    destination: string;
+    pageState: PageState;
+    /** The serialized page state, the `[code]` path segment. */
+    code: string;
+    /** Headers to add to the response, such as the `ufqc` quirk cookie. */
+    headers: Headers;
+    /** Whether Next.js draft mode is on for this request. */
+    draftModeEnabled: boolean;
+    /**
+     * Creates the visitor's Context from the given manifest, updated with the request URL,
+     * cookies and quirks.
+     */
+    createContext: (options: {
+        manifest: ManifestV2;
+    }) => Promise<Context>;
+};
+/**
+ * Returns middleware that rewrites each request to `/uniform/{code}`, where the page resolves the
+ * route. Personalizations, tests and visibility rules are evaluated in the browser.
+ */
 declare const uniformMiddleware: (options?: HandleOptions) => (request: NextRequest) => Promise<NextResponse<unknown>>;
-declare const handleUniformRoute: ({ request, dataClient, ...options }: HandleOptions & {
+/**
+ * Rewrites the request to the page for its code, or answers it directly when
+ * {@link resolveUniformRequest} returns a response.
+ */
+declare const handleUniformRoute: (options: HandleOptions & {
     request: NextRequest;
 }) => Promise<NextResponse<unknown>>;
+/**
+ * Builds the code for the request without producing the final response, so other middleware
+ * (such as the edge middleware) can decide how to serve the rewrite. Makes no network requests:
+ * the code carries the route path and state, and the page resolves the route, including redirects
+ * and not found. Every visitor of a route gets the same code.
+ */
+declare const resolveUniformRequest: ({ request, edgeMode, ...options }: ResolveUniformRequestOptions) => Promise<ResolveUniformRequestResult>;
 declare const determinePreviewMode: ({ searchParams, isDraftModeEnabled, }: {
     searchParams: URLSearchParams;
     isDraftModeEnabled: boolean;
 }) => "preview" | "editor" | undefined;
 
-export { type HandleOptions, type RequestInfo, type RewriteOptions, type RewriteRequestPathOptions, determinePreviewMode, handleUniformRoute, uniformMiddleware };
+export { type HandleOptions, type RequestInfo, type ResolveUniformRequestOptions, type ResolveUniformRequestResult, type RewriteOptions, type RewriteRequestPathOptions, determinePreviewMode, handleUniformRoute, resolveUniformRequest, uniformMiddleware };