@uniformdev/next-app-router 20.75.1-alpha.0 → 20.76.1-alpha.3

package/dist/middleware.js

@@ -3012,7 +3012,9 @@ var DefaultDataClient = class {
       source: "middleware",
       route: options.route,
       routeClient,
-      enableRuntimeCache: options.route.state === CANVAS_PUBLISHED_STATE && getMiddlewareRuntimeCache(),
+      // The runtime cache is keyed on the route path. Development bypasses it so an author sees
+      // an edit right away, the same way the fetch cache is bypassed for development.
+      enableRuntimeCache: options.route.state === CANVAS_PUBLISHED_STATE && getMiddlewareRuntimeCache() && !isDevelopmentEnvironment(),
       disableSwrCache: getDisableSwrMiddlewareCache()
     });
     if (resolvedRoute.type === "composition") {
@@ -3069,16 +3071,82 @@ var DefaultDataClient = class {
   }
 };
 
+// src/middleware/composition/evaluate/evaluateRunnables.ts
+var import_next_app_router_shared = require("@uniformdev/next-app-router-shared");
+var evaluateRunnables = async ({
+  runnables,
+  context,
+  compositionContext,
+  isPrefetch
+}) => {
+  var _a;
+  const result = {
+    components: {},
+    rules: void 0
+  };
+  const runnablesToProcess = runnables.filter((item2) => item2.variantId === void 0);
+  let item;
+  while (item = runnablesToProcess.shift()) {
+    if (item.type === "test" && isPrefetch) {
+      continue;
+    }
+    if (item.type === "test") {
+      const testResult = (0, import_next_app_router_shared.evaluateTest)({
+        context,
+        test: item.result,
+        compositionContext
+      });
+      if (testResult.index !== null) {
+        result.components[item._id] = {
+          indexes: [testResult.index]
+        };
+        if (testResult.componentId) {
+          const dependentRunnables = runnables.filter((r) => r.variantId === testResult.componentId);
+          runnablesToProcess.push(...dependentRunnables);
+        }
+      }
+    } else if (item.type === "personalization") {
+      const personalizationResult = (0, import_next_app_router_shared.evaluatePersonalization)({
+        context,
+        personalization: item.result,
+        compositionContext
+      });
+      if (personalizationResult.indexes.length) {
+        result.components[item._id] = {
+          indexes: personalizationResult.indexes
+        };
+      }
+      if (personalizationResult.componentIds.length) {
+        const dependentRunnables = runnables.filter(
+          (r) => r.variantId && personalizationResult.componentIds.includes(r.variantId)
+        );
+        runnablesToProcess.push(...dependentRunnables);
+      }
+    } else if (item.type === "visibility") {
+      const rules = createQuirksVisibilityRule(context.quirks);
+      const isVisible = evaluateNodeVisibilityParameter({
+        rules,
+        parameter: item.rules
+      });
+      if (isVisible !== null) {
+        result.rules = (_a = result.rules) != null ? _a : {};
+        result.rules[item._id] = isVisible;
+      }
+    }
+  }
+  return result;
+};
+
 // src/data/extract/extractRunnables.ts
-var import_next_app_router_shared3 = require("@uniformdev/next-app-router-shared");
+var import_next_app_router_shared4 = require("@uniformdev/next-app-router-shared");
 
 // src/data/extract/extractPersonalization.ts
