# @gct-paas/word 中文文档

规范地址：https://npmcn.com/package/%40gct-paas/word/

版本：0\.2\.41
npm 元数据更新时间：2026-11-12T02:55:29.685Z
中文译文更新时间：2026-11-16T00:54:22.404Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gct-paas/word
原文对照：https://npmcn.com/package/%40gct-paas/word/?lang=original
源码仓库：https://git.gct-china.com/paas/frontend/gct-word

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

- 包体积（解压后）：12.1 MB，1137 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：11 个
- peer 依赖：vue ^3\.0\.0，dayjs ^1\.11\.0，exifr ^7\.1\.3，jspdf ^3\.0\.4，konva ^10\.0\.8，qrcode ^1\.5\.1，crypto-js ^4\.1\.1，jsbarcode ^3\.11\.5，lodash-es ^4\.17\.21，vue-konva ^3\.2\.6，vxe-table 4\.6\.18，sortablejs ^1\.15\.3，bignumber\.js ^9\.0\.0，floating-vue ^5\.2\.2，vuedraggable ^4\.1\.0，@gct-paas/api \>=0\.1\.0
- 首次发布：2026-03-02T08:22:49.940Z
- 最新版本发布：2026-11-12T02:55:29.478Z
- 近 30 天下载量：12385（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：284（近 12 个月 284 个）

## 中文简介

GCT − Q字数

## 安装

```sh
npm install @gct-paas/word
```

也可以使用：`pnpm add @gct-paas/word`、`yarn add @gct-paas/word`、`bun add @gct-paas/word`

## README

# @gct-paas/word

GCT 在线 Word 文档引擎与 Vue 组件 SDK，用于在业务系统中接入文档设计、渲染与表单填报能力。

## 适用场景

-   需要在 Vue 3 项目中嵌入在线文档设计器/预览器
-   需要统一接入文档实例、模板、填报数据能力
-   需要通过插件机制扩展套件能力（如 `edhr`）

## 环境要求

-   Node.js >= 18
-   Vue 3

## 安装

```bash
pnpm add @gct-paas/word
```

或：

```bash
npm install @gct-paas/word
```

或：

```bash
yarn add @gct-paas/word
```

## 依赖与样式

请在宿主项目中安装/确保以下 peer dependencies 可用（以 `package.json` 为准），包括但不限于：

-   `vue`
-   `floating-vue`
-   `vue-konva`
-   `konva`
-   `vxe-table`
-   `vuedraggable`
-   `sortablejs`
-   `crypto-js`
-   `jspdf`
-   `qrcode`
-   `jsbarcode`
-   `exifr`

同时引入样式文件：

```ts
import '@gct-paas/word/style.css';
```

## 快速开始

下面示例展示从初始化宿主适配器，到创建运行时，再到挂载渲染组件的完整流程。

```ts
import { createApp, defineComponent } from 'vue';
import {
  setupPlatformAdapters,
  setupVueRuntime,
  useWord,
  DocRenderLayout,
  edhrSuitePlugin,
} from '@gct-paas/word';
import '@gct-paas/word/style.css';

// 1) 应用全局初始化（整个应用生命周期调用一次）
setupPlatformAdapters({
  interceptors: {
    requestInterceptors: (config: any) => config,
    requestInterceptorsCatch: (error: any) => Promise.reject(error),
    responseInterceptors: (response: any) => response,
    responseInterceptorsCatch: (error: any) => Promise.reject(error),
  },
  getAppInfo: async () => ({}),
  parseFile: async (file: File) => file,
  uploadFile: async (file: File) => ({ url: '', name: file.name }),
  formulaIdentify: async () => [],
  formulaCalculate: async () => ({}),
  triggerHandler: async () => void 0,
  plugins: [edhrSuitePlugin],
});

const Root = defineComponent({
  name: 'WordDemo',
  components: { DocRenderLayout },
  setup() {
    // 2) 创建文档运行时
    const { controller, docInfo } = useWord(
      {
        requestId: 'your-request-id',
        materialNo: 'optional-material-no',
        requestQuery: {},
      },
      {
        factoryType: 'instance', // 'template' | 'instance'
        modelKey: 'fm_your_model_key',
        suiteKey: 'edhr',
        isPreview: true,
      },
    );

    return { controller, docInfo };
  },
  template: `
    <div style="height: 100vh;">
      <DocRenderLayout />
    </div>
  `,
});

const app = createApp(Root);

// 3) Vue 运行时初始化（createApp 后调用）
setupVueRuntime({ app });
app.mount('#app');
```

