vite-plugin-vercel 10.0.0 → 11.0.0-beta.10

package/README.md

@@ -1,5 +1,8 @@
 # vite-plugin-vercel
 
+> [!NOTE]
+> You are on the [Vite Environment API](https://vite.dev/guide/api-environment.html#environment-configuration) beta branch (v11). Check out [v9 branch](https://github.com/magne4000/vite-plugin-vercel/tree/v9) for current stable version.
+
 Vercel adapter for [Vite](https://vitejs.dev/).
 
 Bundle your Vite application as supported by [Vercel Output API (v3)](https://vercel.com/docs/build-output-api/v3).
@@ -25,12 +28,12 @@ bun add -D vite-plugin-vercel
 ## Features
 
 - [x] [SSG/Static files](https://vercel.com/docs/build-output-api/v3/primitives#static-files)
-  - see [`prerender` config](/packages/vercel/src/types.ts#L37)
+    - see [`prerender` config](/packages/vercel/src/types.ts#L37)
 - [x] [SSR/Serverless functions](https://vercel.com/docs/build-output-api/v3/primitives#serverless-functions)
-  - `.[jt]s` files under the `<root>/api` folder of your project are automatically bundled as Serverless functions under `.vercel/output/functions/api/*.func`
-  - see [`additionalEndpoints` config](/packages/vercel/src/types.ts#L62)
+    - `.[jt]s` files under the `<root>/api` folder of your project are automatically bundled as Serverless functions under `.vercel/output/functions/api/*.func`
+    - see [`additionalEndpoints` config](/packages/vercel/src/types.ts#L62)
 - [x] [ISR/Prerender functions](https://vercel.com/docs/build-output-api/v3/primitives#prerender-functions)
-  - see [`isr` config](/packages/vercel/src/types.ts#L89). Also see implementation of [vike](/packages/vike-integration/vike.ts) for example
+    - see [`isr` config](/packages/vercel/src/types.ts#L89). Also see implementation of [vike](/packages/vike-integration/vike.ts) for example
 - [x] [Edge functions](https://vercel.com/docs/build-output-api/v3/primitives#edge-functions)
 - [x] [Edge middleware](https://vercel.com/docs/functions/edge-middleware/middleware-api)
 - [ ] [Images optimization](https://vercel.com/docs/build-output-api/v3/configuration#images)
@@ -45,27 +48,32 @@ Install this package as a dev dependency and add it to your Vite config:
 // vite.config.ts
 import { defineConfig } from 'vite';
 import vercel from 'vite-plugin-vercel';
+import { getVercelEntries } from "vite-plugin-vercel";
+
+const entries = await getVercelEntries("endpoints/api", {
+  // Auto mapping examples:
+  //   endpoints/api/page.ts -> /api/page
+  //   endpoints/api/name/[name].ts -> /api/name/*
+  destination: "api",
+});
 
 export default defineConfig({
-  plugins: [vercel()],
-  vercel: {
-    // optional configuration options, see "Advanced usage" below for details
-  },
+  plugins: [vercel({
+    entries,
+  })],
 });
 ```
 
 > [!NOTE]
-> Files under `/api` or `/_api` directory will automatically be added under `/api/*` route
-> Prefer using `/_api` directory, as `@vercel/build` is currently force building `/api` files,
-> with no way to disable it, thus avoiding double compilation and unexpected behaviour.
+> `@vercel/build` forces the building of files in the _/api_ folder, with no way to disable this behavior.
+> It's recommended to place your files in a different folder.
 
 ### Configure endpoints
 
-Endpoints under `/api`, `/_api` or added through `additionalEndpoints` can be configured
-by exporting values from the endpoint file:
+Endpoints added via `getVercelEntries` can be configured by exporting values from the endpoint file:
 
 ```ts
-// file: _api/endpoint.ts
+// file: endpoints/api/endpoint.ts
 
 // Should run on edge runtime
 export const edge = true;
@@ -90,53 +98,11 @@ export default async function handler() {
 }
 ```
 
-> [!NOTE]
-> Please create an issue if you need other per-endpoints configurations
-
 ### Edge middleware
 
 You can use [Edge middleware as describe in the official documentation](https://vercel.com/docs/functions/edge-middleware/middleware-api) (i.e. with a `middleware.ts` file at the root of your project).
 
-## Usage with Vike
-
-[Vike](https://vike.dev/) is supported through [@vite-plugin-vercel/vike](/packages/vike-integration/README.md) plugin.
-
-You only need to install `@vite-plugin-vercel/vike`, the Vite config stays the same as above.
-
-You can then leverage [config files](https://vike.dev/config) to customize your endpoints:
-
-```ts
-// /pages/product/+config.ts
-
-import Page from './Page';
-import type { Config } from 'vike/types';
-
-export default {
-  // Customize ISR config for this page
-  isr: { expiration: 15 },
-  // Target Edge instead of Serverless
-  edge: true,
-  // append headers to all responses
-  headers: {
-    'X-Header': 'value'
-  }
-} satisfies Config;
-```
-
-You will also need to extend the [renderer config](https://vike.dev/config#renderer) so that `vike` is aware of the new parameter:
-
-```ts
-// /renderer/+config.ts
-
-import config from '@vite-plugin-vercel/vike/config';
-import type { Config } from 'vike/types';
-
-export default {
-  extends: config,
-} satisfies Config;
-```
-
-## Advanced usage
+## Advanced settings
 
 ```ts
 // vite.config.ts
@@ -144,8 +110,7 @@ import { defineConfig } from 'vite';
 import vercel from 'vite-plugin-vercel';
 
 export default defineConfig({
-  plugins: [vercel()],
-  vercel: {
+  plugins: [vercel({
     // All the followings optional
 
     /**
@@ -162,14 +127,7 @@ export default defineConfig({
      * Defaults to 86400 seconds (24h).
      */
     expiration: 86400,
-    /**
-     * Also known as Server Side Generation, or SSG.
-     * If present, this function is responsible to create static files in `.vercel/output/static`.
-     * Defaults to `false`, which disables prerendering.
-     */
-    prerender(resolvedConfig) {
-      // Check `/packages/vike/vike.ts` `prerender` for an example
-    },
+
     /**
      * See https://vercel.com/docs/projects/project-configuration#rewrites
      */
@@ -203,19 +161,16 @@ export default defineConfig({
      */
     trailingSlash: true,
     /**
-     * By default, all `api/*` and `_api/*` endpoints are compiled under `.vercel/output/functions/api/*.func`.
-     * If others serverless functions need to be compiled under `.vercel/output/functions`, they should be added here.
-     * For instance, a framework can leverage this to have a generic ssr endpoint
-     * without requiring the user to write any code.
+     * Use `getVercelEntries` for mapping your filesystem routes to entries.
+     * If you are interfacing this plugin with a framework, entries can also be added through the {@link https://github.com/photon-js/universal-deploy | universal-deploy} API
      */
-    additionalEndpoints: [
-      {
-        // can also be an Object representing an esbuild StdinOptions
-        source: '/path/to/file.ts',
-        // URL path of the handler, will be generated to `.vercel/output/functions/api/file.func/index.js`
-        destination: '/api/file',
-      },
-    ],
+    entries: {
+      root: {
+        id: 'src/routes/root.ts',
+        name: 'root',
+        route: '/'
+      }
+    },
     /**
      * Advanced configuration to override .vercel/output/config.json
      * See https://vercel.com/docs/build-output-api/v3/configuration#configuration
@@ -228,32 +183,31 @@ export default defineConfig({
       // cache?: string[];
       // crons?: CronsConfig;
     },
-    /**
-     * 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,
-     * or with `.prerender-config.json` extension.
-     * If you have multiple isr configurations pointing to the same underlying function, you can leverage the `symlink`
-     * property.
-     *
-     * Can be an object or a function returning an object (or a Promise of an object).
-     *
-     * Check `/packages/vike/vike.ts` `vitePluginVercelVpsIsrPlugin` for advanced usage.
-     */
-    isr: {
-      // `symlink: 'ssr_'` means that a function is available under `.vercel/output/functions/ssr_.func`
-      '/pages/a': { expiration: 15, symlink: 'ssr_', route: '^/a/.*$' },
-      '/pages/b/c': { expiration: 15, symlink: 'ssr_', route: '^/b/c/.*$' },
-      '/pages/d': { expiration: 15, symlink: 'ssr_', route: '^/d$' },
-      '/pages/e': { expiration: 25 },
-    },
     /**
      * Defaults to `.vercel/output`. Mostly useful for testing purpose
      */
     outDir: '.vercel/output',
-  },
+  })]
 });
 ```
 
+## FAQ
+
+### What does ISR do in dev mode?
+Nothing. It's a production-only feature
+
+### What does `edge: true` target do in dev mode?
+Nothing (yet?). If you have a use-case where an actual Edge runtime would be necessary in dev, please open a discussion
+
+### I don't see Vercel specific headers in dev mode
+This is not yet supported. Please open an issue if you need this (PR welcome).
+
+Related documentation: https://vercel.com/docs/edge-network/headers/request-headers
+
+## Migrations
+
+- [Migration from v9 to v11](https://github.com/magne4000/vite-plugin-vercel/blob/main/MIGRATION.md)
+
 ## Demo
 
 https://vike-photon-demo.vercel.app/

package/dist/api-DR2y7JVQ.js

@@ -0,0 +1,70 @@
+//#region src/utils/assert.ts
+function assert(condition, errorMessage) {
+	if (condition) return;
+	throw new Error(`[vite-plugin-vercel] ${errorMessage}`);
+}
+
+//#endregion
+//#region src/api.ts
+function createAPI(outfiles, pluginConfig) {
+	return {
+		getOutFiles() {
+			return outfiles;
+		},
+		get config() {
+			pluginConfig.config ??= {};
+			return pluginConfig.config;
+		},
+		get defaultMaxDuration() {
+			return pluginConfig.defaultMaxDuration;
+		},
+		set defaultMaxDuration(value) {
+			pluginConfig.defaultMaxDuration = value;
+		},
+		get expiration() {
+			return pluginConfig.expiration;
+		},
+		set expiration(value) {
+			pluginConfig.expiration = value;
+		},
+		get rewrites() {
+			pluginConfig.rewrites ??= [];
+			return pluginConfig.rewrites;
+		},
+		get headers() {
+			pluginConfig.headers ??= [];
+			return pluginConfig.headers;
+		},
+		get redirects() {
+			pluginConfig.redirects ??= [];
+			return pluginConfig.redirects;
+		},
+		get cleanUrls() {
+			return pluginConfig.cleanUrls;
+		},
+		set cleanUrls(value) {
+			pluginConfig.cleanUrls = value;
+		},
+		get trailingSlash() {
+			return pluginConfig.trailingSlash;
+		},
+		set trailingSlash(value) {
+			pluginConfig.trailingSlash = value;
+		},
+		get defaultSupportsResponseStreaming() {
+			return pluginConfig.defaultSupportsResponseStreaming;
+		},
+		set defaultSupportsResponseStreaming(value) {
+			pluginConfig.defaultSupportsResponseStreaming = value;
+		}
+	};
+}
+function getVercelAPI(pluginContextOrServer) {
+	const vpv = ("environment" in pluginContextOrServer ? pluginContextOrServer.environment.config : pluginContextOrServer.config).plugins.find((p) => p.name === "vite-plugin-vercel:api");
+	assert(vpv, "Could not find vite-plugin-vercel:api plugin");
+	assert(vpv.api, "Missing `api`. Make sure vite-plugin-vercel is up-to-date");
+	return vpv.api("environment" in pluginContextOrServer ? pluginContextOrServer : void 0);
+}
+
+//#endregion
+export { getVercelAPI as n, assert as r, createAPI as t };

package/dist/api.d.ts

@@ -0,0 +1,53 @@
+import { PluginContext, ViteVercelConfig, ViteVercelRedirect, ViteVercelRewrite } from "./types.js";
+import { VercelOutputConfig } from "@vite-plugin-vercel/schemas";
+import { ViteDevServer } from "vite";
+import { EntryMeta } from "@universal-deploy/store";
+import * as _vercel_routing_utils0 from "@vercel/routing-utils";
+
+//#region src/api.d.ts
+declare function createAPI(outfiles: ViteVercelOutFile[], pluginConfig: ViteVercelConfig): {
+  /**
+   * @internal
+   */
+  getOutFiles(): ViteVercelOutFile[];
+  readonly config: Partial<Omit<VercelOutputConfig, "version">>;
+  defaultMaxDuration: number | undefined;
+  expiration: number | undefined;
+  readonly rewrites: ViteVercelRewrite[];
+  readonly headers: _vercel_routing_utils0.Header[];
+  readonly redirects: ViteVercelRedirect[];
+  cleanUrls: boolean | undefined;
+  trailingSlash: boolean | undefined;
+  defaultSupportsResponseStreaming: boolean | undefined;
+};
+declare function getVercelAPI(pluginContextOrServer: Pick<PluginContext, "environment"> | ViteDevServer): {
+  /**
+   * @internal
+   */
+  getOutFiles(): ViteVercelOutFile[];
+  readonly config: Partial<Omit<VercelOutputConfig, "version">>;
+  defaultMaxDuration: number | undefined;
+  expiration: number | undefined;
+  readonly rewrites: ViteVercelRewrite[];
+  readonly headers: _vercel_routing_utils0.Header[];
+  readonly redirects: ViteVercelRedirect[];
+  cleanUrls: boolean | undefined;
+  trailingSlash: boolean | undefined;
+  defaultSupportsResponseStreaming: boolean | undefined;
+};
+type ViteVercelApi = ReturnType<typeof createAPI>;
+type ViteVercelOutFile = ViteVercelOutFileChunk | ViteVercelOutFileAsset;
+interface ViteVercelOutFileCommon {
+  filepath: string;
+  root: string;
+  outdir: string;
+}
+interface ViteVercelOutFileChunk extends ViteVercelOutFileCommon {
+  type: "chunk";
+  relatedEntry: EntryMeta;
+}
+interface ViteVercelOutFileAsset extends ViteVercelOutFileCommon {
+  type: "asset";
+}
+//#endregion
+export { ViteVercelApi, ViteVercelOutFile, ViteVercelOutFileAsset, ViteVercelOutFileChunk, createAPI, getVercelAPI };

package/dist/api.js

@@ -0,0 +1,3 @@
+import { n as getVercelAPI, t as createAPI } from "./api-DR2y7JVQ.js";
+
+export { createAPI, getVercelAPI };