-var import_next_app_router_shared = require("@uniformdev/next-app-router-shared");
+var import_next_app_router_shared2 = require("@uniformdev/next-app-router-shared");
 var extractPersonalization = ({
   component
 }) => {
   var _a, _b, _c;
-  const trackingEventName = (0, import_next_app_router_shared.extractPersonalizationName)({ component });
+  const trackingEventName = (0, import_next_app_router_shared2.extractPersonalizationName)({ component });
   const countParameter = (_a = component.parameters) == null ? void 0 : _a.count;
   const algorithmParameter = (_b = component.parameters) == null ? void 0 : _b.algorithm;
   const count = countParameter == null ? void 0 : countParameter.value;
@@ -3114,10 +3182,10 @@ var extractPersonalization = ({
 };
 
 // src/data/extract/extractTest.ts
-var import_next_app_router_shared2 = require("@uniformdev/next-app-router-shared");
+var import_next_app_router_shared3 = require("@uniformdev/next-app-router-shared");
 var extractTest = ({ component }) => {
   var _a;
-  const testName = (0, import_next_app_router_shared2.extractTestName)({ component });
+  const testName = (0, import_next_app_router_shared3.extractTestName)({ component });
   const slot = ((_a = component.slots) == null ? void 0 : _a[CANVAS_TEST_SLOT]) || [];
   const componentVariations = mapSlotToTestVariations(slot).map((variation, index) => {
     const slotComponent = slot[index];
@@ -3173,7 +3241,7 @@ var extractRunnables = (composition) => {
       if (visibilityRules) {
         runnable.push({
           type: "visibility",
-          _id: (0, import_next_app_router_shared3.getRuleId)(visibilityRules),
+          _id: (0, import_next_app_router_shared4.getRuleId)(visibilityRules),
           variantId: findAncestorVariant(node.ancestorsAndSelf),
           rules: visibilityRules
         });
@@ -3183,6 +3251,41 @@ var extractRunnables = (composition) => {
   return runnable;
 };
 
+// src/data/evaluate/evaluatePageState.ts
+var evaluatePageState = async ({
+  composition,
+  matchedRoute,
+  dynamicInputs,
+  pageState,
+  context
+}) => {
+  const extracted = extractRunnables(composition);
+  const result = await evaluateRunnables({
+    runnables: extracted,
+    context,
+    isPrefetch: pageState.isPrefetch,
+    compositionContext: {
+      _id: composition._id,
+      type: composition.type,
+      state: pageState.compositionState,
+      isContextualEditing: pageState.compositionState === CANVAS_EDITOR_STATE,
+      matchedRoute,
+      dynamicInputs,
+      pageState: {
+        ...pageState,
+        // empty for now, we need to pass composition metadata down to evaluateRunnables for Context events enrichment
+        components: {},
+        rules: void 0
+      }
+    }
+  });
+  const allComponentIds = extracted.filter((r) => r.type === "test" || r.type === "personalization").map((r) => r._id);
+  return {
+    ...result,
+    allComponentIds
+  };
+};
+
 // src/data/routes.ts
 var findRouteMatch = (routes, path) => {
   const pieces = path.split("/").filter(Boolean);
@@ -3214,72 +3317,6 @@ var findRouteMatch = (routes, path) => {
   return void 0;
 };
 
-// src/middleware/composition/evaluate/evaluateRunnables.ts
-var import_next_app_router_shared4 = require("@uniformdev/next-app-router-shared");
-var evaluateRunnables = async ({
-  runnables,
-  context,
-  compositionContext,
-  isPrefetch
-}) => {
-  var _a;
-  const result = {
-    components: {},
-    rules: void 0
-  };
-  const runnablesToProcess = runnables.filter((item2) => item2.variantId === void 0);
-  let item;
-  while (item = runnablesToProcess.shift()) {
-    if (item.type === "test" && isPrefetch) {
-      continue;
-    }
-    if (item.type === "test") {
-      const testResult = (0, import_next_app_router_shared4.evaluateTest)({
-        context,
-        test: item.result,
-        compositionContext
-      });
-      if (testResult.index !== null) {
-        result.components[item._id] = {
-          indexes: [testResult.index]
-        };
-        if (testResult.componentId) {
-          const dependentRunnables = runnables.filter((r) => r.variantId === testResult.componentId);
-          runnablesToProcess.push(...dependentRunnables);
-        }
-      }
-    } else if (item.type === "personalization") {
-      const personalizationResult = (0, import_next_app_router_shared4.evaluatePersonalization)({
-        context,
-        personalization: item.result,
-        compositionContext
-      });
-      if (personalizationResult.indexes.length) {
-        result.components[item._id] = {
-          indexes: personalizationResult.indexes
-        };
-      }
-      if (personalizationResult.componentIds.length) {
-        const dependentRunnables = runnables.filter(
-          (r) => r.variantId && personalizationResult.componentIds.includes(r.variantId)
-        );
-        runnablesToProcess.push(...dependentRunnables);
-      }
-    } else if (item.type === "visibility") {
-      const rules = createQuirksVisibilityRule(context.quirks);
-      const isVisible = evaluateNodeVisibilityParameter({
-        rules,
-        parameter: item.rules
-      });
-      if (isVisible !== null) {
-        result.rules = (_a = result.rules) != null ? _a : {};
-        result.rules[item._id] = isVisible;
-      }
-    }
-  }
-  return result;
-};
-
 // ../../node_modules/.pnpm/dequal@2.0.3/node_modules/dequal/lite/index.mjs
 var has = Object.prototype.hasOwnProperty;
 function dequal(foo, bar) {
@@ -4371,8 +4408,8 @@ var TransitionDataStore = class {
   }
   /**
    * Updates data in the transition storage.
-   * @param commands Commands to execute against existing stored value (event based stores)
-   * @param computedValue Pre-computed new value against existing value (object based stores)
+   * @param commands - Commands to execute against existing stored value (event based stores)
+   * @param computedValue - Pre-computed new value against existing value (object based stores)
    * @returns Resolved promise when the data has been updated
    */
   updateData(commands, computedValue) {
@@ -4848,7 +4885,7 @@ var VisitorDataStore = class {
   /**
    * Deletes visitor data (forgetting them)
    * In most cases you should use forget() on the Context instead of this function, which also clears the Context state.
-   * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
+   * @param fromAllDevices - for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
    */
   async delete(fromAllDevices) {
     var _a, _b, _c, _d, _e;
@@ -5367,7 +5404,7 @@ var Context = class {
   }
   /**
    * Forgets the visitor's data and resets the Context to its initial state.
-   * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
+   * @param fromAllDevices - for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
    */
   async forget(fromAllDevices) {
     const previousCompositionMetadata = __privateGet4(this, _state).compositionMetadata;
@@ -5408,14 +5445,14 @@ var Context = class {
     });
     return transitionState;
   }
-  /** @deprecated */
+  /** @deprecated Internal API for test event processing; not for public use. */
   internal_processTestEvent(event) {
     if (event.variantId) {
       this.setTestVariantId(event.name, event.variantId);
       __privateMethod(this, _Context_instances, emitTest_fn).call(this, event);
     }
   }
-  /** @deprecated */
+  /** @deprecated Internal API for personalization event processing; not for public use. */
   internal_processPersonalizationEvent(event) {
     __privateGet4(this, _pzCache)[event.name] = event.variantIds;
     __privateGet4(this, _mitt3).emit("personalizationResult", event);
@@ -5488,7 +5525,8 @@ var dc2 = (0, import_rfdc3.default)();
 
 // src/middleware/context/index.ts
 var createOnDemandContext = async (options) => {
-  const manifest = await options.dataClient.getManifest({ source: "middleware" });
+  var _a;
+  const manifest = await options.dataClient.getManifest({ source: (_a = options.source) != null ? _a : "middleware" });
   if (!manifest) {
     console.error("Uniform manifest not found, falling back to empty manifest");
   }
@@ -5612,6 +5650,22 @@ var determineState = async ({
   return isDraftMode ? (isCanvasEditing ? [CANVAS_EDITOR_STATE] : []).concat([CANVAS_DRAFT_STATE]) : [CANVAS_PUBLISHED_STATE];
 };
 
+// src/utils/quirks.ts
+var buildQuirksFromHeaders = (headers) => {
+  const headerToQuirkKey = {
+    "x-vercel-ip-country": "vc-country",
+    "x-vercel-ip-country-region": "vc-region",
+    "x-vercel-ip-city": "vc-city"
+  };
+  return Object.entries(headerToQuirkKey).reduce((acc, [headerName, quirkKey]) => {
+    const value = headers.get(headerName);
+    if (value) {
+      acc[quirkKey] = value;
+    }
+    return acc;
+  }, {});
+};
+
 // src/middleware.ts
 var uniformMiddleware = (options) => {
   return async (request) => {
@@ -5650,26 +5704,11 @@ var isPlaygroundPath = (path) => {
   );
   return (match == null ? void 0 : match.route.id) === PLAYGROUND_ID ? match : void 0;
 };
-var buildQuirksFromHeaders = (headers) => {
-  const headerToQuirkKey = {
-    "x-vercel-ip-country": "vc-country",
-    "x-vercel-ip-country-region": "vc-region",
-    "x-vercel-ip-city": "vc-city"
-  };
-  return Object.entries(headerToQuirkKey).reduce((acc, [headerName, quirkKey]) => {
-    const value = headers.get(headerName);
-    if (value) {
-      acc[quirkKey] = value;
-    }
-    return acc;
-  }, {});
-};
 var handlePlaygroundRequest = async ({
   request,
-  options,
-  dataClient
+  options
 }) => {
-  var _a, _b;
+  var _a;
   const id = request.nextUrl.searchParams.get("id");
   if (!id) {
     return import_server.NextResponse.json(
@@ -5711,41 +5750,12 @@ var handlePlaygroundRequest = async ({
   }
   const serverConfig = getServerConfig();
   const playgroundPath = getPlaygroundPath();
-  const onDemandContext = await createOnDemandContext({
-    cookies: request.cookies,
-    dataClient,
-    defaultConsent: determineDefaultConsent({
-      serverConfig,
-      defaultConsent: options.defaultConsent
-    })
-  });
-  const context = await onDemandContext.getContext();
-  const { components, rules, allComponentIds } = await extractAndEvaluateRunnables({
-    composition: composition.composition,
-    routePath: id,
-    state: composition.state,
-    context,
-    matchedRoute: id,
-    dynamicInputs: {},
-    releaseId: (_a = options.release) == null ? void 0 : _a.id,
-    defaultConsent: determineDefaultConsent({
-      serverConfig,
-      defaultConsent: options.defaultConsent
-    }),
-    keys: void 0,
-    previewMode: determinePreviewMode({
-      searchParams: request.nextUrl.searchParams,
-      isDraftModeEnabled: true
-      // this is checked above
-    }),
-    isPrefetch: false
-  });
   const pageState = {
     routePath: id,
     compositionState: composition.state,
-    components,
+    components: {},
     keys: void 0,
-    releaseId: (_b = options.release) == null ? void 0 : _b.id,
+    releaseId: (_a = options.release) == null ? void 0 : _a.id,
     defaultConsent: determineDefaultConsent({
       serverConfig,
       defaultConsent: options.defaultConsent
@@ -5755,13 +5765,13 @@ var handlePlaygroundRequest = async ({
       isDraftModeEnabled: true
       // this is checked above
     }),
-    rules,
+    rules: void 0,
     locale: options.locale,
-    isPrefetch: void 0
+    isPrefetch: void 0,
+    requestPath: `${request.nextUrl.pathname}${request.nextUrl.search}`
   };
   const code = (0, import_next_app_router_shared5.serializeEvaluationResult)({
-    payload: pageState,
-    allComponentIds
+    payload: pageState
   });
   let pathToRewriteTo = await (options.rewriteDestinationPath ? options.rewriteDestinationPath({ code, pageState, source: "playground" }) : void 0);
   if (!pathToRewriteTo) {
@@ -5844,30 +5854,10 @@ var handleRouteRequest = async ({
     isDraftModeEnabled: draftModeEnabled
   });
   const isPrefetch = isPrefetchRequest(request);
-  const { components, rules, allComponentIds } = await extractAndEvaluateRunnables({
-    composition: route.compositionApiResponse.composition,
-    routePath,
-    state,
-    context,
-    matchedRoute: route.matchedRoute,
-    dynamicInputs: (_g = route.dynamicInputs) != null ? _g : {},
-    releaseId,
-    defaultConsent: determineDefaultConsent({
-      serverConfig,
-      defaultConsent: options.defaultConsent
-    }),
-    keys: requestPath.keys,
-    previewMode: determinePreviewMode({
-      searchParams: request.nextUrl.searchParams,
-      isDraftModeEnabled: true
-      // this is checked above
-    }),
-    isPrefetch
-  });
-  const pageState = {
+  const basePageState = {
     routePath,
     compositionState: state,
-    components,
+    components: {},
     keys: requestPath.keys,
     releaseId,
     defaultConsent: determineDefaultConsent({
@@ -5875,10 +5865,32 @@ var handleRouteRequest = async ({
       defaultConsent: options.defaultConsent
     }),
     previewMode,
-    rules,
+    rules: void 0,
     locale: options.locale,
-    isPrefetch: isPrefetch || void 0
+    isPrefetch: isPrefetch || void 0,
+    // Draft requests evaluate while the page renders, so they carry with them the inputs that
+    // cannot be derived again there: the request path, and any custom quirks the consumer
+    // supplied to the middleware. Quirks from request headers are rebuilt at render time.
+    requestPath: draftModeEnabled ? `${request.nextUrl.pathname}${request.nextUrl.search}` : void 0,
+    quirks: draftModeEnabled ? options.quirks : void 0
   };
+  let pageState = basePageState;
+  let allComponentIds = void 0;
+  if (!draftModeEnabled) {
+    const evaluated = await evaluatePageState({
+      composition: route.compositionApiResponse.composition,
+      matchedRoute: route.matchedRoute,
+      dynamicInputs: (_g = route.dynamicInputs) != null ? _g : {},
+      pageState: basePageState,
+      context
+    });
+    pageState = {
+      ...basePageState,
+      components: evaluated.components,
+      rules: evaluated.rules
+    };
+    allComponentIds = evaluated.allComponentIds;
+  }
   const code = (0, import_next_app_router_shared5.serializeEvaluationResult)({
     payload: pageState,
     allComponentIds
@@ -5901,49 +5913,6 @@ var handleRouteRequest = async ({
 var isPrefetchRequest = (request) => {
   return request.headers.has("next-url");
 };
-var extractAndEvaluateRunnables = async ({
-  composition,
-  routePath,
-  context,
-  state,
-  matchedRoute,
-  dynamicInputs,
-  releaseId,
-  defaultConsent,
-  keys,
-  previewMode,
-  isPrefetch
-}) => {
-  const extracted = extractRunnables(composition);
-  const result = await evaluateRunnables({
-    runnables: extracted,
-    context,
-    isPrefetch,
-    compositionContext: {
-      _id: composition._id,
-      type: composition.type,
-      state,
-      isContextualEditing: state === CANVAS_EDITOR_STATE,
-      matchedRoute,
-      dynamicInputs,
-      pageState: {
-        routePath,
-        compositionState: state,
-        // empty for now, we need to pass composition metadata down to evaluateRunnables for Context events enrichment
-        components: {},
-        keys,
-        releaseId,
-        defaultConsent,
-        previewMode,
-        rules: void 0,
-        locale: void 0,
-        isPrefetch: isPrefetch || void 0
-      }
-    }
-  });
-  const allComponentIds = extracted.filter((r) => r.type === "test" || r.type === "personalization").map((r) => r._id);
-  return { ...result, allComponentIds };
-};
 var handleRedirect = ({ request, route }) => {
   const href = resolveRedirectHref({
     resolveResult: route,
@@ -5966,7 +5935,7 @@ var buildRoutePath = ({
   pathname,
   route
 }) => {
-  var _a, _b, _c;
+  var _a, _b, _c, _d;
   const [routePath, search] = pathname.split("?");
   const locale = (_a = route.dynamicInputs) == null ? void 0 : _a.locale;
   const projectMapNode = (_b = route.compositionApiResponse.composition.projectMapNodes) == null ? void 0 : _b.find((node) => {
@@ -5981,22 +5950,12 @@ var buildRoutePath = ({
   });
   const searchParams = new URLSearchParams();
   if ((_c = projectMapNode == null ? void 0 : projectMapNode.data) == null ? void 0 : _c.queryStrings) {
-    if (search) {
-      const existingSearchParams = new URLSearchParams(search);
-      for (const [key, value] of existingSearchParams.entries()) {
-        searchParams.set(key, value);
-      }
-    }
+    const existingSearchParams = search ? new URLSearchParams(search) : void 0;
     for (const qs of projectMapNode.data.queryStrings) {
-      if (!searchParams.has(qs.name)) {
-        const qsValue = qs.value;
-        searchParams.set(qs.name, qsValue != null ? qsValue : "");
-      }
+      const existingValue = existingSearchParams == null ? void 0 : existingSearchParams.get(qs.name);
+      searchParams.set(qs.name, (_d = existingValue != null ? existingValue : qs.value) != null ? _d : "");
     }
   }
-  if (process.env.NODE_ENV === "development") {
-    searchParams.set("cache", (/* @__PURE__ */ new Date()).valueOf().toString());
-  }
   if (searchParams.size) {
     return `${routePath}?${searchParams.toString()}`;
   }