feat: add vercel support (#6)

* feat: add vercel support

* .

* feat: update Vercel build process and API handling

* .

* .

* .

* fix: return result as ArrayBuffer in synthesis API

* docs: update README.md with Vercel deployment instructions and enhance api/index.mjs with entry file overview for Vercel Functions

Author: yy4382

.gitignore

@@ -9,4 +9,6 @@ dist-node
 dist-prebuild
 dist-worker
 
-.wrangler
+.wrangler
+.vercel
+.env*.local

README.md

@@ -22,6 +22,14 @@
 TOKEN=YOUR_TOKEN # Optional
 ```
 
+### Vercel
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fyy4382%2Fread-aloud&env=TOKEN&envDescription=%E7%B1%BB%E4%BC%BC%E4%BA%8E%E5%AF%86%E7%A0%81%EF%BC%8C%E9%98%B2%E6%AD%A2%E4%BB%96%E4%BA%BA%E6%BB%A5%E7%94%A8%E4%BD%A0%E7%9A%84%E6%9C%8D%E5%8A%A1&project-name=read-aloud&repository-name=read-aloud)
+
+框架(Framework) 选择 Other，几个 Command 都保持不动（不要 Override）。
+
+环境变量 TOKEN 设置为字母、数字、下划线和连字符的组合（其他特殊字符未被测试是否可用）。
+
 ### Node.js (Docker)
 
 ```bash
@@ -49,3 +57,11 @@ Swagger 文档：<https://ra.yfi.moe/api/ui>
 Deploy to Cloudflare 按钮默认使用 package.json 中 deploy 脚本进行部署。
 
 流程：tsup 打包到 dist-prebuild 目录（`pnpm run prebuild:worker`）（由 wrangler.toml 中的 build 参数运行该命令），然后 wrangler deploy 将 `dist-prebuild/workerd.mjs`（由 wrangler.toml 中的 main 参数指定该文件）部署到 Cloudflare Workers。
+
+### Vercel
+
+使用了 [Custom build step for Node.js](https://vercel.com/docs/functions/runtimes/node-js/advanced-node-configuration#custom-build-step-for-node.js) 方式
+
+通过 `package.json` 中的 `vercel-build` 脚本，Vercel CLI 会执行该命令进行构建，之后 `/api/index.mjs` 会导入构建结果。
+
+同时，依赖 vercel.json 中的 rewrite 配置，将所有 /api 请求重写到 `api/index.mjs` 文件。

api/index.mjs

@@ -0,0 +1,12 @@
+/**
+ * @fileoverview 用于 Vercel Functions 的入口文件
+ *
+ * 使用 Vercel Functions 时，Vercel CLI 会执行 `package.json` 中的 `vercel-build` 脚本进行构建，
+ * 当前文件会导入构建结果，并导出为 Vercel Functions 的入口文件。
+ * 
+ * 同时，依赖 vercel.json 中的 rewrite 配置，将所有 /api 请求重写到这个文件。
+ */
+
+import app from "../dist-prebuild/workerd.mjs";
+
+export default app;

package.json

@@ -8,7 +8,9 @@
     "dev:worker": "wrangler dev",
     "deploy": "wrangler deploy --minify --outdir=dist-worker",
     "dev:node": "tsup-node --watch --onSuccess \"node dist-node/node.mjs\"",
-    "build:node": "tsup-node"
+    "build:node": "tsup-node",
+    "build:vercel": "tsup --outDir=dist-prebuild entries/workerd.ts",
+    "vercel-build": "pnpm run build:vercel"
   },
   "keywords": [],
   "author": "",

public/robots.txt

@@ -0,0 +1,2 @@
+User-agent: *
+Disallow: /

src/api/synthesis.ts

@@ -113,7 +113,7 @@ synthesis.openapi(route, async (c) => {
       },
     );
     c.header("Content-Type", FORMAT_CONTENT_TYPE.get(format));
-    return c.body(result);
+    return c.body(result.buffer as ArrayBuffer);
   } catch (error) {
     if (error instanceof HTTPException) throw error;
     c.status(500);

src/index.ts

@@ -15,7 +15,6 @@ export default app;
 
 app.route("/api", api);
 
-app.get("/robots.txt", (c) => c.text("User-agent: *\nDisallow: /"));
 app.get("/api/ui", swaggerUI({ url: "/api/doc" }));
 app.doc("/api/doc", {
   openapi: "3.0.0",

src/utils/synthesis.ts

@@ -144,6 +144,8 @@ function buf2hex(buffer: ArrayBuffer) {
     .join("");
 }
 
+// provided by and modified from @rexshao
+// https://github.com/yy4382/read-aloud/issues/4#issue-3048109976
 async function getURL() {
   const connectionId = randomUUID().toLowerCase();
   const TRUSTED_CLIENT_TOKEN = "6A5AA1D4EAFF4E9FB37E23D68491D6F4";

vercel.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://openapi.vercel.sh/vercel.json",
+  "rewrites": [{ "source": "/api/(.*)", "destination": "/api" }]
+}