@vercel/routing-utils 5.3.3 → 6.0.0

package/dist/index.js

@@ -55,6 +55,35 @@ function isHandler(route) {
 function isValidHandleValue(handle) {
   return validHandleValues.has(handle);
 }
+function convertRouteAliases(route, index) {
+  if (route.source !== void 0) {
+    if (route.src !== void 0) {
+      throw new Error(
+        `Route at index ${index} cannot define both \`src\` and \`source\`. Please use only one.`
+      );
+    }
+    route.src = route.source;
+    delete route.source;
+  }
+  if (route.destination !== void 0) {
+    if (route.dest !== void 0) {
+      throw new Error(
+        `Route at index ${index} cannot define both \`dest\` and \`destination\`. Please use only one.`
+      );
+    }
+    route.dest = route.destination;
+    delete route.destination;
+  }
+  if (route.statusCode !== void 0) {
+    if (route.status !== void 0) {
+      throw new Error(
+        `Route at index ${index} cannot define both \`status\` and \`statusCode\`. Please use only one.`
+      );
+    }
+    route.status = route.statusCode;
+    delete route.statusCode;
+  }
+}
 function normalizeRoutes(inputRoutes) {
   if (!inputRoutes || inputRoutes.length === 0) {
     return { routes: inputRoutes, error: null };
@@ -65,6 +94,13 @@ function normalizeRoutes(inputRoutes) {
   inputRoutes.forEach((r, i) => {
     const route = { ...r };
     routes.push(route);
+    if (!isHandler(route)) {
+      try {
+        convertRouteAliases(route, i);
+      } catch (err) {
+        errors.push(err.message);
+      }
+    }
     const keys = Object.keys(route);
     if (isHandler(route)) {
       const { handle } = route;
@@ -100,12 +136,12 @@ function normalizeRoutes(inputRoutes) {
       if (handleValue === "hit") {
         if (route.dest) {
           errors.push(
-            `Route at index ${i} cannot define \`dest\` after \`handle: hit\`.`
+            `Route at index ${i} cannot define \`dest\`/\`destination\` after \`handle: hit\`.`
           );
         }
         if (route.status) {
           errors.push(
-            `Route at index ${i} cannot define \`status\` after \`handle: hit\`.`
+            `Route at index ${i} cannot define \`status\`/\`statusCode\` after \`handle: hit\`.`
           );
         }
         if (!route.continue) {
@@ -126,7 +162,7 @@ function normalizeRoutes(inputRoutes) {
       }
     } else {
       errors.push(
-        `Route at index ${i} must define either \`handle\` or \`src\` property.`
+        `Route at index ${i} must define either \`src\` or \`source\` property.`
       );
     }
   });
@@ -142,7 +178,7 @@ function checkRegexSyntax(type, index, src) {
   try {
     new RegExp(src);
   } catch (err) {
-    const prop = type === "Route" ? "src" : "source";
+    const prop = type === "Route" ? "src`/`source" : "source";
     return `${type} at index ${index} has invalid \`${prop}\` regular expression "${src}".`;
   }
   return null;
@@ -215,20 +251,8 @@ function notEmpty(value) {
 }
 function getTransformedRoutes(vercelConfig) {
   const { cleanUrls, rewrites, redirects, headers, trailingSlash } = vercelConfig;
-  let { routes = null } = vercelConfig;
-  if (routes) {
-    const hasNewProperties = typeof cleanUrls !== "undefined" || typeof trailingSlash !== "undefined" || typeof redirects !== "undefined" || typeof headers !== "undefined" || typeof rewrites !== "undefined";
-    if (hasNewProperties) {
-      const error = createError(
-        "invalid_mixed_routes",
-        "If `rewrites`, `redirects`, `headers`, `cleanUrls` or `trailingSlash` are used, then `routes` cannot be present.",
-        "https://vercel.link/mix-routing-props",
-        "Learn More"
-      );
-      return { routes, error };
-    }
-    return normalizeRoutes(routes);
-  }
+  const { routes: userRoutes = null } = vercelConfig;
+  let routes = null;
   if (typeof cleanUrls !== "undefined") {
     const normalized = normalizeRoutes(
       (0, import_superstatic.convertCleanUrls)(cleanUrls, trailingSlash)
@@ -249,6 +273,14 @@ function getTransformedRoutes(vercelConfig) {
     routes = routes || [];
     routes.push(...normalized.routes || []);
   }
+  if (userRoutes) {
+    const normalized = normalizeRoutes(userRoutes);
+    if (normalized.error) {
+      return { routes, error: normalized.error };
+    }
+    routes = routes || [];
+    routes.push(...normalized.routes || []);
+  }
   if (typeof redirects !== "undefined") {
     const code = "invalid_redirect";
     const regexErrorMessage = redirects.map((r, i) => checkRegexSyntax("Redirect", i, r.source)).find(notEmpty);

package/dist/schemas.d.ts

@@ -190,7 +190,6 @@ export declare const hasSchema: {
  */
 export declare const routesSchema: {
     readonly type: "array";
-    readonly deprecated: true;
     readonly description: "A list of routes objects used to rewrite paths to point towards other internal or external paths";
     readonly example: readonly [{
         readonly dest: "https://docs.example.com";
@@ -199,17 +198,29 @@ export declare const routesSchema: {
     readonly items: {
         readonly anyOf: readonly [{
             readonly type: "object";
-            readonly required: readonly ["src"];
+            readonly anyOf: readonly [{
+                readonly required: readonly ["src"];
+            }, {
+                readonly required: readonly ["source"];
+            }];
             readonly additionalProperties: false;
             readonly properties: {
                 readonly src: {
                     readonly type: "string";
                     readonly maxLength: 4096;
                 };
+                readonly source: {
+                    readonly type: "string";
+                    readonly maxLength: 4096;
+                };
                 readonly dest: {
                     readonly type: "string";
                     readonly maxLength: 4096;
                 };
+                readonly destination: {
+                    readonly type: "string";
+                    readonly maxLength: 4096;
+                };
                 readonly headers: {
                     readonly type: "object";
                     readonly additionalProperties: false;
@@ -234,6 +245,7 @@ export declare const routesSchema: {
                     readonly type: "boolean";
                 };
                 readonly important: {
+                    readonly deprecated: true;
                     readonly type: "boolean";
                 };
                 readonly user: {
@@ -243,6 +255,7 @@ export declare const routesSchema: {
                     readonly type: "boolean";
                 };
                 readonly override: {
+                    readonly deprecated: true;
                     readonly type: "boolean";
                 };
                 readonly check: {
@@ -256,6 +269,11 @@ export declare const routesSchema: {
                     readonly minimum: 100;
                     readonly maximum: 999;
                 };
+                readonly statusCode: {
+                    readonly type: "integer";
+                    readonly minimum: 100;
+                    readonly maximum: 999;
+                };
                 readonly locale: {
                     readonly type: "object";
                     readonly additionalProperties: false;
@@ -887,6 +905,7 @@ export declare const routesSchema: {
             };
         }, {
             readonly type: "object";
+            readonly deprecated: true;
             readonly required: readonly ["handle"];
             readonly additionalProperties: false;
             readonly properties: {

package/dist/schemas.js

@@ -364,24 +364,31 @@ const transformsSchema = {
 };
 const routesSchema = {
   type: "array",
-  deprecated: true,
   description: "A list of routes objects used to rewrite paths to point towards other internal or external paths",
   example: [{ dest: "https://docs.example.com", src: "/docs" }],
   items: {
     anyOf: [
       {
         type: "object",
-        required: ["src"],
+        anyOf: [{ required: ["src"] }, { required: ["source"] }],
         additionalProperties: false,
         properties: {
           src: {
             type: "string",
             maxLength: 4096
           },
+          source: {
+            type: "string",
+            maxLength: 4096
+          },
           dest: {
             type: "string",
             maxLength: 4096
           },
+          destination: {
+            type: "string",
+            maxLength: 4096
+          },
           headers: {
             type: "object",
             additionalProperties: false,
@@ -406,6 +413,7 @@ const routesSchema = {
             type: "boolean"
           },
           important: {
+            deprecated: true,
             type: "boolean"
           },
           user: {
@@ -415,6 +423,7 @@ const routesSchema = {
             type: "boolean"
           },
           override: {
+            deprecated: true,
             type: "boolean"
           },
           check: {
@@ -428,6 +437,11 @@ const routesSchema = {
             minimum: 100,
             maximum: 999
           },
+          statusCode: {
+            type: "integer",
+            minimum: 100,
+            maximum: 999
+          },
           locale: {
             type: "object",
             additionalProperties: false,
@@ -493,6 +507,7 @@ const routesSchema = {
       },
       {
         type: "object",
+        deprecated: true,
         required: ["handle"],
         additionalProperties: false,
         properties: {

package/dist/types.d.ts

@@ -57,9 +57,11 @@ export type RouteWithSrc = {
     };
     methods?: string[];
     continue?: boolean;
+    /** @deprecated */
     override?: boolean;
     caseSensitive?: boolean;
     check?: boolean;
+    /** @deprecated */
     important?: boolean;
     status?: number;
     has?: HasField;
@@ -73,6 +75,15 @@ export type RouteWithSrc = {
         redirect?: Record<string, string>;
         cookie?: string;
     };
+    /**
+     * Aliases for `src`, `dest`, and `status`. These provide consistency with the
+     * `rewrites`, `redirects`, and `headers` fields which use `source`, `destination`,
+     * and `statusCode`. During normalization, these are converted to their canonical
+     * forms (`src`, `dest`, `status`) and stripped from the route object.
+     */
+    source?: string;
+    destination?: string;
+    statusCode?: number;
     /**
      * A middleware key within the `output` key under the build result.
      * Overrides a `middleware` definition.
@@ -89,6 +100,7 @@ export type RouteWithSrc = {
     respectOriginCacheControl?: boolean;
 };
 export type RouteWithHandle = {
+    /** @deprecated Internal use only. Do not use in vercel.json. */
     handle: HandleValue;
     src?: string;
     dest?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/routing-utils",
-  "version": "5.3.3",
+  "version": "6.0.0",
   "description": "Vercel routing utilities",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",