vite-plugin-vercel 8.0.0 → 9.0.0

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import { ResolvedConfig, PluginOption } from 'vite';
+import { Rewrite, Redirect } from '@vercel/routing-utils';
 import { StdinOptions, BuildOptions } from 'esbuild';
 import { z } from 'zod';
-import { Rewrite, Redirect } from '@vercel/routing-utils';
 
 /**
  * Schema definition for `.vercel/output/config.json`
@@ -413,6 +413,32 @@ declare const vercelOutputConfigSchema: z.ZodObject<{
 }>;
 type VercelOutputConfig = z.infer<typeof vercelOutputConfigSchema>;
 
+/**
+ * Schema definition for `.vercel/output/config.json`
+ * @see {@link https://vercel.com/docs/build-output-api/v3#build-output-configuration}
+ */
+
+declare const vercelOutputPrerenderConfigSchema: z.ZodObject<{
+    expiration: z.ZodUnion<[z.ZodNumber, z.ZodLiteral<false>]>;
+    group: z.ZodOptional<z.ZodNumber>;
+    bypassToken: z.ZodOptional<z.ZodString>;
+    fallback: z.ZodOptional<z.ZodString>;
+    allowQuery: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strict", z.ZodTypeAny, {
+    expiration: number | false;
+    group?: number | undefined;
+    bypassToken?: string | undefined;
+    fallback?: string | undefined;
+    allowQuery?: string[] | undefined;
+}, {
+    expiration: number | false;
+    group?: number | undefined;
+    bypassToken?: string | undefined;
+    fallback?: string | undefined;
+    allowQuery?: string[] | undefined;
+}>;
+type VercelOutputPrerenderConfig = z.infer<typeof vercelOutputPrerenderConfigSchema>;
+
 /**
  * Schema definition for `.vercel/output/functions/<name>.func/.vc-config.json`
  * @see {@link https://vercel.com/docs/build-output-api/v3/primitives#serverless-function-configuration}
@@ -500,38 +526,13 @@ declare const vercelOutputVcConfigSchema: z.ZodUnion<[z.ZodObject<{
 }>]>;
 type VercelOutputVcConfig = z.infer<typeof vercelOutputVcConfigSchema>;
 
-/**
- * Schema definition for `.vercel/output/config.json`
- * @see {@link https://vercel.com/docs/build-output-api/v3#build-output-configuration}
- */
-
-declare const vercelOutputPrerenderConfigSchema: z.ZodObject<{
-    expiration: z.ZodUnion<[z.ZodNumber, z.ZodLiteral<false>]>;
-    group: z.ZodOptional<z.ZodNumber>;
-    bypassToken: z.ZodOptional<z.ZodString>;
-    fallback: z.ZodOptional<z.ZodString>;
-    allowQuery: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-}, "strict", z.ZodTypeAny, {
-    expiration: number | false;
-    group?: number | undefined;
-    bypassToken?: string | undefined;
-    fallback?: string | undefined;
-    allowQuery?: string[] | undefined;
-}, {
-    expiration: number | false;
-    group?: number | undefined;
-    bypassToken?: string | undefined;
-    fallback?: string | undefined;
-    allowQuery?: string[] | undefined;
-}>;
-type VercelOutputPrerenderConfig = z.infer<typeof vercelOutputPrerenderConfigSchema>;
-
 type ViteVercelRewrite = Rewrite & {
-    enforce?: 'pre' | 'post';
+    enforce?: "pre" | "post";
 };
 type ViteVercelRedirect = Redirect & {
-    enforce?: 'pre' | 'post';
+    enforce?: "pre" | "post";
 };