## 初始化 API

### `setupPlatformAdapters(options)`

平台适配器注册函数。用于将宿主系统能力注入 SDK，全局只需调用一次。

`options` 关键字段：

-   `interceptors`：HTTP 请求拦截器配置
-   `getAppInfo`：获取应用信息/默认上下文
-   `parseFile`：文件解析方法
-   `uploadFile`：文件上传方法
-   `formulaIdentify?`：公式变量识别（可选）
-   `formulaCalculate?`：公式计算（可选）
-   `triggerHandler?`：触发主工程交互（可选）
-   `plugins?`：要安装的 suite 插件列表（如 `edhrSuitePlugin`）

### `setupVueRuntime({ app })`

Vue 运行时注册函数。建议在 `createApp` 后、`mount` 前调用。

作用：

-   注册 `FloatingVue`
-   注册 `VueKonva`
-   注册 SDK 所需全局指令

## 核心运行时 API

### `useWord(props, options)`

文档运行时主入口，返回 `WordRuntime`。

-   `props.requestId`：文档实例 ID 或模板 ID（支持函数形式）
-   `options.factoryType`：`'template' | 'instance'`
-   `options.modelKey`：主模型 key
-   `options.suiteKey?`：套件 key（默认常用 `edhr`）
-   `options.isPreview?` / `options.isRefer?` / `options.isDetailPage?` / `options.renderModeType?`：运行模式控制
    -   `isPreview`：设计器预览，隐藏 ribbon / toolkit / panel
    -   `isRefer`：设计器引用只读（对齐 Excel `DesignMode.Refer`），仅保留右侧属性 panel（隐藏 ribbon / toolkit），禁止编辑
    -   `isPreview` 与 `isRefer` **互斥**；同时为 true 时忽略 `isPreview`，仅启用 `isRefer`

返回值：

-   `controller`：`ShallowRef<DocController | null>`
-   `docInfo`：`Ref<DocInfo>`

### `DocController`（对外 API 清单）

`controller.value` 可用后，主要分为 4 类能力：

1.  状态字段（响应式）：

-   `id: string`：当前文档实例 id
-   `mode`：当前渲染模式
-   `modeLabel`：渲染模式文案
-   `updateTick`：布局刷新计数
-   `pages`：当前页面数组
-   `docRuntimeMeta`：运行时元信息（接口返回 + 业务拼接）

2.  查询 API（只读）：

-   `query.getWidgetByModelId(modelId)`：按模型字段 id 定位组件节点
-   `query.getPaperBySecRefId(id)`：按分节 refId 定位页面

3.  编辑/控制 API：

-   `execute(command, payload?)`：执行内置命令（高级）
-   `undo()` / `redo()`：撤销与重做
-   `setMode(mode)`：切换渲染模式
-   `setModel(model)`：替换当前文档模型
-   `rawData()`：获取原始填报数据
-   `reload()`：手动触发文档重载

4.  数据处理 API：

-   `validate()`：校验字段，返回错误映射或 `null`
-   `exportModel()`：导出 XmlJson 模型数据
-   `getDocumentAttachmentPaths(types?)`：提取附件路径列表
-   `enterBaseline(uniqueId)`：记录基线并进入填报模式
-   `computeBaselineChanges(ctx)`：计算与基线差异
-   `setAnnotation(ids, list)`：设置批注

示例：

```ts
const c = controller.value;
if (!c) return;

const errors = await c.validate();
if (!errors) {
  const model = c.exportModel();
  const data = c.rawData();
  const files = c.getDocumentAttachmentPaths();
  console.log(model, data, files);
}
```

## 对外导出（主入口）

当前包主入口为 `@gct-paas/word`，可直接使用以下能力：

-   初始化 API：`setupPlatformAdapters`、`setupVueRuntime`
-   引擎/类型：`useWord`、`DocModeTypeConst`、`PaperSizeConst`、`BuiltinComponentTypeConst`、`WordRuntime`、`DocController` 等
-   Vue 组件：`DocDesignLayout`、`DocRenderLayout`、`GctLayout`
-   插件能力：`registerSuite`、`WordSuitePlugin`、`edhrSuitePlugin`、`registerPanelSchemas`

