@syzlm/ofdparser 0.0.1

package/src/core/ofd-core/Ofd/CT_DocInfo.km

@@ -0,0 +1,197 @@
+{
+    "root": {
+        "data": {
+            "id": "clv5xa0gfmg0",
+            "created": 1659404845367,
+            "text": "CT_DocInfo"
+        },
+        "children": [
+            {
+                "data": {
+                    "id": "clv7vqoo8a00",
+                    "created": 1659410367151,
+                    "text": "elements"
+                },
+                "children": [
+                    {
+                        "data": {
+                            "id": "clv7vu2j7r40",
+                            "created": 1659410374520,
+                            "text": "DocID",
+                            "note": "#### DocID\n \n可选 xs:string 采用UUID算法生成的由32个字符组成文件标识。每个DocID在文档创建或生成的时候进行分配"
+                        },
+                        "children": []
+                    },
+                    {
+                        "data": {
+                            "id": "clv7vxvaxxk0",
+                            "created": 1659410382790,
+                            "text": "Title",
+                            "note": "#### Title\n\n可选 xs:string 文档标题。标题可以与文件名不同"
+                        },
+                        "children": []
+                    },
+                    {
+                        "data": {
+                            "id": "clv7w3h9wew0",
+                            "created": 1659410395003,
+                            "text": "Author",
+                            "note": "#### Author\n\n可选 xs:string 文档作者"
+                        },
+                        "children": []
+                    },
+                    {
+                        "data": {
+                            "id": "clv7w6fsieo0",
+                            "created": 1659410401443,
+                            "text": "Subject",
+                            "note": "#### Subject\n\n可选 xs:string 文档主题"
+                        },
+                        "children": []
+                    },
+                    {
+                        "data": {
+                            "id": "clv7wb10ils0",
+                            "created": 1659410411433,
+                            "text": "Abstract",
+                            "note": "#### Abstract\n\n可选 xs:string 文档摘要与注释"
+                        },
+                        "children": []
+                    },
+                    {
+                        "data": {
+                            "id": "clv7wfczw3c0",
+                            "created": 1659410420865,
+                            "text": "CreationDate",
+                            "note": "#### CreationDate\n\n可选 xs:date 文档创建日期"
+                        },
+                        "children": []
+                    },
+                    {
+                        "data": {
+                            "id": "clv7wmnt4pc0",
+                            "created": 1659410436756,
+                            "text": "ModDate",
+                            "note": "#### ModDate\n\n可选 xs:date 文档最近修改日期"
+                        },
+                        "children": []
+                    },
+                    {
+                        "data": {
+                            "id": "clv7wq5ob880",
+                            "created": 1659410444367,
+                            "text": "DocUsage",
+                            "note": "#### DocUsage\n\n可选 xs:string 文档分类，默认值Normal，可取值如下：\n\n1. Normal ----- 普通文档\n2. EBook ----- 电子书\n3. ENewsPaper ----- 电子报纸\n4. EMagzine ----- 电子期刊杂志"
+                        },
+                        "children": []
+                    },
+                    {
+                        "data": {
+                            "id": "clv7wt3cm5s0",
+                            "created": 1659410450757,
+                            "text": "Cover",
+                            "note": "#### Cover \n\n可选 ST_Loc 文档封面，此路径指向一个图片文件"
+                        },
+                        "children": []
+                    },
+                    {
+                        "data": {
+                            "id": "clv7wws4vvk0",
+                            "created": 1659410458786,
+                            "text": "Keywords",
+                            "note": "#### Keywords\n\n关键词集合，每个关键词用1个“Keyword”子节点表达"
+                        },
+                        "children": [
+                            {
+                                "data": {
+                                    "id": "clv7x1dl6js0",
+                                    "created": 1659410468790,
+                                    "text": "elements"
+                                },
+                                "children": [
+                                    {
+                                        "data": {
+                                            "id": "clv7x43vbxc0",
+                                            "created": 1659410474733,
+                                            "text": "Keyword",
+                                            "note": "##### Keyword\n\n必填 xs:string 关键词"
+                                        },
+                                        "children": []
+                                    }
+                                ]
+                            }
+                        ]
+                    },
+                    {
+                        "data": {
+                            "id": "clv7x93rijc0",
+                            "created": 1659410485610,
+                            "text": "Creator",
+                            "note": "#### Creator\n \n可选 xs:string 创建文档的应用程序"
+                        },
+                        "children": []
+                    },
+                    {
+                        "data": {
+                            "id": "clv7xe8zz2o0",
+                            "created": 1659410496811,
+                            "text": "CreatorVersion",
+                            "note": "#### CreatorVersion\n\n可选 xs:string 创建文档的应用程序的版本信息"
+                        },
+                        "children": []
+                    },
+                    {
+                        "data": {
+                            "id": "clv7xi5gsf40",
+                            "created": 1659410505304,
+                            "text": "CustomDatas",
+                            "note": "#### CustomDatas\n\n用户自定义元数据集合，其子节点为CustomData"
+                        },
+                        "children": [
+                            {
+                                "data": {
+                                    "id": "clv7xlksze00",
+                                    "created": 1659410512762,
+                                    "text": "elements"
+                                },
+                                "children": [
+                                    {
+                                        "data": {
+                                            "id": "clv7xnmp0ag0",
+                                            "created": 1659410517230,
+                                            "text": "CustomData",
+                                            "note": "##### CustomData\n\n必选 xs:string 用户定义元数据集合，可以指定用一个名称及其对应的值"
+                                        },
+                                        "children": [
+                                            {
+                                                "data": {
+                                                    "id": "clv7xwh5b400",
+                                                    "created": 1659410536485,
+                                                    "text": "attributes"
+                                                },
+                                                "children": [
+                                                    {
+                                                        "data": {
+                                                            "id": "clv7y2nuayo0",
+                                                            "created": 1659410549951,
+                                                            "text": "Name",
+                                                            "note": "###### Name\n\n必选 xs:string 用户自定义元数据名称"
+                                                        },
+                                                        "children": []
+                                                    }
+                                                ]
+                                            }
+                                        ]
+                                    }
+                                ]
+                            }
+                        ]
+                    }
+                ]
+            }
+        ]
+    },
+    "template": "default",
+    "theme": "fresh-blue",
+    "version": "1.4.43"
+}