+type Awaitable<T> = T | Promise<T>;
 interface ViteVercelConfig {
     /**
      * How long Functions should be allowed to run for every request, in seconds.
@@ -592,13 +593,13 @@ interface ViteVercelConfig {
      * }
      * ```
      */
-    additionalEndpoints?: ViteVercelApiEntry[];
+    additionalEndpoints?: (ViteVercelApiEntry | (() => Awaitable<ViteVercelApiEntry>) | (() => Awaitable<ViteVercelApiEntry[]>))[];
     /**
      * Advanced configuration to override .vercel/output/config.json
      * @see {@link https://vercel.com/docs/build-output-api/v3/configuration#configuration}
      * @protected
      */
-    config?: Partial<Omit<VercelOutputConfig, 'version'>>;
+    config?: Partial<Omit<VercelOutputConfig, "version">>;
     /**
      * ISR and SSG pages are mutually exclusive. If a page is found in both, ISR prevails.
      * Keys are path relative to .vercel/output/functions directory, either without extension,
@@ -619,7 +620,7 @@ interface ViteVercelConfig {
      *
      * @protected
      */
-    isr?: Record<string, VercelOutputIsr> | (() => Promise<Record<string, VercelOutputIsr>> | Record<string, VercelOutputIsr>);
+    isr?: Record<string, VercelOutputIsr> | (() => Awaitable<Record<string, VercelOutputIsr>>);
     /**
      * Defaults to `.vercel/output`. Mostly useful for testing purpose
      * @protected
@@ -629,7 +630,7 @@ interface ViteVercelConfig {
      * By default, Vite generates static files under `dist` folder.
      * But usually, when used through a Framework, such as Vike,
      * this folder can contain anything, requiring custom integration.
-     * Set this to false is you create a plugin for a Framework.
+     * Set this to false if you create a plugin for a Framework.
      */
     distContainsOnlyStatic?: boolean;
 }
