@vercel/microfrontends 0.14.0 → 0.16.0

package/dist/next/endpoints.cjs

@@ -25,21 +25,75 @@ __export(endpoints_exports, {
 module.exports = __toCommonJS(endpoints_exports);
 var import_server = require("next/server");
 
-// src/config/client/client-config.ts
-function getClientConfigFromEnv() {
-  const clientConfigJson = process.env.NEXT_PUBLIC_MFE_CLIENT_CONFIG;
-  if (!clientConfigJson) {
-    throw new Error(
-      "Could not find client micro-frontends config in the environment"
+// src/config/microfrontends-config/client/index.ts
+var import_path_to_regexp = require("path-to-regexp");
+var MicrofrontendConfigClient = class {
+  constructor(config, opts) {
+    this.pathCache = {};
+    this.serialized = config;
+    if (opts == null ? void 0 : opts.removeFlaggedPaths) {
+      for (const app of Object.values(config.applications)) {
+        if (app.routing) {
+          app.routing = app.routing.filter((match) => !match.flag);
+        }
+      }
+    }
+    this.applications = config.applications;
+  }
+  /**
+   * Create a new `MicrofrontendConfigClient` from a JSON string.
+   * Config must be passed in to remain framework agnostic
+   */
+  static fromEnv(config, opts) {
+    if (!config) {
+      throw new Error("No microfrontends configuration found");
+    }
+    return new MicrofrontendConfigClient(
+      JSON.parse(config),
+      opts
     );
   }
-  return JSON.parse(clientConfigJson);
-}
+  isEqual(other) {
+    return JSON.stringify(this.applications) === JSON.stringify(other.applications);
+  }
+  getApplicationNameForPath(path) {
+    if (!path.startsWith("/")) {
+      throw new Error(`Path must start with a /`);
+    }
+    if (this.pathCache[path]) {
+      return this.pathCache[path];
+    }
+    const pathname = new URL(path, "https://example.com").pathname;
+    for (const [name, application] of Object.entries(this.applications)) {
+      if (application.routing) {
+        for (const group of application.routing) {
+          for (const childPath of group.paths) {
+            const regexp = (0, import_path_to_regexp.pathToRegexp)(childPath);
+            if (regexp.test(pathname)) {
+              this.pathCache[path] = name;
+              return name;
+            }
+          }
+        }
+      }
+    }
+    const defaultApplication = Object.entries(this.applications).find(
+      ([, application]) => application.default
+    );
+    if (!defaultApplication) {
+      return null;
+    }
+    this.pathCache[path] = defaultApplication[0];
+    return defaultApplication[0];
+  }
+  serialize() {
+    return this.serialized;
+  }
+};
 
 // src/config/well-known/endpoints.ts
-async function getWellKnownClientData(flagValues = {}) {
-  var _a;
-  const config = getClientConfigFromEnv();
+async function getWellKnownClientData(clientConfig, flagValues = {}) {
+  const config = MicrofrontendConfigClient.fromEnv(clientConfig);
   for (const [applicationName, application] of Object.entries(
     config.applications
   )) {
@@ -47,9 +101,9 @@ async function getWellKnownClientData(flagValues = {}) {
       continue;
     }
     const newRoutingMatches = [];
-    for (const pathGroup of application.routing.matches) {
-      if ((_a = pathGroup.options) == null ? void 0 : _a.flag) {
-        const flagName = pathGroup.options.flag;
+    for (const pathGroup of application.routing) {
+      if (pathGroup.flag) {
+        const flagName = pathGroup.flag;
         const flagFn = flagValues[flagName];
         if (!flagFn) {
           throw new Error(
@@ -64,16 +118,21 @@ async function getWellKnownClientData(flagValues = {}) {
         newRoutingMatches.push(pathGroup);
       }
     }
-    application.routing.matches = newRoutingMatches;
+    application.routing = newRoutingMatches;
   }
   return {
-    config
+    config: config.serialize()
   };
 }
 
 // src/next/endpoints/index.ts
-async function wellKnownNextjsClientConfigAppRoute() {
-  return import_server.NextResponse.json(await getWellKnownClientData());
+async function wellKnownNextjsClientConfigAppRoute(flagValues) {
+  return import_server.NextResponse.json(
+    await getWellKnownClientData(
+      process.env.NEXT_PUBLIC_MFE_CLIENT_CONFIG,
+      flagValues
+    )
+  );
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/next/endpoints.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/next/endpoints/index.ts","../../src/config/client/client-config.ts","../../src/config/well-known/endpoints.ts"],"sourcesContent":["import { NextResponse } from 'next/server';\nimport { getWellKnownClientData } from '../../config/well-known/endpoints';\nimport type { WellKnownClientData } from '../../config/client/types';\n\n/**\n * A Next.js App Router API handler to export the micro-frontends client config\n * data.\n *\n * @example In the `app/.well-known/vercel/microfrontends/client-config/route.ts` file,\n * add this code:\n * ```\n * export { wellKnownNextjsClientConfigAppRoute as GET } from '@vercel/microfrontends/next/endpoints';\n * ```\n */\nexport async function wellKnownNextjsClientConfigAppRoute(): Promise<NextResponse> {\n  return NextResponse.json<WellKnownClientData>(await getWellKnownClientData());\n}\n","import type { Config } from '../schema';\nimport type { ClientConfig, WellKnownClientData } from './types';\n\n/**\n * Given a micro-frontends configuration, this returns a version that is\n * acceptable to be used client-side without leaking any information.\n */\nexport function getConfigForClient(config: Config): ClientConfig {\n  return {\n    applications: Object.fromEntries(\n      Object.entries(config.applications).map(([name, application]) => [\n        name,\n        {\n          default: application.default,\n          routing: application.routing,\n        },\n      ]),\n    ),\n  };\n}\n\nexport function getClientConfigFromEnv(): ClientConfig {\n  // This has to use the actual name rather than the constant variable in order\n  // for the env var to be replaced during the build correctly.\n  const clientConfigJson = process.env.NEXT_PUBLIC_MFE_CLIENT_CONFIG;\n  if (!clientConfigJson) {\n    throw new Error(\n      'Could not find client micro-frontends config in the environment',\n    );\n  }\n  return JSON.parse(clientConfigJson) as ClientConfig;\n}\n\nexport type { ClientConfig, WellKnownClientData };\n","import { getClientConfigFromEnv } from '../client/client-config';\nimport type { WellKnownClientData } from '../client/types';\n\n/**\n * Returns data used by the client to ensure that navigations across\n * micro-frontend boundaries are routed and prefetched correctly. The client\n * configuration is safe to expose to users.\n *\n * This data should be exposed in a `.well-known/vercel/microfrontends/client-config`\n * endpoint.\n */\nexport async function getWellKnownClientData(\n  flagValues: Record<string, () => Promise<boolean>> = {},\n): Promise<WellKnownClientData> {\n  const config = getClientConfigFromEnv();\n  for (const [applicationName, application] of Object.entries(\n    config.applications,\n  )) {\n    if (!application.routing) {\n      continue;\n    }\n    const newRoutingMatches = [];\n    for (const pathGroup of application.routing.matches) {\n      if (pathGroup.options?.flag) {\n        const flagName = pathGroup.options.flag;\n        const flagFn = flagValues[flagName];\n        if (!flagFn) {\n          throw new Error(\n            `Flag \"${flagName}\" was specified to control routing for path group \"${pathGroup.group}\" in application ${applicationName} but not found in provided flag values.`,\n          );\n        }\n        // eslint-disable-next-line no-await-in-loop\n        const flagEnabled = await flagFn();\n        if (flagEnabled) {\n          newRoutingMatches.push(pathGroup);\n        }\n      } else {\n        newRoutingMatches.push(pathGroup);\n      }\n    }\n    application.routing.matches = newRoutingMatches;\n  }\n\n  return {\n    config,\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAA6B;;;ACqBtB,SAAS,yBAAuC;AAGrD,QAAM,mBAAmB,QAAQ,IAAI;AACrC,MAAI,CAAC,kBAAkB;AACrB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA,SAAO,KAAK,MAAM,gBAAgB;AACpC;;;ACpBA,eAAsB,uBACpB,aAAqD,CAAC,GACxB;AAbhC;AAcE,QAAM,SAAS,uBAAuB;AACtC,aAAW,CAAC,iBAAiB,WAAW,KAAK,OAAO;AAAA,IAClD,OAAO;AAAA,EACT,GAAG;AACD,QAAI,CAAC,YAAY,SAAS;AACxB;AAAA,IACF;AACA,UAAM,oBAAoB,CAAC;AAC3B,eAAW,aAAa,YAAY,QAAQ,SAAS;AACnD,WAAI,eAAU,YAAV,mBAAmB,MAAM;AAC3B,cAAM,WAAW,UAAU,QAAQ;AACnC,cAAM,SAAS,WAAW,QAAQ;AAClC,YAAI,CAAC,QAAQ;AACX,gBAAM,IAAI;AAAA,YACR,SAAS,8DAA8D,UAAU,yBAAyB;AAAA,UAC5G;AAAA,QACF;AAEA,cAAM,cAAc,MAAM,OAAO;AACjC,YAAI,aAAa;AACf,4BAAkB,KAAK,SAAS;AAAA,QAClC;AAAA,MACF,OAAO;AACL,0BAAkB,KAAK,SAAS;AAAA,MAClC;AAAA,IACF;AACA,gBAAY,QAAQ,UAAU;AAAA,EAChC;AAEA,SAAO;AAAA,IACL;AAAA,EACF;AACF;;;AFhCA,eAAsB,sCAA6D;AACjF,SAAO,2BAAa,KAA0B,MAAM,uBAAuB,CAAC;AAC9E;","names":[]}
+{"version":3,"sources":["../../src/next/endpoints/index.ts","../../src/config/microfrontends-config/client/index.ts","../../src/config/well-known/endpoints.ts"],"sourcesContent":["import { NextResponse } from 'next/server';\nimport { getWellKnownClientData } from '../../config/well-known/endpoints';\nimport type { WellKnownClientData } from '../../config/well-known/types';\n\n/**\n * A Next.js App Router API handler to export the micro-frontends client config\n * data.\n *\n * @example In the `app/.well-known/vercel/microfrontends/client-config/route.ts` file,\n * add this code:\n * ```\n * export { wellKnownNextjsClientConfigAppRoute as GET } from '@vercel/microfrontends/next/endpoints';\n * ```\n */\nexport async function wellKnownNextjsClientConfigAppRoute(\n  flagValues: Record<string, () => Promise<boolean>>,\n): Promise<NextResponse> {\n  return NextResponse.json<WellKnownClientData>(\n    await getWellKnownClientData(\n      process.env.NEXT_PUBLIC_MFE_CLIENT_CONFIG,\n      flagValues,\n    ),\n  );\n}\n\nexport type { WellKnownClientData };\n","import { pathToRegexp } from 'path-to-regexp';\nimport type { ClientConfig } from './types';\n\ninterface MicrofrontendConfigClientOptions {\n  removeFlaggedPaths?: boolean;\n}\n\nexport class MicrofrontendConfigClient {\n  applications: ClientConfig['applications'];\n  pathCache: Record<string, string> = {};\n  private readonly serialized: ClientConfig;\n\n  constructor(config: ClientConfig, opts?: MicrofrontendConfigClientOptions) {\n    this.serialized = config;\n    if (opts?.removeFlaggedPaths) {\n      for (const app of Object.values(config.applications)) {\n        if (app.routing) {\n          app.routing = app.routing.filter((match) => !match.flag);\n        }\n      }\n    }\n    this.applications = config.applications;\n  }\n\n  /**\n   * Create a new `MicrofrontendConfigClient` from a JSON string.\n   * Config must be passed in to remain framework agnostic\n   */\n  static fromEnv(\n    config: string | undefined,\n    opts?: MicrofrontendConfigClientOptions,\n  ): MicrofrontendConfigClient {\n    if (!config) {\n      throw new Error('No microfrontends configuration found');\n    }\n    return new MicrofrontendConfigClient(\n      JSON.parse(config) as ClientConfig,\n      opts,\n    );\n  }\n\n  isEqual(other: MicrofrontendConfigClient): boolean {\n    return (\n      JSON.stringify(this.applications) === JSON.stringify(other.applications)\n    );\n  }\n\n  getApplicationNameForPath(path: string): string | null {\n    if (!path.startsWith('/')) {\n      throw new Error(`Path must start with a /`);\n    }\n\n    if (this.pathCache[path]) {\n      return this.pathCache[path];\n    }\n\n    const pathname = new URL(path, 'https://example.com').pathname;\n    for (const [name, application] of Object.entries(this.applications)) {\n      if (application.routing) {\n        for (const group of application.routing) {\n          for (const childPath of group.paths) {\n            const regexp = pathToRegexp(childPath);\n            if (regexp.test(pathname)) {\n              this.pathCache[path] = name;\n              return name;\n            }\n          }\n        }\n      }\n    }\n    const defaultApplication = Object.entries(this.applications).find(\n      ([, application]) => application.default,\n    );\n    if (!defaultApplication) {\n      return null;\n    }\n\n    this.pathCache[path] = defaultApplication[0];\n    return defaultApplication[0];\n  }\n\n  serialize(): ClientConfig {\n    return this.serialized;\n  }\n}\n","import { MicrofrontendConfigClient } from '../microfrontends-config/client';\nimport type { WellKnownClientData } from './types';\n\n/**\n * Returns data used by the client to ensure that navigations across\n * microfrontend boundaries are routed and prefetched correctly. The client\n * configuration is safe to expose to users.\n *\n * This data should be exposed in a `.well-known/vercel/microfrontends/client-config`\n * endpoint.\n */\nexport async function getWellKnownClientData(\n  clientConfig: string | undefined,\n  flagValues: Record<string, () => Promise<boolean>> = {},\n): Promise<WellKnownClientData> {\n  const config = MicrofrontendConfigClient.fromEnv(clientConfig);\n  for (const [applicationName, application] of Object.entries(\n    config.applications,\n  )) {\n    if (!application.routing) {\n      continue;\n    }\n    const newRoutingMatches = [];\n    for (const pathGroup of application.routing) {\n      if (pathGroup.flag) {\n        const flagName = pathGroup.flag;\n        const flagFn = flagValues[flagName];\n        if (!flagFn) {\n          throw new Error(\n            `Flag \"${flagName}\" was specified to control routing for path group \"${pathGroup.group}\" in application ${applicationName} but not found in provided flag values.`,\n          );\n        }\n        // eslint-disable-next-line no-await-in-loop\n        const flagEnabled = await flagFn();\n        if (flagEnabled) {\n          newRoutingMatches.push(pathGroup);\n        }\n      } else {\n        newRoutingMatches.push(pathGroup);\n      }\n    }\n    application.routing = newRoutingMatches;\n  }\n\n  return {\n    config: config.serialize(),\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAA6B;;;ACA7B,4BAA6B;AAOtB,IAAM,4BAAN,MAAgC;AAAA,EAKrC,YAAY,QAAsB,MAAyC;AAH3E,qBAAoC,CAAC;AAInC,SAAK,aAAa;AAClB,QAAI,6BAAM,oBAAoB;AAC5B,iBAAW,OAAO,OAAO,OAAO,OAAO,YAAY,GAAG;AACpD,YAAI,IAAI,SAAS;AACf,cAAI,UAAU,IAAI,QAAQ,OAAO,CAAC,UAAU,CAAC,MAAM,IAAI;AAAA,QACzD;AAAA,MACF;AAAA,IACF;AACA,SAAK,eAAe,OAAO;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,QACL,QACA,MAC2B;AAC3B,QAAI,CAAC,QAAQ;AACX,YAAM,IAAI,MAAM,uCAAuC;AAAA,IACzD;AACA,WAAO,IAAI;AAAA,MACT,KAAK,MAAM,MAAM;AAAA,MACjB;AAAA,IACF;AAAA,EACF;AAAA,EAEA,QAAQ,OAA2C;AACjD,WACE,KAAK,UAAU,KAAK,YAAY,MAAM,KAAK,UAAU,MAAM,YAAY;AAAA,EAE3E;AAAA,EAEA,0BAA0B,MAA6B;AACrD,QAAI,CAAC,KAAK,WAAW,GAAG,GAAG;AACzB,YAAM,IAAI,MAAM,0BAA0B;AAAA,IAC5C;AAEA,QAAI,KAAK,UAAU,IAAI,GAAG;AACxB,aAAO,KAAK,UAAU,IAAI;AAAA,IAC5B;AAEA,UAAM,WAAW,IAAI,IAAI,MAAM,qBAAqB,EAAE;AACtD,eAAW,CAAC,MAAM,WAAW,KAAK,OAAO,QAAQ,KAAK,YAAY,GAAG;AACnE,UAAI,YAAY,SAAS;AACvB,mBAAW,SAAS,YAAY,SAAS;AACvC,qBAAW,aAAa,MAAM,OAAO;AACnC,kBAAM,aAAS,oCAAa,SAAS;AACrC,gBAAI,OAAO,KAAK,QAAQ,GAAG;AACzB,mBAAK,UAAU,IAAI,IAAI;AACvB,qBAAO;AAAA,YACT;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,UAAM,qBAAqB,OAAO,QAAQ,KAAK,YAAY,EAAE;AAAA,MAC3D,CAAC,CAAC,EAAE,WAAW,MAAM,YAAY;AAAA,IACnC;AACA,QAAI,CAAC,oBAAoB;AACvB,aAAO;AAAA,IACT;AAEA,SAAK,UAAU,IAAI,IAAI,mBAAmB,CAAC;AAC3C,WAAO,mBAAmB,CAAC;AAAA,EAC7B;AAAA,EAEA,YAA0B;AACxB,WAAO,KAAK;AAAA,EACd;AACF;;;ACzEA,eAAsB,uBACpB,cACA,aAAqD,CAAC,GACxB;AAC9B,QAAM,SAAS,0BAA0B,QAAQ,YAAY;AAC7D,aAAW,CAAC,iBAAiB,WAAW,KAAK,OAAO;AAAA,IAClD,OAAO;AAAA,EACT,GAAG;AACD,QAAI,CAAC,YAAY,SAAS;AACxB;AAAA,IACF;AACA,UAAM,oBAAoB,CAAC;AAC3B,eAAW,aAAa,YAAY,SAAS;AAC3C,UAAI,UAAU,MAAM;AAClB,cAAM,WAAW,UAAU;AAC3B,cAAM,SAAS,WAAW,QAAQ;AAClC,YAAI,CAAC,QAAQ;AACX,gBAAM,IAAI;AAAA,YACR,SAAS,8DAA8D,UAAU,yBAAyB;AAAA,UAC5G;AAAA,QACF;AAEA,cAAM,cAAc,MAAM,OAAO;AACjC,YAAI,aAAa;AACf,4BAAkB,KAAK,SAAS;AAAA,QAClC;AAAA,MACF,OAAO;AACL,0BAAkB,KAAK,SAAS;AAAA,MAClC;AAAA,IACF;AACA,gBAAY,UAAU;AAAA,EACxB;AAEA,SAAO;AAAA,IACL,QAAQ,OAAO,UAAU;AAAA,EAC3B;AACF;;;AFjCA,eAAsB,oCACpB,YACuB;AACvB,SAAO,2BAAa;AAAA,IAClB,MAAM;AAAA,MACJ,QAAQ,IAAI;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AACF;","names":[]}

package/dist/next/endpoints.d.ts

@@ -1,4 +1,15 @@
 import { NextResponse } from 'next/server';
+import { C as ClientConfig } from '../types-fc30696d.js';
+import '../types-a29d224a.js';
+
+/**
+ * Data that is returned from the `.well-known/vercel/microfrontends/client-config`
+ * endpoint that is used by the client to ensure that navigations and prefetches
+ * are routed correctly.
+ */
+interface WellKnownClientData {
+    config: ClientConfig;
+}
 
 /**
  * A Next.js App Router API handler to export the micro-frontends client config
@@ -10,6 +21,6 @@ import { NextResponse } from 'next/server';
  * export { wellKnownNextjsClientConfigAppRoute as GET } from '@vercel/microfrontends/next/endpoints';
  * ```
  */
-declare function wellKnownNextjsClientConfigAppRoute(): Promise<NextResponse>;
+declare function wellKnownNextjsClientConfigAppRoute(flagValues: Record<string, () => Promise<boolean>>): Promise<NextResponse>;
 
-export { wellKnownNextjsClientConfigAppRoute };
+export { WellKnownClientData, wellKnownNextjsClientConfigAppRoute };

package/dist/next/endpoints.js

@@ -1,21 +1,75 @@
 // src/next/endpoints/index.ts
 import { NextResponse } from "next/server";
 
-// src/config/client/client-config.ts
-function getClientConfigFromEnv() {
-  const clientConfigJson = process.env.NEXT_PUBLIC_MFE_CLIENT_CONFIG;
-  if (!clientConfigJson) {
-    throw new Error(
-      "Could not find client micro-frontends config in the environment"
+// src/config/microfrontends-config/client/index.ts
+import { pathToRegexp } from "path-to-regexp";
+var MicrofrontendConfigClient = class {
+  constructor(config, opts) {
+    this.pathCache = {};
+    this.serialized = config;
+    if (opts == null ? void 0 : opts.removeFlaggedPaths) {
+      for (const app of Object.values(config.applications)) {
+        if (app.routing) {
+          app.routing = app.routing.filter((match) => !match.flag);
+        }
+      }
+    }
+    this.applications = config.applications;
+  }
+  /**
+   * Create a new `MicrofrontendConfigClient` from a JSON string.
+   * Config must be passed in to remain framework agnostic
+   */
+  static fromEnv(config, opts) {
+    if (!config) {
+      throw new Error("No microfrontends configuration found");
+    }
+    return new MicrofrontendConfigClient(
+      JSON.parse(config),
+      opts
     );
   }
-  return JSON.parse(clientConfigJson);
-}
+  isEqual(other) {
+    return JSON.stringify(this.applications) === JSON.stringify(other.applications);
+  }
+  getApplicationNameForPath(path) {
+    if (!path.startsWith("/")) {
+      throw new Error(`Path must start with a /`);
+    }
+    if (this.pathCache[path]) {
+      return this.pathCache[path];
+    }
+    const pathname = new URL(path, "https://example.com").pathname;
+    for (const [name, application] of Object.entries(this.applications)) {
+      if (application.routing) {
+        for (const group of application.routing) {
+          for (const childPath of group.paths) {
+            const regexp = pathToRegexp(childPath);
+            if (regexp.test(pathname)) {
+              this.pathCache[path] = name;
+              return name;
+            }
+          }
+        }
+      }
+    }
+    const defaultApplication = Object.entries(this.applications).find(
+      ([, application]) => application.default
+    );
+    if (!defaultApplication) {
+      return null;
+    }
+    this.pathCache[path] = defaultApplication[0];
+    return defaultApplication[0];
+  }
+  serialize() {
+    return this.serialized;
+  }
+};
 
 // src/config/well-known/endpoints.ts
-async function getWellKnownClientData(flagValues = {}) {
-  var _a;
-  const config = getClientConfigFromEnv();
+async function getWellKnownClientData(clientConfig, flagValues = {}) {
+  const config = MicrofrontendConfigClient.fromEnv(clientConfig);
   for (const [applicationName, application] of Object.entries(
     config.applications
   )) {
@@ -23,9 +77,9 @@ async function getWellKnownClientData(flagValues = {}) {
       continue;
     }
     const newRoutingMatches = [];
-    for (const pathGroup of application.routing.matches) {
-      if ((_a = pathGroup.options) == null ? void 0 : _a.flag) {
-        const flagName = pathGroup.options.flag;
+    for (const pathGroup of application.routing) {
+      if (pathGroup.flag) {
+        const flagName = pathGroup.flag;
         const flagFn = flagValues[flagName];
         if (!flagFn) {
           throw new Error(
@@ -40,16 +94,21 @@ async function getWellKnownClientData(flagValues = {}) {
         newRoutingMatches.push(pathGroup);
       }
     }
-    application.routing.matches = newRoutingMatches;
+    application.routing = newRoutingMatches;
   }
   return {
-    config
+    config: config.serialize()
   };
 }
 
 // src/next/endpoints/index.ts
-async function wellKnownNextjsClientConfigAppRoute() {
-  return NextResponse.json(await getWellKnownClientData());
+async function wellKnownNextjsClientConfigAppRoute(flagValues) {
+  return NextResponse.json(
+    await getWellKnownClientData(
+      process.env.NEXT_PUBLIC_MFE_CLIENT_CONFIG,
+      flagValues
+    )
+  );
 }
 export {
   wellKnownNextjsClientConfigAppRoute

package/dist/next/endpoints.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/next/endpoints/index.ts","../../src/config/client/client-config.ts","../../src/config/well-known/endpoints.ts"],"sourcesContent":["import { NextResponse } from 'next/server';\nimport { getWellKnownClientData } from '../../config/well-known/endpoints';\nimport type { WellKnownClientData } from '../../config/client/types';\n\n/**\n * A Next.js App Router API handler to export the micro-frontends client config\n * data.\n *\n * @example In the `app/.well-known/vercel/microfrontends/client-config/route.ts` file,\n * add this code:\n * ```\n * export { wellKnownNextjsClientConfigAppRoute as GET } from '@vercel/microfrontends/next/endpoints';\n * ```\n */\nexport async function wellKnownNextjsClientConfigAppRoute(): Promise<NextResponse> {\n  return NextResponse.json<WellKnownClientData>(await getWellKnownClientData());\n}\n","import type { Config } from '../schema';\nimport type { ClientConfig, WellKnownClientData } from './types';\n\n/**\n * Given a micro-frontends configuration, this returns a version that is\n * acceptable to be used client-side without leaking any information.\n */\nexport function getConfigForClient(config: Config): ClientConfig {\n  return {\n    applications: Object.fromEntries(\n      Object.entries(config.applications).map(([name, application]) => [\n        name,\n        {\n          default: application.default,\n          routing: application.routing,\n        },\n      ]),\n    ),\n  };\n}\n\nexport function getClientConfigFromEnv(): ClientConfig {\n  // This has to use the actual name rather than the constant variable in order\n  // for the env var to be replaced during the build correctly.\n  const clientConfigJson = process.env.NEXT_PUBLIC_MFE_CLIENT_CONFIG;\n  if (!clientConfigJson) {\n    throw new Error(\n      'Could not find client micro-frontends config in the environment',\n    );\n  }\n  return JSON.parse(clientConfigJson) as ClientConfig;\n}\n\nexport type { ClientConfig, WellKnownClientData };\n","import { getClientConfigFromEnv } from '../client/client-config';\nimport type { WellKnownClientData } from '../client/types';\n\n/**\n * Returns data used by the client to ensure that navigations across\n * micro-frontend boundaries are routed and prefetched correctly. The client\n * configuration is safe to expose to users.\n *\n * This data should be exposed in a `.well-known/vercel/microfrontends/client-config`\n * endpoint.\n */\nexport async function getWellKnownClientData(\n  flagValues: Record<string, () => Promise<boolean>> = {},\n): Promise<WellKnownClientData> {\n  const config = getClientConfigFromEnv();\n  for (const [applicationName, application] of Object.entries(\n    config.applications,\n  )) {\n    if (!application.routing) {\n      continue;\n    }\n    const newRoutingMatches = [];\n    for (const pathGroup of application.routing.matches) {\n      if (pathGroup.options?.flag) {\n        const flagName = pathGroup.options.flag;\n        const flagFn = flagValues[flagName];\n        if (!flagFn) {\n          throw new Error(\n            `Flag \"${flagName}\" was specified to control routing for path group \"${pathGroup.group}\" in application ${applicationName} but not found in provided flag values.`,\n          );\n        }\n        // eslint-disable-next-line no-await-in-loop\n        const flagEnabled = await flagFn();\n        if (flagEnabled) {\n          newRoutingMatches.push(pathGroup);\n        }\n      } else {\n        newRoutingMatches.push(pathGroup);\n      }\n    }\n    application.routing.matches = newRoutingMatches;\n  }\n\n  return {\n    config,\n  };\n}\n"],"mappings":";AAAA,SAAS,oBAAoB;;;ACqBtB,SAAS,yBAAuC;AAGrD,QAAM,mBAAmB,QAAQ,IAAI;AACrC,MAAI,CAAC,kBAAkB;AACrB,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AACA,SAAO,KAAK,MAAM,gBAAgB;AACpC;;;ACpBA,eAAsB,uBACpB,aAAqD,CAAC,GACxB;AAbhC;AAcE,QAAM,SAAS,uBAAuB;AACtC,aAAW,CAAC,iBAAiB,WAAW,KAAK,OAAO;AAAA,IAClD,OAAO;AAAA,EACT,GAAG;AACD,QAAI,CAAC,YAAY,SAAS;AACxB;AAAA,IACF;AACA,UAAM,oBAAoB,CAAC;AAC3B,eAAW,aAAa,YAAY,QAAQ,SAAS;AACnD,WAAI,eAAU,YAAV,mBAAmB,MAAM;AAC3B,cAAM,WAAW,UAAU,QAAQ;AACnC,cAAM,SAAS,WAAW,QAAQ;AAClC,YAAI,CAAC,QAAQ;AACX,gBAAM,IAAI;AAAA,YACR,SAAS,8DAA8D,UAAU,yBAAyB;AAAA,UAC5G;AAAA,QACF;AAEA,cAAM,cAAc,MAAM,OAAO;AACjC,YAAI,aAAa;AACf,4BAAkB,KAAK,SAAS;AAAA,QAClC;AAAA,MACF,OAAO;AACL,0BAAkB,KAAK,SAAS;AAAA,MAClC;AAAA,IACF;AACA,gBAAY,QAAQ,UAAU;AAAA,EAChC;AAEA,SAAO;AAAA,IACL;AAAA,EACF;AACF;;;AFhCA,eAAsB,sCAA6D;AACjF,SAAO,aAAa,KAA0B,MAAM,uBAAuB,CAAC;AAC9E;","names":[]}
+{"version":3,"sources":["../../src/next/endpoints/index.ts","../../src/config/microfrontends-config/client/index.ts","../../src/config/well-known/endpoints.ts"],"sourcesContent":["import { NextResponse } from 'next/server';\nimport { getWellKnownClientData } from '../../config/well-known/endpoints';\nimport type { WellKnownClientData } from '../../config/well-known/types';\n\n/**\n * A Next.js App Router API handler to export the micro-frontends client config\n * data.\n *\n * @example In the `app/.well-known/vercel/microfrontends/client-config/route.ts` file,\n * add this code:\n * ```\n * export { wellKnownNextjsClientConfigAppRoute as GET } from '@vercel/microfrontends/next/endpoints';\n * ```\n */\nexport async function wellKnownNextjsClientConfigAppRoute(\n  flagValues: Record<string, () => Promise<boolean>>,\n): Promise<NextResponse> {\n  return NextResponse.json<WellKnownClientData>(\n    await getWellKnownClientData(\n      process.env.NEXT_PUBLIC_MFE_CLIENT_CONFIG,\n      flagValues,\n    ),\n  );\n}\n\nexport type { WellKnownClientData };\n","import { pathToRegexp } from 'path-to-regexp';\nimport type { ClientConfig } from './types';\n\ninterface MicrofrontendConfigClientOptions {\n  removeFlaggedPaths?: boolean;\n}\n\nexport class MicrofrontendConfigClient {\n  applications: ClientConfig['applications'];\n  pathCache: Record<string, string> = {};\n  private readonly serialized: ClientConfig;\n\n  constructor(config: ClientConfig, opts?: MicrofrontendConfigClientOptions) {\n    this.serialized = config;\n    if (opts?.removeFlaggedPaths) {\n      for (const app of Object.values(config.applications)) {\n        if (app.routing) {\n          app.routing = app.routing.filter((match) => !match.flag);\n        }\n      }\n    }\n    this.applications = config.applications;\n  }\n\n  /**\n   * Create a new `MicrofrontendConfigClient` from a JSON string.\n   * Config must be passed in to remain framework agnostic\n   */\n  static fromEnv(\n    config: string | undefined,\n    opts?: MicrofrontendConfigClientOptions,\n  ): MicrofrontendConfigClient {\n    if (!config) {\n      throw new Error('No microfrontends configuration found');\n    }\n    return new MicrofrontendConfigClient(\n      JSON.parse(config) as ClientConfig,\n      opts,\n    );\n  }\n\n  isEqual(other: MicrofrontendConfigClient): boolean {\n    return (\n      JSON.stringify(this.applications) === JSON.stringify(other.applications)\n    );\n  }\n\n  getApplicationNameForPath(path: string): string | null {\n    if (!path.startsWith('/')) {\n      throw new Error(`Path must start with a /`);\n    }\n\n    if (this.pathCache[path]) {\n      return this.pathCache[path];\n    }\n\n    const pathname = new URL(path, 'https://example.com').pathname;\n    for (const [name, application] of Object.entries(this.applications)) {\n      if (application.routing) {\n        for (const group of application.routing) {\n          for (const childPath of group.paths) {\n            const regexp = pathToRegexp(childPath);\n            if (regexp.test(pathname)) {\n              this.pathCache[path] = name;\n              return name;\n            }\n          }\n        }\n      }\n    }\n    const defaultApplication = Object.entries(this.applications).find(\n      ([, application]) => application.default,\n    );\n    if (!defaultApplication) {\n      return null;\n    }\n\n    this.pathCache[path] = defaultApplication[0];\n    return defaultApplication[0];\n  }\n\n  serialize(): ClientConfig {\n    return this.serialized;\n  }\n}\n","import { MicrofrontendConfigClient } from '../microfrontends-config/client';\nimport type { WellKnownClientData } from './types';\n\n/**\n * Returns data used by the client to ensure that navigations across\n * microfrontend boundaries are routed and prefetched correctly. The client\n * configuration is safe to expose to users.\n *\n * This data should be exposed in a `.well-known/vercel/microfrontends/client-config`\n * endpoint.\n */\nexport async function getWellKnownClientData(\n  clientConfig: string | undefined,\n  flagValues: Record<string, () => Promise<boolean>> = {},\n): Promise<WellKnownClientData> {\n  const config = MicrofrontendConfigClient.fromEnv(clientConfig);\n  for (const [applicationName, application] of Object.entries(\n    config.applications,\n  )) {\n    if (!application.routing) {\n      continue;\n    }\n    const newRoutingMatches = [];\n    for (const pathGroup of application.routing) {\n      if (pathGroup.flag) {\n        const flagName = pathGroup.flag;\n        const flagFn = flagValues[flagName];\n        if (!flagFn) {\n          throw new Error(\n            `Flag \"${flagName}\" was specified to control routing for path group \"${pathGroup.group}\" in application ${applicationName} but not found in provided flag values.`,\n          );\n        }\n        // eslint-disable-next-line no-await-in-loop\n        const flagEnabled = await flagFn();\n        if (flagEnabled) {\n          newRoutingMatches.push(pathGroup);\n        }\n      } else {\n        newRoutingMatches.push(pathGroup);\n      }\n    }\n    application.routing = newRoutingMatches;\n  }\n\n  return {\n    config: config.serialize(),\n  };\n}\n"],"mappings":";AAAA,SAAS,oBAAoB;;;ACA7B,SAAS,oBAAoB;AAOtB,IAAM,4BAAN,MAAgC;AAAA,EAKrC,YAAY,QAAsB,MAAyC;AAH3E,qBAAoC,CAAC;AAInC,SAAK,aAAa;AAClB,QAAI,6BAAM,oBAAoB;AAC5B,iBAAW,OAAO,OAAO,OAAO,OAAO,YAAY,GAAG;AACpD,YAAI,IAAI,SAAS;AACf,cAAI,UAAU,IAAI,QAAQ,OAAO,CAAC,UAAU,CAAC,MAAM,IAAI;AAAA,QACzD;AAAA,MACF;AAAA,IACF;AACA,SAAK,eAAe,OAAO;AAAA,EAC7B;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,QACL,QACA,MAC2B;AAC3B,QAAI,CAAC,QAAQ;AACX,YAAM,IAAI,MAAM,uCAAuC;AAAA,IACzD;AACA,WAAO,IAAI;AAAA,MACT,KAAK,MAAM,MAAM;AAAA,MACjB;AAAA,IACF;AAAA,EACF;AAAA,EAEA,QAAQ,OAA2C;AACjD,WACE,KAAK,UAAU,KAAK,YAAY,MAAM,KAAK,UAAU,MAAM,YAAY;AAAA,EAE3E;AAAA,EAEA,0BAA0B,MAA6B;AACrD,QAAI,CAAC,KAAK,WAAW,GAAG,GAAG;AACzB,YAAM,IAAI,MAAM,0BAA0B;AAAA,IAC5C;AAEA,QAAI,KAAK,UAAU,IAAI,GAAG;AACxB,aAAO,KAAK,UAAU,IAAI;AAAA,IAC5B;AAEA,UAAM,WAAW,IAAI,IAAI,MAAM,qBAAqB,EAAE;AACtD,eAAW,CAAC,MAAM,WAAW,KAAK,OAAO,QAAQ,KAAK,YAAY,GAAG;AACnE,UAAI,YAAY,SAAS;AACvB,mBAAW,SAAS,YAAY,SAAS;AACvC,qBAAW,aAAa,MAAM,OAAO;AACnC,kBAAM,SAAS,aAAa,SAAS;AACrC,gBAAI,OAAO,KAAK,QAAQ,GAAG;AACzB,mBAAK,UAAU,IAAI,IAAI;AACvB,qBAAO;AAAA,YACT;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,UAAM,qBAAqB,OAAO,QAAQ,KAAK,YAAY,EAAE;AAAA,MAC3D,CAAC,CAAC,EAAE,WAAW,MAAM,YAAY;AAAA,IACnC;AACA,QAAI,CAAC,oBAAoB;AACvB,aAAO;AAAA,IACT;AAEA,SAAK,UAAU,IAAI,IAAI,mBAAmB,CAAC;AAC3C,WAAO,mBAAmB,CAAC;AAAA,EAC7B;AAAA,EAEA,YAA0B;AACxB,WAAO,KAAK;AAAA,EACd;AACF;;;ACzEA,eAAsB,uBACpB,cACA,aAAqD,CAAC,GACxB;AAC9B,QAAM,SAAS,0BAA0B,QAAQ,YAAY;AAC7D,aAAW,CAAC,iBAAiB,WAAW,KAAK,OAAO;AAAA,IAClD,OAAO;AAAA,EACT,GAAG;AACD,QAAI,CAAC,YAAY,SAAS;AACxB;AAAA,IACF;AACA,UAAM,oBAAoB,CAAC;AAC3B,eAAW,aAAa,YAAY,SAAS;AAC3C,UAAI,UAAU,MAAM;AAClB,cAAM,WAAW,UAAU;AAC3B,cAAM,SAAS,WAAW,QAAQ;AAClC,YAAI,CAAC,QAAQ;AACX,gBAAM,IAAI;AAAA,YACR,SAAS,8DAA8D,UAAU,yBAAyB;AAAA,UAC5G;AAAA,QACF;AAEA,cAAM,cAAc,MAAM,OAAO;AACjC,YAAI,aAAa;AACf,4BAAkB,KAAK,SAAS;AAAA,QAClC;AAAA,MACF,OAAO;AACL,0BAAkB,KAAK,SAAS;AAAA,MAClC;AAAA,IACF;AACA,gBAAY,UAAU;AAAA,EACxB;AAEA,SAAO;AAAA,IACL,QAAQ,OAAO,UAAU;AAAA,EAC3B;AACF;;;AFjCA,eAAsB,oCACpB,YACuB;AACvB,SAAO,aAAa;AAAA,IAClB,MAAM;AAAA,MACJ,QAAQ,IAAI;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AACF;","names":[]}