vite-plugin-vercel 0.0.6 → 0.1.1

package/README.md

@@ -0,0 +1,72 @@
+# vite-plugin-vercel
+
+This is a **Work In Progress** Vercel adapter for [`vite`](https://vitejs.dev/).
+
+Its purpose is to help you bundle your application in `.vercel` folder as supported by
+([Vercel API v3](https://vercel.com/docs/build-output-api/v3)).
+
+## Features
+
+- [x] [SSG/Static files support](https://vercel.com/docs/build-output-api/v3#vercel-primitives/static-files)
+  - see [`prerender` config](/packages/vercel/src/types.ts#L33)
+- [x] [SSR/Serverless functions support](https://vercel.com/docs/build-output-api/v3#vercel-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#L54)
+- [x] [ISR/Prerender functions support](https://vercel.com/docs/build-output-api/v3#vercel-primitives/prerender-functions)
+  - see [`isr` config](/packages/vercel/src/types.ts#L81). Also see implementation of [vite-plugin-ssr](./prerender/vite-plugin-ssr.ts) for example
+- [ ] [Edge functions support](https://vercel.com/docs/build-output-api/v3#vercel-primitives/edge-functions)
+- [ ] [Images optimization support](https://vercel.com/docs/build-output-api/v3#build-output-configuration/supported-properties/images)
+- [ ] [Preview mode support](https://vercel.com/docs/build-output-api/v3#features/preview-mode)
+- [x] [Advanced config override](/packages/vercel/src/types.ts#L15)
+  - [ ] Complete config override
+
+## Usage
+
+First, make sure `ENABLE_VC_BUILD=1` is declared as an Environment Variable in your deployment configuration.
+
+Then, install this package as a dev dependency and add it to your Vite config like this:
+
+```ts
+import { defineConfig } from 'vite';
+import vercel from 'vite-plugin-vercel';
+import ssr from 'vite-plugin-ssr';
+
+export default defineConfig({
+  plugins: [ssr(), vercel()],
+});
+```
+
+### Usage with vite-plugin-ssr
+
+[vite-plugin-ssr](https://vite-plugin-ssr.com/) will support this plugin when stable.
+In the meantime, you can add experimental support yourself.
+
+Install `@magne4000/vite-plugin-vercel-ssr` package, and update your vite config:
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite';
+import ssr from 'vite-plugin-ssr/plugin';
+import vercel from 'vite-plugin-vercel';
+import vercelSsr from '@magne4000/vite-plugin-vercel-ssr';
+
+export default defineConfig(async ({ command, mode }) => {
+  return {
+    plugins: [ssr(), vercel(), vercelSsr()],
+    build: {
+      polyfillDynamicImport: false,
+    },
+    vercel: {
+      // Tweak what you need, check TS definition for details
+    },
+  };
+});
+```
+
+### Config
+
+See [TS types](/packages/vercel/src/types.ts#L15) for details.
+
+## Demo
+
+https://test-vite-vercel-plugin.vercel.app/

package/dist/index.cjs

@@ -254,7 +254,7 @@ function getEntries(resolvedConfig) {
     const parsed = import_path3.default.parse(outFilePath);
     const entry = {
       source: filePath,
-      destination: `api/${import_path3.default.join(parsed.dir, parsed.name)}.func`
+      destination: `api/${import_path3.default.posix.join(parsed.dir, parsed.name)}.func`
     };
     entryPoints.push(entry);
     return entryPoints;
@@ -385,8 +385,8 @@ function vercelPlugin() {
       resolvedConfig = config;
     },
     async buildStart() {
-      if (process.env.VERCEL_ENV === "production" && !process.env.ENABLE_FILE_SYSTEM_API) {
-        throw new Error("Missing ENABLE_FILE_SYSTEM_API=1 to your environment variables in your project settings");
+      if (process.env.VERCEL_ENV === "production" && !process.env.ENABLE_VC_BUILD) {
+        throw new Error("Missing ENABLE_VC_BUILD=1 to your environment variables in your project settings");
       }
       if (!resolvedConfig.build.ssr) {
         await cleanOutputDirectory(resolvedConfig);

package/dist/index.js

@@ -231,7 +231,7 @@ function getEntries(resolvedConfig) {
     const parsed = path3.parse(outFilePath);
     const entry = {
       source: filePath,
-      destination: `api/${path3.join(parsed.dir, parsed.name)}.func`
+      destination: `api/${path3.posix.join(parsed.dir, parsed.name)}.func`
     };
     entryPoints.push(entry);
     return entryPoints;
@@ -362,8 +362,8 @@ function vercelPlugin() {
       resolvedConfig = config;
     },
     async buildStart() {
-      if (process.env.VERCEL_ENV === "production" && !process.env.ENABLE_FILE_SYSTEM_API) {
-        throw new Error("Missing ENABLE_FILE_SYSTEM_API=1 to your environment variables in your project settings");
+      if (process.env.VERCEL_ENV === "production" && !process.env.ENABLE_VC_BUILD) {
+        throw new Error("Missing ENABLE_VC_BUILD=1 to your environment variables in your project settings");
       }
       if (!resolvedConfig.build.ssr) {
         await cleanOutputDirectory(resolvedConfig);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-vercel",
-  "version": "0.0.6",
+  "version": "0.1.1",
   "type": "module",
   "files": [
     "dist",
@@ -23,20 +23,20 @@
     "vite": "^2.9.9"
   },
   "devDependencies": {
-    "@types/node": "^17.0.34",
-    "@typescript-eslint/eslint-plugin": "^5.24.0",
-    "@typescript-eslint/parser": "^5.24.0",
-    "eslint": "^8.15.0",
-    "eslint-plugin-solid": "^0.4.7",
-    "tsup": "^5.12.8",
-    "typescript": "^4.6.4"
+    "@types/node": "^17.0.36",
+    "@typescript-eslint/eslint-plugin": "^5.26.0",
+    "@typescript-eslint/parser": "^5.26.0",
+    "eslint": "^8.16.0",
+    "tsup": "^6.0.1",
+    "typescript": "^4.7.2",
+    "vite": "^2.9.9"
   },
   "dependencies": {
     "@brillout/libassert": "^0.5.6",
-    "@vercel/routing-utils": "^1.13.2",
-    "esbuild": "^0.14.39",
+    "@vercel/routing-utils": "^1.13.3",
+    "esbuild": "^0.14.42",
     "fast-glob": "^3.2.11",
-    "zod": "^3.16.0"
+    "zod": "^3.17.3"
   },
   "scripts": {
     "build": "tsup",

package/readme.md

@@ -1,28 +0,0 @@
-# vite-plugin-vercel
-
-This is a wip Vercel adapter for [`vite`](https://vitejs.dev/).
-
-## Usage
-
-Install as a dev dependency and add it to your Vite config like this:
-
-```ts
-import { defineConfig } from 'vite';
-import vercel from 'vite-plugin-vercel';
-import ssr from 'vite-plugin-ssr';
-
-export default defineConfig({
-  plugins: [
-    ssr(),
-    vercel({
-      dynamicRoutes: [
-        {
-          ssr: true,
-          page: '/ssr',
-          regex: '/((?!assets/)(?!api/).*)',
-        },
-      ],
-    }),
-  ],
-});
-```