@xilonglab/oc-docx 1.0.0

package/README.md

@@ -0,0 +1,34 @@
+# oc-docx
+
+OpenClaw 的 DOCX **插件**：逻辑在 **`@xilonglab/js-docx`**（`libs/js-docx`）；本仓库提供根目录 **`package.json`（唯一）**、**`openclaw.plugin.json`**、**`extensions/index.js`**（工具实现）、**`skills/docx/SKILL.md`**（技能说明）。
+
+## 布局
+
+```
+oc-docx/
+├── package.json
+├── openclaw.plugin.json
+├── extensions/
+│   └── index.js
+├── skills/
+│   └── docx/
+│       └── SKILL.md
+└── README.md
+```
+
+## 安装
+
+```bash
+cd /path/to/oc-docx
+npm install
+```
+
+根目录 `dependencies` 里默认 `file:../js-docx` 指向同级 `js-docx` 仓库；发布或 CI 可改为 npm 上的 `@xilonglab/js-docx` 版本号。
+
+## OpenClaw
+
+通过 `openclaw plugins install ./path/to/oc-docx`（或链接安装）加载插件；`openclaw.plugin.json` 中的 `skills` 会指向 `skills/docx`。具体启用方式以你所用 OpenClaw 版本文档为准。
+
+## 与 js-docx-mcp
+
+MCP 与本插件共用 **`@xilonglab/js-docx`** 导出的 `createDocx`、`editDocx`、`renderXml`、`getXmlReference`、`readDocx`。

package/extensions/index.js

@@ -0,0 +1,89 @@
+/**
+ * OpenClaw 插件扩展 — 对 @xilonglab/js-docx 的薄封装（与 js-docx-mcp 同源 API）。
+ */
+
+import jsDocx from '@xilonglab/js-docx';
+
+const {
+  createDocx,
+  editDocx,
+  renderXml,
+  getXmlReference,
+  readDocx,
+} = jsDocx;
+
+function ok(payload) {
+  return {
+    result: typeof payload === 'string' ? payload : JSON.stringify(payload, null, 2),
+  };
+}
+
+function err(e) {
+  return {
+    result: JSON.stringify({ success: false, error: e.message }, null, 2),
+    error: true,
+  };
+}
+
+export default {
+  async create_docx(args) {
+    try {
+      const { templatePath, xmlContent, outputPath, data } = args;
+      return ok(
+        await createDocx({
+          templatePath: templatePath ?? null,
+          xmlContent,
+          outputPath,
+          data: data ?? {},
+        })
+      );
+    } catch (e) {
+      return err(e);
+    }
+  },
+
+  async edit_docx(args) {
+    try {
+      const { docxPath, xmlContent, outputPath, data } = args;
+      return ok(
+        await editDocx({
+          docxPath,
+          xmlContent,
+          outputPath,
+          data: data ?? {},
+        })
+      );
+    } catch (e) {
+      return err(e);
+    }
+  },
+
+  async render_xml(args) {
+    try {
+      const { xmlContent } = args;
+      return ok(renderXml({ xmlContent }));
+    } catch (e) {
+      return err(e);
+    }
+  },
+
+  async get_xml_reference() {
+    const text = getXmlReference() || 'XML 语法参考文件未找到';
+    return ok(text);
+  },
+
+  async read_docx(args) {
+    try {
+      const { docxPath, includeHeaders = false, includeFooters = false } = args;
+      return ok(
+        await readDocx({
+          docxPath,
+          includeHeaders,
+          includeFooters,
+        })
+      );
+    } catch (e) {
+      return err(e);
+    }
+  },
+};

package/oc-docx.code-workspace

@@ -0,0 +1,14 @@
+{
+	"folders": [
+		{
+			"path": "../js-docx-mcp"
+		},
+		{
+			"path": "."
+		},
+		{
+			"path": "../js-docx"
+		}
+	],
+	"settings": {}
+}

package/openclaw.plugin.json

@@ -0,0 +1,12 @@
+{
+  "id": "oc-docx",
+  "name": "oc-docx",
+  "version": "1.0.0",
+  "description": "创建、编辑与读取 DOCX（xl-p / xl-table 等语法）。与 js-docx-mcp 共用 @xilonglab/js-docx。",
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {}
+  },
+  "skills": ["skills/docx"]
+}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@xilonglab/oc-docx",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "OpenClaw DOCX 插件：extensions + skills/docx（依赖 @xilonglab/js-docx）",
+  "main": "./extensions/index.js",
+  "openclaw": {
+    "extensions": ["./extensions/index.js"]
+  },
+  "scripts": {
+    "install:all": "npm install"
+  },
+  "dependencies": {
+    "@xilonglab/js-docx": "file:../js-docx"
+  },
+  "license": "ISC"
+}

package/skills/docx/SKILL.md

@@ -0,0 +1,62 @@
+---
+name: docx
+description: 使用 xl 语法创建、编辑、读取 DOCX；工具由本插件 extensions 注册。
+---
+
+# DOCX（xl 语法）
+
+实现位于 **`@xilonglab/js-docx`**；本技能说明何时、如何调用插件暴露的工具。
+
+## 工具一览
+
+### `create_docx`
+
+根据模板与 XML 内容创建新的 DOCX。
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| `templatePath` | string | 否 | 模板路径，或内置 `"v"`（竖版）/ `"h"`（横版）；省略默认 `v` |
+| `xmlContent` | string | 是 | xl-p、xl-table 等标签的 XML |
+| `outputPath` | string | 是 | 输出 `.docx` 绝对路径或工作区相对路径 |
+| `data` | object | 否 | 模板变量 |
+
+### `edit_docx`
+
+编辑现有 DOCX，替换正文 body。
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| `docxPath` | string | 是 | 要编辑的 `.docx` 路径 |
+| `xmlContent` | string | 是 | 新的 xl 语法 XML |
+| `outputPath` | string | 否 | 输出路径；省略则覆盖原文件 |
+| `data` | object | 否 | 模板变量 |
+
+### `render_xml`
+
+将 xl 语法 XML 编译为 WordprocessingML 片段。
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| `xmlContent` | string | 是 | xl-p、xl-table 等 |
+
+### `get_xml_reference`
+
+返回 xl 语法参考全文（无参数）。
+
+### `read_docx`
+
+读取 DOCX 正文（及可选页眉页脚），反编译为 xl 风格 XML。
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| `docxPath` | string | 是 | `.docx` 路径 |
+| `includeHeaders` | boolean | 否 | 是否包含页眉 |
+| `includeFooters` | boolean | 否 | 是否包含页脚 |
+
+## 权限
+
+插件需要读写工作区文件（`files:read` / `files:write`），与宿主 OpenClaw 配置一致即可。
+
+## 与 js-docx-mcp
+
+MCP 与本插件共用 **`@xilonglab/js-docx`** 的 `createDocx`、`editDocx`、`renderXml`、`getXmlReference`、`readDocx`。