@fayz-ai/plugin-conversations

中文文档
0.45.8发布于 2026/11/11MITTypeScriptES Module近 30 天下载 1.4万

[experimental] Fayz SDK — unified conversations / omni-channel inbox plugin

原始使用文档
文档目录5 节
  1. What's inside
  2. Install
  3. Usage
  4. Part of the Fayz SDK
  5. Roadmap & contributing

@fayz-ai/plugin-conversations

Status: experimental (incubating). Not capability-complete — missing some or all of the capability bar (data-provider contract w/ supabase+mock pair, entity registries, settings, migrations; see docs/plugins/PLUGIN-PATTERNS.md). Fine to explore in dogfoods; NOT ready for fresh installs or generated apps, and its API may change without notice.

One omni-channel inbox — SMS, WhatsApp, Instagram, email, and web chat in one thread.

npm license

Customers reach out everywhere — a WhatsApp here, an Instagram DM there, an email, a text. Replying across five tabs is how businesses drop conversations. plugin-conversations is the GoHighLevel-style unified inbox for the Fayz engine: every channel collapses into one threaded view, so a salon, a restaurant, or an agency answers everyone from a single place.

This is foundational today. The plugin ships a complete inbox UI and a data-provider seam: it runs on a rich mock out of the box, and reads/writes the conversations + conversation_messages tables (tenant-scoped) when a Supabase client is registered. WhatsApp is the first real channel, through the Tyxter connector; Instagram, email and SMS still arrive out-of-band.

What's inside

  • A full-bleed /conversations inbox view backed by a Zustand store
  • A ConversationsProvider seam: mock provider, or a Supabase provider (tenant-scoped via the active org) when a client is registered
  • The Tyxter connector (messaging shelf): WhatsApp on a number the platform already owns — no key to paste — with an optional dedicated number per tenant
  • plg_conversations_channels: which number a message leaves by (product fallback vs tenant dedicated), read by members, written only by the service role
  • Domain events: conversations.message.received, conversations.message.sent
  • AI tools: listConversations (filter by sms / whatsapp / instagram / email / webchat) and sendMessage
  • Configurable navigation and full i18n
  • Exported types (Conversation, Message, Channel) and the Supabase provider factory for custom wiring

Install

npm install @fayz-ai/plugin-conversations

Peer deps: @fayz-ai/core, @fayz-ai/ui, @fayz-ai/admin, plus react / react-dom.

Usage

import { defineSaas } from '@fayz-ai/admin'
import { createConversationsPlugin } from '@fayz-ai/plugin-conversations'

export const app = defineSaas({
  // ...
  plugins: [
    createConversationsPlugin({ navLabel: 'Inbox', navPosition: 1 }),
  ],
})

With no Supabase client registered it runs on the mock inbox; register one and it persists to conversations / conversation_messages automatically.

Part of the Fayz SDK

The conversation layer of the engine. Pairs with plugin-crm (who you're talking to), plugin-marketing (broadcasts that start the thread), and plugin-reputation (turning a happy reply into a review).

Roadmap & contributing

Early and foundational — built in the open. See the Fayz SDK roadmap for current gaps, missing features, and good first issues.

版本与发布记录

@fayz-ai/plugin-conversations 共发布 124 个版本,首次发布于 2026/06/20;过去 12 个月发布了 124 个版本。

版本发布日期距今
0.45.8latest2026/11/112 天前
0.45.72026/11/113 天前
0.45.62026/11/113 天前
0.45.52026/11/067 天前
0.45.42026/11/068 天前
0.45.32026/11/068 天前

其他发布通道:next → 0.9.0-next.1,canary → 0.32.0-canary.20261028153856。

关于 @fayz-ai/plugin-conversations 的常见问题

@fayz-ai/plugin-conversations 是什么?

[experimental] Fayz SDK — unified conversations / omni-channel inbox plugin

如何安装 @fayz-ai/plugin-conversations?

在项目目录运行 npm install @fayz-ai/plugin-conversations,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、zustand(^4.5.0 || ^5.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/plugin-conversations 支持 TypeScript 吗?

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

@fayz-ai/plugin-conversations 支持 ESM 还是 CommonJS?

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

@fayz-ai/plugin-conversations 可以商用吗?

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

@fayz-ai/plugin-conversations 的下载量有多少?

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

@fayz-ai/plugin-conversations 还在维护吗?

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