rubix-studios-pty-ltd/payload-typesense
GitHub: rubix-studios-pty-ltd/payload-typesense
为 Payload CMS 提供 Typesense 搜索引擎集成的生产就绪插件，支持实时同步、拼写容错和可选的向量语义搜索。
Stars: 28 | Forks: 3
# PayloadCMS + Typesense 插件
Rubix Studios 为 Payload CMS 开发的 Typesense 集成专为生产环境的搜索工作流而构建，具有轻量级、模块化的结构，并可选支持诸如向量查询等高级功能。
该插件由 Rubix Studios 积极维护。
[](https://www.npmjs.com/package/@rubixstudios/payload-typesense)
## 安装
```
pnpm add @rubixstudios/payload-typesense
```
```
// payload.config.ts
import { buildConfig } from 'payload/config'
import { typesenseSearch } from '@rubixstudios/payload-typesense'
export default buildConfig({
plugins: [
typesenseSearch({
typesense: {
apiKey: 'xyz',
nodes: [
{
host: 'localhost',
port: 8108,
protocol: 'http',
},
],
},
collections: {
posts: {
enabled: true,
searchFields: ['title', 'content'],
facetFields: ['category', 'status'],
displayName: 'Blog Posts',
icon: '📝',
syncLimit: 500, // Overrides the default sync limit of 1000
},
},
// This feature is experimental
vectorSearch: {
enabled: true, // Enables vector-based semantic search
embedFrom: ['title', 'content'], // Omit to fall back to collection searchFields
embeddingModel: 'azure/text-embedding-ada-002',
modelConfig: {
api_key: 'your-api-key',
url: 'https://modelendpoint.com/openai',
},
}),
],
})
```
```
import { HeadlessSearchInput } from '@rubixstudios/payload-typesense'
export function GlobalSearchPage() {
return (
{
console.log('Selected document:', result.document)
}}
/>
)
}
export function CollectionSearch() {
return (
{
console.log('Selected document:', result.document)
}}
/>
)
}
export function VectorSearch() {
return (
{
console.log('Selected document:', result.document)
}}
/>
)
}
```
## 功能
- **高性能**
通过优化的请求处理实现亚毫秒级的搜索响应。
- **灵活搜索**
使用单个组件即可实现单集合、多集合或全局搜索。
- **向量搜索**
使用 embedding 进行可选的语义搜索，并无缝回退至关键字搜索。
- **现代化 UI**
兼容 Tailwind CSS 的无头、响应式实现。
- **实时同步**
与 Payload CMS 持续进行索引和同步。
- **高效缓存**
带有可配置 TTL 和竞态条件保护机制的内存缓存。
- **生产就绪**
稳健的错误处理、部署安全的默认设置以及平台兼容性。
- **可 Tree-Shake 架构**
模块化设计，可生成更小的 bundle 并支持选择性使用功能。
## 接口
- `GET /api/search` - 跨所有集合的全局搜索
- `GET /api/search/{collection}` - 搜索特定集合
- `POST /api/search/{collection}` - 带有过滤器的高级搜索
- `GET /api/search/{collection}/suggest` - 搜索建议
- `GET /api/search/collections` - 集合元数据
- `GET /api/search/health` - 健康检查
## 组件
- **HeadlessSearchInput**：支持所有搜索模式的单个组件：
- **集合**：`collections={['posts', 'products']}` - 支持全局搜索的智能过滤
- **全局搜索**：无需 collection 属性 - 跨所有集合进行搜索
- **完全的 UI 控制**：通过全面的主题系统实现可自定义渲染
## 主题
该插件包含一个强大的主题系统，拥有 2 个预构建主题并支持无限的自定义：
### 预构建
```
// Modern theme (default)
标签：CMS插件, Payload CMS, Syscall, Typesense, Web开发, 搜索引擎, 数据同步, 自动化攻击