# @burdenoff/microfe-support 中文文档

规范地址：https://npmcn.com/package/%40burdenoff/microfe-support/

版本：2026\.1031\.2
npm 元数据更新时间：2026-10-31T19:08:41.539Z
中文译文更新时间：2026-11-08T20:12:44.115Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40burdenoff/microfe-support
原文对照：https://npmcn.com/package/%40burdenoff/microfe-support/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：10.1 MB，357 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：17 个
- peer 依赖：react ^19\.0\.0，zustand ^5\.0\.0，react-dom ^19\.0\.0，@apollo/client ^4\.0\.9
- 首次发布：2026-05-11T04:10:00.846Z
- 最新版本发布：2026-10-31T19:08:41.374Z
- 近 30 天下载量：8532（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：75（近 12 个月 75 个）

## 中文简介

负担支持微前端 - 完整的客户支持和出票接口

## 安装

```sh
npm install @burdenoff/microfe-support
```

也可以使用：`pnpm add @burdenoff/microfe-support`、`yarn add @burdenoff/microfe-support`、`bun add @burdenoff/microfe-support`

## README

# @ taffleoff/微费支持

> Burdenoff平台的客户支持和服务台系统

[![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue.svg)](https://www.typescriptlang.org/) [![React](https://img.shields.io/badge/React-19-61dafb.svg)](https://reactjs.org/) [![Vite](https://img.shields.io/badge/Vite-7-646cff.svg)](https://vitejs.dev/)

## 概览

支持微前端提供了一个全面的客户支持平台,包括售票管理,售票后的对话,知识库,分析,以及SLA跟踪. 以持久的票证历史和业务见解为客户提供支持.

**端口 :** `5154` **模块类型 :** 租户单元 **API 网关 :** 港口 4018

## 特征

-   **车票管理**
    
    -   创建和管理支持票
    -   优先级别(低、常、高、关键)
    -   状况跟踪(新、在建、已解决、已关闭)
    -   罚单分配和升级
    -   内部说明和客户答复
    -   文件附件
-   **退票谈话**
    
    -   客户和代理人对支持票的答复
    -   更新票的订阅信件
    -   持久的谈话历史
    -   答复
    -   通过票务流程分配和升级
-   **知识库**
    
    -   自助文章
    -   类别组织
    -   条款查询
    -   视图跟踪
    -   帮助/无帮助投票
    -   相关条款
-   **SLA 管理**
    
    -   配置 SLA 政策
    -   跟踪响应时间
    -   决议时间监测
    -   苏丹解放军突破警报
    -   办公时间配置
    -   每个优先级自定义 SLA 规则
-   **分析盘**
    
    -   车票数量趋势
    -   反应时间指标
    -   分辨率时间尺度
    -   代理业绩
    -   客户满意度分数
    -   类别细目
-   **设置配置( S)**
    
    -   常规设置
    -   工作时间
    -   苏丹解放军政策
    -   答复
    -   电子邮件模板
    -   车票类别

## 安装

```bash
# Install dependencies
bun install

# Generate GraphQL types
bun run codegen
```

## 发展

```bash
# Start development server (port 5154)
bun run dev

# Run linter
bun run lint

# Format code
bun run format

# Type check
bun run type:check

# Build for production
bun run build

# Run all quality checks
bun run sanity
```

## 项目结构

```
src/
├── dev/                      # Development harness
├── support/                  # Main module
│   ├── components/          # React components
│   │   ├── PageLayout.tsx
│   │   ├── analytics/       # Analytics components
│   │   ├── chat/           # Chat components
│   │   ├── settings/       # Settings components
│   │   ├── shared/         # Shared components
│   │   ├── tickets/        # Ticket components
│   │   └── ui.tsx          # UI components
│   ├── graphql/            # GraphQL operations
│   │   ├── client.ts
│   │   ├── generated/      # Generated types
│   │   └── operations/     # Queries/Mutations
│   ├── hooks/              # Custom React hooks
│   │   ├── useAnalyticsOperations.ts
│   │   ├── useChatOperations.ts
│   │   ├── useKnowledgeBaseOperations.ts
│   │   ├── useSettingsOperations.ts
│   │   └── useTicketOperations.ts
│   ├── pages/              # Page components
│   ├── providers/          # Context providers
│   ├── store/              # State management
│   ├── types/              # TypeScript types
│   └── utils/              # Utility functions
```

## 图QL 操作

### 查询

-   `getTickets` - 名单支持票
-   `getTicketDetail` - 获取票务信息和状况
-   `mySupportTickets` - 列出我的支持票
-   `getArticles` - 列出 KB 文章
-   `getArticle` - 获取文章细节
-   `getSupportAnalytics` - 得到分析
-   `getSLAPolicies` - 列出苏丹解放军的政策
-   `getCannedResponses` - 获得罐头反应

### 变异

-   `createTicket` - 创建支持票
-   `updateTicket` - 更新票
-   `addTicketMessage` - 在票上添加消息
-   `assignTicket` - 指派给特工
-   `changeTicketStatus` - 最新情况
-   `createSLAPolicy` - 制定苏丹解放军政策
-   `createCannedResponse` - 创建罐装反应

### 订阅

-   `ticketUpdated` - 车票状态变化(以生成代码)
-   `ticketMessageAdded` - 实时售票谈话更新(以生成代码)

## 配置

### 环境变量

```env
VITE_API_GATEWAY_URL=http://localhost:4018/graphql
VITE_TENANT_ID=your-tenant-id
VITE_WORKSPACE_ID=your-workspace-id
```

### 与壳牌公司合并

```tsx
import { SupportRoot } from '@burdenoff/microfe-support';

function App() {
  return (
    <SupportRoot
      basePath="/support"
      navigate={navigate}
      apiGatewayUrl="http://localhost:4018/graphql"
      workspaceId="workspace-123"
      currentUser={{
        id: 'user-1',
        email: 'agent@example.com',
        displayName: 'Support Agent',
      }}
      onTicketCreated={(ticket) => {
        console.log('Ticket created:', ticket);
      }}
      onChatStarted={(session) => {
        console.log('Ticket conversation started:', session);
      }}
      onArticleViewed={(article) => {
        console.log('Article viewed:', article);
      }}
    />
  );
}
```

## 车票优先级

| 优先权 | 苏丹解放军的回应 | 苏丹解放军决议 | 使用大小写 |
| --- | --- | --- | --- |
| **关键** | 15分钟 | 4小时 | 系统关闭,数据丢失 |
| **高级** | 1小时 | 8小时 | 主要功能已断开 |
| **常规** | 4小时 | 24小时 | 一般问题 |
| **低级** | 24小时 | 72小时 | 问题、请求 |

## 车票状态

-   **新设** - 刚刚创建,尚未指定
-   **进行中** - 被特工调查
-   **等待客户** - 等待客户回应
-   **决定** - 定案,等待确认
-   **关闭** - 确认已解决
-   **重新打开** - 关闭后重新开放

## SLA 违反状态

-   **无** - 在轨道上
-   **警告 50%** - 时间的50%
-   **警告:75%** - 75%的时间
-   **警告 90%** - 90%的时间
-   **被突破** - 苏丹解放军时间超过

## 知识库

### 条状结构

-   标题和说明
-   文章内容( 马可达)
-   类别
-   搜索标记
-   相关条款
-   查看计数跟踪
-   帮助收视率

### SEO- 友好的 URL

```
/knowledge-base/getting-started
/knowledge-base/account-management/password-reset
/knowledge-base/billing/upgrade-plan
```

## 可用的脚本

| 脚本 | 说明 |
| --- | --- |
| `bun run dev` | 启动开发服务器 |
| `bun run build` | 生产建筑 |
| `bun run lint` | 运行 ESLint |
| `bun run format` | 格式为 Pretier |
| `bun run type:check` | 脚本类型检查 |
| `bun run codegen` | 生成图QL 类型 |
| `bun run sanity` | 运行所有质量检查 |

## 技术堆栈

-   **框架:** 使用类型脚本 5.9 的反应 19
-   **构建工具 :** 视频 7
-   **州管理层:** Zu5
-   **图QL 客户端 :** 阿波罗客户端
-   **风格:** 尾风 CSS v4
-   **UI 组件 :** Radix 用户界面
-   **图标 :** 路西德反应
-   **跑道:** 反应路由器 DOM 7
-   **实时 :** 图QL 订阅

## 已知问题

### 图QL 生成代码

2 类型脚本出错 `src/support/graphql/generated/operations.ts` (行778,787)与阿波罗客户端订阅类型相容性有关. 这些在 **生成代码** 当图形QL 方案重新生成时, 将解决它。 尽管存在这些错误,该模块仍然充分发挥作用.

## 最佳做法

1.  **车票管理**
    
    -   在苏丹解放军时间内作出反应
    -   不断更新客户信息
    -   使用内部注释进行团队通信
    -   立即关闭已解决的罚单
2.  **现场聊天**
    
    -   快速问候顾客
    -   使用罐装反应提高效率
    -   必要时转至专家
    -   礼貌地结束聊天
3.  **知识库**
    
    -   写清楚,简洁的文章
    -   包含截图/视频
    -   内容不断更新
    -   监测文章的有用性

## 许可证

版权所有——版权2025 Burdenoff咨询服务有限公司.

## 常见问题

### @burdenoff/microfe-support 是什么？

负担支持微前端 - 完整的客户支持和出票接口

### 如何安装 @burdenoff/microfe-support？

在项目目录运行 npm install @burdenoff/microfe-support，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19\.0\.0）、zustand（^5\.0\.0）、react-dom（^19\.0\.0）、@apollo/client（^4\.0\.9）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @burdenoff/microfe-support 支持 TypeScript 吗？

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

### @burdenoff/microfe-support 支持 ESM 还是 CommonJS？

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

### @burdenoff/microfe-support 可以商用吗？

@burdenoff/microfe-support 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @burdenoff/microfe-support 的下载量有多少？

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

### @burdenoff/microfe-support 还在维护吗？

最新版本 2026\.1031\.2 发布于 2026/11/01（8 天前）；至今共发布 75 个版本，其中过去 12 个月发布了 75 个；首次发布于 2026/05/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

