@_tc/template-core 0.0.1-bate.47 → 0.0.1-bate.49

package/AGENT_README.md

@@ -0,0 +1,506 @@
+# TemplateCore AI 助手速读
+
+这份文档给在消费方项目中协助开发的 AI 助手/代码代理阅读。项目本身才是 `@_tc/template-core` 的使用方；AI 通过这份速读文档快速理解包的用法和边界。它是 `README.md` 的精简版，按渐进式披露组织：先用下面的最小信息完成常见任务，只有需要深入时再读末尾的参考文档。
+
+## 1. 先看结论
+
+TemplateCore 是一个 TypeScript + Koa + React 的后台框架包。它提供：
+
+- Koa 服务启动和约定式后端加载。
+- 内置 Dashboard、Schema CRUD 页面和 React UI 组件库。
+- `model/` 配置驱动的菜单、项目和 CRUD 页面。
+- 前端构建 `buildFE()` 和消费方 Node/backend 构建 `buildBE()`。
+- 类型扩展机制，用于扩展 SchemaForm 字段、CallCom 组件和 Koa app 类型。
+
+优先使用公开入口，不要从包内部源码路径导入。
+
+| 入口 | 用途 |
+| --- | --- |
+| `@_tc/template-core` | `serverStart`、`baseFn`、Koa/Controller/Service 类型。 |
+| `@_tc/template-core/bundler` | `buildFE()`、`buildBE()`。 |
+| `@_tc/template-core/fe` | 前端初始化、请求方法、Dashboard/Schema 类型、共享状态、业务前端组件。 |
+| `@_tc/template-core/fe/rc` | React UI 组件和 SchemaForm 组件。 |
+| `@_tc/template-core/fe/tailwind_ui.css` | 内置前端/UI 全局样式。 |
+| `@_tc/template-core/model` | `ModelDataType` 等 model 配置类型。 |
+
+## 2. 最小业务项目
+
+推荐结构：
+
+```text
+my-admin/
+├── app/
+│   ├── controller/
+│   │   └── product.ts
+│   └── router/
+│       └── product.ts
+├── config/
+│   └── config.default.ts
+├── model/
+│   └── product/
+│       ├── mode.ts
+│       └── project/
+│           └── demo.ts
+└── index.ts
+```
+
+启动入口：
+
+```ts
+import { join } from 'path'
+import { serverStart } from '@_tc/template-core'
+import { buildFE } from '@_tc/template-core/bundler'
+
+async function main() {
+  await serverStart({
+    name: 'my-admin',
+    baseDir: join(__dirname, '.'),
+  })
+
+  await buildFE('dev')
+}
+
+main().catch((error) => {
+  console.error(error)
+  process.exit(1)
+})
+```
+
+只使用后端能力时，可以不调用 `buildFE('dev')`。
+
+配置：
+
+```ts
+// config/config.default.ts
+export default {
+  port: 9000,
+}
+```
+
+访问内置后台：
+
+```text
+http://localhost:9000/dash?projk=demo
+```
+
+`projk` 对应 `model/{modelKey}/project/{projectKey}.ts`。
+
+## 3. 后端约定
+
+`serverStart({ baseDir })` 会按目录自动加载业务代码：
+
+```text
+app/controller/**/*.(js|ts)      -> app.controller
+app/service/**/*.(js|ts)         -> app.service
+app/middleware/**/*.(js|ts)      -> app.middlewares
+app/router/**/*.(js|ts)          -> Koa router
+app/router-schema/**/*.(js|ts)   -> app.routerSchema
+app/extend/*.(js|ts)             -> app.extends
+config/config.default.(js|ts)    -> app.config
+config/config.{env}.(js|ts)      -> app.config
+model/**/*.(js|ts)               -> 项目模型配置
+```
+
+Controller 示例：
+
+```ts
+import { baseFn, type ControllerFN, type Ctx } from '@_tc/template-core'
+
+const products = [
+  { product_id: '1', product_name: '商品 A', price: 100 },
+]
+
+const getProductController = ((app) => {
+  const BaseController = baseFn.baseControllerFn(app)
+
+  return class ProductController extends BaseController {
+    list = async (ctx: Ctx) => {
+      this.success(ctx, {
+        data: products,
+        page: Number(ctx.request.query.page || 1),
+        pageSize: Number(ctx.request.query.pageSize || 10),
+        total: products.length,
+      })
+    }
+
+    detail = async (ctx: Ctx) => {
+      const item = products.find((product) => {
+        return product.product_id === ctx.request.query.product_id
+      })
+
+      this.success(ctx, item ?? null)
+    }
+  }
+}) satisfies ControllerFN
+
+export default getProductController
+```
+
+Router 示例：
+
+```ts
+import type { KoaApp, Router } from '@_tc/template-core'
+
+export default (app: KoaApp, router: Router) => {
+  router.get('/api/product/list', app.controller.product.list)
+  router.get('/api/product', app.controller.product.detail)
+}
+```
+
+路由挂载顺序：
+
+- 每个 `app/router/*.ts` 文件都会获得独立的 `koa-router` 实例。
+- 可以通过 `router.level = number` 控制挂载顺序，数值越小越早挂载。
+- 默认 `level` 是 `0`，框架兜底 router 是 `99`。
+- 通配、兜底、重定向类路由建议设置较大的 `level`，避免抢先匹配业务 API。
+
+```ts
+import type { KoaApp, Router } from '@_tc/template-core'
+
+export default (app: KoaApp, router: Router) => {
+  router.level = 10
+  router.get('/api/fallback/:id', app.controller.fallback.detail)
+}
+```
+
+内置响应约定：`BaseController.success(ctx, data)` 返回 `{ data, code: 0, message: 'ok' }`。
+
+内置扩展：
+
+- `app.extends.$fetch`：Node 侧 axios 风格 fetch 实例。
+- `app.extends.db`：默认 SQLite 数据存储，可用业务 `app/extend/db.ts` 覆盖。
+
+## 4. model 配置
+
+`model` 是内置 Dashboard 和 Schema CRUD 的数据源。
+
+```text
+model/{modelKey}/mode.ts                  -> 模型模板
+model/{modelKey}/project/{projectKey}.ts  -> 项目覆盖
+```
+
+`mode.ts` 示例：
+
+```ts
+import type { ModelDataType } from '@_tc/template-core/model'
+
+const model: ModelDataType = {
+  mode: 'MB',
+  name: '商品后台',
+  desc: '商品管理',
+  homePage: '/_sidebar_/product?projk=demo',
+  menuLayout: 'left',
+  menu: [
+    {
+      key: 'product',
+      name: '商品列表',
+      menuType: 'module',
+      moduleType: 'schema',
+      schemaConfig: {
+        api: '/api/product',
+        schema: {
+          type: 'object',
+          properties: {
+            product_id: {
+              type: 'string',
+              label: '商品 ID',
+              tableOption: { width: 160 },
+              detailPanelOption: {},
+              editFormOption: {
+                comType: 'input',
+                disabled: true,
+              },
+            },
+            product_name: {
+              type: 'string',
+              label: '商品名称',
+              tableOption: {},
+              searchOption: { comType: 'input' },
+              createFormOption: { comType: 'input' },
+              editFormOption: { comType: 'input' },
+              detailPanelOption: {},
+            },
+            price: {
+              type: 'number',
+              label: '价格',
+              tableOption: {},
+              createFormOption: { comType: 'inputNumber' },
+              editFormOption: { comType: 'inputNumber' },
+              detailPanelOption: {},
+            },
+          },
+          required: ['product_name'],
+        },
+        componentConfig: {
+          createForm: {
+            title: '新增商品',
+            saveBtnText: '创建',
+          },
+          editForm: {
+            title: '编辑商品',
+            saveBtnText: '保存',
+            fetchKey: 'product_id',
+          },
+          detailPanel: {
+            title: '商品详情',
+            fetchKey: 'product_id',
+          },
+        },
+        tableConfig: {
+          headerButtons: [
+            {
+              label: '新增',
+              eventKey: 'callComponent',
+              variant: 'primary',
+              eventOption: { comName: 'createForm' },
+            },
+          ],
+          rowButtons: [
+            {
+              label: '编辑',
+              eventKey: 'callComponent',
+              eventOption: { comName: 'editForm' },
+            },
+            {
+              label: '详情',
+              eventKey: 'callComponent',
+              eventOption: { comName: 'detailPanel' },
+            },
+            {
+              label: '删除',
+              eventKey: 'remove',
+              eventOption: {
+                params: {
+                  product_id: '$schema::product_id',
+                },
+              },
+            },
+          ],
+        },
+      },
+    },
+  ],
+}
+
+export default model
+```
+
+`project/demo.ts` 示例：
+
+```ts
+export default {
+  name: 'Demo 企业',
+  desc: 'Demo 企业商品后台',
+  homePage: '/_sidebar_/product?projk=demo',
+}
+```
+
+合并规则：
+
+- `project` 会继承同目录上层 `mode`。
+- 对象递归合并，`project` 覆盖 `mode`。
+- 数组按 `key` 合并：同 key 覆盖，不同 key 新增。
+- `model/index.ts` 和 `model/index.js` 会被 loader 跳过。
+
+常见菜单模块：
+
+| `moduleType` | 用途 |
+| --- | --- |
+| `schema` | 配置驱动 CRUD 页面，使用 `schemaConfig`。 |
+| `custom` | 自定义前端页面，使用 `customConfig.path`。 |
+| `iframe` | iframe 页面，使用 `iframeConfig.path`。 |
+| `sidebar` | 顶部菜单下挂左侧菜单，使用 `sidebarConfig.menu`。 |
+
+## 5. 前端使用
+
+使用内置组件或自定义前端入口时，确保引入样式：
+
+```ts
+import '@_tc/template-core/fe/tailwind_ui.css'
+```
+
+前端公共能力优先从 `@_tc/template-core/fe` 导入：
+
+```ts
+import {
+  get,
+  post,
+  request,
+  schemaEventBus,
+  schemaStore,
+  useSchemaStore,
+  LanguageSwitch,
+  ThemeSwitch,
+} from '@_tc/template-core/fe'
+```
+
+UI 组件从 `@_tc/template-core/fe/rc` 导入：
+
+```tsx
+import { Button, DataTable, Form, Input, Modal, Select } from '@_tc/template-core/fe/rc'
+```
+
+常用前端能力：
+
+- 请求方法：`request`、`get`、`post`、`put`、`patch`、`del`。
+- Schema 通信：`schemaEventBus`、`eventsInfo`、`merge`。
+- 共享状态：`modeStore`、`schemaStore`、`apiFreezerStore` 及对应 hooks。
+- 多语言：`i18nStore.addResources()`，配置文案可写 `$i18n::...`。
+- 主题：`ThemeSwitch` 会同步根节点 `dark` class 和 `localStorage`。
+
+不要直接依赖 `frontend/src/...`、`packages/react/ui/...` 这类包内部路径。
+
+## 6. 构建
+
+前端资源构建：
+
+```ts
+import { buildFE } from '@_tc/template-core/bundler'
+
+await buildFE('dev')
+await buildFE('prod', { output: 'run' })
+```
+
+`buildFE('dev')` 是构建一次并监听业务 `frontend/` 变化后重建，不是 Vite dev server/HMR。
+
+Node/backend 构建：
+
+```ts
+import { buildBE } from '@_tc/template-core/bundler'
+
+await buildBE()
+```
+
+`buildBE()` 默认：
+
+- 构建当前工作目录的 `index.ts`、`index.js`、`app`、`config`、`model`。
+- 输出到 `dist`。
+- 输出格式为 `cjs`。
+- 外部化 Node 内置模块和 npm 包。
+- 默认不生成 `.d.ts`。
+- 默认不注入 alias；需要时显式传 `alias`。
+
+自定义示例：
+
+```ts
+await buildBE({
+  input: ['app', 'config', 'model/index.ts'],
+  outDir: 'dist',
+  format: ['es', 'cjs'],
+  dts: true,
+  alias: {
+    '@app': './app',
+    '@model': './model',
+  },
+})
+```
+
+消费方脚本示例：
+
+```js
+// scripts/build-be.mjs
+import { buildBE } from '@_tc/template-core/bundler'
+
+await buildBE({
+  input: ['index.ts', 'index.js', 'app', 'config', 'model'],
+  outDir: 'dist',
+  format: 'cjs',
+})
+```
+
+监听文件变化重新构建：
+
+```js
+// scripts/watch-be.mjs
+import chokidar from 'chokidar'
+import { buildBE } from '@_tc/template-core/bundler'
+
+const input = ['index.ts', 'index.js', 'app', 'config', 'model']
+
+let building = false
+let pending = false
+
+async function runBuild() {
+  if (building) {
+    pending = true
+    return
+  }
+
+  building = true
+
+  try {
+    await buildBE({ input, outDir: 'dist', format: 'cjs' })
+  } finally {
+    building = false
+
+    if (pending) {
+      pending = false
+      await runBuild()
+    }
+  }
+}
+
+await runBuild()
+
+chokidar
+  .watch(input, {
+    ignored: ['dist/**', 'node_modules/**'],
+    ignoreInitial: true,
+  })
+  .on('all', runBuild)
+```
+
+```json
+{
+  "scripts": {
+    "build:be": "node scripts/build-be.mjs",
+    "build:be:watch": "node scripts/watch-be.mjs"
+  }
+}
+```
+
+## 7. 常见任务速查
+
+新增后端接口：
+
+1. 在 `app/controller/*.ts` 写 controller。
+2. 在 `app/router/*.ts` 注册路由。
+3. 返回数据时优先用 `this.success(ctx, data)`。
+
+新增一个 Schema CRUD 页面：
+
+1. 在 `model/{modelKey}/mode.ts` 或 `project/{projectKey}.ts` 添加菜单项。
+2. 菜单项使用 `menuType: 'module'`、`moduleType: 'schema'`。
+3. `schemaConfig.api` 指向后端资源 API。
+4. 字段在 `schema.properties` 中配置 `tableOption`、`searchOption`、`createFormOption`、`editFormOption`、`detailPanelOption`。
+5. 需要新增/编辑/详情时，在 `componentConfig` 和 `tableConfig` 配置按钮与弹层。
+
+新增自定义前端页面：
+
+1. 在业务 `frontend/` 下添加入口 `*.entry.tsx`。
+2. 需要样式时引入 `@_tc/template-core/fe/tailwind_ui.css`。
+3. 在 `model` 菜单中使用 `moduleType: 'custom'`，让 `customConfig.path` 指向页面路径。
+4. 使用 `buildFE('dev')` 或 `buildFE('prod')` 生成资源。
+
+扩展前端类型或组件：
+
+1. SchemaForm 字段类型、CallCom 组件、Koa app 类型都支持 TypeScript 声明合并。
+2. 运行时组件通常放在业务 `frontend/extended/`。
+3. 优先查看公开入口 `.d.ts` 和 npm 包根目录 `README.md`；如果当前环境是源码仓库，再继续读 `docs/type-extension.md` 和 `docs/schema-form.md`。
+
+## 8. 继续深入
+
+需要更多信息时，按任务读取：
+
+| 任务 | 建议阅读 |
+| --- | --- |
+| 完整安装和使用说明 | npm 包根目录 `README.md` |
+| 生成项目、model、CRUD | `.skills/tc-generator/SKILL.md` |
+| 组件选型和用法 | `.skills/tc-component-usage-skills/SKILL.md` |
+| model/schema 配置细节 | `.skills/tc-generator/reference/model-schema.md` |
+| 完整 CRUD 示例 | `.skills/tc-generator/reference/example.md` |
+| 可复制项目骨架 | `.skills/tc-generator/reference/project-template/` |
+| UI 组件现场预览 | 启动服务后访问 `/ui-components` |
+| 已安装包的类型细节 | 查看对应公开入口的 `.d.ts` 文件 |
+
+如果当前环境是源码仓库而不是 npm 安装目录，还可以继续读 `docs/`、`frontend/README.md`、`model/README.md`、`bundler/README.md` 和 `BUILD.md`。

