feat: Support pageNumType (#684)

* fix: support page num type writer

* fix: read page num type

* fix: add json type

* fix: add page num type writer

* 0.4.12-beta0

* fix

* fix

docx-core/src/documents/document.rs

@@ -228,6 +228,11 @@ impl Document {
         self.section_property.text_direction = direction;
         self
     }
+
+    pub fn page_num_type(mut self, p: PageNumType) -> Self {
+        self.section_property = self.section_property.page_num_type(p);
+        self
+    }
 }
 
 impl BuildXML for DocumentChild {

docx-core/src/documents/elements/mod.rs

@@ -61,6 +61,7 @@ mod numbering_id;
 mod numbering_property;
 mod outline_lvl;
 mod page_margin;
+mod page_num_type;
 mod page_size;
 mod paragraph;
 mod paragraph_borders;
@@ -185,6 +186,7 @@ pub use numbering_id::*;
 pub use numbering_property::*;
 pub use outline_lvl::*;
 pub use page_margin::*;
+pub use page_num_type::*;
 pub use page_size::*;
 pub use paragraph::*;
 pub use paragraph_borders::*;

docx-core/src/documents/elements/page_num_type.rs

@@ -0,0 +1,42 @@
+use crate::documents::BuildXML;
+use crate::xml_builder::*;
+use serde::Serialize;
+
+#[derive(Debug, Clone, PartialEq, Serialize, Default)]
+#[cfg_attr(feature = "wasm", derive(ts_rs::TS))]
+#[cfg_attr(feature = "wasm", ts(export))]
+#[serde(rename_all = "camelCase")]
+pub struct PageNumType {
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub start: Option<u32>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub chap_style: Option<String>,
+}
+
+impl PageNumType {
+    pub fn new() -> Self {
+        Default::default()
+    }
+
+    pub fn start(self, s: u32) -> Self {
+        Self {
+            start: Some(s),
+            ..self
+        }
+    }
+
+    pub fn chap_style(self, s: impl Into<String>) -> Self {
+        Self {
+            chap_style: Some(s.into()),
+            ..self
+        }
+    }
+}
+
+impl BuildXML for PageNumType {
+    fn build(&self) -> Vec<u8> {
+        XMLBuilder::new()
+            .page_num_type(self.start, self.chap_style.clone())
+            .build()
+    }
+}

docx-core/src/documents/elements/section_property.rs

@@ -43,6 +43,8 @@ pub struct SectionProperty {
     pub even_footer: Option<Footer>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub section_type: Option<SectionType>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub page_num_type: Option<PageNumType>,
 }
 
 impl SectionProperty {
@@ -157,6 +159,11 @@ impl SectionProperty {
         }
         footers
     }
+
+    pub fn page_num_type(mut self, h: PageNumType) -> Self {
+        self.page_num_type = Some(h);
+        self
+    }
 }
 
 impl Default for SectionProperty {
@@ -184,6 +191,7 @@ impl Default for SectionProperty {
             even_footer_reference: None,
             even_footer: None,
             section_type: None,
+            page_num_type: None,
         }
     }
 }