package/src/core/ofd-core/Ofd/OFD.km

@@ -0,0 +1,114 @@
+{
+    "root": {
+        "data": {
+            "id": "clv5ptqgtg00",
+            "created": 1659404261385,
+            "text": "OFD"
+        },
+        "children": [
+            {
+                "data": {
+                    "id": "clv5q3dp28w0",
+                    "created": 1659404282381,
+                    "text": "Elements",
+                    "expandState": "expand"
+                },
+                "children": [
+                    {
+                        "data": {
+                            "id": "clv5su6chb40",
+                            "created": 1659404497438,
+                            "text": "DocBody",
+                            "note": "\n## DocBody\n\n必填 文件对象入口，可以存在多个，以便在一个文档中包含多个板式文档\n\n\n"
+                        },
+                        "children": [
+                            {
+                                "data": {
+                                    "id": "clv5tcm2nrk0",
+                                    "created": 1659404537571,
+                                    "text": "Elements"
+                                },
+                                "children": [
+                                    {
+                                        "data": {
+                                            "id": "clv5tfr0mao0",
+                                            "created": 1659404544400,
+                                            "text": "DocInfo",
+                                            "note": "### DocInfo\n\nCT_DocInfo 文档元数据信息描述，文档元数据信息具体结构见图[CT_DocInfo.km](./CT_DocInfo.km)"
+                                        },
+                                        "children": []
+                                    },
+                                    {
+                                        "data": {
+                                            "id": "clv5tlu5go00",
+                                            "created": 1659404557651,
+                                            "text": "DocRoot",
+                                            "note": "### DocRoot\n\n可选 ST_Loc 指向文档根节点，有关文档跟节点描述见7.5"
+                                        },
+                                        "children": []
+                                    },
+                                    {
+                                        "data": {
+                                            "id": "clv5ts5wuvk0",
+                                            "created": 1659404571422,
+                                            "text": "Versions",
+                                            "note": "### Versions\n\n包含多个版本描述节点，用于定义文件因注释和其他改动产生的版本信息，见第19章"
+                                        },
+                                        "children": []
+                                    },
+                                    {
+                                        "data": {
+                                            "id": "clv5tvtmu8o0",
+                                            "created": 1659404579387,
+                                            "text": "Signatures",
+                                            "note": "### Signatures\n\n可选 ST_Loc 指向该文档中签名和签章结构，见第18章"
+                                        },
+                                        "children": []
+                                    }
+                                ]
+                            }
+                        ]
+                    }
+                ]
+            },
+            {
+                "data": {
+                    "id": "clv5q9muzqg0",
+                    "created": 1659404295996,
+                    "text": "attributes",
+                    "layout_mind_offset": {
+                        "x": 21,
+                        "y": 1
+                    }
+                },
+                "children": [
+                    {
+                        "data": {
+                            "id": "clv5qq005rs0",
+                            "created": 1659404331619,
+                            "text": "Version",
+                            "layout_left_offset": {
+                                "x": -5,
+                                "y": -22
+                            },
+                            "note": "## Version\n\n必填 xs:string 文件格式的版本号，取值为“1.0”"
+                        },
+                        "children": []
+                    },
+                    {
+                        "data": {
+                            "id": "clv5qzc5iu00",
+                            "created": 1659404351945,
+                            "text": "DocType",
+                            "note": "## DocType\n\n必须 xs:string 文件格式子集类型，取值为“OFD”，表明此文件符合本标准。取值为“OFD-A”，表明此文件符合OFD存档规范"
+                        },
+                        "children": []
+                    }
+                ]
+            }
+        ]
+    },
+    "template": "default",
+    "theme": "fresh-blue",
+    "version": "1.4.43"
+}