package/README.md

@@ -158,7 +158,7 @@ http://localhost:9000/dash?projk=demo
 | 入口 | 用途 |
 | --- | --- |
 | `@_tc/template-core` | 服务启动、基础 Controller/Service、Koa 类型 |
-| `@_tc/template-core/bundler` | 构建入口，提供前端资源构建 `buildFE` 和消费方 Node/backend 构建 `buildFB` |
+| `@_tc/template-core/bundler` | 构建入口，提供前端资源构建 `buildFE` 和消费方 Node/backend 构建 `buildBE` |
 | `@_tc/template-core/fe` | 前端初始化、Dash 路由扩展、请求方法、SchemaPage 事件、共享状态和内置前端组件 |
 | `@_tc/template-core/fe/rc` | UI/SchemaForm 组件和类型 |
 | `@_tc/template-core/fe/tailwind_ui.css` | 前端全局样式入口，源码对应 `frontend/src/main.css` |
@@ -844,6 +844,22 @@ export default (app: KoaApp, router: Router) => {
 }
 ```
 
+路由挂载顺序：
+
+- 每个 `app/router/*.ts` 文件都会获得独立的 `koa-router` 实例。
+- 可以通过 `router.level = number` 控制挂载顺序，数值越小越早挂载。
+- 默认 `level` 是 `0`，框架兜底 router 是 `99`。
+- 通配、兜底、重定向类路由建议设置较大的 `level`，避免抢先匹配业务 API。
+
+```ts
+import type { KoaApp, Router } from '@_tc/template-core'
+
+export default (app: KoaApp, router: Router) => {
+  router.level = 10
+  router.get('/api/fallback/:id', app.controller.fallback.detail)
+}
+```
+
 ## model 数据如何配置
 
 `model` 是后台菜单、项目和 Schema 页面的数据源。框架会读取：
@@ -1543,16 +1559,113 @@ buildFE('prod', {
 })
 ```
 
-## Node/backend 构建 buildFB
+## Node/backend 构建 buildBE
 
-消费方 Node/backend 侧构建使用 `buildFB()`。它复用发布包内的 `scripts/vite-build/buildEntries`，只是提供消费方默认配置。
+消费方 Node/backend 侧构建使用 `buildBE()`。它复用发布包内的 `scripts/vite-build/buildEntries`，只是提供消费方默认配置。
 
 最小用法：
 
 ```ts
-import { buildFB } from '@_tc/template-core/bundler'
+import { buildBE } from '@_tc/template-core/bundler'
+
+await buildBE()
+```
+
+消费方脚本示例：
+
+```js
+// scripts/build-be.mjs
+import { buildBE } from '@_tc/template-core/bundler'
 
-await buildFB()
+await buildBE({
+  rootDir: process.cwd(),
+  input: ['index.ts', 'index.js', 'app', 'config', 'model'],
+  outDir: 'dist',
+  format: 'cjs',
+  alias: {
+    '@app': './app',
+    '@model': './model',
+  },
+})
+```
+
+```json
+{
+  "scripts": {
+    "build:be": "node scripts/build-be.mjs"
+  }
+}
+```
+
+监听文件变化并重新构建：
+
+```js
+// scripts/watch-be.mjs
+import chokidar from 'chokidar'
+import { buildBE } from '@_tc/template-core/bundler'
+
+const input = ['index.ts', 'index.js', 'app', 'config', 'model']
+
+let building = false
+let pending = false
+
+async function runBuild() {
+  if (building) {
+    pending = true
+    return
+  }
+
+  building = true
+
+  try {
+    console.log('[buildBE] building...')
+    await buildBE({
+      rootDir: process.cwd(),
+      input,
+      outDir: 'dist',
+      format: 'cjs',
+      alias: {
+        '@app': './app',
+        '@model': './model',
+      },
+    })
+    console.log('[buildBE] done')
+  } catch (error) {
+    console.error('[buildBE] failed')
+    console.error(error)
+  } finally {
+    building = false
+
+    if (pending) {
+      pending = false
+      await runBuild()
+    }
+  }
+}
+
+await runBuild()
+
+chokidar
+  .watch(input, {
+    ignored: ['dist/**', 'node_modules/**'],
+    ignoreInitial: true,
+  })
+  .on('all', async (_event, filePath) => {
+    console.log(`[buildBE] changed: ${filePath}`)
+    await runBuild()
+  })
+```
+
+```json
+{
+  "scripts": {
+    "build:be": "node scripts/build-be.mjs",
+    "build:be:watch": "node scripts/watch-be.mjs"
+  },
+  "devDependencies": {
+    "chokidar": "^4.0.3"
+  }
+}
 ```
 
 默认会在当前工作目录构建这些入口：
@@ -1561,12 +1674,12 @@ await buildFB()
 ['index.ts', 'index.js', 'app', 'config', 'model']
 ```
 
-不存在的默认入口会自动跳过；如果没有任何匹配源码，构建仍会失败。输出到 `dist`，格式为 `cjs`。默认 `outputStructure: "preserve"` 按源路径输出，`bundleDependencies: false` 会 external Node 内置模块和 npm 包，不会把依赖打进产物。`buildFB` 会按同一组 input 扫描并复制内置白名单资源扩展，主要覆盖 `app`、`config`、`model` 目录。
+不存在的默认入口会自动跳过；如果没有任何匹配源码，构建仍会失败。输出到 `dist`，格式为 `cjs`。默认 `outputStructure: "preserve"` 按源路径输出，`bundleDependencies: false` 会 external Node 内置模块和 npm 包，不会把依赖打进产物。`buildBE` 会按同一组 input 扫描并复制内置白名单资源扩展，主要覆盖 `app`、`config`、`model` 目录。
 
 常见配置：
 
 ```ts
-await buildFB({
+await buildBE({
   input: ['app', 'config', 'model'],
   outDir: 'dist',
   format: ['es', 'cjs'],
@@ -1580,7 +1693,7 @@ await buildFB({
 如果需要声明文件：
 
 ```ts
-await buildFB({
+await buildBE({
   dts: {
     outDir: 'types',
     tsconfig: 'tsconfig.json',
@@ -1588,12 +1701,12 @@ await buildFB({
 })
 ```
 
-`buildEntries()` 底层默认生成 d.ts，但 `buildFB()` 默认关闭声明文件；需要时按上面这样显式传 `dts`。
+`buildEntries()` 底层默认生成 d.ts，但 `buildBE()` 默认关闭声明文件；需要时按上面这样显式传 `dts`。
 
 如果传入自定义 `input`，缺失路径默认会报错；需要跳过时显式打开：
 
 ```ts
-await buildFB({
+await buildBE({
   input: ['app', 'config', 'model'],
   allowMissingInput: true,
 })

package/cjs/app/controller/view.js

@@ -1 +1 @@
-var e=e=>JSON.stringify(e).replace(/</g,`\\u003c`).replace(/>/g,`\\u003e`).replace(/&/g,`\\u0026`).replace(/\u2028/g,`\\u2028`).replace(/\u2029/g,`\\u2029`),t=(t=>class{async renderPage(n){t.extends.logger.log(` - render page: `+n.params.page);try{t.extends.renderView(`dist/${n.params.page}.entry.tpl`,n,{projKey:n.query.projk,name:t.options?.name,env:t.envs.get(),basePath:e(`${t.options.pageBasePage}${n.params.page}`),projKeyJson:e(String(n.query.projk??``)),signKey:e(t.config.signKey),options:e(t.options)})}catch(e){console.log(`-------------- render view error --------------`),console.log(e),t.extends.generateErrorMessage(`template not found`,{status:404,showError:!0,code:0})}}});module.exports=t;
+var e=e=>JSON.stringify(e).replace(/</g,`\\u003c`).replace(/>/g,`\\u003e`).replace(/&/g,`\\u0026`).replace(/\u2028/g,`\\u2028`).replace(/\u2029/g,`\\u2029`),t=(t=>class{async renderPage(n){if(!n.path.includes(`${t.options.apiPrefix}/`)){t.extends.logger.log(` - render page: `+n.params.page);try{t.extends.renderView(`dist/${n.params.page}.entry.tpl`,n,{projKey:n.query.projk,name:t.options?.name,env:t.envs.get(),basePath:e(`${t.options.pageBasePage}${n.params.page}`),projKeyJson:e(String(n.query.projk??``)),signKey:e(t.config.signKey),options:e(t.options)})}catch(e){console.log(`-------------- render view error --------------`),console.log(e),t.extends.generateErrorMessage(`template not found`,{status:404,showError:!0,code:0})}}}});module.exports=t;

package/cjs/app/middleware/api-params-verify.js

@@ -1 +1 @@
-const e=require(`../../_virtual/_rolldown/runtime.js`);let t=require(`ajv`);t=e.__toESM(t);var n=new t.default,r=`http://json-schema.org/draft-07/schema#`,i=(e,t,i)=>{if(t[e]&&i[e]){i[e].$schema=r;let a=n.compile(i[e]);return[a(t[e]),a]}},a=e=>async(t,r)=>{let{path:a,method:o}=t;if(a.indexOf(`/api`)<0)return r();let s=e.currentUseRouter,c;for(let e of s){let t=e.match(a,`get`);if(t){c=t;break}}let l=c?.path[0]?.path;if(l){let r=e.extends.parsingParamsOnUrl(l,a),{body:s,query:c,headers:u}=t.request,d={params:r,body:s,query:c,headers:u};e.extends.logger?.info(`--[api params verify] [${o} ${a}] body: ${JSON.stringify(s)}--`),e.extends.logger?.info(`--[api params verify] [${o} ${a}] query: ${JSON.stringify(c)}--`),e.extends.logger?.info(`--[api params verify] [${o} ${a}] params: ${JSON.stringify(r)}--`),e.extends.logger?.info(`--[api params verify] [${o} ${a}] headers: ${JSON.stringify(u)}--`);let f=e.routerSchema[l]?.[o.toLowerCase()];if(f){let t=!0,r,a=[`headers`,`body`,`query`,`params`];for(let e=0;e<a.length;e++){let n=a[e];if(t){let e=i(n,{...d},f);t=e?.[0]??!0,r=e?.[1]}}if(!t){let t=`request vaidate fail: ${n.errorsText(r?.errors)}`;e.extends.logger?.error(`--[api valid error] message: ${t}--`),e.extends.generateErrorMessage(t,{showError:!0,code:442})}}}return r()};module.exports=a;
+const e=require(`../../_virtual/_rolldown/runtime.js`);let t=require(`ajv`);t=e.__toESM(t);var n=new t.default,r=`http://json-schema.org/draft-07/schema#`,i=(e,t,i)=>{if(t[e]&&i[e]){i[e].$schema=r;let a=n.compile(i[e]);return[a(t[e]),a]}},a=e=>async(t,r)=>{let{path:a,method:o}=t;if(a.indexOf(e.options.apiPrefix)<0)return r();let s=e.currentUseRouter,c;for(let e of s){let t=e.match(a,`get`);if(t){c=t;break}}let l=c?.path[0]?.path;if(l){let r=e.extends.parsingParamsOnUrl(l,a),{body:s,query:c,headers:u}=t.request,d={params:r,body:s,query:c,headers:u};e.extends.logger?.info(`--[api params verify] [${o} ${a}] body: ${JSON.stringify(s)}--`),e.extends.logger?.info(`--[api params verify] [${o} ${a}] query: ${JSON.stringify(c)}--`),e.extends.logger?.info(`--[api params verify] [${o} ${a}] params: ${JSON.stringify(r)}--`),e.extends.logger?.info(`--[api params verify] [${o} ${a}] headers: ${JSON.stringify(u)}--`);let f=e.routerSchema[l]?.[o.toLowerCase()];if(f){let t=!0,r,a=[`headers`,`body`,`query`,`params`];for(let e=0;e<a.length;e++){let n=a[e];if(t){let e=i(n,{...d},f);t=e?.[0]??!0,r=e?.[1]}}if(!t){let t=`request vaidate fail: ${n.errorsText(r?.errors)}`;e.extends.logger?.error(`--[api valid error] message: ${t}--`),e.extends.generateErrorMessage(t,{showError:!0,code:442})}}}return r()};module.exports=a;

package/cjs/app/middleware/api-sign-verify.js

@@ -1 +1 @@
-const e=require(`../../_virtual/_rolldown/runtime.js`);let t=require(`md5`);t=e.__toESM(t);var n=1e3*60*10,r=e=>async(r,i)=>{let{path:a,method:o}=r;if(a.includes(`api`)&&!e.config?.apiSignVerify?.whiteList?.includes(a)){e.extends.logger?.info(`--[api-sign-verify]--`);let{s_sign:i,s_t:s}=r.request.header,{signKey:c}=e.config,l=(0,t.default)(`${c}_${s}`);e.extends.logger?.info(`[${o} ${a}] signature: ${l}`),(!s||!i||i.toLowerCase()!==l||Date.now()-Number(s)>n)&&e.extends.generateErrorMessage(`signature not correct or api timeout`,{showError:!0,code:100014})}await i()};module.exports=r;
+const e=require(`../../_virtual/_rolldown/runtime.js`);let t=require(`md5`);t=e.__toESM(t);var n=1e3*60*10,r=e=>async(r,i)=>{let{path:a,method:o}=r;if(a.includes(e.options.apiPrefix)&&!e.config?.apiSignVerify?.whiteList?.includes(a)){e.extends.logger?.info(`--[api-sign-verify]--`);let{s_sign:i,s_t:s}=r.request.header,{signKey:c}=e.config,l=(0,t.default)(`${c}_${s}`);e.extends.logger?.info(`[${o} ${a}] signature: ${l}`),(!s||!i||i.toLowerCase()!==l||Date.now()-Number(s)>n)&&e.extends.generateErrorMessage(`signature not correct or api timeout`,{showError:!0,code:100014})}await i()};module.exports=r;

package/cjs/app/middleware/project-handler.js

@@ -1 +1 @@
-var e=()=>async(e,t)=>{let n=e.headers.projk,{path:r}=e;if(r.indexOf(`/api/proj/`)!==-1&&(!n||[`undefined`,`null`].includes(n))){e.status=200,e.body={code:110,data:null,message:`请求不合法`};return}e.extInfo={key:n},await t()};module.exports=e;
+var e=e=>async(t,n)=>{let r=t.headers.projk,{path:i}=t;if(i.indexOf(`${e.options.apiPrefix}/proj/`)!==-1&&(!r||[`undefined`,`null`].includes(r))){t.status=200,t.body={code:110,data:null,message:`请求不合法`};return}t.extInfo={key:r},await n()};module.exports=e;

package/cjs/app/router/project.js

@@ -1 +1 @@
-var e=(e,t)=>{let{project:n}=e.controller;t.get(`/api/project/model_list`,n.getModelList),t.get(`/api/project/list`,n.getProjectList),t.get(`/api/project/:key`,n.getProject)};module.exports=e;
+var e=(e,t)=>{let{project:n}=e.controller,{apiPrefix:r}=e.options;t.get(`${r}/project/model_list`,n.getModelList),t.get(`${r}/project/list`,n.getProjectList),t.get(`${r}/project/:key`,n.getProject)};module.exports=e;

package/cjs/bundler/{buildFB.js → buildBE.js}

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`../scripts/vite-build/build.js`);require(`../scripts/vite-build/index.js`);var t=[`index.ts`,`index.js`,`app`,`config`,`model`];async function n(n={}){return e.buildEntries({...n,rootDir:n.rootDir,input:n.input??t,outDir:n.outDir??`dist`,format:n.format??`cjs`,alias:n.alias,allowMissingInput:n.allowMissingInput??!n.input,outputStructure:n.outputStructure??`preserve`,bundleDependencies:n.bundleDependencies??!1,externalNodeBuiltins:n.externalNodeBuiltins??!0,dts:n.dts??!1,copy:n.copy??{input:n.input??t,extensions:{input:[`.tpl`,`.html`,`.css`,`.scss`,`.sass`,`.less`,`.svg`,`.png`,`.jpg`,`.jpeg`,`.gif`,`.webp`,`.ico`,`.json`,`.md`,`.txt`,`.xml`,`.yml`,`.yaml`],mergeDefault:!1}}})}exports.buildFB=n;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`../scripts/vite-build/build.js`);require(`../scripts/vite-build/index.js`);var t=[`index.ts`,`index.js`,`app`,`config`,`model`];async function n(n={}){return e.buildEntries({...n,rootDir:n.rootDir,input:n.input??t,outDir:n.outDir??`dist`,format:n.format??`cjs`,alias:n.alias,allowMissingInput:n.allowMissingInput??!n.input,outputStructure:n.outputStructure??`preserve`,bundleDependencies:n.bundleDependencies??!1,externalNodeBuiltins:n.externalNodeBuiltins??!0,dts:n.dts??!1,copy:n.copy??{input:n.input??t,extensions:{input:[`.tpl`,`.html`,`.css`,`.scss`,`.sass`,`.less`,`.svg`,`.png`,`.jpg`,`.jpeg`,`.gif`,`.webp`,`.ico`,`.json`,`.md`,`.txt`,`.xml`,`.yml`,`.yaml`],mergeDefault:!1}}})}exports.buildBE=n;

package/cjs/bundler/index.js

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./buildFB.js`),t=require(`../packages/common/log/index.js`),n=require(`./state.js`),r=require(`./dev.js`),i=require(`./prod.js`);var a=(e,a)=>{switch(n.setBuildFEOptions(a),e){case`dev`:r.dev();break;case`prod`:i.prod();break;default:t.logRed(`Usage: npx tsx scripts/index.ts [dev|prod]`)}};exports.buildFB=e.buildFB,exports.buildFE=a;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./buildBE.js`),t=require(`../packages/common/log/index.js`),n=require(`./state.js`),r=require(`./dev.js`),i=require(`./prod.js`);var a=(e,a)=>{switch(n.setBuildFEOptions(a),e){case`dev`:r.dev();break;case`prod`:i.prod();break;default:t.logRed(`Usage: npx tsx scripts/index.ts [dev|prod]`)}};exports.buildBE=e.buildBE,exports.buildFE=a;

package/cjs/packages/core/index.js

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`../../_virtual/_rolldown/runtime.js`),t=require(`./env.js`),n=require(`../utils/path.js`),r=require(`../utils/runFileFn.js`);require(`../utils/index.js`);const i=require(`./loader/config.js`),a=require(`./loader/controller.js`),o=require(`./loader/extend.js`),s=require(`./loader/middleware.js`),c=require(`./loader/model.js`),l=require(`./loader/router.js`),u=require(`./loader/router-schema.js`),d=require(`./loader/service.js`);let f=require(`koa`);f=e.__toESM(f,1);var p=c,m=async(e={})=>{let r=new f.default;r.hooks={},r.hooks.initing?.();let{frameBaseDir:c,baseDir:p,...m}=e;r.options=m,r.options.pageBasePage=r.options.pageBasePage??`/`;let g=r.baseDir=p??process.cwd(),_=r.frameBaseDir=c??n.resolve(__dirname,`..`);r.businessAppPath=n.resolve(g,`app`),r.frameAppPath=n.resolve(_,`app`),r.paths=[{type:`frame`,path:r.frameAppPath},{type:`business`,path:r.businessAppPath}],r.envs=t(),console.log(`-- [init] env: ${r.envs.get()} --`),i(r),console.log(`-- [init] loader config done --`),await o(r),console.log(`-- [init] loader extend done --`),u(r),console.log(`-- [init] loader routerSchema done --`),d(r),console.log(`-- [init] loader service done --`),a(r),console.log(`-- [init] loader controller done --`),s(r),console.log(`-- [init] loader middleware done --`),h(r),l(r),console.log(`-- [init] loader router done --`);try{let e=r.config.port||process.env.PORT||`8080`,n=parseInt(e+``,10),i=process.env.IP||`0.0.0.0`;r.listen(n,i),console.log(`Server port: http://localhost:${n}`),console.log(`run env is ${t().get()}`)}catch(e){console.error(e)}return r.hooks.inited?.(),r},h=e=>{e.paths.forEach(t=>{for(let i of[`ts`,`js`]){let a=`middleware.${i}`,o=n.resolve(t.path,a);try{r.runFileFn(o)?.(e),console.log(`-- [init] loader ${t.type} appMiddleware ${a} done -- (${t.path})`);break}catch(e){let n=e;if(!(n?.code===`MODULE_NOT_FOUND`&&typeof n?.message==`string`&&(n.message.includes(`Cannot find module '${o}'`)||n.message.includes(`Cannot find module "${o}"`))))throw console.log(`-- [error] loader ${t.type} appMiddleware ${a} error -- (${o})`),e}}})};exports.loaderModel=p,exports.start=m;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`../../_virtual/_rolldown/runtime.js`),t=require(`./env.js`),n=require(`../utils/path.js`),r=require(`../utils/runFileFn.js`);require(`../utils/index.js`);const i=require(`./loader/config.js`),a=require(`./loader/controller.js`),o=require(`./loader/extend.js`),s=require(`./loader/middleware.js`),c=require(`./loader/model.js`),l=require(`./loader/router.js`),u=require(`./loader/router-schema.js`),d=require(`./loader/service.js`);let f=require(`koa`);f=e.__toESM(f,1);var p=c,m=async(e={})=>{let r=new f.default;r.hooks={},r.hooks.initing?.();let{frameBaseDir:c,baseDir:p,...m}=e;r.options=m,r.options.pageBasePage=r.options.pageBasePage??`/`,r.options.apiPrefix=r.options.apiPrefix||`/api`;let g=r.baseDir=p??process.cwd(),_=r.frameBaseDir=c??n.resolve(__dirname,`..`);r.businessAppPath=n.resolve(g,`app`),r.frameAppPath=n.resolve(_,`app`),r.paths=[{type:`frame`,path:r.frameAppPath},{type:`business`,path:r.businessAppPath}],r.envs=t(),console.log(`-- [init] env: ${r.envs.get()} --`),i(r),console.log(`-- [init] loader config done --`),await o(r),console.log(`-- [init] loader extend done --`),u(r),console.log(`-- [init] loader routerSchema done --`),d(r),console.log(`-- [init] loader service done --`),a(r),console.log(`-- [init] loader controller done --`),s(r),console.log(`-- [init] loader middleware done --`),h(r),l(r),console.log(`-- [init] loader router done --`);try{let e=r.config.port||process.env.PORT||`8080`,n=parseInt(e+``,10),i=process.env.IP||`0.0.0.0`;r.listen(n,i),console.log(`Server port: http://localhost:${n}`),console.log(`run env is ${t().get()}`)}catch(e){console.error(e)}return r.hooks.inited?.(),r},h=e=>{e.paths.forEach(t=>{for(let i of[`ts`,`js`]){let a=`middleware.${i}`,o=n.resolve(t.path,a);try{r.runFileFn(o)?.(e),console.log(`-- [init] loader ${t.type} appMiddleware ${a} done -- (${t.path})`);break}catch(e){let n=e;if(!(n?.code===`MODULE_NOT_FOUND`&&typeof n?.message==`string`&&(n.message.includes(`Cannot find module '${o}'`)||n.message.includes(`Cannot find module "${o}"`))))throw console.log(`-- [error] loader ${t.type} appMiddleware ${a} error -- (${o})`),e}}})};exports.loaderModel=p,exports.start=m;

package/esm/app/controller/view.js

@@ -1,23 +1,25 @@
 //#region app/controller/view.ts
 var e = (e) => JSON.stringify(e).replace(/</g, "\\u003c").replace(/>/g, "\\u003e").replace(/&/g, "\\u0026").replace(/\u2028/g, "\\u2028").replace(/\u2029/g, "\\u2029"), t = ((t) => class {
 	async renderPage(n) {
-		t.extends.logger.log(" - render page: " + n.params.page);
-		try {
-			t.extends.renderView(`dist/${n.params.page}.entry.tpl`, n, {
-				projKey: n.query.projk,
-				name: t.options?.name,
-				env: t.envs.get(),
-				basePath: e(`${t.options.pageBasePage}${n.params.page}`),
-				projKeyJson: e(String(n.query.projk ?? "")),
-				signKey: e(t.config.signKey),
-				options: e(t.options)
-			});
-		} catch (e) {
-			console.log("-------------- render view error --------------"), console.log(e), t.extends.generateErrorMessage("template not found", {
-				status: 404,
-				showError: !0,
-				code: 0
-			});
+		if (!n.path.includes(`${t.options.apiPrefix}/`)) {
+			t.extends.logger.log(" - render page: " + n.params.page);
+			try {
+				t.extends.renderView(`dist/${n.params.page}.entry.tpl`, n, {
+					projKey: n.query.projk,
+					name: t.options?.name,
+					env: t.envs.get(),
+					basePath: e(`${t.options.pageBasePage}${n.params.page}`),
+					projKeyJson: e(String(n.query.projk ?? "")),
+					signKey: e(t.config.signKey),
+					options: e(t.options)
+				});
+			} catch (e) {
+				console.log("-------------- render view error --------------"), console.log(e), t.extends.generateErrorMessage("template not found", {
+					status: 404,
+					showError: !0,
+					code: 0
+				});
+			}
 		}
 	}
 });

package/esm/app/middleware/api-params-verify.js

@@ -8,7 +8,7 @@ var t = new e(), n = "http://json-schema.org/draft-07/schema#", r = (e, r, i) =>
 	}
 }, i = (e) => async (n, i) => {
 	let { path: a, method: o } = n;
-	if (a.indexOf("/api") < 0) return i();
+	if (a.indexOf(e.options.apiPrefix) < 0) return i();
 	let s = e.currentUseRouter, c;
 	for (let e of s) {
 		let t = e.match(a, "get");

package/esm/app/middleware/api-sign-verify.js

@@ -2,7 +2,7 @@ import e from "md5";
 //#region app/middleware/api-sign-verify.ts
 var t = 1e3 * 60 * 10, n = (n) => async (r, i) => {
 	let { path: a, method: o } = r;
-	if (a.includes("api") && !n.config?.apiSignVerify?.whiteList?.includes(a)) {
+	if (a.includes(n.options.apiPrefix) && !n.config?.apiSignVerify?.whiteList?.includes(a)) {
 		n.extends.logger?.info("--[api-sign-verify]--");
 		let { s_sign: i, s_t: s } = r.request.header, { signKey: c } = n.config, l = e(`${c}_${s}`);
 		n.extends.logger?.info(`[${o} ${a}] signature: ${l}`), (!s || !i || i.toLowerCase() !== l || Date.now() - Number(s) > t) && n.extends.generateErrorMessage("signature not correct or api timeout", {

package/esm/app/middleware/project-handler.js

@@ -1,15 +1,15 @@
 //#region app/middleware/project-handler.ts
-var e = () => async (e, t) => {
-	let n = e.headers.projk, { path: r } = e;
-	if (r.indexOf("/api/proj/") !== -1 && (!n || ["undefined", "null"].includes(n))) {
-		e.status = 200, e.body = {
+var e = (e) => async (t, n) => {
+	let r = t.headers.projk, { path: i } = t;
+	if (i.indexOf(`${e.options.apiPrefix}/proj/`) !== -1 && (!r || ["undefined", "null"].includes(r))) {
+		t.status = 200, t.body = {
 			code: 110,
 			data: null,
 			message: "请求不合法"
 		};
 		return;
 	}
-	e.extInfo = { key: n }, await t();
+	t.extInfo = { key: r }, await n();
 };
 //#endregion
 export { e as default };

package/esm/app/router/project.js

@@ -1,7 +1,7 @@
 //#region app/router/project.ts
 var e = (e, t) => {
-	let { project: n } = e.controller;
-	t.get("/api/project/model_list", n.getModelList), t.get("/api/project/list", n.getProjectList), t.get("/api/project/:key", n.getProject);
+	let { project: n } = e.controller, { apiPrefix: r } = e.options;
+	t.get(`${r}/project/model_list`, n.getModelList), t.get(`${r}/project/list`, n.getProjectList), t.get(`${r}/project/:key`, n.getProject);
 };
 //#endregion
 export { e as default };

package/esm/bundler/{buildFB.js → buildBE.js}

@@ -1,6 +1,6 @@
 import { buildEntries as e } from "../scripts/vite-build/build.js";
 import "../scripts/vite-build/index.js";
-//#region bundler/buildFB.ts
+//#region bundler/buildBE.ts
 var t = [
 	"index.ts",
 	"index.js",
@@ -51,4 +51,4 @@ async function n(n = {}) {
 	});
 }
 //#endregion
-export { n as buildFB };
+export { n as buildBE };

package/esm/bundler/index.js

@@ -1,4 +1,4 @@
-import { buildFB as e } from "./buildFB.js";
+import { buildBE as e } from "./buildBE.js";
 import { logRed as t } from "../packages/common/log/index.js";
 import { setBuildFEOptions as n } from "./state.js";
 import { dev as r } from "./dev.js";
@@ -16,4 +16,4 @@ var a = (e, a) => {
 	}
 };
 //#endregion
-export { e as buildFB, a as buildFE };
+export { e as buildBE, a as buildFE };

package/esm/packages/core/index.js

@@ -16,7 +16,7 @@ var f = s, p = async (n = {}) => {
 	let s = new d();
 	s.hooks = {}, s.hooks.initing?.();
 	let { frameBaseDir: f, baseDir: p, ...h } = n;
-	s.options = h, s.options.pageBasePage = s.options.pageBasePage ?? "/";
+	s.options = h, s.options.pageBasePage = s.options.pageBasePage ?? "/", s.options.apiPrefix = s.options.apiPrefix || "/api";
 	let g = s.baseDir = p ?? process.cwd(), _ = s.frameBaseDir = f ?? t(__dirname, "..");
 	s.businessAppPath = t(g, "app"), s.frameAppPath = t(_, "app"), s.paths = [{
 		type: "frame",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@_tc/template-core",
-  "version": "0.0.1-bate.47",
+  "version": "0.0.1-bate.49",
   "description": "A full-stack TypeScript admin framework powered by Koa, React, and Vite - monorepo root",
   "types": "./types/index.d.ts",
   "exports": {

package/types/app/middleware/project-handler.d.ts

@@ -1,4 +1,4 @@
-import type { Ctx } from "../type";
 import type Koa from "koa";
-declare const _default: () => (ctx: Ctx, next: Koa.Next) => Promise<void>;
+import type { Ctx, KoaApp } from "../type";
+declare const _default: (app: KoaApp) => (ctx: Ctx, next: Koa.Next) => Promise<void>;
 export default _default;

package/types/app/router/project.d.ts

@@ -1,4 +1,4 @@
-import type { KoaApp } from "../type";
 import type Router from "koa-router";
+import type { KoaApp } from "../type";
 declare const _default: (app: KoaApp, router: Router) => void;
 export default _default;

package/types/bundler/buildBE.d.ts

@@ -0,0 +1,13 @@
+import type { Alias } from "vite";
+import type { BuildEntriesConfig, BuildEntriesResult, BuildFormat } from "../scripts/vite-build/types";
+export type BuildBEAlias = Record<string, string> | Alias[];
+export type BuildBEFormat = BuildFormat;
+export type BuildBEOptions = Omit<BuildEntriesConfig, 'input' | 'format' | 'outDir' | 'rootDir' | 'alias'> & {
+    rootDir?: string;
+    input?: string[];
+    outDir?: string;
+    format?: BuildBEFormat | BuildBEFormat[];
+    alias?: BuildBEAlias;
+};
+export type BuildBEResult = BuildEntriesResult;
+export declare function buildBE(options?: BuildBEOptions): Promise<BuildBEResult>;

package/types/bundler/index.d.ts

@@ -1,4 +1,4 @@
 import type { BuildFEOptions } from "./state";
-export { buildFB } from "./buildFB";
-export type { BuildFBAlias, BuildFBFormat, BuildFBOptions, BuildFBResult } from "./buildFB";
+export { buildBE } from "./buildBE";
+export type { BuildBEAlias, BuildBEFormat, BuildBEOptions, BuildBEResult } from "./buildBE";
 export declare const buildFE: (mode: "dev" | "prod", options?: BuildFEOptions) => void;

package/types/packages/core/types.d.ts

@@ -109,6 +109,13 @@ export interface StartOptions {
      * - 主要是配合 buildFE 修改了输出路径时使用
      */
     additionalPublicPaths?: string | string[];
+    /**
+     * API 访问前缀。
+     * 为空或空字符串时会使用默认值 `/api`。
+     * 配置后会影响内置项目 API 路由，以及 API 参数校验、签名校验、项目处理等中间件的路径匹配。
+     * @default '/api'
+     */
+    apiPrefix?: string;
     /**
      * - 页面访问前缀 默认为 /
      * @default '/'

package/types/bundler/buildFB.d.ts

@@ -1,13 +0,0 @@
-import type { Alias } from "vite";
-import type { BuildEntriesConfig, BuildEntriesResult, BuildFormat } from "../scripts/vite-build/types";
-export type BuildFBAlias = Record<string, string> | Alias[];
-export type BuildFBFormat = BuildFormat;
-export type BuildFBOptions = Omit<BuildEntriesConfig, 'input' | 'format' | 'outDir' | 'rootDir' | 'alias'> & {
-    rootDir?: string;
-    input?: string[];
-    outDir?: string;
-    format?: BuildFBFormat | BuildFBFormat[];
-    alias?: BuildFBAlias;
-};
-export type BuildFBResult = BuildEntriesResult;
-export declare function buildFB(options?: BuildFBOptions): Promise<BuildFBResult>;