@@ -640,8 +641,8 @@ interface VercelOutputIsr extends VercelOutputPrerenderConfig {
 /**
  * Keys are path relative to .vercel/output/static directory
  */
-type ViteVercelPrerenderRoute = VercelOutputConfig['overrides'];
-type ViteVercelPrerenderFn = (resolvedConfig: ResolvedConfig) => ViteVercelPrerenderRoute | Promise<ViteVercelPrerenderRoute>;
+type ViteVercelPrerenderRoute = VercelOutputConfig["overrides"];
+type ViteVercelPrerenderFn = (resolvedConfig: ResolvedConfig) => Awaitable<ViteVercelPrerenderRoute>;
 interface ViteVercelApiEntry {
     /**
      * Path to entry file, or stdin config
@@ -656,10 +657,15 @@ interface ViteVercelApiEntry {
      */
     buildOptions?: BuildOptions;
     /**
-     * Automatically add a route for the function (mimics defaults Vercel behavior)
-     * Set to `false` to disable
+     * @deprecated use `route` instead
      */
     addRoute?: boolean;
+    /**
+     * If `true`, guesses route for the function, and adds it to config.json (mimics defaults Vercel behavior).
+     * If a string is provided, it will be equivalent to a `rewrites` rule.
+     * Set to `false` to disable
+     */
+    route?: string | boolean;
     /**
      * Set to `true` to mark this function as an Edge Function
      */
@@ -680,4 +686,4 @@ interface ViteVercelApiEntry {
 
 declare function allPlugins(options?: any): PluginOption[];
 
-export { type VercelOutputConfig, type VercelOutputIsr, type VercelOutputPrerenderConfig, type VercelOutputVcConfig, type ViteVercelApiEntry, type ViteVercelConfig, type ViteVercelPrerenderFn, type ViteVercelPrerenderRoute, type ViteVercelRedirect, type ViteVercelRewrite, allPlugins as default };
+export { type Awaitable, type VercelOutputConfig, type VercelOutputIsr, type VercelOutputPrerenderConfig, type VercelOutputVcConfig, type ViteVercelApiEntry, type ViteVercelConfig, type ViteVercelPrerenderFn, type ViteVercelPrerenderRoute, type ViteVercelRedirect, type ViteVercelRewrite, allPlugins as default };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { ResolvedConfig, PluginOption } from 'vite';
+import { Rewrite, Redirect } from '@vercel/routing-utils';
 import { StdinOptions, BuildOptions } from 'esbuild';
 import { z } from 'zod';
-import { Rewrite, Redirect } from '@vercel/routing-utils';
 
 /**
  * Schema definition for `.vercel/output/config.json`
@@ -413,6 +413,32 @@ declare const vercelOutputConfigSchema: z.ZodObject<{
 }>;
 type VercelOutputConfig = z.infer<typeof vercelOutputConfigSchema>;
 
+/**
+ * Schema definition for `.vercel/output/config.json`
+ * @see {@link https://vercel.com/docs/build-output-api/v3#build-output-configuration}
+ */
+
+declare const vercelOutputPrerenderConfigSchema: z.ZodObject<{
+    expiration: z.ZodUnion<[z.ZodNumber, z.ZodLiteral<false>]>;
+    group: z.ZodOptional<z.ZodNumber>;
+    bypassToken: z.ZodOptional<z.ZodString>;
+    fallback: z.ZodOptional<z.ZodString>;
+    allowQuery: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strict", z.ZodTypeAny, {
+    expiration: number | false;
+    group?: number | undefined;
+    bypassToken?: string | undefined;
+    fallback?: string | undefined;
+    allowQuery?: string[] | undefined;
+}, {
+    expiration: number | false;
+    group?: number | undefined;
+    bypassToken?: string | undefined;
+    fallback?: string | undefined;
+    allowQuery?: string[] | undefined;
+}>;
+type VercelOutputPrerenderConfig = z.infer<typeof vercelOutputPrerenderConfigSchema>;
+
 /**
  * Schema definition for `.vercel/output/functions/<name>.func/.vc-config.json`
  * @see {@link https://vercel.com/docs/build-output-api/v3/primitives#serverless-function-configuration}
@@ -500,38 +526,13 @@ declare const vercelOutputVcConfigSchema: z.ZodUnion<[z.ZodObject<{
 }>]>;
 type VercelOutputVcConfig = z.infer<typeof vercelOutputVcConfigSchema>;
 
-/**
- * Schema definition for `.vercel/output/config.json`
- * @see {@link https://vercel.com/docs/build-output-api/v3#build-output-configuration}
- */
-
-declare const vercelOutputPrerenderConfigSchema: z.ZodObject<{
-    expiration: z.ZodUnion<[z.ZodNumber, z.ZodLiteral<false>]>;
-    group: z.ZodOptional<z.ZodNumber>;
-    bypassToken: z.ZodOptional<z.ZodString>;
-    fallback: z.ZodOptional<z.ZodString>;
-    allowQuery: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-}, "strict", z.ZodTypeAny, {
-    expiration: number | false;
-    group?: number | undefined;
-    bypassToken?: string | undefined;
-    fallback?: string | undefined;
-    allowQuery?: string[] | undefined;
-}, {
-    expiration: number | false;
-    group?: number | undefined;
-    bypassToken?: string | undefined;
-    fallback?: string | undefined;
-    allowQuery?: string[] | undefined;
-}>;
-type VercelOutputPrerenderConfig = z.infer<typeof vercelOutputPrerenderConfigSchema>;
-
 type ViteVercelRewrite = Rewrite & {
-    enforce?: 'pre' | 'post';
+    enforce?: "pre" | "post";
 };
 type ViteVercelRedirect = Redirect & {
-    enforce?: 'pre' | 'post';
+    enforce?: "pre" | "post";
 };
+type Awaitable<T> = T | Promise<T>;
 interface ViteVercelConfig {
     /**
      * How long Functions should be allowed to run for every request, in seconds.
@@ -592,13 +593,13 @@ interface ViteVercelConfig {
      * }
      * ```
      */
-    additionalEndpoints?: ViteVercelApiEntry[];
+    additionalEndpoints?: (ViteVercelApiEntry | (() => Awaitable<ViteVercelApiEntry>) | (() => Awaitable<ViteVercelApiEntry[]>))[];
     /**
      * Advanced configuration to override .vercel/output/config.json
      * @see {@link https://vercel.com/docs/build-output-api/v3/configuration#configuration}
      * @protected
      */
-    config?: Partial<Omit<VercelOutputConfig, 'version'>>;
+    config?: Partial<Omit<VercelOutputConfig, "version">>;
     /**
      * ISR and SSG pages are mutually exclusive. If a page is found in both, ISR prevails.
      * Keys are path relative to .vercel/output/functions directory, either without extension,
@@ -619,7 +620,7 @@ interface ViteVercelConfig {
      *
      * @protected
      */
-    isr?: Record<string, VercelOutputIsr> | (() => Promise<Record<string, VercelOutputIsr>> | Record<string, VercelOutputIsr>);
+    isr?: Record<string, VercelOutputIsr> | (() => Awaitable<Record<string, VercelOutputIsr>>);
     /**
      * Defaults to `.vercel/output`. Mostly useful for testing purpose
      * @protected
@@ -629,7 +630,7 @@ interface ViteVercelConfig {
      * By default, Vite generates static files under `dist` folder.
      * But usually, when used through a Framework, such as Vike,
      * this folder can contain anything, requiring custom integration.
-     * Set this to false is you create a plugin for a Framework.
+     * Set this to false if you create a plugin for a Framework.
      */
     distContainsOnlyStatic?: boolean;
 }
@@ -640,8 +641,8 @@ interface VercelOutputIsr extends VercelOutputPrerenderConfig {
 /**
  * Keys are path relative to .vercel/output/static directory
  */
-type ViteVercelPrerenderRoute = VercelOutputConfig['overrides'];
-type ViteVercelPrerenderFn = (resolvedConfig: ResolvedConfig) => ViteVercelPrerenderRoute | Promise<ViteVercelPrerenderRoute>;
+type ViteVercelPrerenderRoute = VercelOutputConfig["overrides"];
+type ViteVercelPrerenderFn = (resolvedConfig: ResolvedConfig) => Awaitable<ViteVercelPrerenderRoute>;
 interface ViteVercelApiEntry {
     /**
      * Path to entry file, or stdin config
@@ -656,10 +657,15 @@ interface ViteVercelApiEntry {
      */
     buildOptions?: BuildOptions;
     /**
-     * Automatically add a route for the function (mimics defaults Vercel behavior)
-     * Set to `false` to disable
+     * @deprecated use `route` instead
      */
     addRoute?: boolean;
+    /**
+     * If `true`, guesses route for the function, and adds it to config.json (mimics defaults Vercel behavior).
+     * If a string is provided, it will be equivalent to a `rewrites` rule.
+     * Set to `false` to disable
+     */
+    route?: string | boolean;
     /**
      * Set to `true` to mark this function as an Edge Function
      */
@@ -680,4 +686,4 @@ interface ViteVercelApiEntry {
 
 declare function allPlugins(options?: any): PluginOption[];
 
-export { type VercelOutputConfig, type VercelOutputIsr, type VercelOutputPrerenderConfig, type VercelOutputVcConfig, type ViteVercelApiEntry, type ViteVercelConfig, type ViteVercelPrerenderFn, type ViteVercelPrerenderRoute, type ViteVercelRedirect, type ViteVercelRewrite, allPlugins as default };
+export { type Awaitable, type VercelOutputConfig, type VercelOutputIsr, type VercelOutputPrerenderConfig, type VercelOutputVcConfig, type ViteVercelApiEntry, type ViteVercelConfig, type ViteVercelPrerenderFn, type ViteVercelPrerenderRoute, type ViteVercelRedirect, type ViteVercelRewrite, allPlugins as default };