docxdriver 0.4.2__tar.gz → 0.4.4__tar.gz

{docxdriver-0.4.2 → docxdriver-0.4.4}/Cargo.lock

@@ -416,7 +416,7 @@ dependencies = [
 
 [[package]]
 name = "docxdriver-cli"
-version = "0.4.2"
+version = "0.4.4"
 dependencies = [
  "clap",
  "docxdriver-core",
@@ -427,7 +427,7 @@ dependencies = [
 
 [[package]]
 name = "docxdriver-core"
-version = "0.4.2"
+version = "0.4.4"
 dependencies = [
  "hex",
  "latex2mathml",
@@ -445,7 +445,7 @@ dependencies = [
 
 [[package]]
 name = "docxdriver-mcp"
-version = "0.4.2"
+version = "0.4.4"
 dependencies = [
  "axum",
  "cap-std",
@@ -463,14 +463,14 @@ dependencies = [
 
 [[package]]
 name = "docxdriver-monty-repl"
-version = "0.4.2"
+version = "0.4.4"
 dependencies = [
  "docxdriver-core",
 ]
 
 [[package]]
 name = "docxdriver-python"
-version = "0.4.2"
+version = "0.4.4"
 dependencies = [
  "docxdriver-core",
  "pyo3",
@@ -480,7 +480,7 @@ dependencies = [
 
 [[package]]
 name = "docxdriver-wasm"
-version = "0.4.2"
+version = "0.4.4"
 dependencies = [
  "docxdriver-core",
  "js-sys",

{docxdriver-0.4.2 → docxdriver-0.4.4}/Cargo.toml

@@ -3,7 +3,7 @@ resolver = "2"
 members = ["crates/docxdriver-python"]
 
 [workspace.package]
-version = "0.4.2"
+version = "0.4.4"
 edition = "2021"
 license = "MIT"
 repository = "https://github.com/jhnoel/docxdriver"

{docxdriver-0.4.2 → docxdriver-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docxdriver
-Version: 0.4.2
+Version: 0.4.4
 Summary: Python SDK for the native Rust DOCX engine
 License-Expression: MIT
 Requires-Python: >=3.10
@@ -29,6 +29,7 @@ from docxdriver.plan import Plan, ReplaceText
 doc = Document(Path("contract.docx").read_bytes())
 doc.markup()                      # body with the ids plans address
 doc.comments(); doc.revisions(); doc.styles(); doc.assets()
+doc.bookmarks()                   # same as doc.read(kind="bookmarks")
 doc.find("thirty")
 review = doc.review(Plan(author="Reviewer", ops=[
     ReplaceText(at="0F537164", select="thirty", with_="sixty"),

{docxdriver-0.4.2/crates/docxdriver-python → docxdriver-0.4.4}/README.md

@@ -20,6 +20,7 @@ from docxdriver.plan import Plan, ReplaceText
 doc = Document(Path("contract.docx").read_bytes())
 doc.markup()                      # body with the ids plans address
 doc.comments(); doc.revisions(); doc.styles(); doc.assets()
+doc.bookmarks()                   # same as doc.read(kind="bookmarks")
 doc.find("thirty")
 review = doc.review(Plan(author="Reviewer", ops=[
     ReplaceText(at="0F537164", select="thirty", with_="sixty"),

{docxdriver-0.4.2 → docxdriver-0.4.4}/crates/docxdriver-core/src/api.rs

@@ -564,7 +564,20 @@ pub enum EditOp {
         with: String,
     },
     EditTable { at: String, action: TableEdit },
-    InsertTable { at: ParagraphAddress, position: InsertPosition, rows: u32, columns: u32, #[serde(rename = "as", default)] alias: Option<String> },
+    /// A `rows` × `columns` grid of new cells. `cells` fills them row by
+    /// row with the inline content `insert_paragraph`'s `with` accepts;
+    /// missing trailing rows and cells stay empty. With `as`, cell row N
+    /// column M is the paragraph alias `$<as>_rNcM` for later operations.
+    InsertTable {
+        at: ParagraphAddress,
+        position: InsertPosition,
+        rows: u32,
+        columns: u32,
+        #[serde(default)]
+        cells: Option<Vec<Vec<String>>>,
+        #[serde(rename = "as", default)]
+        alias: Option<String>,
+    },
     FormatTable { at: String, format: TableFormat },
     FormatRow { at: String, format: RowFormat },
     FormatCell { at: String, format: CellFormat },
@@ -748,6 +761,35 @@ pub enum EditOp {
     CommentDelete {
         comment_id: String,
     },
+    /// Bookmark the paragraph at `at`: its whole content, or the `select`
+    /// span. Applied directly in both change modes (Word does not track
+    /// bookmarks). Body paragraphs only.
+    BookmarkAdd {
+        at: ParagraphAddress,
+        name: String,
+        #[serde(default)]
+        select: Option<String>,
+        #[serde(default)]
+        occurrence: Option<u32>,
+    },
+    /// Rename a body bookmark; `new_name` follows the add rules.
+    BookmarkRename {
+        name: String,
+        new_name: String,
+    },
+    /// Re-anchor a body bookmark, keeping its name and `w:id`.
+    BookmarkMove {
+        name: String,
+        at: ParagraphAddress,
+        #[serde(default)]
+        select: Option<String>,
+        #[serde(default)]
+        occurrence: Option<u32>,
+    },
+    /// Remove a body bookmark's start and end markers; the text stays.
+    BookmarkDelete {
+        name: String,
+    },
     RevisionSettle {
         target: RevisionTarget,
         action: RevisionAction,
@@ -1260,7 +1302,11 @@ fn validate_plan(mut p: Plan) -> Result<Plan, Diagnostic> {
 }
 
 fn validation_field(message: &str) -> Option<&'static str> {
-    let field = if message.contains("MathML") {
+    let field = if message.starts_with("new_name ") {
+        "new_name"
+    } else if message.starts_with("name ") {
+        "name"
+    } else if message.contains("MathML") {
         "mathml"
     } else if message.contains("equation must") {
         "equation"
@@ -1361,9 +1407,31 @@ fn normalize_op(op: &mut EditOp) -> Result<(), String> {
             }
         }
         EditOp::EditTable { at, action } => crate::commands::table_structure::validate(at, action)?,
-        EditOp::InsertTable { rows, columns, alias, .. } => {
+        EditOp::InsertTable { rows, columns, cells, alias, .. } => {
             if *rows == 0 || *columns == 0 || *rows > 100 || *columns > 100 { return Err("insert_table dimensions must be 1..100".into()); }
             if alias.as_ref().is_some_and(|a| !valid_alias(a)) { return Err("invalid alias".into()); }
+            let cells = cells.as_deref().unwrap_or_default();
+            if cells.len() > *rows as usize {
+                let extra = cells.len() - *rows as usize;
+                return Err(format!(
+                    "cells has {} rows but the table has {rows}: remove cells[{rows}..] (row {}{})",
+                    cells.len(),
+                    *rows + 1,
+                    if extra > 1 { format!(" to row {}", cells.len()) } else { String::new() },
+                ));
+            }
+            for (index, row) in cells.iter().enumerate() {
+                if row.len() > *columns as usize {
+                    let extra = row.len() - *columns as usize;
+                    return Err(format!(
+                        "cells[{index}] (row {}) has {} cells but the table has {columns} columns: remove cells[{index}][{columns}..] (column {}{})",
+                        index + 1,
+                        row.len(),
+                        *columns + 1,
+                        if extra > 1 { format!(" to column {}", row.len()) } else { String::new() },
+                    ));
+                }
+            }
         }
         EditOp::FormatTable { at, format } => crate::commands::tables::validate_table(at, format)?,
         EditOp::FormatRow { at, format } => crate::commands::tables::validate_row(at, format)?,
@@ -1566,6 +1634,31 @@ fn normalize_op(op: &mut EditOp) -> Result<(), String> {
                 return Err("set_page_margins requires a margin".into());
             }
         }
+        EditOp::BookmarkAdd {
+            name,
+            select,
+            occurrence,
+            ..
+        } => {
+            crate::commands::bookmarks::validate_new_name(name, "name")?;
+            validate_bookmark_select(select, occurrence)?;
+        }
+        EditOp::BookmarkMove {
+            name,
+            select,
+            occurrence,
+            ..
+        } => {
+            crate::commands::bookmarks::validate_existing_name(name)?;
+            validate_bookmark_select(select, occurrence)?;
+        }
+        EditOp::BookmarkRename { name, new_name } => {
+            crate::commands::bookmarks::validate_existing_name(name)?;
+            crate::commands::bookmarks::validate_new_name(new_name, "new_name")?;
+        }
+        EditOp::BookmarkDelete { name } => {
+            crate::commands::bookmarks::validate_existing_name(name)?;
+        }
         EditOp::CommentAdd {
             text,
             occurrence,
@@ -1620,6 +1713,18 @@ fn normalize_op(op: &mut EditOp) -> Result<(), String> {
     }
     Ok(())
 }
+fn validate_bookmark_select(select: &Option<String>, occurrence: &Option<u32>) -> Result<(), String> {
+    if select.as_deref() == Some("") {
+        return Err("select must be non-empty; omit it to bookmark the whole paragraph".into());
+    }
+    if occurrence == &Some(0) {
+        return Err("occurrence must be positive".into());
+    }
+    if occurrence.is_some() && select.is_none() {
+        return Err("occurrence requires select".into());
+    }
+    Ok(())
+}
 fn diag(code: impl Into<String>, message: impl Into<String>, path: Option<String>) -> Diagnostic {
     Diagnostic {
         code: code.into(),
@@ -1932,6 +2037,37 @@ fn fold_typed(
             if matches!(op, EditOp::InsertTable { .. } | EditOp::EditTable { .. }) {
                 aliases.insert(alias.clone(), Value::String(format!("${alias}")));
             }
+            if let Some(rows) = outcome.result.as_ref().and_then(|r| r.get("cells")).and_then(Value::as_array) {
+                let cells = rows.iter().enumerate().flat_map(|(r, row)| {
+                    row.as_array().into_iter().flatten().enumerate().map(move |(c, id)| (format!("{alias}_r{}c{}", r + 1, c + 1), id.clone()))
+                });
+                for (name, id) in cells {
+                    if aliases.contains_key(&name) {
+                        attach_affected(&mut state, &mut reports, &affected_ids);
+                        let report = PlanReport {
+                            completed: index,
+                            stopped_at: Some(index),
+                            ops: reports,
+                            repaired_ids: repaired_ids.clone(),
+                            allocated_ids: allocated_ids.clone(),
+                            aliases: aliases.clone().into_iter().collect(),
+                        };
+                        return (
+                            report.clone(),
+                            None,
+                            Some((
+                                diag(
+                                    "duplicate_alias",
+                                    format!("cell alias {name:?} of table alias {alias:?} is already defined"),
+                                    Some(format!("ops[{index}].as")),
+                                ),
+                                report,
+                            )),
+                        );
+                    }
+                    aliases.insert(name, id);
+                }
+            }
             if let Some(id) = outcome
                 .result
                 .as_ref()
@@ -1942,6 +2078,12 @@ fn fold_typed(
                 aliases.insert(alias.clone(), id);
             }
         }
+        if let EditOp::InsertTable { .. } = op {
+            let rows = outcome.result.as_ref().and_then(|r| r.get("cells")).and_then(Value::as_array);
+            for id in rows.into_iter().flatten().filter_map(Value::as_array).flatten() {
+                allocated_ids.push(id.as_str().unwrap_or_default().into());
+            }
+        }
     }
     attach_affected(&mut state, &mut reports, &affected_ids);
     let report = PlanReport {
@@ -1992,6 +2134,16 @@ fn explain_selector_drift(
             at,
             select: Some(select),
             ..
+        }
+        | EditOp::BookmarkAdd {
+            at,
+            select: Some(select),
+            ..
+        }
+        | EditOp::BookmarkMove {
+            at,
+            select: Some(select),
+            ..
         } => (at, vec![select.as_str()]),
         EditOp::ReviseText {
             at: Some(at),
@@ -2098,6 +2250,10 @@ fn operation_name(op: &EditOp) -> &'static str {
         EditOp::CommentReply { .. } => "comment_reply",
         EditOp::CommentSetStatus { .. } => "comment_set_status",
         EditOp::CommentDelete { .. } => "comment_delete",
+        EditOp::BookmarkAdd { .. } => "bookmark_add",
+        EditOp::BookmarkRename { .. } => "bookmark_rename",
+        EditOp::BookmarkMove { .. } => "bookmark_move",
+        EditOp::BookmarkDelete { .. } => "bookmark_delete",
         EditOp::RevisionSettle { .. } => "revision_settle",
     }
 }
@@ -2128,7 +2284,9 @@ fn resolve_typed_aliases(
         | EditOp::InsertTable { at, .. }
         | EditOp::SetSectionBoundary { at, .. }
         | EditOp::FormatParagraph { at, .. }
-        | EditOp::CommentAdd { at, .. } => resolve(at)?,
+        | EditOp::CommentAdd { at, .. }
+        | EditOp::BookmarkAdd { at, .. }
+        | EditOp::BookmarkMove { at, .. } => resolve(at)?,
         EditOp::ReviseText { at: Some(at), .. } => resolve(at)?,
         EditOp::InsertParagraph { at, .. } => {
             if let InsertAnchor::Paragraph(addr) = at {
@@ -2478,6 +2636,11 @@ fn typed_read(input: Option<&[u8]>, kind: &str, view: Option<&str>) -> crate::ou
             "revisions",
             source,
         ),
+        "bookmarks" => typed_listing(
+            crate::commands::bookmarks::list_bookmarks(&state.package, &state.xml, source),
+            "bookmarks",
+            source,
+        ),
         other => crate::outcome::Outcome::error(format!("unknown read kind: {other}")),
     }
 }