package/src/core/ofd-core/Ofd/OFD.md

@@ -0,0 +1,99 @@
+# OFD.xml 文件描述
+
+## Version
+
+必填 xs:string 文件格式的版本号，取值为“1.0”
+
+## DocType
+
+必须 xs:string 文件格式子集类型，取值为“OFD”，表明此文件符合本标准。取值为“OFD-A”，表明此文件符合OFD存档规范
+
+## DocBody
+
+必填 文件对象入口，可以存在多个，以便在一个文档中包含多个板式文档
+
+### DocInfo
+
+必填 CT_DocInfo 文档元数据信息描述，文档元数据信息具体结构见图 CT_DocInfo.km
+
+#### DocID
+ 
+可选 xs:string 采用UUID算法生成的由32个字符组成文件标识。每个DocID在文档创建或生成的时候进行分配
+
+#### Title
+
+可选 xs:string 文档标题。标题可以与文件名不同
+
+#### Author
+
+可选 xs:string 文档作者
+
+#### Subject
+
+可选 xs:string 文档主题
+
+#### Abstract
+
+可选 xs:string 文档摘要与注释
+
+#### CreationDate
+
+可选 xs:date 文档创建日期
+
+#### ModDate
+
+可选 xs:date 文档最近修改日期
+
+#### DocUsage
+
+可选 xs:string 文档分类，默认值Normal，可取值如下：
+
+1. Normal ----- 普通文档
+2. EBook ----- 电子书
+3. ENewsPaper ----- 电子报纸
+4. EMagzine ----- 电子期刊杂志
+
+#### Cover 
+
+可选 ST_Loc 文档封面，此路径指向一个图片文件
+
+#### Keywords
+
+关键词集合，每个关键词用1个“Keyword”子节点表达
+
+##### Keyword
+
+必填 xs:string 关键词
+
+#### Creator
+ 
+可选 xs:string 创建文档的应用程序
+
+#### CreatorVersion
+
+可选 xs:string 创建文档的应用程序的版本信息
+
+#### CustomDatas
+
+用户自定义元数据集合，其子节点为CustomData
+
+##### CustomData
+
+必选 xs:string 用户定义元数据集合，可以指定用一个名称及其对应的值
+
+###### Name
+
+必选 xs:string 用户自定义元数据名称
+
+### DocRoot
+
+可选 ST_Loc 指向文档根节点，有关文档跟节点描述见7.5
+
+### Versions
+
+包含多个版本描述节点，用于定义文件因注释和其他改动产生的版本信息，见第19章
+
+### Signatures
+
+可选 ST_Loc 指向该文档中签名和签章结构，见第18章
+

package/src/core/ofd-core/Ofd/OFDXml.ts

