@uniformdev/next-app-router 20.81.1-alpha.29.sha-2124c4c450 → 20.81.1-alpha.38.sha-299feccf62

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

@@ -13,6 +13,10 @@ 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 ResolveComponentResult = {
@@ -50,15 +54,22 @@ type UniformResolvedCompositionProps = {
      * 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;
 };
 /**
- * Renders a resolved composition, or nothing when the result is a redirect or not found. Wrap the
- * page's compositions in one `UniformContext`, which initializes Uniform context on the client and
- * loads the contextual editing script.
+ * 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;
 

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

@@ -13,6 +13,10 @@ 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 ResolveComponentResult = {
@@ -50,15 +54,22 @@ type UniformResolvedCompositionProps = {
      * 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;
 };
 /**
- * Renders a resolved composition, or nothing when the result is a redirect or not found. Wrap the
- * page's compositions in one `UniformContext`, which initializes Uniform context on the client and
- * loads the contextual editing script.
+ * 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;
 

package/dist/cache.d.mts

@@ -1,16 +1,18 @@
-import { R as ResolveCompositionByIdOptions, a as ResolveCompositionBySlugOptions, b as ResolveRouteFromCodeOptions, c as ResolveRouteFromPathOptions } from './resolveRouteFromPath-C62DO3_K.mjs';
+import { R as ResolveCompositionByIdOptions, a as ResolveCompositionBySlugOptions, b as ResolveRouteFromCodeOptions, c as ResolveRouteFromPathOptions } from './resolveRouteFromPath-DWNRjFHQ.mjs';
 import { R as ResolvedCompositionResult, a as ResolvedRouteResult } from './composition-C7voY4YR.mjs';
 import '@uniformdev/next-app-router-shared';
 import '@uniformdev/canvas';
 
 /**
  * `resolveRouteFromCode` inside a `'use cache'` scope for published content, tagged with the
- * route path and the resolved composition id. Other states resolve uncached.
+ * project map patterns that can match the route path and the resolved composition id. Other
+ * states resolve uncached.
  */
 declare const resolveRouteFromCode: ({ code, }: ResolveRouteFromCodeOptions) => Promise<ResolvedRouteResult>;
 /**
- * `resolveRouteFromPath` inside a `'use cache'` scope for published content, tagged with the path
- * and the resolved composition id. Other states resolve uncached.
+ * `resolveRouteFromPath` inside a `'use cache'` scope for published content, tagged with the
+ * project map patterns that can match the path and the resolved composition id. Other states
+ * resolve uncached.
  */
 declare const resolveRouteFromPath: ({ path, ...source }: ResolveRouteFromPathOptions) => Promise<ResolvedRouteResult>;
 /**

package/dist/cache.d.ts

@@ -1,16 +1,18 @@
-import { R as ResolveCompositionByIdOptions, a as ResolveCompositionBySlugOptions, b as ResolveRouteFromCodeOptions, c as ResolveRouteFromPathOptions } from './resolveRouteFromPath-BVy72a9s.js';
+import { R as ResolveCompositionByIdOptions, a as ResolveCompositionBySlugOptions, b as ResolveRouteFromCodeOptions, c as ResolveRouteFromPathOptions } from './resolveRouteFromPath-BpuMu5ZS.js';
 import { R as ResolvedCompositionResult, a as ResolvedRouteResult } from './composition-C7voY4YR.js';
 import '@uniformdev/next-app-router-shared';
 import '@uniformdev/canvas';
 
 /**
  * `resolveRouteFromCode` inside a `'use cache'` scope for published content, tagged with the
- * route path and the resolved composition id. Other states resolve uncached.
+ * project map patterns that can match the route path and the resolved composition id. Other
+ * states resolve uncached.
  */
 declare const resolveRouteFromCode: ({ code, }: ResolveRouteFromCodeOptions) => Promise<ResolvedRouteResult>;
 /**
- * `resolveRouteFromPath` inside a `'use cache'` scope for published content, tagged with the path
- * and the resolved composition id. Other states resolve uncached.
+ * `resolveRouteFromPath` inside a `'use cache'` scope for published content, tagged with the
+ * project map patterns that can match the path and the resolved composition id. Other states
+ * resolve uncached.
  */
 declare const resolveRouteFromPath: ({ path, ...source }: ResolveRouteFromPathOptions) => Promise<ResolvedRouteResult>;
 /**

package/dist/cache.js

@@ -1135,10 +1135,56 @@ var import_cache5 = require("next/cache");
 
 // src/utils/tag.ts
 var encodePathForTag = (path) => path.split("/").map((segment) => /[^\x00-\x7F]/.test(segment) ? encodeURIComponent(segment) : segment).join("/");
-var buildPathTag = (path) => {
-  const actualPath = path.startsWith("/") ? path : `/${path}`;
-  return `path:${encodePathForTag(actualPath)}`.toLowerCase();
+var ROUTE_TAG = "route";
+var FETCH_CACHED_ROUTE_TAG = "route-fetch";
+var COMPOSITIONS_TAG = "compositions";
+var MAX_SHAPE_SEGMENTS = 4;
+var DYNAMIC_SEGMENT = ":";
+var MAX_TAG_LENGTH = 256;
+var hashString = (value) => {
+  let hash = 2166136261;
+  for (let i = 0; i < value.length; i++) {
+    hash ^= value.charCodeAt(i);
+    hash = Math.imul(hash, 16777619);
+  }
+  return (hash >>> 0).toString(16);
 };
+var limitTagLength = (tag) => tag.length > MAX_TAG_LENGTH ? `${tag.slice(0, MAX_TAG_LENGTH - 9)}#${hashString(tag)}` : tag;
+var toTagSegments = (path) => {
+  var _a;
+  return encodePathForTag((_a = path.split("?")[0]) != null ? _a : "").toLowerCase().split("/").filter(Boolean);
+};
+var buildShapes = (segments) => segments.reduce(
+  (shapes, segment) => shapes.flatMap((shape) => [
+    [...shape, segment],
+    [...shape, DYNAMIC_SEGMENT]
+  ]),
+  [[]]
+);
+var buildShapeTag = (shape, segmentCount) => {
+  const deeper = segmentCount > shape.length ? `/+${segmentCount - shape.length}` : "";
+  return limitTagLength(`route-shape:/${shape.join("/")}${deeper}`);
+};
+var buildSubtreeTag = (shape) => limitTagLength(`route-subtree:/${shape.join("/")}`);
+var buildRouteShapeTags = (path) => {
+  const segments = toTagSegments(path);
+  return buildShapes(segments.slice(0, MAX_SHAPE_SEGMENTS)).map(
+    (shape) => buildShapeTag(shape, segments.length)
+  );
+};
+var buildRouteSubtreeTags = (path) => {
+  const segments = toTagSegments(path);
+  const prefixLengths = Math.min(segments.length, MAX_SHAPE_SEGMENTS + 1);
+  return Array.from(
+    { length: prefixLengths },
+    (_, length) => buildShapes(segments.slice(0, length)).map(buildSubtreeTag)
+  ).flat();
+};
+var buildRouteTags = (path) => [
+  ROUTE_TAG,
+  ...buildRouteShapeTags(path),
+  ...buildRouteSubtreeTags(path)
+];
 var buildCompositionTag = (compositionId) => {
   return `composition:${compositionId}`.toLowerCase();
 };
@@ -1147,19 +1193,7 @@ var buildCompositionSlugTag = (slug) => {
 };
 
 // src/clients/tags.ts
-var generateRouteCacheTags = ({ path }) => {
-  const tags = ["route"];
-  if (path) {
-    const pathWithoutQuery = path.split("?")[0];
-    const pieces = pathWithoutQuery.split("/");
-    for (let i = 0; i < pieces.length; i++) {
-      const segmentPieces = pieces.slice(0, i + 1);
-      const segment = segmentPieces.join("/");
-      tags.push(buildPathTag(segment));
-    }
-  }
-  return tags;
-};
+var generateRouteCacheTags = ({ path }) => buildRouteTags(path);
 
 // src/clients/canvas.ts
 var import_server_only = require("server-only");
@@ -1423,7 +1457,7 @@ var buildCanvasClientOptions = (options) => {
       } else {
         requestedUrl = new URL(req.url);
       }
-      const tags = [];
+      const tags = [COMPOSITIONS_TAG];
       if (requestedUrl) {
         const compositionIdKey = "compositionId";
         const compositionIdsKey = "compositionIDs";
@@ -1467,7 +1501,7 @@ var getCompositionDeliveryClient = (options) => {
 // src/clients/route.ts
 var import_server_only2 = require("server-only");
 var getRouteCacheTags = (requestedUrl) => {
-  const tags = ["route"];
+  const tags = [ROUTE_TAG];
   if (requestedUrl) {
     const pathKey = "path";
     const path = requestedUrl.searchParams.get(pathKey);
@@ -1496,8 +1530,11 @@ var getRouteClient = (options) => {
       } else {
         requestedUrl = new URL(req.url);
       }
-      const tags = getRouteCacheTags(requestedUrl);
       const { cache: fetchCache, revalidate } = determineFetchCacheOptions(cache);
+      const tags = [
+        ...getRouteCacheTags(requestedUrl),
+        ...fetchCache === "no-cache" || fetchCache === "no-store" ? [] : [FETCH_CACHED_ROUTE_TAG]
+      ];
       return fetch(req, {
         ...init,
         headers: {
@@ -1598,10 +1635,32 @@ var DataClient = class {
 var import_next_app_router_shared = require("@uniformdev/next-app-router-shared");
 var deserializePageState = ({ code }) => (0, import_next_app_router_shared.deserializeEvaluationResult)({ input: code });
 
+// src/config/helpers.ts
+var import_resolved = __toESM(require("@uniformdev/next-app-router/config/resolved"));
+var getDefaultConsent = () => {
+  if (typeof import_resolved.default.defaultConsent === "boolean") {
+    return import_resolved.default.defaultConsent;
+  }
+  return false;
+};
+
 // src/data/pageStateFromSource.ts
 var pageStateFromSource = (source) => {
-  var _a;
-  return (_a = source.pageState) != null ? _a : deserializePageState({ code: source.code });
+  if (source.pageState) {
+    return source.pageState;
+  }
+  if (source.code !== void 0) {
+    return deserializePageState({ code: source.code });
+  }
+  return {
+    compositionState: CANVAS_PUBLISHED_STATE,
+    routePath: "/",
+    keys: void 0,
+    releaseId: void 0,
+    defaultConsent: getDefaultConsent(),
+    previewMode: void 0,
+    locale: void 0
+  };
 };
 
 // src/data/resolveCompositionForPageState.ts
@@ -1697,6 +1756,7 @@ var resolveCompositionCached = async (pageState, selector, matchedRoute) => {
       dataClient: createScopeDataClient()
     }),
     [
+      COMPOSITIONS_TAG,
       "compositionId" in selector ? buildCompositionTag(selector.compositionId) : buildCompositionSlugTag(selector.slug)
     ]
   );

package/dist/cache.mjs

@@ -1119,10 +1119,56 @@ import { cacheTag } from "next/cache";
 
 // src/utils/tag.ts
 var encodePathForTag = (path) => path.split("/").map((segment) => /[^\x00-\x7F]/.test(segment) ? encodeURIComponent(segment) : segment).join("/");
-var buildPathTag = (path) => {
-  const actualPath = path.startsWith("/") ? path : `/${path}`;
-  return `path:${encodePathForTag(actualPath)}`.toLowerCase();
+var ROUTE_TAG = "route";
+var FETCH_CACHED_ROUTE_TAG = "route-fetch";
+var COMPOSITIONS_TAG = "compositions";
+var MAX_SHAPE_SEGMENTS = 4;
+var DYNAMIC_SEGMENT = ":";
+var MAX_TAG_LENGTH = 256;
+var hashString = (value) => {
+  let hash = 2166136261;
+  for (let i = 0; i < value.length; i++) {
+    hash ^= value.charCodeAt(i);
+    hash = Math.imul(hash, 16777619);
+  }
+  return (hash >>> 0).toString(16);
 };
+var limitTagLength = (tag) => tag.length > MAX_TAG_LENGTH ? `${tag.slice(0, MAX_TAG_LENGTH - 9)}#${hashString(tag)}` : tag;
+var toTagSegments = (path) => {
+  var _a;
+  return encodePathForTag((_a = path.split("?")[0]) != null ? _a : "").toLowerCase().split("/").filter(Boolean);
+};
+var buildShapes = (segments) => segments.reduce(
+  (shapes, segment) => shapes.flatMap((shape) => [
+    [...shape, segment],
+    [...shape, DYNAMIC_SEGMENT]
+  ]),
+  [[]]
+);
+var buildShapeTag = (shape, segmentCount) => {
+  const deeper = segmentCount > shape.length ? `/+${segmentCount - shape.length}` : "";
+  return limitTagLength(`route-shape:/${shape.join("/")}${deeper}`);
+};
+var buildSubtreeTag = (shape) => limitTagLength(`route-subtree:/${shape.join("/")}`);
+var buildRouteShapeTags = (path) => {
+  const segments = toTagSegments(path);
+  return buildShapes(segments.slice(0, MAX_SHAPE_SEGMENTS)).map(
+    (shape) => buildShapeTag(shape, segments.length)
+  );
+};
+var buildRouteSubtreeTags = (path) => {
+  const segments = toTagSegments(path);
+  const prefixLengths = Math.min(segments.length, MAX_SHAPE_SEGMENTS + 1);
+  return Array.from(
+    { length: prefixLengths },
+    (_, length) => buildShapes(segments.slice(0, length)).map(buildSubtreeTag)
+  ).flat();
+};
+var buildRouteTags = (path) => [
+  ROUTE_TAG,
+  ...buildRouteShapeTags(path),
+  ...buildRouteSubtreeTags(path)
+];
 var buildCompositionTag = (compositionId) => {
   return `composition:${compositionId}`.toLowerCase();
 };
@@ -1131,19 +1177,7 @@ var buildCompositionSlugTag = (slug) => {
 };
 
 // src/clients/tags.ts
-var generateRouteCacheTags = ({ path }) => {
-  const tags = ["route"];
-  if (path) {
-    const pathWithoutQuery = path.split("?")[0];
-    const pieces = pathWithoutQuery.split("/");
-    for (let i = 0; i < pieces.length; i++) {
-      const segmentPieces = pieces.slice(0, i + 1);
-      const segment = segmentPieces.join("/");
-      tags.push(buildPathTag(segment));
-    }
-  }
-  return tags;
-};
+var generateRouteCacheTags = ({ path }) => buildRouteTags(path);
 
 // src/clients/canvas.ts
 import "server-only";
@@ -1407,7 +1441,7 @@ var buildCanvasClientOptions = (options) => {
       } else {
         requestedUrl = new URL(req.url);
       }
-      const tags = [];
+      const tags = [COMPOSITIONS_TAG];
       if (requestedUrl) {
         const compositionIdKey = "compositionId";
         const compositionIdsKey = "compositionIDs";
@@ -1451,7 +1485,7 @@ var getCompositionDeliveryClient = (options) => {
 // src/clients/route.ts
 import "server-only";
 var getRouteCacheTags = (requestedUrl) => {
-  const tags = ["route"];
+  const tags = [ROUTE_TAG];
   if (requestedUrl) {
     const pathKey = "path";
     const path = requestedUrl.searchParams.get(pathKey);
@@ -1480,8 +1514,11 @@ var getRouteClient = (options) => {
       } else {
         requestedUrl = new URL(req.url);
       }
-      const tags = getRouteCacheTags(requestedUrl);
       const { cache: fetchCache, revalidate } = determineFetchCacheOptions(cache);
+      const tags = [
+        ...getRouteCacheTags(requestedUrl),
+        ...fetchCache === "no-cache" || fetchCache === "no-store" ? [] : [FETCH_CACHED_ROUTE_TAG]
+      ];
       return fetch(req, {
         ...init,
         headers: {
@@ -1582,10 +1619,32 @@ var DataClient = class {
 import { deserializeEvaluationResult } from "@uniformdev/next-app-router-shared";
 var deserializePageState = ({ code }) => deserializeEvaluationResult({ input: code });
 
+// src/config/helpers.ts
+import config from "@uniformdev/next-app-router/config/resolved";
+var getDefaultConsent = () => {
+  if (typeof config.defaultConsent === "boolean") {
+    return config.defaultConsent;
+  }
+  return false;
+};
+
 // src/data/pageStateFromSource.ts
 var pageStateFromSource = (source) => {
-  var _a;
-  return (_a = source.pageState) != null ? _a : deserializePageState({ code: source.code });
+  if (source.pageState) {
+    return source.pageState;
+  }
+  if (source.code !== void 0) {
+    return deserializePageState({ code: source.code });
+  }
+  return {
+    compositionState: CANVAS_PUBLISHED_STATE,
+    routePath: "/",
+    keys: void 0,
+    releaseId: void 0,
+    defaultConsent: getDefaultConsent(),
+    previewMode: void 0,
+    locale: void 0
+  };
 };
 
 // src/data/resolveCompositionForPageState.ts
@@ -1681,6 +1740,7 @@ var resolveCompositionCached = async (pageState, selector, matchedRoute) => {
       dataClient: createScopeDataClient()
     }),
     [
+      COMPOSITIONS_TAG,
       "compositionId" in selector ? buildCompositionTag(selector.compositionId) : buildCompositionSlugTag(selector.slug)
     ]
   );

package/dist/cf-vinext.d.mts

@@ -1,13 +1,14 @@
-import { C as CreateEdgeRouteStoreOptions, a as CreateCachedManifestProviderOptions, U as UniformEdgeMiddlewareOptions } from './uniformEdgeMiddleware-BOyFWW7Z.mjs';
+import { C as CreateEdgeRouteStoreOptions, a as CreateCachedManifestProviderOptions, U as UniformEdgeMiddlewareOptions } from './uniformEdgeMiddleware-BcitsCE7.mjs';
 import { E as EdgeRouteStore, M as ManifestProvider, a as EdgeRouteFilter } from './models-kIvBB7Tv.mjs';
 import * as next_server from 'next/server';
 import '@uniformdev/context';
 import './middleware.mjs';
 import '@uniformdev/next-app-router-shared';
+import './createPreviewGETRouteHandler-ii7w-gAc.mjs';
 
 /**
  * Creates an edge route store for `uniformEdgeMiddleware` that keeps its records in vinext's data
- * cache, tagged with each page's `path:` tag, so publishing a composition or changing the project
+ * cache, tagged like a cached route for each page's path, so publishing a composition or changing the project
  * map expires the records of its paths through the preview route handler's `revalidateTag`.
  *
  * Requires the optional peer dependency `vinext`.

package/dist/cf-vinext.d.ts

@@ -1,13 +1,14 @@
-import { C as CreateEdgeRouteStoreOptions, a as CreateCachedManifestProviderOptions, U as UniformEdgeMiddlewareOptions } from './uniformEdgeMiddleware-BiqRqhob.js';
+import { C as CreateEdgeRouteStoreOptions, a as CreateCachedManifestProviderOptions, U as UniformEdgeMiddlewareOptions } from './uniformEdgeMiddleware-D2frG4_C.js';
 import { E as EdgeRouteStore, M as ManifestProvider, a as EdgeRouteFilter } from './models-kIvBB7Tv.js';
 import * as next_server from 'next/server';
 import '@uniformdev/context';
 import './middleware.js';
 import '@uniformdev/next-app-router-shared';
+import './createPreviewGETRouteHandler-ii7w-gAc.js';
 
 /**
  * Creates an edge route store for `uniformEdgeMiddleware` that keeps its records in vinext's data
- * cache, tagged with each page's `path:` tag, so publishing a composition or changing the project
+ * cache, tagged like a cached route for each page's path, so publishing a composition or changing the project
  * map expires the records of its paths through the preview route handler's `revalidateTag`.
  *
  * Requires the optional peer dependency `vinext`.