vite-plugin-vercel 10.0.0-beta.3 → 10.0.0-beta.5

package/README.md

@@ -1,14 +1,15 @@
 # vite-plugin-vercel
 
-> [!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.
+> [!NOTE]
+> You are on the [Vite Environment API](https://vite.dev/guide/api-environment.html#environment-configuration) beta branch (v10). Check out [v9 branch](https://github.com/magne4000/vite-plugin-vercel/tree/v9) for current stable version.
 
-Vercel adapter for [Vite 6](https://vitejs.dev/).
+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).
 
+> [!NOTE]
+> This plugin is mostly a re-export of [`@photonjs/vercel`](https://github.com/photon-js/photon/tree/main/packages/adapter-vercel)
+
 ## Install
 
 ```bash
@@ -52,16 +53,16 @@ import { defineConfig } from 'vite';
 import vercel from 'vite-plugin-vercel';
 import { getEntriesFromFs } from "vite-plugin-vercel/utils";
 
+const entries = await getEntriesFromFs("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({
-    entries: [
-      ...(await getEntriesFromFs("endpoints/api", {
-        // Auto mapping examples:
-        //   endpoints/api/page.ts -> /api/page
-        //   endpoints/api/name/[name].ts -> /api/name/*
-        destination: "api",
-      }))
-    ]
+    entries,
   })],
 });
 ```
@@ -104,6 +105,95 @@ export default async function handler() {
 
 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).
 
+## Advanced settings
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite';
+import vercel from 'vite-plugin-vercel';
+
+export default defineConfig({
+  plugins: [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,
+
+    /**
+     * 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,
+    /**
+     * Use `getEntriesFromFs` for mapping your filesystem routes to entries.
+     * If you are interfacing this plugin with a framework, entries can also be added through the Photon API
+     */
+    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
+     */
+    config: {
+      // routes?: Route[];
+      // images?: ImagesConfig;
+      // wildcard?: WildcardConfig;
+      // overrides?: OverrideConfig;
+      // cache?: string[];
+      // crons?: CronsConfig;
+    },
+    /**
+     * Defaults to `.vercel/output`. Mostly useful for testing purpose
+     */
+    outDir: '.vercel/output',
+  })]
+});
+```
+
 ## FAQ
 
 ### What does ISR do in dev mode?
@@ -117,6 +207,10 @@ 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
 
-## Migration from v9
+## Migrations
+
+- [Migration from v9 to v10](https://github.com/magne4000/vite-plugin-vercel/blob/main/MIGRATION.md)
+
+## Demo
 
-TODO
+https://vike-photon-demo.vercel.app/

package/dist/api.d.ts

@@ -1,55 +1 @@
-/// <reference types="@photonjs/core" />
-
-import * as _vercel_routing_utils from '@vercel/routing-utils';
-import { ViteVercelConfig, ViteVercelRewrite, ViteVercelRedirect } from './types.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 };
+export * from '@photonjs/vercel/api';

package/dist/api.js

@@ -1,9 +1,2 @@
-import {
-  createAPI,
-  getVercelAPI
-} from "./chunk-CR7Q2T4Q.js";
-import "./chunk-UTQ72LMT.js";
-export {
-  createAPI,
-  getVercelAPI
-};
+// src/api.ts
+export * from "@photonjs/vercel/api";

package/dist/index.d.ts

@@ -1,11 +1,5 @@
-/// <reference types="@photonjs/core" />
+import plugin from '@photonjs/vercel/vite';
 
-import { PluginOption } from 'vite';
-import { ViteVercelConfig } from './types.js';
-import '@photonjs/core';
-import '@vercel/routing-utils';
-import '@vite-plugin-vercel/schemas';
-
-declare function vercel(pluginConfig?: ViteVercelConfig): PluginOption[];
+declare const vercel: typeof plugin;
 
 export { vercel as default, vercel };