@@ -0,0 +1,69 @@
+import { Element } from 'xml-js';
+
+import OFDElement from '../OFDElement';
+import DocumnetXml from '../Documents/DocumnetXml';
+import SignaturesXml from '../Signatures/Signatures';
+import { ResultData } from '..';
+
+class OFDXMl extends OFDElement {
+  static fileName: string;
+  constructor(ofdxml: { [key: string]: Element }) {
+    OFDElement.init();
+    OFDXMl.fileName = 'OFD.xml';
+    super(ofdxml);
+    this.XmlChangeJson(OFDXMl.fileName);
+    this.getDocument();
+    this.getSignatures();
+  }
+
+  getDocument() {
+    const res = this.getElements('DocRoot', OFDXMl.fileName);
+    this.setST_Loc(res.replace(/^\//, ''));
+    if (res) {
+      return new DocumnetXml(res.replace(/^\//, ''));
+    }
+    return null;
+  }
+
+  getSignatures() {
+    const res = this.getElements('Signatures', OFDXMl.fileName);
+    if (res) {
+      return new SignaturesXml(res.replace(/^\//, ''));
+    }
+    return null;
+  }
+
+  /**
+   * 将OFD文件XML转换成渲染获取可操作数据
+   * @returns ResultData
+   */
+  getData(): ResultData {
+    const {
+      Pages,
+      Res,
+      OFDElements,
+      DocumnetResRoot,
+      PublicResRoot,
+      Tpls,
+      STLoc,
+      PageArea,
+      Signatures,
+      PageSignatures
+    } = OFDElement;
+
+    return {
+      Pages,
+      Res,
+      DocumnetResRoot,
+      PublicResRoot,
+      Tpls,
+      STLoc,
+      OFDElements,
+      PageArea,
+      Signatures,
+      PageSignatures
+    };
+  }
+}
+
+export default OFDXMl;

package/src/core/ofd-core/Pages/PAGE.md

@@ -0,0 +1,40 @@
+# Page 结构
+
+## Area
+
+### CT_PageArea
+
+定义该页面页面区域的大小和位置，仅对该页有效，该节点不出现时只使用模版页中的定义，如果模版页不存在或模版页中没有定义页面区域，则使用文件CommonData中的定义
+
+## Template
+
+该页使用的模版页，模版页的内容结构和普通页相同，定义在CommonData指定的XMl文件中。一个页可以使用多个模版页。该节点使用时通过TemplateID来引用具体的模版，并通过ZOrder属性来控制模版在页面中的呈现顺序。
+注：在模版页内的内容描述中该属性无效
+
+### TemplatePage
+
+#### ID 模版标识
+
+#### BaseLoc 指向模版页内容描述文件
+
+#### Name 模版页名称
+
+#### ZOrder 模版页的默认图层类型
+
+其类型描述和呈显顺序与Layer中Type的描述和处理一致，见表15，如果页面引用的多个模版的此属性相同，则应根据引用的顺序来显示，先引用者先绘制 默认Background
+
+1. Body 正文层
+2. Foreground 前景层
+3. Background 背景层
+
+## PageRes
+
+页资源，指向该页使用的资源文件
+
+## Content
+
+页面内容描述，该节点不存在时表示空白页
+
+## Actions
+
+与页面关联的动作，事件类型应为PO（页面打开动作）

package/src/core/ofd-core/Pages/PageXml.ts

@@ -0,0 +1,59 @@
+import { Element } from 'xml-js';
+import { replacePathPriex } from '../utils';
+import OFDElement from '../OFDElement';
+// import OFDXMl from '../ofd/OFDXml';
+// import { OFD_PATH } from '../constant';
+
+class PagesXml extends OFDElement {
+  /**
+   * Pages xml文件，以数组存放，存在多页
+   * @date 2022/7/27 - 09:41:22
+   *
+   * @type {Element[]}
+   */
+  pagesXml: (Element & { PageID: string })[];
+  static fileName: string;
+  constructor(pagesElements: Element[]) {
+    super();
+    this.setPagesXml(pagesElements);
+    this.pagesXml = [];
+    // this.getPages();
+  }
+
+  formatPageXml(pagesFile: (Element & { PageID: string })[]) {
+    pagesFile.forEach(item => {
+      this.setPages(item);
+    });
+  }
+
+  setPagesXml(pageElements: Element[]): void {
+    if (pageElements?.length) {
+      const pageName = this.OFDCommonQName('Page');
+      this.pagesXml = [];
+      pageElements.forEach(item => {
+        const { attributes, name } = item;
+        if (name === pageName && attributes) {
+          const { BaseLoc, ID } = attributes;
+          const pagePath = replacePathPriex(OFDElement.STLoc, `${BaseLoc}`);
+          this.pagesXml.push({
+            ...OFDElement.OFDElements[pagePath],
+            PageID: String(ID || '')
+          });
+        }
+      });
+      // 获取 Page xml 内数据
+      this.formatPageXml(this.pagesXml);
+    }
+  }
+
+  //   getPages() {
+  //     const res = this.getElements('DocRoot', PagesXml.fileName);
+  //     console.log('getPages:', res);
+  //     if (res) {
+  //       return new DocumnetXml(this.OFDElements, res);
+  //     }
+  //     return null;
+  //   }
+}
+
+export default PagesXml;