@vercel/config 0.0.14 → 0.0.17

package/dist/router.d.ts

@@ -1,3 +1,4 @@
+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).
@@ -544,102 +545,52 @@ export declare class Router {
      */
     private createEnvProxy;
     /**
-     * Helper to extract environment variable names from a string or string array.
-     * Environment variables are identified by the pattern $VAR_NAME where VAR_NAME
-     * is typically uppercase with underscores (e.g., $API_KEY, $BEARER_TOKEN).
-     */
-    private extractEnvVars;
-    /**
+     * @deprecated No longer used after refactor to return schema objects directly
      * Internal helper to convert TransformOptions to Transform array
      * @param options Transform options to convert
      * @param trackedEnvVars Optional set of environment variables that were accessed via the env proxy
      */
-    private transformOptionsToTransforms;
     /**
-     * Adds a single rewrite rule (synchronous).
-     * Automatically enables rewrite caching by adding the x-vercel-enable-rewrite-caching header.
+     * 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 using callback
+     *    // With transforms
      *    router.rewrite('/users/:userId', 'https://api.example.com/users/$1', ({userId, env}) => ({
-     *      requestHeaders: {
-     *        'x-user-id': userId,
-     *        'authorization': `Bearer ${env.API_TOKEN}`
-     *      }
-     *    }));
-     *
-     *    // With transforms using object (legacy)
-     *    router.rewrite('/users/:userId', 'https://api.example.com/users/$1', {
-     *      requestHeaders: {
-     *        'x-user-id': param('userId')
-     *      }
-     *    });
+     *      requestHeaders: { 'x-user-id': userId }
+     *    }))
+     * @internal Can return Route with transforms internally
      */
     rewrite(source: string, destination: string, optionsOrCallback?: {
-        methods?: string[];
-        status?: number;
         has?: Condition[];
         missing?: Condition[];
         requestHeaders?: Record<string, string | string[]>;
         responseHeaders?: Record<string, string | string[]>;
         requestQuery?: Record<string, string | string[]>;
-        appendRequestHeaders?: Record<string, string | string[]>;
-        appendResponseHeaders?: Record<string, string | string[]>;
-        appendRequestQuery?: Record<string, string | string[]>;
-        deleteRequestHeaders?: string[];
-        deleteResponseHeaders?: string[];
-        deleteRequestQuery?: string[];
     } | ((params: Record<string, string> & {
         env: any;
     }) => {
-        methods?: string[];
-        status?: number;
         has?: Condition[];
         missing?: Condition[];
         requestHeaders?: Record<string, string | string[]>;
         responseHeaders?: Record<string, string | string[]>;
         requestQuery?: Record<string, string | string[]>;
-        appendRequestHeaders?: Record<string, string | string[]>;
-        appendResponseHeaders?: Record<string, string | string[]>;
-        appendRequestQuery?: Record<string, string | string[]>;
-        deleteRequestHeaders?: string[];
-        deleteResponseHeaders?: string[];
-        deleteRequestQuery?: string[];
-    })): this;
-    /**
-     * Loads rewrite rules asynchronously and appends them.
-     * Automatically enables rewrite caching for all loaded rules by adding the x-vercel-enable-rewrite-caching header.
-     *
-     * @example
-     *    // This will automatically enable caching for all rewrites
-     *    await router.rewrites(() => fetchRewriteRulesFromDB());
-     */
-    rewrites(provider: RewriteProvider): Promise<this>;
+    })): Rewrite | Route;
     /**
-     * Adds a single redirect rule (synchronous).
+     * 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 using callback
+     *    // With transforms
      *    router.redirect('/users/:userId', '/new-users/$1', ({userId, env}) => ({
      *      permanent: true,
-     *      requestHeaders: {
-     *        'x-user-id': userId,
-     *        'x-api-key': env.API_KEY
-     *      }
+     *      requestHeaders: { 'x-user-id': userId }
      *    }))
-     *
-     *    // With transforms using object (legacy)
-     *    router.redirect('/users/:userId', '/new-users/$1', {
-     *      permanent: true,
-     *      requestHeaders: {
-     *        'x-user-id': param('userId')
-     *      }
-     *    })
+     * @internal Can return Route with transforms internally
      */
     redirect(source: string, destination: string, optionsOrCallback?: {
         permanent?: boolean;
@@ -647,14 +598,6 @@ export declare class Router {
         has?: Condition[];
         missing?: Condition[];
         requestHeaders?: Record<string, string | string[]>;
-        responseHeaders?: Record<string, string | string[]>;
-        requestQuery?: Record<string, string | string[]>;
-        appendRequestHeaders?: Record<string, string | string[]>;
-        appendResponseHeaders?: Record<string, string | string[]>;
-        appendRequestQuery?: Record<string, string | string[]>;
-        deleteRequestHeaders?: string[];
-        deleteResponseHeaders?: string[];
-        deleteRequestQuery?: string[];
     } | ((params: Record<string, string> & {
         env: any;
     }) => {
@@ -663,46 +606,41 @@ export declare class Router {
         has?: Condition[];
         missing?: Condition[];
         requestHeaders?: Record<string, string | string[]>;
-        responseHeaders?: Record<string, string | string[]>;
-        requestQuery?: Record<string, string | string[]>;
-        appendRequestHeaders?: Record<string, string | string[]>;
-        appendResponseHeaders?: Record<string, string | string[]>;
-        appendRequestQuery?: Record<string, string | string[]>;
-        deleteRequestHeaders?: string[];
-        deleteResponseHeaders?: string[];
-        deleteRequestQuery?: string[];
-    })): this;
+    })): Redirect | Route;
     /**
-     * Loads redirect rules asynchronously and appends them.
-     */
-    redirects(provider: RedirectProvider): Promise<this>;
-    /**
-     * Adds a single header rule (synchronous).
+     * Creates a header rule matching the vercel.json schema.
      * @example
      *    router.header('/api/(.*)', [{ key: 'X-Custom', value: 'HelloWorld' }])
      */
     header(source: string, headers: Header[], options?: {
         has?: Condition[];
         missing?: Condition[];
-    }): this;
-    /**
-     * Loads header rules asynchronously and appends them.
-     */
-    headers(provider: HeaderProvider): Promise<this>;
+    }): {
+        source: string;
+        headers: Header[];
+        has?: Condition[];
+        missing?: Condition[];
+    };
     /**
-     * Adds a typed "Cache-Control" header, leveraging `pretty-cache-header`.
-     * This method is purely for convenience, so you can do:
+     * Creates a Cache-Control header rule, leveraging `pretty-cache-header`.
+     * Returns a HeaderRule matching the vercel.json schema.
      *
-     *   router.cacheControl('/my-page', {
-     *     public: true,
-     *     maxAge: '1week',
-     *     staleWhileRevalidate: '1year'
-     *   });
+     * @example
+     *    router.cacheControl('/my-page', {
+     *      public: true,
+     *      maxAge: '1week',
+     *      staleWhileRevalidate: '1year'
+     *    })
      */
     cacheControl(source: string, cacheOptions: CacheOptions, options?: {
         has?: Condition[];
         missing?: Condition[];
-    }): this;
+    }): {
+        source: string;
+        headers: Header[];
+        has?: Condition[];
+        missing?: Condition[];
+    };
     /**
      * Adds a route with transforms support.
      * This is the newer, more powerful routing format that supports transforms.