@vercel/config 0.0.20 → 0.0.22

package/README.md

@@ -13,10 +13,8 @@ npm install @vercel/config
 Create a `vercel.ts` file in your project root:
 
 ```typescript
-import { createRouter } from '@vercel/config';
-import type { VercelConfig } from '@vercel/config';
-
-const router = createRouter();
+import { routes } from '@vercel/config/v1';
+import type { VercelConfig } from '@vercel/config/v1';
 
 export const config: VercelConfig = {
   buildCommand: 'npm run build',
@@ -24,10 +22,10 @@ export const config: VercelConfig = {
   
   rewrites: [
     // Simple rewrite
-    router.rewrite('/api/(.*)', 'https://backend.api.example.com/$1'),
+    routes.rewrite('/api/(.*)', 'https://backend.api.example.com/$1'),
     
     // Rewrite with transforms
-    router.rewrite('/users/:userId', 'https://api.example.com/users/$1', 
+    routes.rewrite('/users/:userId', 'https://api.example.com/users/$1', 
       ({ userId, env }) => ({
         requestHeaders: {
           'x-user-id': userId,
@@ -38,11 +36,11 @@ export const config: VercelConfig = {
   ],
   
   redirects: [
-    router.redirect('/old-docs', '/docs', { permanent: true })
+    routes.redirect('/old-docs', '/docs', { permanent: true })
   ],
 
   headers: [
-    router.cacheControl('/static/(.*)', {
+    routes.cacheControl('/static/(.*)', {
       public: true,
       maxAge: '1 week',
       immutable: true
@@ -58,7 +56,7 @@ export const config: VercelConfig = {
 ## Features
 
 - **Type-safe configuration** - Full TypeScript support with IDE autocomplete
-- **Readable syntax** - Helper methods like `router.redirect()`, `router.rewrite()`, `router.header()`
+- **Readable syntax** - Helper methods like `routes.redirect()`, `routes.rewrite()`, `routes.header()`
 - **Transforms** - Modify request/response headers and query parameters on the fly
 - **Conditions** - Advanced routing with `has` and `missing` conditions
 - **CLI tools** - `compile` and `validate` commands for development

package/dist/router.d.ts

@@ -1,21 +1,35 @@
 import type { Redirect, Rewrite } from './types';
 /**
- * Helper function to reference a path parameter in transforms.
- * Path parameters are extracted from the route pattern (e.g., :userId).
+ * Type utility to extract path parameter names from a route pattern string.
+ * Supports :paramName syntax used in path-to-regexp patterns.
  *
  * @example
- * param('userId') // Returns '$userId'
+ * ExtractPathParams<'/users/:userId/posts/:postId'> // 'userId' | 'postId'
+ * ExtractPathParams<'/api/(.*)'> // never
  */
-export declare function param(name: string): string;
+type ExtractPathParams<T extends string> = T extends `${string}:${infer Param}/${infer Rest}` ? (Param extends `${infer P}(${string}` ? P : Param) | ExtractPathParams<`/${Rest}`> : T extends `${string}:${infer Param}` ? Param extends `${infer P}(${string}` ? P : Param : never;
 /**
- * Helper function to reference a runtime environment variable in transforms.
- * These are environment variables that get resolved at request time by Vercel's routing layer,
- * not at build time.
+ * Creates an object type where keys are the extracted path parameter names
+ * and values are strings (the resolved $paramName values).
+ */
+type PathParams<T extends string> = {
+    [K in ExtractPathParams<T>]: string;
+};
+/**
+ * Helper function to reference a Vercel project environment variable.
+ * These are placeholders that get resolved at request time by Vercel's routing layer.
+ * They are set per-deployment and don't change until you redeploy.
  *
  * @example
- * runtimeEnv('BEARER_TOKEN') // Returns '$BEARER_TOKEN'
+ * // Usage in rewrites with type-safe path params:
+ * routes.rewrite('/users/:userId', 'https://api.example.com/$1', ({ userId }) => ({
+ *   requestHeaders: {
+ *     'x-user-id': userId,
+ *     'authorization': `Bearer ${deploymentEnv('API_KEY')}`
+ *   }
+ * }))
  */
-export declare function runtimeEnv(name: string): string;
+export declare function deploymentEnv(name: string): string;
 /**
  * Template literal type for durations recognized by pretty-cache-header.
  *
@@ -466,31 +480,10 @@ export interface RouterConfig {
      * When routes is present, other fields (redirects, headers, rewrites, crons) are excluded.
      */
     routes?: Route[];
-    /**
-     * When true, Vercel automatically removes file extensions and normalizes
-     * certain paths, serving HTML and serverless routes extension-free.
-     */
-    cleanUrls?: boolean;
-    /**
-     * When true, routes are normalized to include a trailing slash.
-     */
-    trailingSlash?: boolean;
-    /**
-     * Path to a JSON file containing bulk redirect rules.
-     */
-    bulkRedirectsPath?: string;
     /**
      * Array of cron definitions for scheduled invocations.
      */
     crons?: CronRule[];
-    /**
-     * Custom build command to run during deployment.
-     */
-    buildCommand?: string;
-    /**
-     * Custom install command to run during deployment.
-     */
-    installCommand?: string;
 }
 /**
  * The main Router class for building a Vercel configuration object in code.
@@ -503,35 +496,6 @@ export declare class Router {
     private rewriteRules;
     private routeRules;
     private cronRules;
-    private cleanUrlsConfig;
-    private trailingSlashConfig;
-    private bulkRedirectsPathConfig;
-    private buildCommandConfig;
-    private installCommandConfig;
-    /**
-     * Property setter for cleanUrls configuration.
-     */
-    set cleanUrls(value: boolean | undefined);
-    /**
-     * Property getter for cleanUrls configuration.
-     */
-    get cleanUrls(): boolean | undefined;
-    /**
-     * Property setter for trailingSlash configuration.
-     */
-    set trailingSlash(value: boolean | undefined);
-    /**
-     * Property getter for trailingSlash configuration.
-     */
-    get trailingSlash(): boolean | undefined;
-    /**
-     * Property setter for bulkRedirectsPath configuration.
-     */
-    set bulkRedirectsPath(value: string | undefined);
-    /**
-     * Property getter for bulkRedirectsPath configuration.
-     */
-    get bulkRedirectsPath(): string | undefined;
     /**
      * Helper to extract path parameter names from a source pattern.
      * Path parameters are identified by :paramName syntax.
@@ -539,11 +503,6 @@ export declare class Router {
      * extractPathParams('/users/:userId/posts/:postId') // Returns ['userId', 'postId']
      */
     private extractPathParams;
-    /**
-     * Creates a Proxy object that tracks environment variable accesses.
-     * Returns both the proxy and a set of accessed environment variable names.
-     */
-    private createEnvProxy;
     /**
      * Creates a rewrite rule. Returns either a Rewrite object (simple case) or Route with transforms.
      *
@@ -551,27 +510,42 @@ export declare class Router {
      *    // Simple rewrite
      *    router.rewrite('/api/(.*)', 'https://old-on-prem.com/$1')
      *
-     *    // With transforms
-     *    router.rewrite('/users/:userId', 'https://api.example.com/users/$1', ({userId, env}) => ({
-     *      requestHeaders: { 'x-user-id': userId }
+     *    // With transforms but no path params
+     *    router.rewrite('/(.*)', 'https://api.example.com/$1', {
+     *      requestHeaders: {
+     *        'authorization': `Bearer ${deploymentEnv('API_KEY')}`
+     *      }
+     *    })
+     *
+     *    // With type-safe path params
+     *    router.rewrite('/users/:userId', 'https://api.example.com/users/$1', ({ userId }) => ({
+     *      requestHeaders: {
+     *        'x-user-id': userId,
+     *        'authorization': `Bearer ${deploymentEnv('API_KEY')}`
+     *      }
      *    }))
+     *
+     *    // With conditions only
+     *    router.rewrite('/admin/(.*)', 'https://admin.example.com/$1', {
+     *      has: [{ type: 'header', key: 'x-admin-token' }]
+     *    })
      * @internal Can return Route with transforms internally
      */
-    rewrite(source: string, destination: string, optionsOrCallback?: {
+    rewrite<T extends string>(source: T, destination: string): Rewrite | Route;
+    rewrite<T extends string>(source: T, destination: string, callback: (params: PathParams<T>) => {
         has?: Condition[];
         missing?: Condition[];
         requestHeaders?: Record<string, string | string[]>;
         responseHeaders?: Record<string, string | string[]>;
         requestQuery?: Record<string, string | string[]>;
-    } | ((params: Record<string, string> & {
-        env: any;
-    }) => {
+    }): Rewrite | Route;
+    rewrite<T extends string>(source: T, destination: string, options: ({
         has?: Condition[];
         missing?: Condition[];
         requestHeaders?: Record<string, string | string[]>;
         responseHeaders?: Record<string, string | string[]>;
         requestQuery?: Record<string, string | string[]>;
-    })): Rewrite | Route;
+    }) & Record<never, never>): Rewrite | Route;
     /**
      * Creates a redirect rule. Returns either a Redirect object (simple case) or Route with transforms.
      *
@@ -579,28 +553,44 @@ export declare class Router {
      *    // Simple redirect
      *    router.redirect('/old-path', '/new-path', { permanent: true })
      *
-     *    // With transforms
-     *    router.redirect('/users/:userId', '/new-users/$1', ({userId, env}) => ({
+     *    // With transforms but no path params
+     *    router.redirect('/old', '/new', {
      *      permanent: true,
-     *      requestHeaders: { 'x-user-id': userId }
+     *      requestHeaders: {
+     *        'x-api-key': deploymentEnv('API_KEY')
+     *      }
+     *    })
+     *
+     *    // With type-safe path params
+     *    router.redirect('/users/:userId', '/new-users/$1', ({ userId }) => ({
+     *      permanent: true,
+     *      requestHeaders: {
+     *        'x-user-id': userId,
+     *        'x-api-key': deploymentEnv('API_KEY')
+     *      }
      *    }))
+     *
+     *    // With conditions only
+     *    router.redirect('/dashboard/(.*)', '/login', {
+     *      missing: [{ type: 'cookie', key: 'auth-token' }]
+     *    })
      * @internal Can return Route with transforms internally
      */
-    redirect(source: string, destination: string, optionsOrCallback?: {
+    redirect<T extends string>(source: T, destination: string): Redirect | Route;
+    redirect<T extends string>(source: T, destination: string, callback: (params: PathParams<T>) => {
         permanent?: boolean;
         statusCode?: number;
         has?: Condition[];
         missing?: Condition[];
         requestHeaders?: Record<string, string | string[]>;
-    } | ((params: Record<string, string> & {
-        env: any;
-    }) => {
+    }): Redirect | Route;
+    redirect<T extends string>(source: T, destination: string, options: {
         permanent?: boolean;
         statusCode?: number;
         has?: Condition[];
         missing?: Condition[];
         requestHeaders?: Record<string, string | string[]>;
-    })): Redirect | Route;
+    }): Redirect | Route;
     /**
      * Creates a header rule matching the vercel.json schema.
      * @example
@@ -661,27 +651,6 @@ export declare class Router {
      *    });
      */
     route(config: Route): this;
-    /**
-     * When true, automatically serve HTML files and serverless functions
-     * without the .html or .js extension. This is a built-in Vercel feature.
-     */
-    setCleanUrls(value: boolean): this;
-    /**
-     * When true, automatically normalize paths to include a trailing slash.
-     */
-    setTrailingSlash(value: boolean): this;
-    /**
-     * Sets a custom build command to run during deployment.
-     * @example
-     *   router.setBuildCommand('pnpm run generate-config')
-     */
-    setBuildCommand(value: string): this;
-    /**
-     * Sets a custom install command to run during deployment.
-     * @example
-     *   router.setInstallCommand('pnpm install --no-frozen-lockfile')
-     */
-    setInstallCommand(value: string): this;
     /**
      * Adds a single cron rule (synchronous).
      */
@@ -707,7 +676,15 @@ export declare class Router {
 /**
  * A simple factory function for creating a new Router instance.
  * @example
- *   import { createRouter } from '@vercel/router-sdk';
- *   const router = createRouter();
+ *   import { createRoutes } from '@vercel/router-sdk';
+ *   const routes = createRoutes();
+ */
+export declare function createRoutes(): Router;
+/**
+ * Default singleton router instance for convenience.
+ * @example
+ *   import { routes } from '@vercel/router-sdk';
+ *   routes.redirect('/old', '/new');
  */
-export declare function createRouter(): Router;
+export declare const routes: Router;
+export {};

package/dist/router.js

@@ -1,31 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRouter = exports.Router = exports.runtimeEnv = exports.param = void 0;
+exports.routes = exports.createRoutes = exports.Router = exports.deploymentEnv = void 0;
 const pretty_cache_header_1 = require("pretty-cache-header");
 const validation_1 = require("./utils/validation");
 /**
- * Helper function to reference a path parameter in transforms.
- * Path parameters are extracted from the route pattern (e.g., :userId).
+ * Helper function to reference a Vercel project environment variable.
+ * These are placeholders that get resolved at request time by Vercel's routing layer.
+ * They are set per-deployment and don't change until you redeploy.
  *
  * @example
- * param('userId') // Returns '$userId'
+ * // Usage in rewrites with type-safe path params:
+ * routes.rewrite('/users/:userId', 'https://api.example.com/$1', ({ userId }) => ({
+ *   requestHeaders: {
+ *     'x-user-id': userId,
+ *     'authorization': `Bearer ${deploymentEnv('API_KEY')}`
+ *   }
+ * }))
  */
-function param(name) {
+function deploymentEnv(name) {
     return `$${name}`;
 }
-exports.param = param;
-/**
- * Helper function to reference a runtime environment variable in transforms.
- * These are environment variables that get resolved at request time by Vercel's routing layer,
- * not at build time.
- *
- * @example
- * runtimeEnv('BEARER_TOKEN') // Returns '$BEARER_TOKEN'
- */
-function runtimeEnv(name) {
-    return `$${name}`;
-}
-exports.runtimeEnv = runtimeEnv;
+exports.deploymentEnv = deploymentEnv;
 /**
  * Extract environment variable names from a string or array of strings
  * Returns env var names without the $ prefix, excluding path parameters
@@ -62,47 +57,6 @@ class Router {
         this.rewriteRules = [];
         this.routeRules = [];
         this.cronRules = [];
-        this.cleanUrlsConfig = undefined;
-        this.trailingSlashConfig = undefined;
-        this.bulkRedirectsPathConfig = undefined;
-        this.buildCommandConfig = undefined;
-        this.installCommandConfig = undefined;
-    }
-    /**
-     * Property setter for cleanUrls configuration.
-     */
-    set cleanUrls(value) {
-        this.cleanUrlsConfig = value;
-    }
-    /**
-     * Property getter for cleanUrls configuration.
-     */
-    get cleanUrls() {
-        return this.cleanUrlsConfig;
-    }
-    /**
-     * Property setter for trailingSlash configuration.
-     */
-    set trailingSlash(value) {
-        this.trailingSlashConfig = value;
-    }
-    /**
-     * Property getter for trailingSlash configuration.
-     */
-    get trailingSlash() {
-        return this.trailingSlashConfig;
-    }
-    /**
-     * Property setter for bulkRedirectsPath configuration.
-     */
-    set bulkRedirectsPath(value) {
-        this.bulkRedirectsPathConfig = value;
-    }
-    /**
-     * Property getter for bulkRedirectsPath configuration.
-     */
-    get bulkRedirectsPath() {
-        return this.bulkRedirectsPathConfig;
     }
     /**
      * Helper to extract path parameter names from a source pattern.
@@ -118,50 +72,15 @@ class Router {
         }
         return params;
     }
-    /**
-     * Creates a Proxy object that tracks environment variable accesses.
-     * Returns both the proxy and a set of accessed environment variable names.
-     */
-    createEnvProxy() {
-        const accessedVars = new Set();
-        const proxy = new Proxy({}, {
-            get(_target, prop) {
-                if (typeof prop === 'string') {
-                    accessedVars.add(prop);
-                    return `$${prop}`;
-                }
-                return undefined;
-            }
-        });
-        return { proxy, accessedVars };
-    }
-    /**
-     * Creates a rewrite rule. Returns either a Rewrite object (simple case) or Route with transforms.
-     *
-     * @example
-     *    // Simple rewrite
-     *    router.rewrite('/api/(.*)', 'https://old-on-prem.com/$1')
-     *
-     *    // With transforms
-     *    router.rewrite('/users/:userId', 'https://api.example.com/users/$1', ({userId, env}) => ({
-     *      requestHeaders: { 'x-user-id': userId }
-     *    }))
-     * @internal Can return Route with transforms internally
-     */
     rewrite(source, destination, optionsOrCallback) {
         this.validateSourcePattern(source);
         let options;
-        // Handle callback syntax
         if (typeof optionsOrCallback === 'function') {
             const pathParams = this.extractPathParams(source);
-            const { proxy: envProxy } = this.createEnvProxy();
-            // Create params object with path parameters as $paramName
             const paramsObj = {};
             for (const param of pathParams) {
                 paramsObj[param] = `$${param}`;
             }
-            paramsObj.env = envProxy;
-            // Call the callback to get options
             options = optionsOrCallback(paramsObj);
         }
         else {
@@ -241,34 +160,15 @@ class Router {
             rewrite.missing = missing;
         return rewrite;
     }
-    /**
-     * Creates a redirect rule. Returns either a Redirect object (simple case) or Route with transforms.
-     *
-     * @example
-     *    // Simple redirect
-     *    router.redirect('/old-path', '/new-path', { permanent: true })
-     *
-     *    // With transforms
-     *    router.redirect('/users/:userId', '/new-users/$1', ({userId, env}) => ({
-     *      permanent: true,
-     *      requestHeaders: { 'x-user-id': userId }
-     *    }))
-     * @internal Can return Route with transforms internally
-     */
     redirect(source, destination, optionsOrCallback) {
         this.validateSourcePattern(source);
         let options;
-        // Handle callback syntax
         if (typeof optionsOrCallback === 'function') {
             const pathParams = this.extractPathParams(source);
-            const { proxy: envProxy } = this.createEnvProxy();
-            // Create params object with path parameters as $paramName
             const paramsObj = {};
             for (const param of pathParams) {
                 paramsObj[param] = `$${param}`;
             }
-            paramsObj.env = envProxy;
-            // Call the callback to get options
             options = optionsOrCallback(paramsObj);
         }
         else {
@@ -392,39 +292,6 @@ class Router {
         this.routeRules.push(config);
         return this;
     }
-    /**
-     * When true, automatically serve HTML files and serverless functions
-     * without the .html or .js extension. This is a built-in Vercel feature.
-     */
-    setCleanUrls(value) {
-        this.cleanUrlsConfig = value;
-        return this;
-    }
-    /**
-     * When true, automatically normalize paths to include a trailing slash.
-     */
-    setTrailingSlash(value) {
-        this.trailingSlashConfig = value;
-        return this;
-    }
-    /**
-     * Sets a custom build command to run during deployment.
-     * @example
-     *   router.setBuildCommand('pnpm run generate-config')
-     */
-    setBuildCommand(value) {
-        this.buildCommandConfig = value;
-        return this;
-    }
-    /**
-     * Sets a custom install command to run during deployment.
-     * @example
-     *   router.setInstallCommand('pnpm install --no-frozen-lockfile')
-     */
-    setInstallCommand(value) {
-        this.installCommandConfig = value;
-        return this;
-    }
     /**
      * Adds a single cron rule (synchronous).
      */
@@ -532,16 +399,6 @@ class Router {
             };
             // NOTE: crons are now handled via export const crons in vercel.ts
             // They are no longer included in router.getConfig()
-            // Only include optional fields if they're explicitly set
-            if (this.bulkRedirectsPathConfig !== undefined) {
-                config.bulkRedirectsPath = this.bulkRedirectsPathConfig;
-            }
-            if (this.buildCommandConfig !== undefined) {
-                config.buildCommand = this.buildCommandConfig;
-            }
-            if (this.installCommandConfig !== undefined) {
-                config.installCommand = this.installCommandConfig;
-            }
             return config;
         }
         // Otherwise, return the legacy format
@@ -549,20 +406,8 @@ class Router {
             redirects: this.redirectRules,
             headers: this.headerRules,
             rewrites: legacyRewrites,
-            cleanUrls: this.cleanUrlsConfig,
-            trailingSlash: this.trailingSlashConfig,
             // NOTE: crons are now handled via export const crons in vercel.ts
         };
-        // Only include optional fields if they're explicitly set
-        if (this.bulkRedirectsPathConfig !== undefined) {
-            config.bulkRedirectsPath = this.bulkRedirectsPathConfig;
-        }
-        if (this.buildCommandConfig !== undefined) {
-            config.buildCommand = this.buildCommandConfig;
-        }
-        if (this.installCommandConfig !== undefined) {
-            config.installCommand = this.installCommandConfig;
-        }
         return config;
     }
     /**
@@ -633,10 +478,17 @@ exports.Router = Router;
 /**
  * A simple factory function for creating a new Router instance.
  * @example
- *   import { createRouter } from '@vercel/router-sdk';
- *   const router = createRouter();
+ *   import { createRoutes } from '@vercel/router-sdk';
+ *   const routes = createRoutes();
  */
-function createRouter() {
+function createRoutes() {
     return new Router();
 }
-exports.createRouter = createRouter;
+exports.createRoutes = createRoutes;
+/**
+ * Default singleton router instance for convenience.
+ * @example
+ *   import { routes } from '@vercel/router-sdk';
+ *   routes.redirect('/old', '/new');
+ */
+exports.routes = new Router();

package/dist/types.d.ts

@@ -3,75 +3,123 @@
  * https://openapi.vercel.sh/vercel.json
  */
 export type Framework = 'blitzjs' | 'nextjs' | 'gatsby' | 'remix' | 'react-router' | 'astro' | 'hexo' | 'eleventy' | 'docusaurus-2' | 'docusaurus' | 'preact' | 'solidstart-1' | 'solidstart' | 'dojo' | 'ember' | 'vue' | 'scully' | 'ionic-angular' | 'angular' | 'polymer' | 'svelte' | 'sveltekit' | 'sveltekit-1' | 'ionic-react' | 'create-react-app' | 'gridsome' | 'umijs' | 'sapper' | 'saber' | 'stencil' | 'nuxtjs' | 'redwoodjs' | 'hugo' | 'jekyll' | 'brunch' | 'middleman' | 'zola' | 'hydrogen' | 'vite' | 'tanstack-start' | 'vitepress' | 'vuepress' | 'parcel' | 'fastapi' | 'flask' | 'fasthtml' | 'sanity-v3' | 'sanity' | 'storybook' | 'nitro' | 'hono' | 'express' | 'h3' | 'nestjs' | 'elysia' | 'fastify' | 'xmcp' | null;
-export interface CronJob {
-    schedule: string;
-    path: string;
-}
 export interface FunctionConfig {
+    /**
+     * A glob pattern to match files that should be excluded from your Serverless Function. If you’re using a Community Runtime, the behavior might vary.
+     */
     excludeFiles?: string;
+    /**
+     * A glob pattern to match files that should be included in your Serverless Function. If you’re using a Community Runtime, the behavior might vary.
+     */
     includeFiles?: string;
+    /**
+     * An integer defining how long your Serverless Function should be allowed to run on every request in seconds (between 1 and the maximum limit of your plan).
+     */
     maxDuration?: number;
+    /**
+     * An integer defining the memory your Serverless Function should be provided with (between 128 and 10240).
+     */
     memory?: number;
+    /**
+     * The npm package name of a Runtime, including its version
+     */
     runtime?: string;
+    /**
+     * A boolean that defines whether the Function supports cancellation (default: false)
+     */
     supportsCancellation?: boolean;
-    experimentalTriggers?: Array<{
-        type: 'queue/v1beta';
+    /**
+     * An array of experimental triggers for this Serverless Function. Currently only supports queue triggers.
+     */
+    experimentalTriggers?: {
+        /**
+         * Event type pattern this trigger handles
+         */
+        type: string;
+        /**
+         * Name of the queue topic to consume from
+         */
         topic: string;
+        /**
+         * Name of the consumer group for this trigger
+         */
         consumer: string;
+        /**
+         * Maximum number of delivery attempts
+         */
         maxDeliveries?: number;
+        /**
+         * Delay in seconds before retrying failed executions
+         */
         retryAfterSeconds?: number;
+        /**
+         * Initial delay in seconds before first execution attempt
+         */
         initialDelaySeconds?: number;
-    }>;
+    }[];
+}
+export interface CronJob {
+    schedule: string;
+    path: string;
 }
 export interface GitDeploymentConfig {
     [branch: string]: boolean;
 }
 export interface GitConfig {
+    /**
+     * Specifies the branches that will not trigger an auto-deployment when committing to them. Any non specified branch is `true` by default.
+     */
     deploymentEnabled?: boolean | GitDeploymentConfig;
     /**
+     * If specified, the git repository will be exclusive to the specificed Team IDs. Teams that are not specified in the list will not be able to link new projects or create new deployments.
      * @private
      */
     exclusivity?: {
+        /**
+         * A list of allowed Team IDs.
+         */
         teams?: string[];
     };
 }
 export interface GithubConfig {
-    enabled?: boolean;
+    /**
+     * When set to `false`, Vercel for GitHub will not deploy the given project regardless of the GitHub app being installed.
+     */
     autoAlias?: boolean;
+    /**
+     * When set to `false`, Vercel for GitHub will always build pushes in sequence without cancelling a build for the most recent commit.
+     */
     autoJobCancelation?: boolean;
     /**
+     * When set to false, Vercel for GitHub will not apply the alias upon merge.
+     */
+    enabled?: boolean;
+    /**
+     * [deprecated] Please use the Project Settings in the dashboard instead: https://vercel.link/46vERTS When set to `true`, Vercel for GitHub will stop commenting on pull requests and commits.
      * @deprecated
      */
     silent?: boolean;
 }
 export interface ImageConfig {
-    sizes: number[];
-    domains?: string[];
-    formats?: ('image/avif' | 'image/webp' | 'image/jpeg' | 'image/png')[];
-    minimumCacheTTL?: number;
-    dangerouslyAllowSVG?: boolean;
-    contentSecurityPolicy?: string;
     contentDispositionType?: 'inline' | 'attachment';
-    qualities?: number[];
-    localPatterns?: Array<{
+    contentSecurityPolicy?: string;
+    dangerouslyAllowSVG?: boolean;
+    domains?: string[];
+    formats?: 'image/avif' | 'image/webp' | 'image/jpeg' | 'image/png'[];
+    localPatterns?: {
         pathname?: string;
         search?: string;
-    }>;
-    remotePatterns?: Array<{
+    }[];
+    minimumCacheTTL?: number;
+    qualities?: number[];
+    remotePatterns?: {
         protocol?: 'http' | 'https';
         hostname: string;
         port?: string;
         pathname?: string;
         search?: string;
-    }>;
-}
-export interface ProbeConfig {
-    path: string;
-    initialDelaySeconds?: number;
-    periodSeconds?: number;
-    timeoutSeconds?: number;
-    successThreshold?: number;
-    failureThreshold?: number;
+    }[];
+    sizes: number[];
 }
 /**
  * HTTP header key/value pair
@@ -101,7 +149,7 @@ export interface Condition {
 }
 /**
  * Redirect matching vercel.json schema
- * Returned by router.redirect()
+ * Returned by routes.redirect()
  */
 export interface Redirect {
     source: string;
@@ -113,7 +161,7 @@ export interface Redirect {
 }
 /**
  * Rewrite matching vercel.json schema
- * Returned by router.rewrite()
+ * Returned by routes.rewrite()
  */
 export interface Rewrite {
     source: string;
@@ -123,7 +171,7 @@ export interface Rewrite {
 }
 /**
  * Header rule matching vercel.json schema
- * Returned by router.header() and router.cacheControl()
+ * Returned by routes.header() and routes.cacheControl()
  */
 export interface HeaderRule {
     source: string;
@@ -145,154 +193,133 @@ export interface BuildConfig {
     env?: Record<string, string>;
 }
 export interface BuildItem {
+    config?: Record<string, any>;
     src?: string;
     use: string;
-    config?: Record<string, any>;
 }
 export interface VercelConfig {
     /**
-     * JSON schema URL for editor completions and validation.
-     */
-    $schema?: string;
-    /**
-     * Aliases that will get assigned when the deployment is `READY` and the target is `production`.
+     * Aliases that will get assigned when the deployment is `READY` and the target is `production`. The client needs to make a `GET` request to its API to ensure the assignment
      */
     alias?: string | string[];
     /**
-     * Build configuration (deprecated).
+     * An object containing another object with information to be passed to the Build Process
      * @deprecated
      */
     build?: BuildConfig;
     /**
-     * Build descriptions (deprecated).
+     * A list of build descriptions whose src references valid source files.
      * @deprecated
      */
     builds?: BuildItem[];
     /**
-     * Path to a JSON file containing bulk redirect rules.
-     */
-    bulkRedirectsPath?: string;
-    /**
-     * When set to `true`, all HTML files and Serverless Functions will have their extension removed.
+     * When set to `true`, all HTML files and Serverless Functions will have their extension removed. When visiting a path that ends with the extension, a 308 response will redirect the client to the extensionless path.
      */
     cleanUrls?: boolean;
     /**
-     * An array of cron jobs that should be created for production Deployments.
-     */
-    crons?: CronJob[];
-    /**
-     * An object containing the deployment's environment variables.
+     * An object containing the deployment's environment variable names and values. Secrets can be referenced by prefixing the value with `@`
+     * @deprecated
      */
     env?: Record<string, string>;
     /**
-     * An array of the passive regions the deployment's Serverless Functions should be deployed to.
+     * An array of the passive regions the deployment's Serverless Functions should be deployed to that can be failed over to during a lambda outage
      */
     passiveRegions?: string[];
     /**
-     * Same as passiveRegions. An array of passive regions for failover.
+     * Same as passiveRegions. An array of the passive regions the deployment's Serverless Functions should be deployed to so we can failover to these regions on lambda outages
      */
     functionFailoverRegions?: string[];
     /**
-     * An object describing custom options for Serverless Functions.
+     * An object describing custom options for your Serverless Functions. Each key must be glob pattern that matches the paths of the Serverless Functions you would like to customize (like `api/*.js` or `api/test.js`).
      */
     functions?: Record<string, FunctionConfig>;
-    /**
-     * Git-related configuration.
-     */
     git?: GitConfig;
     /**
-     * GitHub-related configuration.
+     * @private
      */
     github?: GithubConfig;
     /**
-     * HTTP headers configuration.
-     * Can use router.header() and router.cacheControl() helpers.
+     * A list of header definitions.
      */
     headers?: RouteType[];
-    /**
-     * Image optimization configuration.
-     */
     images?: ImageConfig;
     /**
-     * A name for the deployment.
+     * A name for the deployment
      */
     name?: string;
     /**
-     * Probe configuration for health checks.
-     */
-    probes?: ProbeConfig[];
-    /**
-     * When true, the source code is not stored on the platform and only the production output will be deployed.
+     * Whether a deployment's source and logs are available publicly
      */
     public?: boolean;
     /**
-     * HTTP redirects configuration.
-     * Can use router.redirect() helper.
+     * A list of redirect definitions.
      */
     redirects?: RouteType[];
     /**
-     * An array of regions where the deployment's Serverless Functions and Edge Functions should be deployed to.
+     * The path to a file containing bulk redirects; supports JSON, JSONL, and CSV
+     */
+    bulkRedirectsPath?: string | null;
+    /**
+     * An array of the regions the deployment's Serverless Functions should be deployed to
      */
     regions?: string[];
     /**
-     * HTTP rewrites configuration.
-     * Can use router.rewrite() helper.
+     * A list of rewrite definitions.
      */
     rewrites?: RouteType[];
     /**
-     * Routes configuration using the lower-level routes primitive.
-     * Use this if you need transforms or want everything in one place.
-     * Cannot be mixed with headers, redirects, or rewrites.
+     * A list of routes objects used to rewrite paths to point towards other internal or external paths
+     * @deprecated
      */
     routes?: RouteType[];
     /**
-     * Scope (user or team) for deployment.
+     * This property determines the scope (user or team) under which the project will be deployed by Vercel CLI.
      * @private
      */
     scope?: string;
     /**
-     * Wildcard domain configuration.
+     * When `false`, visiting a path that ends with a forward slash will respond with a `308` status code and redirect to the path without the trailing slash.
      */
-    wildcard?: WildcardDomain[];
+    trailingSlash?: boolean;
     /**
-     * Version of the configuration schema.
      * @private
      */
     version?: number;
     /**
-     * The build command for this project. When `null`, automatically detected.
+     * @private
      */
-    buildCommand?: string | null;
+    wildcard?: WildcardDomain[];
     /**
-     * The ignore command for this project.
+     * The build command for this project. When `null` is used this value will be automatically detected
      */
+    buildCommand?: string | null;
     ignoreCommand?: string | null;
     /**
-     * The dev command for this project. When `null`, automatically detected.
+     * The dev command for this project. When `null` is used this value will be automatically detected
      */
     devCommand?: string | null;
     /**
-     * The framework being used. When `null`, no framework is selected.
+     * The framework that is being used for this project. When `null` is used no framework is selected
      */
     framework?: Framework;
     /**
-     * The install command for this project. When `null`, automatically detected.
+     * The install command for this project. When `null` is used this value will be automatically detected
      */
     installCommand?: string | null;
     /**
-     * The output directory of the project. When `null`, automatically detected.
+     * The output directory of the project. When `null` is used this value will be automatically detected
      */
     outputDirectory?: string | null;
     /**
-     * When `false`, visiting a path that ends with a forward slash will redirect to the path without the trailing slash.
+     * An array of cron jobs that should be created for production Deployments.
      */
-    trailingSlash?: boolean;
+    crons?: CronJob[];
     /**
      * An array of projectIds to associate with the current project.
      */
     relatedProjects?: string[];
     /**
-     * Enables Fluid compute for the project.
+     * Enables Fluid compute for the project. It's enabled by default for new projects.
      */
     fluid?: boolean;
     /**

package/dist/v1/index.d.ts

@@ -1,4 +1,4 @@
-export { createRouter, Router } from "../router";
+export { createRoutes, routes, Router } from "../router";
 export * from "../router";
 export { VercelConfig } from "../types";
 export type { Redirect, Rewrite, HeaderRule, Condition, RouteType } from "../types";

package/dist/v1/index.js

@@ -14,9 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateStaticFields = exports.validateStaticStringArray = exports.validateStaticObject = exports.validateStaticBoolean = exports.validateStaticString = exports.VercelConfig = exports.Router = exports.createRouter = void 0;
+exports.validateStaticFields = exports.validateStaticStringArray = exports.validateStaticObject = exports.validateStaticBoolean = exports.validateStaticString = exports.VercelConfig = exports.Router = exports.routes = exports.createRoutes = void 0;
 var router_1 = require("../router");
-Object.defineProperty(exports, "createRouter", { enumerable: true, get: function () { return router_1.createRouter; } });
+Object.defineProperty(exports, "createRoutes", { enumerable: true, get: function () { return router_1.createRoutes; } });
+Object.defineProperty(exports, "routes", { enumerable: true, get: function () { return router_1.routes; } });
 Object.defineProperty(exports, "Router", { enumerable: true, get: function () { return router_1.Router; } });
 __exportStar(require("../router"), exports);
 var types_1 = require("../types");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/config",
-  "version": "0.0.20",
+  "version": "0.0.22",
   "description": "A TypeScript SDK for programmatically configuring Vercel projects",
   "bugs": {
     "url": "https://github.com/vercel/config/issues"
@@ -40,6 +40,7 @@
     "@typescript-eslint/parser": "^5.0.0",
     "eslint": "^8.0.0",
     "prettier": "^2.8.0",
+    "tsx": "^4.7.0",
     "typescript": "^4.9.0",
     "vitest": "^1.0.0"
   },
@@ -49,6 +50,7 @@
   "scripts": {
     "build": "tsc",
     "format": "prettier --write \"src/**/*.ts\"",
+    "generate-types": "tsx scripts/generate-types.ts",
     "lint": "eslint . --ext .ts",
     "release": "npm run build && changeset publish",
     "test": "vitest",