## 插件扩展

### 方式一：在 `setupPlatformAdapters` 里批量注册（推荐）

```ts
import { setupPlatformAdapters, edhrSuitePlugin } from '@gct-paas/word';

setupPlatformAdapters({
  interceptors,
  getAppInfo,
  parseFile,
  uploadFile,
  plugins: [edhrSuitePlugin],
});
```

### 方式二：手动调用 `registerSuite`

```ts
import { registerSuite, edhrSuitePlugin } from '@gct-paas/word';

registerSuite(edhrSuitePlugin);
```

### 自定义插件协议

```ts
import type { WordSuitePlugin } from '@gct-paas/word';

const customPlugin: WordSuitePlugin = {
  key: 'custom-suite',
  install() {
    // 在这里注册你的 suite 能力
  },
};
```

### 主工程注册属性面板（如数据加载）

`edhrSuitePlugin` 不再内置注册 `data-load.basic`，需在 **edhr 插件之后** 由主工程注册：

```ts
import { edhrSuitePlugin, registerPanelSchemas, type WordSuitePlugin } from '@gct-paas/word';
import DataLoadPanel from './panels/data-load/DataLoadPanel.vue';

const hostPanelPlugin: WordSuitePlugin = {
  key: 'host-panels',
  install() {
    registerPanelSchemas('edhr', {
      'data-load.basic': {
        key: 'data-load.basic',
        title: '数据加载',
        render: DataLoadPanel,
      },
    });
  },
};

setupPlatformAdapters({
  // ...
  plugins: [edhrSuitePlugin, hostPanelPlugin],
});
```

## 最佳实践

-   `setupPlatformAdapters` 只在应用启动时调用一次，避免重复注册全局能力。
-   在 `createApp` 之后立即执行 `setupVueRuntime`，再调用 `mount`。
-   `uploadFile`、`parseFile`、`getAppInfo` 建议提供稳定兜底实现，避免运行时空函数导致异常。
-   通过 `controller` 调用业务动作前，先判断 `controller.value` 是否已就绪。

## 常见问题

### 1) 组件渲染空白

-   检查是否已引入 `@gct-paas/word/style.css`
-   检查是否调用了 `setupVueRuntime({ app })`
-   检查容器是否有明确高度（例如 `height: 100vh`）

### 2) 数据加载失败

-   检查 `requestId`、`factoryType`、`modelKey` 是否匹配当前业务接口
-   检查 `interceptors` 与鉴权逻辑是否正确透传
-   检查 `getAppInfo`、`requestQuery` 是否包含业务必需上下文

### 3) 插件能力未生效

-   检查插件是否执行了 `install()`
-   检查是否在 `setupPlatformAdapters` 初始化阶段完成注册
-   检查 `suiteKey` 与已注册插件 `key` 是否一致

## 本仓库开发与发布

维护 `@gct-paas/word` 的分支策略、版本号与 npm 发布约定见仓库根目录文档：

[开发与发布流程](https://npmcn.com/package/docs/development-and-release.md)

## License

MIT

## 常见问题

### @gct-paas/word 是什么？

GCT − Q字数

### 如何安装 @gct-paas/word？

在项目目录运行 npm install @gct-paas/word，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vue（^3\.0\.0）、dayjs（^1\.11\.0）、exifr（^7\.1\.3）、jspdf（^3\.0\.4）、konva（^10\.0\.8）、qrcode（^1\.5\.1）、crypto-js（^4\.1\.1）、jsbarcode（^3\.11\.5）、lodash-es（^4\.17\.21）、vue-konva（^3\.2\.6）、vxe-table（4\.6\.18）、sortablejs（^1\.15\.3）、bignumber\.js（^9\.0\.0）、floating-vue（^5\.2\.2）、vuedraggable（^4\.1\.0）、@gct-paas/api（\>=0\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gct-paas/word 支持 TypeScript 吗？

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

### @gct-paas/word 支持 ESM 还是 CommonJS？

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

### @gct-paas/word 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @gct-paas/word 可以商用吗？

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

### @gct-paas/word 的下载量有多少？

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

### @gct-paas/word 还在维护吗？

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

