@fayz-ai/app-builder

中文文档
64.0.0发布于 2026/11/11MITTypeScriptES Module零依赖近 30 天下载 7375

[experimental] Fayz SDK — the app-builder surface: window chrome, live canvas, publish and chat seams

原始使用文档
文档目录5 节
  1. Two doors
  2. Install
  3. The surface
  4. The admin
  5. Part of the Fayz SDK

@fayz-ai/app-builder

Status: preview (experimental). The surface is real; the code view, publish and chat are contracts with minimal implementations. API may change without notice.

The app-builder surface: a window bar, the app running inside it, and the seams for seeing the code, publishing, and talking to whoever is doing the work.

npm license

The Fayz editor and an admin app need the same thing: the window chrome, the live app inside it, the conversation beside it, and a publish button. Writing that twice is the mistake this package exists to avoid. One surface, two hosts — the editor keeps its container lifecycle and its chat, the admin keeps its shell and its assistant, and both mount the same component.

Two doors

  • . — the surface. No @fayz-ai/* dependency at all: React, lucide-react and shadcn tokens, which both hosts already have. This is the door the Fayz editor imports.
  • ./plugin — createAppBuilderPlugin(), how the SDK admin mounts it. Pulls @fayz-ai/core, @fayz-ai/admin and @fayz-ai/ui as optional peers, so importing the surface never drags the admin in.

Install

npm install @fayz-ai/app-builder

Peer deps: react, react-dom, lucide-react. Optional peers (only for ./plugin): @fayz-ai/core, @fayz-ai/admin, @fayz-ai/ui.

The surface

import { AppBuilder } from '@fayz-ai/app-builder'

<AppBuilder
  target={{ name: 'Artorius', url: containerPreviewUrl, liveUrl }}
  chat={<YourChatColumn />}
  chatContract={{ send: (message, element) => yourChat.send(message, element) }}
  publish={{ state, publish }}
  onClose={goBack}
  onToggleChat={toggleChat}
  onToggleWide={toggleSidebar}
  slots={{ chromeEnd: <YourTabs />, belowCanvas: <YourTerminal /> }}
/>

Preview and code are one surface in two states (mode), not two components: pass a code slot and the switch appears; omit it and it does not exist. The chat is never drawn here — it varies per host — but chatContract is how "change this block" gets from the canvas into whatever conversation the host mounted. publish is the same button in both hosts with each one's transport behind it; without a contract it renders disabled and says why.

The admin

import { createAppBuilderPlugin } from '@fayz-ai/app-builder/plugin'

plugins: [createAppBuilderPlugin({ sandboxUrl: import.meta.env.VITE_APP_BUILDER_SANDBOX_URL })]

Mounts an immersive route (no nav entry — the door is the "Seu site" widget), resolves the target from the tenant's site row, opens the shell's assistant rail, and publishes builder_navigate / builder_reload / builder_set_viewport / builder_request_change to the agent.

Part of the Fayz SDK

Roadmap: the element-picker overlay (the protocol is already wired on both sides), a real code surface, and the Fayz editor swapping its components/preview/ tree for this one.

版本与发布记录

@fayz-ai/app-builder 共发布 69 个版本,首次发布于 2026/09/08;过去 12 个月发布了 69 个版本。

版本发布日期距今
64.0.0latest2026/11/112 天前
63.0.02026/11/113 天前
62.0.02026/11/113 天前
61.0.02026/11/067 天前
60.0.02026/11/068 天前
59.0.02026/11/068 天前

其他发布通道:canary → 55.0.0-canary.20261028153856。

关于 @fayz-ai/app-builder 的常见问题

@fayz-ai/app-builder 是什么?

[experimental] Fayz SDK — the app-builder surface: window chrome, live canvas, publish and chat seams

如何安装 @fayz-ai/app-builder?

在项目目录运行 npm install @fayz-ai/app-builder,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、react-dom(^18.0.0 || ^19.0.0)、lucide-react(>=0.400.0 <1.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fayz-ai/app-builder 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@fayz-ai/app-builder 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@fayz-ai/app-builder 可以商用吗?

@fayz-ai/app-builder 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@fayz-ai/app-builder 的下载量有多少?

根据 npm 官方下载统计,@fayz-ai/app-builder 在 2026/10/15 – 2026/11/13 这 30 天内被下载 7,375 次,日均约 246 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@fayz-ai/app-builder 还在维护吗?

最新版本 64.0.0 发布于 2026/11/11(2 天前);至今共发布 69 个版本,其中过去 12 个月发布了 69 个;首次发布于 2026/09/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。