vite-plugin-vercel 9.0.7 → 10.0.0-beta.0

package/README.md

@@ -1,6 +1,11 @@
 # vite-plugin-vercel
 
-Vercel adapter for [Vite](https://vitejs.dev/).
+> [!WARNING]
+> :construction: Work In Progress
+> 
+> You are on the [Vite Environment API](https://vite.dev/guide/api-environment.html#environment-configuration) development branch. Check out [v9 branch](https://github.com/magne4000/vite-plugin-vercel/tree/v9) current stable version.
+
+Vercel adapter for [Vite 6](https://vitejs.dev/).
 
 Bundle your Vite application as supported by [Vercel Output API (v3)](https://vercel.com/docs/build-output-api/v3).
 
@@ -45,27 +50,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 { getEntriesFromFs } from "vite-plugin-vercel/utils";
 
 export default defineConfig({
-  plugins: [vercel()],
-  vercel: {
-    // optional configuration options, see "Advanced usage" below for details
-  },
+  plugins: [vercel({
+    entries: [
+      ...(await getEntriesFromFs("endpoints/api", {
+        // Auto mapping examples:
+        //   endpoints/api/page.ts -> /api/page
+        //   endpoints/api/name/[name].ts -> /api/name/*
+        destination: "api",
+      }))
+    ]
+  })],
 });
 ```
 
 > [!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` currently 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 `getEntriesFromFs` 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,170 +100,23 @@ 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
+## FAQ
 
-[Vike](https://vike.dev/) is supported through [@vite-plugin-vercel/vike](/packages/vike-integration/README.md) plugin.
+### What does ISR do in dev mode?
+Nothing. It's a production-only feature
 
-You only need to install `@vite-plugin-vercel/vike`, the Vite config stays the same as above.
+### 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
 
-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;
-```
+### 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).
 
-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
-
-```ts
-// vite.config.ts
-import { defineConfig } from 'vite';
-import vercel from 'vite-plugin-vercel';
-
-export default defineConfig({
-  plugins: [vercel()],
-  vercel: {
-    // All the followings optional
-
-    /**
-     * How long Functions should be allowed to run for every request, in seconds.
-     * If left empty, default value for your plan will be used.
-     */
-    defaultMaxDuration: 30,
-    /**
-     * Enable streaming responses by default for all Serverless Functions
-     */
-    defaultSupportsResponseStreaming: true,
-    /**
-     * Default expiration time (in seconds) for prerender functions.
-     * 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
-     */
-    rewrites: [{ source: '/about', destination: '/about-our-company.html' }],
-    /**
-     * @see {@link https://vercel.com/docs/projects/project-configuration#headers}
-     */
-    headers: [
-      {
-        "source": "/service-worker.js",
-        "headers": [
-          {
-            "key": "Cache-Control",
-            "value": "public, max-age=0, must-revalidate"
-          }
-        ]
-      }
-    ],
-    /**
-     * See https://vercel.com/docs/projects/project-configuration#redirects
-     */
-    redirects: [
-      { source: '/me', destination: '/profile.html', permanent: false },
-    ],
-    /**
-     * See https://vercel.com/docs/projects/project-configuration#cleanurls
-     */
-    cleanUrls: true,
-    /**
-     * See https://vercel.com/docs/projects/project-configuration#trailingslash
-     */
-    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.
-     */
-    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',
-      },
-    ],
-    /**
-     * Advanced configuration to override .vercel/output/config.json
-     * See https://vercel.com/docs/build-output-api/v3/configuration#configuration
-     */
-    config: {
-      // routes?: Route[];
-      // images?: ImagesConfig;
-      // wildcard?: WildcardConfig;
-      // overrides?: OverrideConfig;
-      // 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',
-  },
-});
-```
+Related documentation: https://vercel.com/docs/edge-network/headers/request-headers
 
-## Demo
+## Migration from v9
 
-https://test-vite-vercel-plugin.vercel.app/
+TODO

package/dist/api.d.ts

@@ -0,0 +1,55 @@
+/// <reference types="@photonjs/core" />
+
+import * as _vercel_routing_utils from '@vercel/routing-utils';
+import { V as ViteVercelConfig, a as ViteVercelRewrite, b as ViteVercelRedirect } from './types-BjqDHPFV.js';
+import { PluginContext } from 'rollup';
+import { ViteDevServer } from 'vite';
+import { Photon } from '@photonjs/core';
+import { VercelOutputConfig } from '@vite-plugin-vercel/schemas';
+
+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_utils.Header[];
+    readonly redirects: ViteVercelRedirect[];
+    cleanUrls: boolean | undefined;
+    trailingSlash: boolean | undefined;
+    defaultSupportsResponseStreaming: boolean | undefined;
+};
+declare function getVercelAPI(pluginContextOrServer: PluginContext | ViteDevServer): {
+    /**
+     * @internal
+     */
+    getOutFiles(): ViteVercelOutFile[];
+    readonly config: Partial<Omit<VercelOutputConfig, "version">>;
+    defaultMaxDuration: number | undefined;
+    expiration: number | undefined;
+    readonly rewrites: ViteVercelRewrite[];
+    readonly headers: _vercel_routing_utils.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: Photon.Entry;
+}
+interface ViteVercelOutFileAsset extends ViteVercelOutFileCommon {
+    type: "asset";
+}
+
+export { type ViteVercelApi, type ViteVercelOutFile, type ViteVercelOutFileAsset, type ViteVercelOutFileChunk, createAPI, getVercelAPI };

package/dist/api.js

@@ -0,0 +1,9 @@
+import {
+  createAPI,
+  getVercelAPI
+} from "./chunk-CR7Q2T4Q.js";
+import "./chunk-UTQ72LMT.js";
+export {
+  createAPI,
+  getVercelAPI
+};

package/dist/chunk-CR7Q2T4Q.js

@@ -0,0 +1,75 @@
+import {
+  assert
+} from "./chunk-UTQ72LMT.js";
+
+// src/api.ts
+function createAPI(outfiles, pluginConfig) {
+  return {
+    /**
+     * @internal
+     */
+    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 config = "environment" in pluginContextOrServer ? pluginContextOrServer.environment.config : pluginContextOrServer.config;
+  const vpv = 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);
+}
+
+export {
+  createAPI,
+  getVercelAPI
+};

package/dist/chunk-OCCU6UM5.js

@@ -0,0 +1,33 @@
+import {
+  assert
+} from "./chunk-UTQ72LMT.js";
+
+// src/utils/destination.ts
+import path from "path";
+function photonEntryDestinationDefault(entry) {
+  return entry.vercel?.destination ?? entry.name.replace(/[^a-zA-Z0-9\-_[\]/]/g, "-");
+}
+function photonEntryDestination(entry, postfix) {
+  return `${path.posix.join("functions/", photonEntryDestinationDefault(entry))}${postfix}`;
+}
+
+// src/utils/route.ts
+import { toPathToRegexpV6 } from "convert-route/path-to-regexp-v6";
+import { fromNextFs } from "convert-route/next-fs";
+import path2 from "path";
+import { toRou3 } from "convert-route";
+function entryToPathtoregex(entry) {
+  assert(typeof entry.vercel?.route !== "string", "Do not pass entry with route string to entryToPathtoregex");
+  return toPathToRegexpV6(fromNextFs(path2.posix.resolve("/", photonEntryDestinationDefault(entry))));
+}
+function entryToRou3(entry) {
+  assert(typeof entry.vercel?.route !== "string", "Do not pass entry with route string to entryToPathtoregex");
+  return toRou3(fromNextFs(path2.posix.resolve("/", photonEntryDestinationDefault(entry))));
+}
+
+export {
+  photonEntryDestinationDefault,
+  photonEntryDestination,
+  entryToPathtoregex,
+  entryToRou3
+};

package/dist/chunk-UTQ72LMT.js

@@ -0,0 +1,13 @@
+// src/assert.ts
+import { newError } from "@brillout/libassert";
+function assert(condition, errorMessage) {
+  if (condition) {
+    return;
+  }
+  const err = newError(`["vite-plugin-vercel"] ${errorMessage}`, 2);
+  throw err;
+}
+
+export {
+  assert
+};

package/dist/chunk-YN5MUEL2.js

@@ -0,0 +1,34 @@
+// src/utils/original-request.ts
+function getOriginalRequest(request) {
+  const xNowRouteMatchesHeader = request.headers.get("x-now-route-matches");
+  const originalUrl = new URL(request.url);
+  const originalPath = originalUrl.searchParams.get("__original_path");
+  let newUrl = null;
+  let newRequest = request;
+  if (originalPath) {
+    newUrl = new URL(originalPath, request.url).toString();
+  } else if (typeof xNowRouteMatchesHeader === "string") {
+    const originalPathBis = new URLSearchParams(xNowRouteMatchesHeader).get("1");
+    if (originalPathBis) {
+      newUrl = new URL(originalPathBis, request.url).toString();
+    }
+  }
+  if (newUrl) {
+    newRequest = new Request(newUrl, {
+      method: request.method,
+      headers: request.headers,
+      body: request.body,
+      mode: request.mode,
+      credentials: request.credentials,
+      cache: request.cache,
+      redirect: request.redirect,
+      referrer: request.referrer,
+      integrity: request.integrity
+    });
+  }
+  return newRequest;
+}
+
+export {
+  getOriginalRequest
+};