@uniformdev/next-app-router 20.81.1-alpha.4.sha-de16ebeee7 → 20.81.1-alpha.41.sha-adcf82dedd

package/dist/{UniformComposition-fq7Qfhvp.d.mts → UniformResolvedComposition-Ckhza3b7.d.mts}

@@ -1,8 +1,7 @@
 import { RootComponentInstance, ComponentInstance } from '@uniformdev/canvas';
 import { ComponentProps } from '@uniformdev/next-app-router-shared';
 import React, { ComponentType } from 'react';
-import { a as ResolvedRouteResult, R as ResolveRouteFunction, D as DataClient } from './resolveRouteFromCode-CId7aItt.mjs';
-import { ClientContextComponent } from '@uniformdev/next-app-router-client';
+import { a as ResolvedRouteResult } from './composition-C7voY4YR.mjs';
 
 type CompositionCache = {
     getUniformComposition: ({ id }: {
@@ -14,19 +13,12 @@ type CompositionCache = {
         componentId: string;
     }) => ComponentInstance | null;
 };
+/**
+ * Creates a cache of the compositions rendered during a request, which components read with
+ * `getUniformComposition` and `getUniformComponent`. Each request starts empty.
+ */
 declare const createCompositionCache: () => CompositionCache;
 
-type UniformContextProps = {
-    /**
-     * Component to initialize Uniform context on the client.
-     */
-    clientContextComponent?: ClientContextComponent;
-    /**
-     * The result of the route resolution.
-     */
-    result: ResolvedRouteResult | undefined;
-};
-
 type ResolveComponentResult = {
     component: ComponentType<ComponentProps<any, any>> | null;
     includeContext?: boolean;
@@ -47,32 +39,38 @@ type ResolveComponentFunction = (options: {
     component: ComponentInstance;
 }) => ResolveComponentResult;
 type ResolveEmptyPlaceholderFunction = (options: ResolveEmptyPlaceholderOptions) => ResolveEmptyPlaceholderResult;
-type UniformCompositionProps = {
+type UniformResolvedCompositionProps = {
     /**
-     * The code to resolve the route from.
+     * The result of any resolver, passed as is. A composition renders; a redirect or not found
+     * renders nothing. To redirect or return a 404 instead, pass the result through
+     * `requireComposition` first.
      */
-    code: string;
-    /**
-     * Function to resolve the route from the code.
-     */
-    resolveRoute: ResolveRouteFunction;
+    result: ResolvedRouteResult;
     /**
      * Function to map composition components to React components.
      */
     resolveComponent: ResolveComponentFunction;
-    /**
-     * Resolves the route for the code. Defaults to `DefaultDataClient`.
-     */
-    dataClient?: DataClient;
     /**
      * Function to map empty placeholders to React components.
      */
     resolveEmptyPlaceholder?: ResolveEmptyPlaceholderFunction;
+    /**
+     * Marks the page's primary composition. It sets the composition metadata of the visitor's
+     * context, which Uniform Insights attributes page hits and goals to, and the default consent
+     * from its page state. In the editor and draft states it also loads the contextual editing
+     * script. Set it on one composition per page.
+     */
+    pageComposition?: boolean;
     /**
      * Composition cache, will be used to cache the composition.
      */
     compositionCache?: CompositionCache;
-} & Pick<UniformContextProps, 'clientContextComponent'>;
-declare function UniformComposition({ code, ...props }: UniformCompositionProps): React.JSX.Element;
+};
+/**
+ * Renders a resolved composition, or nothing when the result is a redirect or not found. Render it
+ * before the root layout's `UniformContext`, and set `pageComposition` on the page's primary
+ * composition.
+ */
+declare function UniformResolvedComposition(props: UniformResolvedCompositionProps): React.JSX.Element;
 
-export { type CompositionCache as C, type ResolveComponentResult as R, type UniformCompositionProps as U, type ResolveComponentFunction as a, UniformComposition as b, createCompositionCache as c };
+export { type CompositionCache as C, type ResolveComponentResult as R, type UniformResolvedCompositionProps as U, type ResolveComponentFunction as a, UniformResolvedComposition as b, createCompositionCache as c };

package/dist/{UniformComposition-T7CRvU1H.d.ts → UniformResolvedComposition-Dr73WwIO.d.ts}

@@ -1,8 +1,7 @@
 import { RootComponentInstance, ComponentInstance } from '@uniformdev/canvas';
 import { ComponentProps } from '@uniformdev/next-app-router-shared';
 import React, { ComponentType } from 'react';
-import { a as ResolvedRouteResult, R as ResolveRouteFunction, D as DataClient } from './resolveRouteFromCode-CId7aItt.js';
-import { ClientContextComponent } from '@uniformdev/next-app-router-client';
+import { a as ResolvedRouteResult } from './composition-C7voY4YR.js';
 
 type CompositionCache = {
     getUniformComposition: ({ id }: {
@@ -14,19 +13,12 @@ type CompositionCache = {
         componentId: string;
     }) => ComponentInstance | null;
 };
+/**
+ * Creates a cache of the compositions rendered during a request, which components read with
+ * `getUniformComposition` and `getUniformComponent`. Each request starts empty.
+ */
 declare const createCompositionCache: () => CompositionCache;
 
-type UniformContextProps = {
-    /**
-     * Component to initialize Uniform context on the client.
-     */
-    clientContextComponent?: ClientContextComponent;
-    /**
-     * The result of the route resolution.
-     */
-    result: ResolvedRouteResult | undefined;
-};
-
 type ResolveComponentResult = {
     component: ComponentType<ComponentProps<any, any>> | null;
     includeContext?: boolean;
@@ -47,32 +39,38 @@ type ResolveComponentFunction = (options: {
     component: ComponentInstance;
 }) => ResolveComponentResult;
 type ResolveEmptyPlaceholderFunction = (options: ResolveEmptyPlaceholderOptions) => ResolveEmptyPlaceholderResult;
-type UniformCompositionProps = {
+type UniformResolvedCompositionProps = {
     /**
-     * The code to resolve the route from.
+     * The result of any resolver, passed as is. A composition renders; a redirect or not found
+     * renders nothing. To redirect or return a 404 instead, pass the result through
+     * `requireComposition` first.
      */
-    code: string;
-    /**
-     * Function to resolve the route from the code.
-     */
-    resolveRoute: ResolveRouteFunction;
+    result: ResolvedRouteResult;
     /**
      * Function to map composition components to React components.
      */
     resolveComponent: ResolveComponentFunction;
-    /**
-     * Resolves the route for the code. Defaults to `DefaultDataClient`.
-     */
-    dataClient?: DataClient;
     /**
      * Function to map empty placeholders to React components.
      */
     resolveEmptyPlaceholder?: ResolveEmptyPlaceholderFunction;
+    /**
+     * Marks the page's primary composition. It sets the composition metadata of the visitor's
+     * context, which Uniform Insights attributes page hits and goals to, and the default consent
+     * from its page state. In the editor and draft states it also loads the contextual editing
+     * script. Set it on one composition per page.
+     */
+    pageComposition?: boolean;
     /**
      * Composition cache, will be used to cache the composition.
      */
     compositionCache?: CompositionCache;
-} & Pick<UniformContextProps, 'clientContextComponent'>;
-declare function UniformComposition({ code, ...props }: UniformCompositionProps): React.JSX.Element;
+};
+/**
+ * Renders a resolved composition, or nothing when the result is a redirect or not found. Render it
+ * before the root layout's `UniformContext`, and set `pageComposition` on the page's primary
+ * composition.
+ */
+declare function UniformResolvedComposition(props: UniformResolvedCompositionProps): React.JSX.Element;
 
-export { type CompositionCache as C, type ResolveComponentResult as R, type UniformCompositionProps as U, type ResolveComponentFunction as a, UniformComposition as b, createCompositionCache as c };
+export { type CompositionCache as C, type ResolveComponentResult as R, type UniformResolvedCompositionProps as U, type ResolveComponentFunction as a, UniformResolvedComposition as b, createCompositionCache as c };

package/dist/akamai.d.mts

@@ -0,0 +1,106 @@
+import { Quirks } from '@uniformdev/context';
+import { UniformServerConfig, RewriteRequestPathResult } from '@uniformdev/next-app-router-shared';
+import { U as UniformEdgeMiddlewareOptions } from './createEdgeRouteStore-DaU9QjP2.mjs';
+export { c as createEdgeRouteStore } from './createEdgeRouteStore-DaU9QjP2.mjs';
+import { HandleOptions } from './middleware.mjs';
+export { U as UNIFORM_EDGE_ORIGIN_HEADER, c as createStaticEdgeRouteFilter, l as learnedEdgeRouteFilter } from './learnedEdgeRouteFilter-DWg-puGg.mjs';
+import 'next/server';
+import './models-kIvBB7Tv.mjs';
+import './createPreviewGETRouteHandler-ii7w-gAc.mjs';
+
+/** The request an EdgeWorker event handler of `akamaiUniformEdgeWorker` receives. */
+type AkamaiRequest = EW.IngressClientRequest | EW.ResponseProviderRequest | EW.EgressClientRequest;
+
+/** Skips `responseProvider` for the request when `onClientRequest` sets it to `true`. */
+declare const AKAMAI_BYPASS_RESPONSE_PROVIDER_VARIABLE = "PMUSER_BYPASS_EW_RP_EVENT";
+type AkamaiUniformEdgeWorkerOptions = Pick<UniformEdgeMiddlewareOptions, 'manifest' | 'filter' | 'store' | 'etags'> & Pick<HandleOptions, 'rewriteDestinationPath' | 'queryStrings' | 'release' | 'quirks' | 'defaultConsent' | 'locale'> & {
+    /**
+     * The app's server config, the default export of `uniform.server.config.ts`. Pass the origin's
+     * config, so the worker builds the codes and the visitor's Context the way the app does.
+     *
+     * @defaultValue the default config
+     */
+    config?: UniformServerConfig;
+    /**
+     * Returns the route path, and the keys, to resolve for the request. The path includes the
+     * query string.
+     *
+     * @defaultValue the request path and query string
+     */
+    rewriteRequestPath?: (options: {
+        request: AkamaiRequest;
+        path: string;
+        query: string;
+    }) => Promise<RewriteRequestPathResult | undefined>;
+    /**
+     * Builds the quirks the visitor's Context and the browser get from the request. `quirks` are
+     * added on top.
+     *
+     * @defaultValue `buildAkamaiQuirks`, the visitor's Akamai location
+     */
+    buildQuirks?: (request: AkamaiRequest) => Quirks;
+    /**
+     * Whether the worker rewrites the request path. Other requests reach the origin untouched.
+     *
+     * @defaultValue every path except `/api`, `/_next/static`, `/_next/image`, `/favicon.ico`,
+     * `/sitemap.xml` and `/robots.txt`, like the Next.js middleware matcher of the Uniform examples
+     */
+    matcher?: (path: string) => boolean;
+    /**
+     * Called when the manifest provider throws, when processing fails before the response starts,
+     * and when the NESI transform fails. Without it, the last two are logged with the EdgeWorkers
+     * `logger`.
+     *
+     * A provider failure receives the error, and the worker chooses with an empty manifest:
+     * personalizations show their defaults, and the browser chooses tests after hydration.
+     *
+     * A failure before the response starts, such as the `filter` throwing or the fetch of the page
+     * failing, receives the error, and the visitor gets the page without edge mode, so the browser
+     * chooses the variants.
+     *
+     * A transform failure also receives the decoded HTML chunk that triggered it, when available,
+     * and the response ends at the point of failure.
+     */
+    onError?: UniformEdgeMiddlewareOptions['onError'];
+};
+/**
+ * Returns the event handlers of an Akamai EdgeWorker in front of a Next.js app that uses Uniform.
+ * The worker does what `uniformEdgeMiddleware` does in the app: it rewrites each published route
+ * to its `/uniform/{code}` page, and keeps only the visitor's variants of pages in edge mode. Akamai
+ * caches each page once for every visitor.
+ *
+ * - `onClientRequest` rewrites client navigations, prefetches, other methods and pages the
+ *   `filter` skips with `route()`, and leaves HTML document requests for pages in edge mode to
+ *   `responseProvider`. Requests in draft mode, paths `matcher` excludes and the worker's own
+ *   fetches reach the origin untouched, where the app's middleware handles them.
+ * - `responseProvider` fetches the page in edge mode through Akamai and streams it through the NESI
+ *   transform, with the ETags `serveEdgePage` describes.
+ * - `onClientResponse` hands the quirks to the browser in the `ufqc` cookie.
+ *
+ * Export all three from the bundle's `main.js`. The property needs the user-defined variable
+ * `PMUSER_BYPASS_EW_RP_EVENT`, with `false` as its initial value, so `onClientRequest` can skip
+ * `responseProvider`. The app's middleware lets the rewritten requests through, since they carry
+ * `UNIFORM_EDGE_ORIGIN_HEADER`.
+ *
+ * Mark the EdgeWorkers modules `cookies`, `create-response`, `crypto`, `encoding`, `http-request`,
+ * `log`, `streams` and `url-search-params` external in the bundler. `encoding` and `crypto` also
+ * name an npm package and a Node module, which do not run on EdgeWorkers.
+ *
+ * EdgeWorkers has no `waitUntil`, so a `store` write that is still pending when the response ends
+ * may be lost. A manifest provider may only fetch from hosts Akamai serves; pass a manifest baked
+ * into the bundle to avoid fetching it.
+ */
+declare const akamaiUniformEdgeWorker: ({ config, manifest, filter, store, etags, onError, rewriteRequestPath, rewriteDestinationPath, queryStrings, release, quirks: customQuirks, defaultConsent: defaultConsentOption, locale, buildQuirks, matcher, }: AkamaiUniformEdgeWorkerOptions) => {
+    onClientRequest: (request: EW.IngressClientRequest) => Promise<void>;
+    responseProvider: (request: EW.ResponseProviderRequest) => Promise<object>;
+    onClientResponse: (request: EW.EgressClientRequest, response: EW.EgressClientResponse) => void;
+};
+
+/**
+ * Builds quirks from the visitor's Akamai location, named like those of
+ * `@uniformdev/context-edge-akamai`: `aka-loc-continent`, `aka-loc-country`, `aka-loc-region` and
+ * `aka-loc-city`. Locations Akamai cannot supply are left out.
+ */
+declare const buildAkamaiQuirks: (request: AkamaiRequest) => Quirks;
+
+export { AKAMAI_BYPASS_RESPONSE_PROVIDER_VARIABLE, type AkamaiRequest, type AkamaiUniformEdgeWorkerOptions, akamaiUniformEdgeWorker, buildAkamaiQuirks };

package/dist/akamai.d.ts

@@ -0,0 +1,106 @@
+import { Quirks } from '@uniformdev/context';
+import { UniformServerConfig, RewriteRequestPathResult } from '@uniformdev/next-app-router-shared';
+import { U as UniformEdgeMiddlewareOptions } from './createEdgeRouteStore-B2ugix2E.js';
+export { c as createEdgeRouteStore } from './createEdgeRouteStore-B2ugix2E.js';
+import { HandleOptions } from './middleware.js';
+export { U as UNIFORM_EDGE_ORIGIN_HEADER, c as createStaticEdgeRouteFilter, l as learnedEdgeRouteFilter } from './learnedEdgeRouteFilter-i9hELx_t.js';
+import 'next/server';
+import './models-kIvBB7Tv.js';
+import './createPreviewGETRouteHandler-ii7w-gAc.js';
+
+/** The request an EdgeWorker event handler of `akamaiUniformEdgeWorker` receives. */
+type AkamaiRequest = EW.IngressClientRequest | EW.ResponseProviderRequest | EW.EgressClientRequest;
+
+/** Skips `responseProvider` for the request when `onClientRequest` sets it to `true`. */
+declare const AKAMAI_BYPASS_RESPONSE_PROVIDER_VARIABLE = "PMUSER_BYPASS_EW_RP_EVENT";
+type AkamaiUniformEdgeWorkerOptions = Pick<UniformEdgeMiddlewareOptions, 'manifest' | 'filter' | 'store' | 'etags'> & Pick<HandleOptions, 'rewriteDestinationPath' | 'queryStrings' | 'release' | 'quirks' | 'defaultConsent' | 'locale'> & {
+    /**
+     * The app's server config, the default export of `uniform.server.config.ts`. Pass the origin's
+     * config, so the worker builds the codes and the visitor's Context the way the app does.
+     *
+     * @defaultValue the default config
+     */
+    config?: UniformServerConfig;
+    /**
+     * Returns the route path, and the keys, to resolve for the request. The path includes the
+     * query string.
+     *
+     * @defaultValue the request path and query string
+     */
+    rewriteRequestPath?: (options: {
+        request: AkamaiRequest;
+        path: string;
+        query: string;
+    }) => Promise<RewriteRequestPathResult | undefined>;
+    /**
+     * Builds the quirks the visitor's Context and the browser get from the request. `quirks` are
+     * added on top.
+     *
+     * @defaultValue `buildAkamaiQuirks`, the visitor's Akamai location
+     */
+    buildQuirks?: (request: AkamaiRequest) => Quirks;
+    /**
+     * Whether the worker rewrites the request path. Other requests reach the origin untouched.
+     *
+     * @defaultValue every path except `/api`, `/_next/static`, `/_next/image`, `/favicon.ico`,
+     * `/sitemap.xml` and `/robots.txt`, like the Next.js middleware matcher of the Uniform examples
+     */
+    matcher?: (path: string) => boolean;
+    /**
+     * Called when the manifest provider throws, when processing fails before the response starts,
+     * and when the NESI transform fails. Without it, the last two are logged with the EdgeWorkers
+     * `logger`.
+     *
+     * A provider failure receives the error, and the worker chooses with an empty manifest:
+     * personalizations show their defaults, and the browser chooses tests after hydration.
+     *
+     * A failure before the response starts, such as the `filter` throwing or the fetch of the page
+     * failing, receives the error, and the visitor gets the page without edge mode, so the browser
+     * chooses the variants.
+     *
+     * A transform failure also receives the decoded HTML chunk that triggered it, when available,
+     * and the response ends at the point of failure.
+     */
+    onError?: UniformEdgeMiddlewareOptions['onError'];
+};
+/**
+ * Returns the event handlers of an Akamai EdgeWorker in front of a Next.js app that uses Uniform.
+ * The worker does what `uniformEdgeMiddleware` does in the app: it rewrites each published route
+ * to its `/uniform/{code}` page, and keeps only the visitor's variants of pages in edge mode. Akamai
+ * caches each page once for every visitor.
+ *
+ * - `onClientRequest` rewrites client navigations, prefetches, other methods and pages the
+ *   `filter` skips with `route()`, and leaves HTML document requests for pages in edge mode to
+ *   `responseProvider`. Requests in draft mode, paths `matcher` excludes and the worker's own
+ *   fetches reach the origin untouched, where the app's middleware handles them.
+ * - `responseProvider` fetches the page in edge mode through Akamai and streams it through the NESI
+ *   transform, with the ETags `serveEdgePage` describes.
+ * - `onClientResponse` hands the quirks to the browser in the `ufqc` cookie.
+ *
+ * Export all three from the bundle's `main.js`. The property needs the user-defined variable
+ * `PMUSER_BYPASS_EW_RP_EVENT`, with `false` as its initial value, so `onClientRequest` can skip
+ * `responseProvider`. The app's middleware lets the rewritten requests through, since they carry
+ * `UNIFORM_EDGE_ORIGIN_HEADER`.
+ *
+ * Mark the EdgeWorkers modules `cookies`, `create-response`, `crypto`, `encoding`, `http-request`,
+ * `log`, `streams` and `url-search-params` external in the bundler. `encoding` and `crypto` also
+ * name an npm package and a Node module, which do not run on EdgeWorkers.
+ *
+ * EdgeWorkers has no `waitUntil`, so a `store` write that is still pending when the response ends
+ * may be lost. A manifest provider may only fetch from hosts Akamai serves; pass a manifest baked
+ * into the bundle to avoid fetching it.
+ */
+declare const akamaiUniformEdgeWorker: ({ config, manifest, filter, store, etags, onError, rewriteRequestPath, rewriteDestinationPath, queryStrings, release, quirks: customQuirks, defaultConsent: defaultConsentOption, locale, buildQuirks, matcher, }: AkamaiUniformEdgeWorkerOptions) => {
+    onClientRequest: (request: EW.IngressClientRequest) => Promise<void>;
+    responseProvider: (request: EW.ResponseProviderRequest) => Promise<object>;
+    onClientResponse: (request: EW.EgressClientRequest, response: EW.EgressClientResponse) => void;
+};
+
+/**
+ * Builds quirks from the visitor's Akamai location, named like those of
+ * `@uniformdev/context-edge-akamai`: `aka-loc-continent`, `aka-loc-country`, `aka-loc-region` and
+ * `aka-loc-city`. Locations Akamai cannot supply are left out.
+ */
+declare const buildAkamaiQuirks: (request: AkamaiRequest) => Quirks;
+
+export { AKAMAI_BYPASS_RESPONSE_PROVIDER_VARIABLE, type AkamaiRequest, type AkamaiUniformEdgeWorkerOptions, akamaiUniformEdgeWorker, buildAkamaiQuirks };