@modern-js/main-doc 2.69.7 → 3.0.0-alpha.1

package/docs/zh/guides/advanced-features/bff/cross-project.mdx

@@ -7,8 +7,9 @@ import { PackageManagerTabs } from '@theme';
 
 ## BFF 生产端
 
-升级 Modern.js 相关依赖到 x.64.4 及以上版本，通过配置即可启用跨项目调用能力。你可以将已启用 BFF 能力的项目视为 BFF 生产端，也可以单独创建独立的 BFF 应用。
+你可以将已启用 BFF 能力的项目视为 BFF 生产端，也可以单独创建独立的 BFF 应用。
 当执行 `dev` 或 `build`，都会自动生成供消费端使用的产物，包括：
+
 - `dist/client` 目录下的接口函数
 - `dist/runtime` 目录下的运行时配置函数
 - `package.json` 中 `exports` 定义接口函数出口
@@ -24,27 +25,20 @@ import { PackageManagerTabs } from '@theme';
 export default defineConfig({
   bff: {
     crossProject: true,
-  }
+  },
 });
 ```
 
-
 2. 生成 SDK 类型文件
 
 为一体化调用 SDK 提供类型提示，需要在 `TypeScript` 的 `tsconfig.json` 文件中打开 `declaration` 选项，配置如下：
 
 ```ts title="tsconfig.json"
 "compilerOptions": {
-    "declaration": true,
+  "declaration": true,
 }
 ```
 
-### 创建 BFF 应用
-
-import CreateApi from "@site-docs/components/create-bff-api-app"
-
-<CreateApi/>
-
 ## BFF 消费端
 
 :::info
@@ -92,13 +86,13 @@ configure({
 
 ```ts title="src/routes/page.tsx"
 import { configure } from '${package_name}/runtime';
-import { configure as innerConfigure } from '@modern-js/runtime/bff';
+import { configure as innerConfigure } from '@modern-js/plugin-bff/client';
 import axios from 'axios';
 
 configure({
-    setDomain() {
-        return 'https://your-bff-api.com';
-    },
+  setDomain() {
+    return 'https://your-bff-api.com';
+  },
 });
 
 innerConfigure({
@@ -115,6 +109,4 @@ innerConfigure({
     return res.data;
   },
 });
-
-
 ```

package/docs/zh/guides/advanced-features/bff/extend-server.mdx

@@ -4,21 +4,35 @@
 
 Modern.js 支持用户通过 [Middleware](/guides/advanced-features/web-server.html#middleware) 的方式来自由扩展 BFF Server。
 
-
 ## 使用中间件
 
-开发者可以在 `server/modern.server.ts` 中通过 配置 middlewares 来使用中间件。下面介绍如何手写一个 BFF 中间件，添加权限校验：
+:::tip 版本一致性
+在使用中间件之前，需要先安装 `@modern-js/server-runtime` 依赖。请确保 `@modern-js/server-runtime` 的版本与项目中 `@modern-js/app-tools` 的版本保持一致。Modern.js 的所有官方包使用统一版本号发布，版本不一致可能导致兼容性问题。
+
+请先查看 `@modern-js/app-tools` 的版本，然后安装相同版本的 `@modern-js/server-runtime`：
+
+```bash
+# 查看当前 @modern-js/app-tools 的版本
+pnpm list @modern-js/app-tools
+
+# 安装相同版本的 @modern-js/server-runtime
+pnpm add @modern-js/server-runtime@<版本号>
+```
+
+:::
 
+开发者可以在 `server/modern.server.ts` 中通过配置 middlewares 来使用中间件。下面介绍如何手写一个 BFF 中间件，添加权限校验：
 
 ```ts title="server/modern.server.ts"
 import {
   type MiddlewareHandler,
   defineServerConfig,
+  getCookie,
 } from '@modern-js/server-runtime';
 
 const requireAuthForApi: MiddlewareHandler = async (c, next) => {
   if (c.req.path.startsWith('/api') && c.req.path !== '/api/login') {
-    const sid = c.req.cookie('sid');
+    const sid = getCookie(c, 'sid');
     if (!sid) {
       return c.json({ code: -1, message: 'need login' }, 400);
     }
@@ -32,17 +46,20 @@ export default defineServerConfig({
       name: 'require-auth-for-api',
       handler: requireAuthForApi,
     },
-  ]
+  ],
 });