@@ -202,7 +210,9 @@ impl BuildXML for SectionProperty {
             .add_optional_child(&self.even_header_reference)
             .add_optional_child(&self.footer_reference)
             .add_optional_child(&self.first_footer_reference)
-            .add_optional_child(&self.even_footer_reference);
+            .add_optional_child(&self.even_footer_reference)
+            .add_optional_child(&self.page_num_type);
+
         if !self.text_direction.eq("lrTb") {
             b = b.text_direction(&self.text_direction);
         }

docx-core/src/documents/mod.rs

@@ -505,6 +505,11 @@ impl Docx {
         self
     }
 
+    pub fn page_num_type(mut self, p: PageNumType) -> Self {
+        self.document = self.document.page_num_type(p);
+        self
+    }
+
     pub fn build(mut self) -> XMLDocx {
         self.reset();
 

docx-core/src/reader/mod.rs

@@ -30,6 +30,7 @@ mod level_override;
 mod mc_fallback;
 mod numbering_property;
 mod numberings;
+mod page_num_type;
 mod paragraph;
 mod paragraph_property;
 mod paragraph_property_change;
@@ -358,7 +359,9 @@ pub fn read_docx(buf: &[u8]) -> Result<Docx, ReaderError> {
         .clone()
     {
         if let Some((footer, rels)) = footers.get(&f.id) {
-            docx.document = docx.document.first_footer_without_title_pg(footer.clone(), &f.id);
+            docx.document = docx
+                .document
+                .first_footer_without_title_pg(footer.clone(), &f.id);
             let count = docx.document_rels.footer_count + 1;
             docx.document_rels.footer_count = count;
             docx.content_type = docx.content_type.add_footer();

docx-core/src/reader/page_num_type.rs

@@ -0,0 +1,27 @@
+use std::io::Read;
+use std::str::FromStr;
+
+use xml::attribute::OwnedAttribute;
+use xml::reader::EventReader;
+
+use super::*;
+
+impl ElementReader for PageNumType {
+    fn read<R: Read>(
+        _r: &mut EventReader<R>,
+        attrs: &[OwnedAttribute],
+    ) -> Result<Self, ReaderError> {
+        let mut p = PageNumType::new();
+        for a in attrs {
+            let local_name = &a.name.local_name;
+            if local_name == "start" {
+                if let Ok(s) = u32::from_str(&a.value) {
+                    p = p.start(s);
+                }
+            } else if local_name == "chapStyle" {
+                p = p.chap_style(a.value.clone());
+            }
+        }
+        Ok(p)
+    }
+}

docx-core/src/reader/section_property.rs

@@ -106,6 +106,11 @@ impl ElementReader for SectionProperty {
                                 sp = sp.doc_grid(doc_grid);
                             }
                         }
+                        XMLElement::PageNumType => {
+                            if let Ok(page_num_type) = PageNumType::read(r, &attributes) {
+                                sp = sp.page_num_type(page_num_type);
+                            }
+                        }
                         XMLElement::HeaderReference => {
                             if let Ok((rid, header_type)) =
                                 read_header_or_footer_reference(&attributes)

docx-core/src/reader/xml_element.rs

@@ -158,6 +158,7 @@ pub enum XMLElement {
     EvenAndOddHeaders,
     StructuredDataTag,
     Type,
+    PageNumType,
     Unsupported,
 }
 
@@ -390,6 +391,7 @@ impl FromStr for XMLElement {
             "titlePg" => Ok(XMLElement::TitlePg),
             "evenAndOddHeaders" => Ok(XMLElement::EvenAndOddHeaders),
             "sdt" => Ok(XMLElement::StructuredDataTag),
+            "pgNumType" => Ok(XMLElement::PageNumType),
             "type" => Ok(XMLElement::Type),
             _ => Ok(XMLElement::Unsupported),
         }

docx-core/src/xml_builder/elements.rs

@@ -447,7 +447,11 @@ impl XMLBuilder {
     closed!(ul_trail_space, "w:ulTrailSpace");
     closed!(do_not_expand_shift_return, "w:doNotExpandShiftReturn");
     closed!(adjust_line_height_table, "w:adjustLineHeightInTable");
-    closed!(character_spacing_control,"w:characterSpacingControl","w:val");
+    closed!(
+        character_spacing_control,
+        "w:characterSpacingControl",
+        "w:val"
+    );
     closed!(use_fe_layout, "w:useFELayout");
     closed!(
         compat_setting,
@@ -563,6 +567,20 @@ impl XMLBuilder {
         self.close()
     }
 
+    pub(crate) fn page_num_type(mut self, start: Option<u32>, chap_style: Option<String>) -> Self {
+        let mut w = XmlEvent::start_element("w:pgNumType");
+        let start_string = format!("{}", start.unwrap_or_default());
+        let chap_style_string = chap_style.clone().unwrap_or_default();
+        if start.is_some() {
+            w = w.attr("w:start", &start_string);
+        }
+        if chap_style.is_some() {
+            w = w.attr("w:chapStyle", &chap_style_string);
+        }
+        self.writer.write(w).expect(EXPECT_MESSAGE);
+        self.close()
+    }
+
     pub(crate) fn tab(
         mut self,
         v: Option<TabValueType>,

docx-wasm/js/index.ts

@@ -517,6 +517,12 @@ export class Docx {
       }
     }
 
+    if (this.sectionProperty._pageTypeNum) {
+      const { start, chapStyle } = this.sectionProperty._pageTypeNum;
+      const p = wasm.createPageNumType(start, chapStyle);
+      docx = docx.page_num_type(p);
+    }
+
     if (this.sectionProperty._docGrid) {
       const { gridType, charSpace, linePitch } = this.sectionProperty._docGrid;
       let type = wasm.DocGridType.Default;

docx-wasm/js/json/bindings/PageNumType.ts

@@ -0,0 +1,2 @@
+
+export interface PageNumType { start?: number, chapStyle?: string, }

docx-wasm/js/json/section-property.ts

@@ -1,5 +1,8 @@
 import { HeaderJSON, HeaderReferenceJSON } from "./header";
 import { FooterJSON, FooterReferenceJSON } from "./footer";
+import { PageNumType as PageNumTypeJSON } from "./bindings/PageNumType";
+
+export { PageNumType as PageNumTypeJSON } from "./bindings/PageNumType";
 
 export type DocGridType = "default" | "lines" | "linesAndChars" | "snapToChars";
 
@@ -48,4 +51,5 @@ export type SectionPropertyJSON = {
   firstFooter?: FooterJSON;
   evenFooterReference?: FooterReferenceJSON;
   evenFooter?: FooterJSON;
+  pageNumType?: PageNumTypeJSON;
 };

docx-wasm/js/section-property.ts

@@ -1,6 +1,7 @@
 import { DocGridType } from ".";
 import { Footer } from "./footer";
 import { Header } from "./header";
+import { PageNumType } from "./json/bindings/PageNumType";
 
 export type DocGrid = {
   gridType: DocGridType;
@@ -21,6 +22,7 @@ export class SectionProperty {
   _footer: Footer | null = null;
   _firstFooter: Footer | null = null;
   _evenFooter: Footer | null = null;
+  _pageTypeNum: PageNumType | null = null;
 
   pageSize(w: number, h: number) {
     this._pageSize.w = w;
@@ -72,6 +74,11 @@ export class SectionProperty {
     this._evenFooter = footer;
     return this;
   }
+
+  pageTypeNum({ start, chapStyle }: { start: number; chapStyle: string }) {
+    this._pageTypeNum = { start, chapStyle };
+    return this;
+  }
 }
 
 export type PageOrientationType = "landscape" | "portrait";

docx-wasm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docx-wasm",
-  "version": "0.4.11",
+  "version": "0.4.12-beta1",
   "main": "dist/node/index.js",
   "browser": "dist/web/index.js",
   "author": "bokuweb <bokuweb12@gmail.com>",

docx-wasm/src/doc.rs

@@ -178,6 +178,11 @@ impl Docx {
         self
     }
 
+    pub fn page_num_type(mut self, p: PageNumType) -> Self {
+        self.0 = self.0.page_num_type(p.take());
+        self
+    }
+
     pub fn doc_grid(
         mut self,
         grid_type: docx_rs::DocGridType,

docx-wasm/src/lib.rs

@@ -12,6 +12,7 @@ mod level_override;
 mod line_spacing;
 mod numbering;
 mod page_margin;
+mod page_num_type;
 mod paragraph;
 mod pic;
 mod reader;
@@ -40,6 +41,7 @@ pub use level_override::*;
 pub use line_spacing::*;
 pub use numbering::*;
 pub use page_margin::*;
+pub use page_num_type::*;
 pub use paragraph::*;
 pub use pic::*;
 pub use reader::*;

docx-wasm/src/page_num_type.rs

@@ -0,0 +1,23 @@
+use wasm_bindgen::prelude::*;
+
+#[wasm_bindgen]
+#[derive(Debug)]
+pub struct PageNumType(docx_rs::PageNumType);
+
+#[wasm_bindgen(js_name = createPageNumType)]
+pub fn create_page_num_type(start: Option<u32>, chap_style: Option<String>) -> PageNumType {
+    let mut p = docx_rs::PageNumType::new();
+    if let Some(start) = start {
+        p = p.start(start);
+    }
+    if let Some(chap_style) = chap_style {
+        p = p.chap_style(chap_style);
+    }
+    PageNumType(p)
+}
+
+impl PageNumType {
+    pub fn take(self) -> docx_rs::PageNumType {
+        self.0
+    }
+}

docx-wasm/test/__snapshots__/index.test.js.snap

@@ -19614,6 +19614,7 @@ Object {
         "right": 1440,
         "top": 1440,
       },
+      "pageNumType": Object {},
       "pageSize": Object {
         "h": 15840,
         "orient": null,
@@ -36413,6 +36414,10 @@ Object {
         "right": 1701,
         "top": 1985,
       },
+      "pageNumType": Object {
+        "chapStyle": "1",
+        "start": 200,
+      },
       "pageSize": Object {
         "h": 16838,
         "orient": null,
@@ -111340,6 +111345,9 @@ Object {
                 "right": 1440,
                 "top": 1440,
               },
+              "pageNumType": Object {
+                "start": 1,
+              },
               "pageSize": Object {
                 "h": 15840,
                 "orient": null,
@@ -116710,6 +116718,9 @@ Object {
         "right": 1440,
         "top": 1440,
       },
+      "pageNumType": Object {
+        "start": 1,
+      },
       "pageSize": Object {
         "h": 15840,
         "orient": null,