@vercel/microfrontends 0.9.0

package/dist/validation.cjs

@@ -0,0 +1,754 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/schema/validation.ts
+var validation_exports = {};
+__export(validation_exports, {
+  validateV1Schema: () => validateSchema2,
+  validateV2Schema: () => validateSchema
+});
+module.exports = __toCommonJS(validation_exports);
+
+// src/config-v2/microfrontends/server/validation.ts
+var import_jsonc_parser = require("jsonc-parser");
+var import_ajv = require("ajv");
+
+// src/config/errors.ts
+var MicroFrontendError = class extends Error {
+  constructor(message, opts) {
+    super(message);
+    this.name = "MicroFrontendsError";
+    this.source = (opts == null ? void 0 : opts.source) ?? "@vercel/micro-frontends";
+    this.type = (opts == null ? void 0 : opts.type) ?? "unknown";
+    this.subtype = opts == null ? void 0 : opts.subtype;
+    Error.captureStackTrace(this, MicroFrontendError);
+  }
+  isKnown() {
+    return this.type !== "unknown";
+  }
+  isUnknown() {
+    return !this.isKnown();
+  }
+  /**
+   * Converts an error to a MicroFrontendsError.
+   * @param original - The original error to convert.
+   * @returns The converted MicroFrontendsError.
+   */
+  static convert(original, opts) {
+    if (opts == null ? void 0 : opts.fileName) {
+      const err = MicroFrontendError.convertFSError(original, opts.fileName);
+      if (err) {
+        return err;
+      }
+    }
+    if (original.message.includes(
+      "Code generation from strings disallowed for this context"
+    )) {
+      return new MicroFrontendError(original.message, {
+        type: "config",
+        subtype: "unsupported_validation_env",
+        source: "ajv"
+      });
+    }
+    return new MicroFrontendError(original.message);
+  }
+  static convertFSError(original, fileName) {
+    if (original instanceof Error && "code" in original) {
+      if (original.code === "ENOENT") {
+        return new MicroFrontendError(`Could not find "${fileName}"`, {
+          type: "config",
+          subtype: "unable_to_read_file",
+          source: "fs"
+        });
+      }
+      if (original.code === "EACCES") {
+        return new MicroFrontendError(
+          `Permission denied while accessing "${fileName}"`,
+          {
+            type: "config",
+            subtype: "invalid_permissions",
+            source: "fs"
+          }
+        );
+      }
+    }
+    if (original instanceof SyntaxError) {
+      return new MicroFrontendError(
+        `Failed to parse "${fileName}": Invalid JSON format.`,
+        {
+          type: "config",
+          subtype: "invalid_syntax",
+          source: "fs"
+        }
+      );
+    }
+    return null;
+  }
+  /**
+   * Handles an unknown error and returns a MicroFrontendsError instance.
+   * @param err - The error to handle.
+   * @returns A MicroFrontendsError instance.
+   */
+  static handle(err, opts) {
+    if (err instanceof MicroFrontendError) {
+      return err;
+    }
+    if (err instanceof Error) {
+      return MicroFrontendError.convert(err, opts);
+    }
+    if (typeof err === "object" && err !== null) {
+      if ("message" in err && typeof err.message === "string") {
+        return MicroFrontendError.convert(new Error(err.message), opts);
+      }
+    }
+    return new MicroFrontendError("An unknown error occurred");
+  }
+};
+
+// schema/schema-v2.json
+var schema_v2_default = {
+  $schema: "http://json-schema.org/draft-07/schema#",
+  $ref: "#/definitions/Config",
+  definitions: {
+    Config: {
+      anyOf: [
+        {
+          $ref: "#/definitions/MainConfig"
+        },
+        {
+          $ref: "#/definitions/ChildConfig"
+        }
+      ]
+    },
+    MainConfig: {
+      type: "object",
+      properties: {
+        $schema: {
+          type: "string"
+        },
+        version: {
+          type: "string",
+          const: "2"
+        },
+        options: {
+          $ref: "#/definitions/Options"
+        },
+        remotes: {
+          type: "object",
+          additionalProperties: {
+            $ref: "#/definitions/Application"
+          },
+          description: "Applications that only serve a subset of the microfrontend routes only need to reference the name of the primary application that owns the full microfrontends configuration."
+        },
+        provider: {
+          $ref: "#/definitions/Provider"
+        },
+        applications: {
+          $ref: "#/definitions/ApplicationRouting",
+          description: "Mapping of application names to the routes that they host. Only needs to be defined in the application that owns the primary microfrontend domain"
+        }
+      },
+      required: ["applications", "provider", "version"]
+    },
+    Options: {
+      type: "object",
+      properties: {
+        vercel: {
+          $ref: "#/definitions/VercelOptions",
+          description: "Micro-Frontends wide options for Vercel."
+        },
+        localProxy: {
+          $ref: "#/definitions/LocalProxyOptions",
+          description: "Options for local proxy."
+        }
+      }
+    },
+    VercelOptions: {
+      type: "object",
+      properties: {
+        previewDeploymentSuffix: {
+          type: "string",
+          description: "If your team uses a custom Preview Deployment Suffix, please specify it here. See https://vercel.com/docs/deployments/preview-deployment-suffix. The default is `vercel.app`."
+        },
+        teamSlug: {
+          type: "string",
+          description: "Team slug for the Vercel team"
+        },
+        disableOverrides: {
+          type: "boolean",
+          description: "If you want to disable the overrides for the site. For example, if you are managing rewrites between applications externally, you may wish to disable the overrides on the toolbar as they will have no effect."
+        }
+      }
+    },
+    LocalProxyOptions: {
+      type: "object",
+      properties: {
+        port: {
+          type: "number",
+          description: "The port number used by the local proxy server.\n\nThe default is `3024`."
+        }
+      }
+    },
+    Application: {
+      anyOf: [
+        {
+          $ref: "#/definitions/DefaultApplication"
+        },
+        {
+          $ref: "#/definitions/ChildApplication"
+        }
+      ]
+    },
+    DefaultApplication: {
+      type: "object",
+      properties: {
+        vercel: {
+          $ref: "#/definitions/Vercel"
+        },
+        development: {
+          $ref: "#/definitions/Development"
+        },
+        production: {
+          $ref: "#/definitions/HostConfig"
+        }
+      },
+      required: ["production"]
+    },
+    Vercel: {
+      type: "object",
+      properties: {
+        projectId: {
+          type: "string",
+          description: "Vercel project ID"
+        },
+        routeSpeedInsightsToDefaultZone: {
+          type: "boolean"
+        }
+      },
+      required: ["projectId"]
+    },
+    Development: {
+      type: "object",
+      properties: {
+        local: {
+          $ref: "#/definitions/LocalHostConfig"
+        },
+        fallback: {
+          $ref: "#/definitions/HostConfig",
+          description: "Fallback for local development, could be a host config that points to any environment. If this is not provided, or the application is not running - requests to the application in local development will error."
+        },
+        task: {
+          type: "string",
+          description: "Optional task to run when starting the development server. Should reference a script in the package.json of the application."
+        }
+      }
+    },
+    LocalHostConfig: {
+      type: "object",
+      properties: {
+        host: {
+          type: "string",
+          description: "The hostname or IP address of the server. This can be a domain name (e.g., `example.com`) or an IP address (e.g., `192.168.1.1`)."
+        },
+        protocol: {
+          type: "string",
+          enum: ["http", "https"],
+          description: 'The protocol to be used for the connection.\n- `http`: Hypertext Transfer Protocol (HTTP).\n- `https`: Secure Hypertext Transfer Protocol (HTTPS).\n\n* @defaultValue "http" for local development, "https" for otherwise'
+        },
+        port: {
+          type: "number",
+          description: "The port number to be used for the connection. Common values include `80` for HTTP and `443` for HTTPS."
+        }
+      }
+    },
+    HostConfig: {
+      type: "object",
+      properties: {
+        protocol: {
+          type: "string",
+          enum: ["http", "https"],
+          description: 'The protocol to be used for the connection.\n- `http`: Hypertext Transfer Protocol (HTTP).\n- `https`: Secure Hypertext Transfer Protocol (HTTPS).\n\n* @defaultValue "http" for local development, "https" for otherwise'
+        },
+        host: {
+          type: "string",
+          description: "The hostname or IP address of the server. This can be a domain name (e.g., `example.com`) or an IP address (e.g., `192.168.1.1`)."
+        },
+        port: {
+          type: "number",
+          description: "The port number to be used for the connection. Common values include `80` for HTTP and `443` for HTTPS."
+        }
+      },
+      required: ["host"]
+    },
+    ChildApplication: {
+      type: "object",
+      properties: {
+        vercel: {
+          $ref: "#/definitions/Vercel"
+        },
+        development: {
+          $ref: "#/definitions/Development"
+        },
+        routing: {
+          $ref: "#/definitions/Routing",
+          description: "Groups of path expressions that are routed to this application."
+        },
+        production: {
+          $ref: "#/definitions/HostConfig"
+        }
+      },
+      required: ["routing"]
+    },
+    Routing: {
+      type: "array",
+      items: {
+        $ref: "#/definitions/PathGroup"
+      }
+    },
+    PathGroup: {
+      type: "object",
+      properties: {
+        group: {
+          type: "string",
+          description: "Optional group name for the paths"
+        },
+        flag: {
+          type: "string",
+          description: "flag name that can be used to enable/disable all paths in the group"
+        },
+        routeToDefaultApplication: {
+          type: "boolean",
+          description: "True to route the request to the default application for this micro-frontends set-up. This must be `true` when using `flag` or when you want to use custom logic to make the routing decision for this group of paths."
+        },
+        paths: {
+          type: "array",
+          items: {
+            type: "string"
+          }
+        }
+      },
+      required: ["paths"]
+    },
+    Provider: {
+      type: "string",
+      enum: ["vercel", "other"]
+    },
+    ApplicationRouting: {
+      type: "object",
+      additionalProperties: {
+        $ref: "#/definitions/Application"
+      }
+    },
+    ChildConfig: {
+      type: "object",
+      properties: {
+        $schema: {
+          type: "string"
+        },
+        version: {
+          type: "string",
+          const: "2"
+        },
+        options: {
+          $ref: "#/definitions/Options"
+        },
+        remotes: {
+          type: "object",
+          additionalProperties: {
+            $ref: "#/definitions/Application"
+          },
+          description: "Applications that only serve a subset of the microfrontend routes only need to reference the name of the primary application that owns the full microfrontends configuration."
+        },
+        partOf: {
+          type: "string",
+          description: "Applications that only serve a subset of the microfrontend routes only need to reference the name of the primary application that owns the full microfrontends configuration."
+        }
+      },
+      required: ["partOf", "version"]
+    }
+  }
+};
+
+// src/config-v2/schema/utils/load.ts
+var SCHEMA = schema_v2_default;
+
+// src/config-v2/microfrontends/server/validation.ts
+function validateSchema(configString) {
+  const parsedConfig = (0, import_jsonc_parser.parse)(configString);
+  const ajv = new import_ajv.Ajv();
+  const validate = ajv.compile(SCHEMA);
+  const isValid = validate(parsedConfig);
+  if (!isValid) {
+    throw new MicroFrontendError(
+      `Invalid config: ${ajv.errorsText(validate.errors)}`,
+      { type: "config", subtype: "does_not_match_schema" }
+    );
+  }
+  return parsedConfig;
+}
+
+// src/config/validation.ts
+var import_jsonc_parser2 = require("jsonc-parser");
+var import_path_to_regexp = require("path-to-regexp");
+var import_ajv2 = require("ajv");
+
+// schema/schema.json
+var schema_default = {
+  $schema: "http://json-schema.org/draft-07/schema#",
+  $ref: "#/definitions/Config",
+  definitions: {
+    Config: {
+      type: "object",
+      properties: {
+        version: {
+          type: "string"
+        },
+        $schema: {
+          type: "string"
+        },
+        name: {
+          type: "string",
+          description: 'Name for the micro-frontend site (eg. "vercel.com", "vercel-site" etc.).'
+        },
+        applications: {
+          $ref: "#/definitions/ApplicationConfigsById"
+        },
+        options: {
+          $ref: "#/definitions/Options",
+          description: "Optional configuration for the entire micro-frontends setup."
+        }
+      },
+      required: ["version", "applications"],
+      description: "Configuration for micro-frontend applications\n\nTODO: Add proxy configuration"
+    },
+    ApplicationConfigsById: {
+      type: "object",
+      additionalProperties: {
+        $ref: "#/definitions/ApplicationConfig"
+      }
+    },
+    ApplicationConfig: {
+      anyOf: [
+        {
+          $ref: "#/definitions/DefaultApplicationConfig"
+        },
+        {
+          $ref: "#/definitions/CommonApplicationConfig"
+        }
+      ],
+      description: "A Micro-Frontend Deployment Target"
+    },
+    DefaultApplicationConfig: {
+      type: "object",
+      properties: {
+        default: {
+          type: "boolean",
+          const: true,
+          description: "The default application is used no other application is matched via the routing config"
+        },
+        routing: {
+          $ref: "#/definitions/Routing"
+        },
+        development: {
+          type: "object",
+          properties: {
+            local: {
+              $ref: "#/definitions/HostConfig"
+            },
+            fallback: {
+              $ref: "#/definitions/HostConfig",
+              description: "Fallback for local development, could be a host config that points to any environment. If this is not provided, or the application is not running - requests to the application in local development will error."
+            },
+            task: {
+              type: "string",
+              description: "Optional task to run when starting the development server. Should reference a script in the package.json of the application."
+            }
+          },
+          required: ["local"]
+        },
+        production: {
+          $ref: "#/definitions/HostConfig"
+        },
+        metadata: {
+          type: "object",
+          additionalProperties: {
+            type: "string"
+          }
+        },
+        federation: {
+          type: "object",
+          properties: {
+            exposes: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  name: {
+                    type: "string",
+                    description: "The name of the module - should be used when importing the module from another application"
+                  },
+                  path: {
+                    type: "string",
+                    description: "Relative path to the module within its `application`"
+                  }
+                },
+                required: ["name", "path"]
+              },
+              description: "Modules that are exposed by this application"
+            },
+            uses: {
+              type: "array",
+              items: {
+                type: "string"
+              },
+              description: "Modules that are used by this application. Only the name of the module is required."
+            }
+          }
+        },
+        vercel: {
+          $ref: "#/definitions/Vercel"
+        }
+      },
+      required: ["default", "development", "production"]
+    },
+    Routing: {
+      type: "object",
+      properties: {
+        assetPrefix: {
+          type: "string",
+          description: "[assetPrefix] for the application"
+        },
+        matches: {
+          type: "array",
+          items: {
+            $ref: "#/definitions/PathGroup"
+          },
+          description: "Path expressions that are routed to this application."
+        }
+      },
+      required: ["matches"]
+    },
+    PathGroup: {
+      type: "object",
+      properties: {
+        group: {
+          type: "string",
+          description: "Optional group name for the paths"
+        },
+        options: {
+          type: "object",
+          properties: {
+            flag: {
+              type: "string",
+              description: "flag name that can be used to enable/disable all paths in the group"
+            },
+            routeToDefaultApplication: {
+              type: "boolean",
+              description: "True to route the request to the default application for this micro-frontends set-up. This must be `true` when using `flag` or when you want to use custom logic to make the routing decision for this group of paths."
+            }
+          }
+        },
+        paths: {
+          type: "array",
+          items: {
+            type: "string"
+          }
+        }
+      },
+      required: ["paths"]
+    },
+    HostConfig: {
+      type: "object",
+      properties: {
+        protocol: {
+          type: "string",
+          enum: ["http", "https"],
+          description: 'The protocol to be used for the connection.\n- `http`: Hypertext Transfer Protocol (HTTP).\n- `https`: Secure Hypertext Transfer Protocol (HTTPS).\n\n* @defaultValue "https"'
+        },
+        host: {
+          type: "string",
+          description: "The hostname or IP address of the server. This can be a domain name (e.g., `example.com`) or an IP address (e.g., `192.168.1.1`)."
+        },
+        port: {
+          type: "number",
+          description: "The port number to be used for the connection. Common values include `80` for HTTP and `443` for HTTPS.\n\nThis field is optional and can be omitted if the default ports for the specified protocol are used"
+        }
+      },
+      required: ["host"]
+    },
+    Vercel: {
+      type: "object",
+      properties: {
+        projectId: {
+          type: "string",
+          description: "Vercel project ID"
+        },
+        projectName: {
+          type: "string",
+          description: "Vercel project name (temporary until we can use project ID)"
+        },
+        defaultRoute: {
+          type: "string",
+          description: "The default route for the application. Used to render screenshots, favicons, and provide direct zone links"
+        },
+        routeSpeedInsightsToDefaultZone: {
+          type: "boolean",
+          description: "Whether to route Speed Insights to the default zone or each individual microfrontend."
+        }
+      },
+      required: ["projectId"]
+    },
+    CommonApplicationConfig: {
+      type: "object",
+      properties: {
+        default: {
+          type: "boolean",
+          const: false,
+          description: "The default application is used no other application is matched via the routing config"
+        },
+        routing: {
+          $ref: "#/definitions/Routing"
+        },
+        development: {
+          type: "object",
+          properties: {
+            local: {
+              $ref: "#/definitions/HostConfig"
+            },
+            fallback: {
+              $ref: "#/definitions/HostConfig",
+              description: "Fallback for local development, could be a host config that points to any environment. If this is not provided, or the application is not running - requests to the application in local development will error."
+            },
+            task: {
+              type: "string",
+              description: "Optional task to run when starting the development server. Should reference a script in the package.json of the application."
+            }
+          },
+          required: ["local"]
+        },
+        production: {
+          $ref: "#/definitions/HostConfig"
+        },
+        metadata: {
+          type: "object",
+          additionalProperties: {
+            type: "string"
+          }
+        },
+        federation: {
+          type: "object",
+          properties: {
+            exposes: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  name: {
+                    type: "string",
+                    description: "The name of the module - should be used when importing the module from another application"
+                  },
+                  path: {
+                    type: "string",
+                    description: "Relative path to the module within its `application`"
+                  }
+                },
+                required: ["name", "path"]
+              },
+              description: "Modules that are exposed by this application"
+            },
+            uses: {
+              type: "array",
+              items: {
+                type: "string"
+              },
+              description: "Modules that are used by this application. Only the name of the module is required."
+            }
+          }
+        },
+        vercel: {
+          $ref: "#/definitions/Vercel"
+        }
+      },
+      required: ["default", "development", "production", "routing"]
+    },
+    Options: {
+      type: "object",
+      properties: {
+        vercel: {
+          $ref: "#/definitions/VercelOptions",
+          description: "Micro-Frontends wide options for Vercel."
+        },
+        localProxy: {
+          $ref: "#/definitions/LocalProxyOptions",
+          description: "Options for local proxy."
+        }
+      }
+    },
+    VercelOptions: {
+      type: "object",
+      properties: {
+        previewDeploymentSuffix: {
+          type: "string",
+          description: "If your team uses a custom Preview Deployment Suffix, please specify it here. See https://vercel.com/docs/deployments/preview-deployment-suffix. The default is `vercel.app`."
+        },
+        teamSlug: {
+          type: "string",
+          description: "Team slug for the Vercel team"
+        },
+        disableOverrides: {
+          type: "boolean",
+          description: "If you want to disable the overrides for the site. For example, if you are managing rewrites between applications externally, you may wish to disable the overrides on the toolbar as they will have no effect."
+        }
+      }
+    },
+    LocalProxyOptions: {
+      type: "object",
+      properties: {
+        port: {
+          type: "number",
+          description: "The port number used by the local proxy server.\n\nThe default is `3024`."
+        }
+      }
+    }
+  }
+};
+
+// src/config/utils/load-schema.ts
+var SCHEMA2 = schema_default;
+
+// src/config/validation.ts
+var validateSchema2 = (configString) => {
+  const parsedConfig = (0, import_jsonc_parser2.parse)(configString);
+  const ajv = new import_ajv2.Ajv();
+  const validate = ajv.compile(SCHEMA2);
+  const isValid = validate(parsedConfig);
+  if (!isValid) {
+    throw new MicroFrontendError(
+      `Invalid config: ${ajv.errorsText(validate.errors)}`,
+      { type: "config", subtype: "does_not_match_schema" }
+    );
+  }
+  return parsedConfig;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  validateV1Schema,
+  validateV2Schema
+});
+//# sourceMappingURL=validation.cjs.map