-
 ```
 
-
 然后添加一个普通的 BFF 函数 `api/lambda/hello.ts`：
 
 ```ts title="api/lambda/hello.ts"
-export default async () => {
-  return 'Hello Modern.js';
+import { useHonoContext } from '@modern-js/plugin-bff/server';
+
+export const get = async () => {
+  return {
+    code: 0,
+    message: 'Hello Modern.js',
+  };
 };
 ```
 

package/docs/zh/guides/advanced-features/bff/frameworks.mdx

@@ -7,20 +7,6 @@ title: 运行时框架
 
 Modern.js 以 [Hono.js](https://hono.dev/) 作为 BFF 和 Server 运行时框架，因此可以基于 Hono.js 生态[扩展 BFF Server](/guides/advanced-features/bff/extend-server.html)。
 
-## 获取请求上下文
-
-在 BFF 函数中，有时需要获取请求上下文，来处理更多逻辑。此时，你可以通过 `useHonoContext` 来获取：
-
-```ts title="api/lambda/hello.ts"
-import { useHonoContext } from '@modern-js/plugin-bff/hono'
-export const get = async () => {
-  const c = useHonoContext();
-  console.info(`access url: ${c.req.url}`);
-  return 'Hello Modern.js'
-};
-```
-
-:::info
-详细内容可以参考 [useHonoContext](/apis/app/runtime/bff/use-hono-context)。
-:::
+import Hono from '@site-docs/components/hono';
 
+<Hono />

package/docs/zh/guides/advanced-features/bff/function.mdx

@@ -6,9 +6,9 @@
 
 ## 启用 BFF
 
-import EnableBFF from "@site-docs/components/enable-bff"
+import EnableBFF from '@site-docs/components/enable-bff';
 
-<EnableBFF/>
+<EnableBFF />
 
 ## BFF 函数
 
@@ -34,11 +34,6 @@ export default () => {
 };
 ```
 
-:::tip
-在调用 `new` 命令后，Modern.js 生成器会自动在 `tsconfig.json` 中配置 `@api` 别名，因此可以直接通过别名的方式引入函数。
-
-:::
-
 在 `src/routes/page.tsx` 中引入的函数，会自动转换成接口调用，不需要再通过请求 SDK 或 Web Fetch 调用接口。
 
 执行 `pnpm run dev` 后，打开 `http://localhost:8080/` 可以看到页面已经展示了 BFF 函数返回的内容，在 Network 中可以看到页面向 `http://localhost:8080/api/hello` 发送了请求：
@@ -69,7 +64,7 @@ Modern.js 中，BFF 函数对应的路由系统是基于文件系统实现的，
 
 ### 动态路由
 
-同样的，创建命名带有 `[xxx]` 的文件夹或者文件，支持动态的命名路由参数。动态路由的函数参数规则可以看 [dynamac-path](/guides/advanced-features/bff/function#dynamic-path)。
+同样的，创建命名带有 `[xxx]` 的文件夹或者文件，支持动态的命名路由参数。动态路由的函数参数规则可以看 [dynamac-path](/guides/advanced-features/bff/function.html#dynamic-path)。
 
 - `api/lambda/user/[username]/info.ts` -> `{prefix}/user/:username/info`
 - `api/lambda/user/username/[action].ts` -> `{prefix}/user/username/:action`
@@ -193,7 +188,7 @@ Dynamic Path 之后的参数是包含 querystring、request body 的对象 `Requ
 在不存在动态路由的普通函数中，可以从第一个入参中获取传入的 `data` 和 `query`，例如：
 
 ```ts title="api/lambda/hello.ts"
-import type { RequestOption } from '@modern-js/runtime/server';
+import type { RequestOption } from '@modern-js/server-runtime';
 
 export async function post({
   query,
@@ -206,7 +201,7 @@ export async function post({
 这里你也可以使用自定义类型：
 
 ```ts title="api/lambda/hello.ts"
-import type { RequestOption } from '@modern-js/runtime/server';
+import type { RequestOption } from '@modern-js/server-runtime';
 
 type IQuery = {
   // some types
@@ -258,9 +253,9 @@ export default () => {
 
 ## 扩展 BFF 函数
 
-import ExtendBFF from "@site-docs/components/extend-bff-function"
+import ExtendBFF from '@site-docs/components/extend-bff-function';
 
-<ExtendBFF/>
+<ExtendBFF />
 
 ## 代码共享