[build-utils] add experimentalBypassFor field to Prerender

packages/build-utils/src/prerender.ts

@@ -1,4 +1,4 @@
-import { File } from './types';
+import type { File, HasField } from './types';
 import { Lambda } from './lambda';
 
 interface PrerenderOptions {
@@ -7,6 +7,7 @@ interface PrerenderOptions {
   fallback: File | null;
   group?: number;
   bypassToken?: string | null /* optional to be non-breaking change */;
+  experimentalBypassFor?: HasField;
   allowQuery?: string[];
   initialHeaders?: Record<string, string>;
   initialStatus?: number;
@@ -26,13 +27,15 @@ export class Prerender {
   public initialStatus?: number;
   public passQuery?: boolean;
   public sourcePath?: string;
+  public experimentalBypassFor?: HasField;
 
   constructor({
     expiration,
     lambda,
     fallback,
     group,
     bypassToken,
+    experimentalBypassFor,
     allowQuery,
     initialHeaders,
     initialStatus,
@@ -86,6 +89,26 @@ export class Prerender {
       );
     }
 
+    if (experimentalBypassFor !== undefined) {
+      if (
+        !Array.isArray(experimentalBypassFor) ||
+        experimentalBypassFor.some(
+          field =>
+            typeof field !== 'object' ||
+            // host doesn't need a key
+            (field.type !== 'host' && typeof field.key !== 'string') ||
+            typeof field.type !== 'string' ||
+            (field.value !== undefined && typeof field.value !== 'string')
+        )
+      ) {
+        throw new Error(
+          'The `experimentalBypassFor` argument for `Prerender` must be Array of objects with fields `type`, `key` and optionally `value`.'
+        );
+      }
+
+      this.experimentalBypassFor = experimentalBypassFor;
+    }
+
     if (typeof fallback === 'undefined') {
       throw new Error(
         'The `fallback` argument for `Prerender` needs to be a `FileBlob`, `FileFsRef`, `FileRef`, or null.'

packages/build-utils/src/types.ts

@@ -45,6 +45,18 @@ export interface Config {
   [key: string]: unknown;
 }
 
+export type HasField = Array<
+  | {
+      type: 'host';
+      value: string;
+    }
+  | {
+      type: 'header' | 'cookie' | 'query';
+      key: string;
+      value?: string;
+    }
+>;
+
 export interface Meta {
   isDev?: boolean;
   devCacheDir?: string;

packages/build-utils/test/unit.test.ts

@@ -344,6 +344,71 @@ it('should support initialHeaders and initialStatus correctly', async () => {
   });
 });
 
+it('should support experimentalBypassFor correctly', async () => {
+  new Prerender({
+    expiration: 1,
+    fallback: null,
+    group: 1,
+    bypassToken: 'some-long-bypass-token-to-make-it-work',
+    experimentalBypassFor: [{ type: 'header', key: 'Next-Action' }],
+  });
+  new Prerender({
+    expiration: 1,
+    fallback: null,
+    group: 1,
+    bypassToken: 'some-long-bypass-token-to-make-it-work',
+    experimentalBypassFor: [
+      { type: 'header', key: 'Next-Action' },
+      {
+        type: 'cookie',
+        key: '__prerender_bypass',
+        value: 'some-long-bypass-token-to-make-it-work',
+      },
+    ],
+  });
+  new Prerender({
+    expiration: 1,
+    fallback: null,
+    group: 1,
+    bypassToken: 'some-long-bypass-token-to-make-it-work',
+    experimentalBypassFor: [{ type: 'query', key: 'bypass', value: '1' }],
+  });
+
+  new Prerender({
+    expiration: 1,
+    fallback: null,
+    group: 1,
+    bypassToken: 'some-long-bypass-token-to-make-it-work',
+    experimentalBypassFor: [{ type: 'host', value: 'vercel.com' }],
+  });
+
+  expect(() => {
+    new Prerender({
+      expiration: 1,
+      fallback: null,
+      group: 1,
+      bypassToken: 'some-long-bypass-token-to-make-it-work',
+      // @ts-expect-error: testing invalid args
+      experimentalBypassFor: 'foo',
+    });
+  }).toThrowError(
+    'The `experimentalBypassFor` argument for `Prerender` must be Array of objects with fields `type`, `key` and optionally `value`.'
+  );
+
+  expect(() => {
+    new Prerender({
+      expiration: 1,
+      fallback: null,
+      group: 1,
+      bypassToken: 'some-long-bypass-token-to-make-it-work',
+      // @ts-expect-error: testing invalid args
+      experimentalBypassFor: [{ type: 'header', value: { foo: 'bar' } }],
+    });
+  }).toThrowError(
+    'The `experimentalBypassFor` argument for `Prerender` must be Array of objects with fields `type`, `key` and optionally `value`.'
+  );
+});
+
 it('should support passQuery correctly', async () => {
   new Prerender({
     expiration: 1,