designcraft/crates/engine/tests/hyperlink_offsets.rs

//! Hyperlink text source range adjustments across text editing (#1219).

use designcraft_doc::{HyperlinkSource, StoryId};
use designcraft_engine::Session;
use serde_json::json;

fn fixture(text: &str) -> (Session, StoryId, u64) {
    let mut s = Session::new();
    s.execute("file.new", &json!({})).unwrap();
    let r = s.execute("frame.create", &json!({"rect": [36, 36, 500, 700], "content": "text", "text": text})).unwrap();
    let sid = StoryId(r["story"].as_u64().unwrap());
    (s, sid, r["id"].as_u64().unwrap())
}

fn text_hyperlink_range(s: &Session, hid: u64) -> (usize, usize) {
    let doc = &s.doc().unwrap().doc;
    let link = doc.hyperlinks.iter().find(|h| h.id == hid).expect("hyperlink exists");
    match link.source {
        HyperlinkSource::Text { start, end, .. } => (start, end),
        _ => panic!("expected text hyperlink source"),
    }
}

#[test]
fn typing_before_hyperlink_shifts_source_range() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    // "page 2" is at bytes 17..23
    assert_eq!(&initial[17..23], "page 2");
    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();

    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));

    // Type "ABC " at the start of the story (offset 0)
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 0})).unwrap();
    s.execute("text.insert", &json!({"text": "ABC ", "raw": true})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "ABC Hello world. See page 2 for details.");

    // The hyperlink must now be at bytes 21..27, covering "page 2"
    let (start, end) = text_hyperlink_range(&s, hid);
    assert_eq!((start, end), (21, 27));
    assert_eq!(&text[start..end], "page 2");
}

#[test]
fn multibyte_utf8_inserted_before_hyperlink_shifts_by_byte_length() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();

    // Insert soft hyphen U+00AD (2 UTF-8 bytes) at offset 0
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 0})).unwrap();
    s.execute("text.insert", &json!({"text": "\u{00AD}", "raw": true})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    let (start, end) = text_hyperlink_range(&s, hid);
    assert_eq!((start, end), (19, 25));
    assert_eq!(&text[start..end], "page 2");

    // Insert German umlaut word "Größe " (8 UTF-8 bytes: G, r, ö (2B), ß (2B), e, space) at offset 0
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 0})).unwrap();
    s.execute("text.insert", &json!({"text": "Größe ", "raw": true})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    let (start, end) = text_hyperlink_range(&s, hid);
    assert_eq!((start, end), (27, 33));
    assert_eq!(&text[start..end], "page 2");
}

#[test]
fn typing_inside_hyperlink_expands_source_range() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();

    // Type "XYZ " inside the link between "page " and "2" (offset 22)
    s.execute("text.select", &json!({"story": sid.0, "anchor": 22, "focus": 22})).unwrap();
    s.execute("text.insert", &json!({"text": "XYZ ", "raw": true})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "Hello world. See page XYZ 2 for details.");

    let (start, end) = text_hyperlink_range(&s, hid);
    assert_eq!((start, end), (17, 27));
    assert_eq!(&text[start..end], "page XYZ 2");
}

#[test]
fn deleting_before_and_across_hyperlink() {
    let initial = "ABC Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    // "page 2" is at bytes 21..27
    assert_eq!(&initial[21..27], "page 2");
    s.execute("text.select", &json!({"story": sid.0, "anchor": 21, "focus": 27})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();

    // Delete "ABC " (4 bytes) before the link
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 4})).unwrap();
    s.execute("text.delete", &json!({})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "Hello world. See page 2 for details.");

    let (start, end) = text_hyperlink_range(&s, hid);
    assert_eq!((start, end), (17, 23));
    assert_eq!(&text[start..end], "page 2");

    // Delete across the link: from offset 13 ("See ") through 22 ("page")
    s.execute("text.select", &json!({"story": sid.0, "anchor": 13, "focus": 22})).unwrap();
    s.execute("text.delete", &json!({})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "Hello world. 2 for details.");

    // "2" survived the deletion, starting at offset 13
    let (start, end) = text_hyperlink_range(&s, hid);
    assert_eq!((start, end), (13, 14));
    assert_eq!(&text[start..end], "2");
}

#[test]
fn deleting_entire_hyperlink_removes_it() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();

    // Select text encompassing the entire link (13..27: "See page 2 for") and delete
    s.execute("text.select", &json!({"story": sid.0, "anchor": 13, "focus": 27})).unwrap();
    s.execute("text.delete", &json!({})).unwrap();

    let doc = &s.doc().unwrap().doc;
    assert!(!doc.hyperlinks.iter().any(|h| h.id == hid), "hyperlink should be pruned when text is deleted");
}

#[test]
fn replacing_hyperlink_text_updates_source_range() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();

    // Select "page 2" and replace with "chapter 5" (9 bytes)
    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    s.execute("text.insert", &json!({"text": "chapter 5", "raw": true})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "Hello world. See chapter 5 for details.");

    let (start, end) = text_hyperlink_range(&s, hid);
    assert_eq!((start, end), (17, 26));
    assert_eq!(&text[start..end], "chapter 5");
}

#[test]
fn undo_and_redo_restore_hyperlink_ranges() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();

    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));

    // Type "ABC " at 0
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 0})).unwrap();
    s.execute("text.insert", &json!({"text": "ABC ", "raw": true})).unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (21, 27));

    // Undo
    s.execute("edit.undo", &json!({})).unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));

    // Redo
    s.execute("edit.redo", &json!({})).unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (21, 27));
}

#[test]
fn track_changes_deleting_inserted_text_reconciles_hyperlink_ranges() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));

    // Enable Track Changes
    s.execute("changes.track", &json!({"on": true})).unwrap();

    // Type "Draft " (6 bytes) at offset 0 while tracking
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 0})).unwrap();
    s.execute("text.insert", &json!({"text": "Draft ", "raw": true})).unwrap();

    // Hyperlink shifts to 23..29
    assert_eq!(text_hyperlink_range(&s, hid), (23, 29));

    // Now select and delete the inserted "Draft " (0..6) while tracking is on
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 6})).unwrap();
    s.execute("text.delete", &json!({})).unwrap();

    // The inserted text was physically removed, so the hyperlink must reconcile back to 17..23
    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "Hello world. See page 2 for details.");
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));
}

#[test]
fn change_case_adjusts_hyperlink_offsets_when_text_length_changes() {
    let initial = "Look at \u{FB01} and see page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    // "\u{FB01}" (fi ligature) is at bytes 8..11 (3 bytes).
    // "page 2" is at bytes 20..26.
    s.execute("text.select", &json!({"story": sid.0, "anchor": 20, "focus": 26})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (20, 26));

    // Select "\u{FB01}" (8..11) and convert to uppercase ("FI", 2 bytes)
    s.execute("text.select", &json!({"story": sid.0, "anchor": 8, "focus": 11})).unwrap();
    s.execute("type.changeCase", &json!({"case": "upper"})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "Look at FI and see page 2 for details.");

    // Hyperlink should shift backward by 1 byte: 19..25
    let (start, end) = text_hyperlink_range(&s, hid);
    assert_eq!((start, end), (19, 25));
    assert_eq!(&text[start..end], "page 2");
}

#[test]
fn change_case_preserves_hyperlink_strictly_inside_selection() {
    let initial = "Hello world";
    let (mut s, sid, _) = fixture(initial);

    // Hyperlink on "world" (6..11)
    s.execute("text.select", &json!({"story": sid.0, "anchor": 6, "focus": 11})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com/world"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (6, 11));

    // Select entire line (0..11) containing the hyperlink inside it and uppercase
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 11})).unwrap();
    s.execute("type.changeCase", &json!({"case": "upper"})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "HELLO WORLD");

    // Hyperlink must remain intact at 6..11
    let (start, end) = text_hyperlink_range(&s, hid);
    assert_eq!((start, end), (6, 11));
    assert_eq!(&text[start..end], "WORLD");
}

#[test]
fn formatted_paste_adjusts_hyperlinks_and_placeholders() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));

    // Select "Hello " (0..6) and copy it
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 6})).unwrap();
    s.execute("edit.copy", &json!({})).unwrap();

    // Move caret to start and paste formatted
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 0})).unwrap();
    s.execute("edit.paste", &json!({"formatted": true})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "Hello Hello world. See page 2 for details.");

    // Hyperlink shifts forward by 6 bytes: 23..29
    let (start, end) = text_hyperlink_range(&s, hid);
    assert_eq!((start, end), (23, 29));
    assert_eq!(&text[start..end], "page 2");
}

#[test]
fn drag_move_preserves_hyperlink_and_adjusts_intervening_ranges() {
    let initial = "Hello brave world.";
    let (mut s, sid, fid) = fixture(initial);

    // Hyperlink on "brave" (6..11)
    s.execute("text.select", &json!({"story": sid.0, "anchor": 6, "focus": 11})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com/brave"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (6, 11));

    let at = |s: &Session, b: usize| {
        let d = &s.doc().unwrap().doc;
        let cs = designcraft_compose::compose_story(d, sid, &Default::default());
        let l = &cs.frames[0].lines[0];
        let g = l.glyphs.iter().find(|g| g.byte == b).unwrap();
        json!([g.x + g.adv * 0.25, l.baseline - 3.0])
    };
    let end = |s: &Session| {
        let d = &s.doc().unwrap().doc;
        let cs = designcraft_compose::compose_story(d, sid, &Default::default());
        let l = &cs.frames[0].lines[0];
        json!([l.end_x + 2.0, l.baseline - 3.0])
    };

    // Drag "brave " (6..12) to the end of the line
    s.execute("text.select", &json!({"story": sid.0, "anchor": 6, "focus": 12})).unwrap();
    s.execute("text.placeCaret", &json!({"frame": fid, "point": at(&s, 8)})).unwrap();
    s.execute("text.release", &json!({"frame": fid, "point": end(&s), "moved": true})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "Hello world.brave ");

    // The hyperlink on "brave" must follow the moved text to 12..17
    let (start, end_pos) = text_hyperlink_range(&s, hid);
    assert_eq!((start, end_pos), (12, 17));
    assert_eq!(&text[start..end_pos], "brave");
}

#[test]
fn typing_at_end_of_hyperlink_does_not_expand_range() {
    let initial = "Click here for details.";
    let (mut s, sid, _) = fixture(initial);

    // "here" is at bytes 6..10
    s.execute("text.select", &json!({"story": sid.0, "anchor": 6, "focus": 10})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (6, 10));

    // Place caret at the very end of "here" (offset 10) and type
    s.execute("text.select", &json!({"story": sid.0, "anchor": 10, "focus": 10})).unwrap();
    s.execute("text.insert", &json!({"text": " right now", "raw": true})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "Click here right now for details.");
    // The hyperlink on "here" must NOT expand; it must stay 6..10
    assert_eq!(text_hyperlink_range(&s, hid), (6, 10));
    assert_eq!(&text[6..10], "here");
}

#[test]
fn track_changes_accept_all_shifts_later_hyperlinks() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    // "page 2" at 17..23
    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));

    // Track Changes on
    s.execute("changes.track", &json!({"on": true})).unwrap();

    // Delete "Hello " (0..6) while tracking
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 6})).unwrap();
    s.execute("text.delete", &json!({})).unwrap();

    // While tracked change is pending, "Hello " is marked deleted but still in text
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));

    // Accept All
    s.execute("changes.acceptAll", &json!({})).unwrap();

    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "world. See page 2 for details.");
    // Link must shift by 6 bytes to 11..17
    assert_eq!(text_hyperlink_range(&s, hid), (11, 17));
    assert_eq!(&text[11..17], "page 2");
}

#[test]
fn track_changes_replacing_hyperlink_text_leaves_link_on_deleted_span_until_resolved() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    // "page 2" at 17..23
    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));

    // Track Changes on
    s.execute("changes.track", &json!({"on": true})).unwrap();

    // Select "page 2" (17..23) and replace with "p. 2" (length 4)
    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    s.execute("text.insert", &json!({"text": "p. 2", "raw": true})).unwrap();

    // While pending, "page 2" remains in text (marked Deleted). Link stays on 17..23.
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));

    // Reject All restores original text and keeps the link intact.
    s.execute("changes.rejectAll", &json!({})).unwrap();
    let text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    assert_eq!(text, "Hello world. See page 2 for details.");
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));
}

#[test]
fn track_changes_accepting_deletion_of_hyperlink_text_prunes_link() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    // "page 2" at 17..23
    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));

    // Track Changes on
    s.execute("changes.track", &json!({"on": true})).unwrap();

    // Select "page 2" (17..23) and replace with "p. 2" (length 4)
    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    s.execute("text.insert", &json!({"text": "p. 2", "raw": true})).unwrap();

    // Accepting all removes the deleted text, pruning the link
    s.execute("changes.acceptAll", &json!({})).unwrap();
    let doc = &s.doc().unwrap().doc;
    assert_eq!(doc.story(sid).unwrap().text, "Hello world. See p. 2 for details.");
    assert!(doc.hyperlinks.iter().all(|h| h.id != hid));
}

#[test]
fn inline_markers_shift_subsequent_hyperlinks() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    // "page 2" at 17..23
    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));

    // 1. Create a text anchor at offset 5 ("anchor.create")
    s.execute("text.select", &json!({"story": sid.0, "anchor": 5, "focus": 5})).unwrap();
    let aid = s.execute("anchor.create", &json!({"name": "TargetAnchor"})).unwrap()["id"].as_u64().unwrap();
    let anchor_shift = designcraft_doc::ANCHOR_MARK.len_utf8();
    assert_eq!(text_hyperlink_range(&s, hid), (17 + anchor_shift, 23 + anchor_shift));

    // 2. Insert a cross-reference at offset 0 ("xref.insert")
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 0})).unwrap();
    s.execute("xref.insert", &json!({"anchor": aid})).unwrap();
    let xref_shift = designcraft_doc::XREF_MARK.len_utf8();
    assert_eq!(text_hyperlink_range(&s, hid), (17 + anchor_shift + xref_shift, 23 + anchor_shift + xref_shift));

    // 3. Insert an editorial note at offset 2 ("note.new")
    s.execute("text.select", &json!({"story": sid.0, "anchor": 2, "focus": 2})).unwrap();
    let nid = s.execute("note.new", &json!({"text": "review this"})).unwrap()["id"].as_u64().unwrap();
    let note_shift = designcraft_doc::NOTE_MARK.len_utf8();
    assert_eq!(text_hyperlink_range(&s, hid), (17 + anchor_shift + xref_shift + note_shift, 23 + anchor_shift + xref_shift + note_shift));

    // 4. Delete the editorial note ("note.delete")
    s.execute("note.delete", &json!({"story": sid.0, "id": nid})).unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (17 + anchor_shift + xref_shift, 23 + anchor_shift + xref_shift));
}

#[test]
fn zero_length_placeholder_at_caret_is_preserved_on_story_edits() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    s.execute("data.source.select", &json!({"bytes": "TmFtZQpBZGEK", "name": "people.csv"})).unwrap();
    s.execute("text.select", &json!({"story": sid.0, "anchor": 6, "focus": 6})).unwrap();
    let ph_id = s.execute("data.placeholder.add", &json!({"field": "Name", "role": "hyperlink"})).unwrap()["id"].as_u64().unwrap();

    let doc = &s.doc().unwrap().doc;
    let ph = doc.data_merge.placeholders.iter().find(|p| p.id == ph_id).unwrap();
    assert_eq!(ph.anchor, designcraft_doc::PlaceholderAnchor::Text { story: sid, start: 6, end: 6 });

    // Type text at offset 0
    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 0})).unwrap();
    s.execute("text.insert", &json!({"text": "Prefix: ", "raw": true})).unwrap();

    // Placeholder must shift forward and NOT be pruned
    let doc = &s.doc().unwrap().doc;
    let ph = doc.data_merge.placeholders.iter().find(|p| p.id == ph_id).expect("placeholder must survive edit");
    assert_eq!(ph.anchor, designcraft_doc::PlaceholderAnchor::Text { story: sid, start: 14, end: 14 });
}

#[test]
fn find_change_in_table_cell_does_not_shift_story_hyperlinks() {
    let initial = "Before table. ";
    let (mut s, sid, _) = fixture(initial);

    // Insert a table with 1 row and 1 col, typing "apple" into the cell
    s.execute("text.select", &json!({"story": sid.0, "anchor": 14, "focus": 14})).unwrap();
    s.execute("table.insert", &json!({"rows": 1, "cols": 1})).unwrap();
    s.execute("text.insert", &json!({"text": "apple", "raw": true})).unwrap();

    // Add more text and a hyperlink to the parent story
    s.execute("text.select", &json!({"story": sid.0, "anchor": 15, "focus": 15})).unwrap();
    s.execute("text.insert", &json!({"text": "After table link text.", "raw": true})).unwrap();

    // Link covers "link" in parent story
    let st_text = &s.doc().unwrap().doc.story(sid).unwrap().text;
    let link_start = st_text.find("link").unwrap();
    let link_end = link_start + 4;
    s.execute("text.select", &json!({"story": sid.0, "anchor": link_start, "focus": link_end})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (link_start, link_end));

    // Run find.change on document scope to replace "apple" with "longer replacement" in the cell
    let r = s.execute("find.change", &json!({"find": "apple", "change": "longer replacement", "scope": "document"})).unwrap();
    assert_eq!(r["count"], 1);

    // The cell was changed, but the parent story hyperlink offsets MUST remain intact
    assert_eq!(text_hyperlink_range(&s, hid), (link_start, link_end));
}

#[test]
fn xref_insert_paragraph_target_shifts_subsequent_hyperlinks() {
    let initial = "First target paragraph.\nSecond paragraph with a link here.";
    let (mut s, sid, _) = fixture(initial);

    // "link" in second paragraph
    let link_start = initial.find("link").unwrap();
    let link_end = link_start + 4;
    s.execute("text.select", &json!({"story": sid.0, "anchor": link_start, "focus": link_end})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (link_start, link_end));

    // Insert cross reference at the end of the second paragraph targeting the first paragraph
    s.execute("text.select", &json!({"story": sid.0, "anchor": initial.len(), "focus": initial.len()})).unwrap();
    s.execute("xref.insert", &json!({"paragraph": "First target"})).unwrap();

    // The first paragraph now has an ANCHOR_MARK inserted at offset 0.
    // The hyperlink in the second paragraph is after offset 0, so it must shift by ANCHOR_MARK.len_utf8()!
    let anchor_shift = designcraft_doc::ANCHOR_MARK.len_utf8();
    assert_eq!(text_hyperlink_range(&s, hid), (link_start + anchor_shift, link_end + anchor_shift));
}

#[test]
fn tracked_replacement_pruning_selected_entry_does_not_corrupt_unrelated_entry() {
    let initial = "Initial text. ";
    let (mut s, sid, _) = fixture(initial);

    // Track Changes on
    s.execute("changes.track", &json!({"on": true})).unwrap();

    // Type text under track changes at offset 14: "Tracked link. Unrelated link."
    s.execute("text.select", &json!({"story": sid.0, "anchor": 14, "focus": 14})).unwrap();
    s.execute("text.insert", &json!({"text": "Tracked link. Unrelated link.", "raw": true})).unwrap();

    // "Tracked link" is at 14..26 (marked Inserted). Add a hyperlink on it.
    s.execute("text.select", &json!({"story": sid.0, "anchor": 14, "focus": 26})).unwrap();
    let h1 = s.execute("hyperlink.create", &json!({"url": "https://example.com/tracked"})).unwrap()["ids"][0].as_u64().unwrap();

    // "Unrelated link" is at 28..42. Add a hyperlink on it.
    s.execute("text.select", &json!({"story": sid.0, "anchor": 28, "focus": 42})).unwrap();
    let h2 = s.execute("hyperlink.create", &json!({"url": "https://example.com/unrelated"})).unwrap()["ids"][0].as_u64().unwrap();

    assert_eq!(text_hyperlink_range(&s, h1), (14, 26));
    assert_eq!(text_hyperlink_range(&s, h2), (28, 42));

    // Now select "Tracked link." (14..27) which has ChangeMark::Inserted and replace it with "New."
    s.execute("text.select", &json!({"story": sid.0, "anchor": 14, "focus": 27})).unwrap();
    s.execute("text.insert", &json!({"text": "New.", "raw": true})).unwrap();

    // The old tracked text (14..27) was physically removed by mark_deleted_reporting.
    // h1 covered (14..26) inside that removed range, and was pruned.
    // h2 must NOT have been corrupted by taking on the insertion span!
    // It should simply have shifted with the edit (14..27 removed, 4 bytes inserted -> net delta -9).
    assert_eq!(text_hyperlink_range(&s, h2), (19, 33));
    let doc = &s.doc().unwrap().doc;
    let st_text = &doc.story(sid).unwrap().text;
    assert_eq!(&st_text[19..33], "Unrelated link");
}

#[test]
fn place_text_at_caret_shifts_subsequent_hyperlinks_by_actual_inserted_length() {
    let initial = "Hello world. See link here.";
    let (mut s, sid, _) = fixture(initial);

    let link_start = initial.find("link").unwrap();
    let link_end = link_start + 4;
    s.execute("text.select", &json!({"story": sid.0, "anchor": link_start, "focus": link_end})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (link_start, link_end));

    // Place caret at offset 6 ("world.")
    s.execute("text.select", &json!({"story": sid.0, "anchor": 6, "focus": 6})).unwrap();
    // Base64 for "amazing new " (12 bytes)
    let b64 = "YW1hemluZyBuZXcg";
    s.execute("file.place", &json!({"base64": b64, "name": "insert.txt"})).unwrap();

    let doc = &s.doc().unwrap().doc;
    let text = &doc.story(sid).unwrap().text;
    assert!(text.contains("amazing new "));
    // Subsequent hyperlink must shift by 12 bytes
    assert_eq!(text_hyperlink_range(&s, hid), (link_start + 12, link_end + 12));
}

#[test]
fn wholesale_story_replacement_prunes_links_and_undo_restores_them() {
    let initial = "Hello world. See page 2 for details.";
    let (mut s, sid, _) = fixture(initial);

    s.execute("text.select", &json!({"story": sid.0, "anchor": 17, "focus": 23})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));

    // Replace the entire story text via story.setText
    s.execute("story.setText", &json!({"story": sid.0, "text": "Brand new story content entirely."})).unwrap();

    // Hyperlink in sid must be pruned
    assert!(s.doc().unwrap().doc.hyperlinks.iter().all(|h| h.id != hid));

    // Undo restores the document snapshot including the hyperlink
    s.execute("edit.undo", &json!({})).unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (17, 23));
}

#[test]
fn delete_surrounding_adjusts_hyperlink_ranges() {
    let initial = "Prefix Keep Caret Suffix LinkText";
    let (mut s, sid, _) = fixture(initial);

    let link_start = initial.find("LinkText").unwrap();
    let link_end = link_start + "LinkText".len();
    s.execute("text.select", &json!({"story": sid.0, "anchor": link_start, "focus": link_end})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert_eq!(text_hyperlink_range(&s, hid), (link_start, link_end));

    // Place caret between "Keep" and " Caret" (offset 11)
    let caret = initial.find(" Caret").unwrap();
    s.execute("text.select", &json!({"story": sid.0, "anchor": caret, "focus": caret})).unwrap();

    // Delete 4 chars before ("Keep") and 6 chars after (" Caret")
    s.execute("text.deleteSurrounding", &json!({"before": 4, "after": 6})).unwrap();

    let doc = &s.doc().unwrap().doc;
    let text = &doc.story(sid).unwrap().text;
    assert_eq!(text, "Prefix  Suffix LinkText");
    // Link must shift down by 10 bytes (4 before + 6 after)
    assert_eq!(text_hyperlink_range(&s, hid), (link_start - 10, link_end - 10));
    assert_eq!(&text[link_start - 10..link_end - 10], "LinkText");
}

#[test]
fn regenerating_toc_prunes_story_hyperlinks() {
    let mut s = Session::new();
    s.execute("file.newSample", &json!({})).unwrap();
    let pages = s.doc().unwrap().doc.page_count();
    s.execute("layout.pages.insert", &json!({"count": 1})).unwrap();
    let r = s.execute("toc.generate", &json!({"styles": ["Headline", "Cover Title"], "page": pages + 1})).unwrap();
    let sid = StoryId(r["story"].as_u64().unwrap());

    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 8})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert!(s.doc().unwrap().doc.hyperlinks.iter().any(|h| h.id == hid));

    let d = &s.doc().unwrap().doc;
    let hid_heading = d.stories.iter().find(|(_, st)| st.text.starts_with("Notes on the Grid")).map(|(id, _)| *id).unwrap();
    s.execute("story.replaceRange", &json!({"story": hid_heading.0, "start": 0, "end": 5, "text": "Thoughts"})).unwrap();
    s.execute("toc.update", &json!({})).unwrap();

    assert!(s.doc().unwrap().doc.hyperlinks.iter().all(|h| h.id != hid));
    s.doc().unwrap().doc.check().unwrap();
}

#[test]
fn regenerating_index_prunes_story_hyperlinks() {
    let mut s = Session::new();
    s.execute("file.new", &json!({"pages": 2, "facingPages": false})).unwrap();
    let sp = s.doc().unwrap().doc.page_loc(0).unwrap().0;
    let r =
        s.execute("frame.create", &json!({"spread": sp, "rect": [72, 72, 400, 300], "content": "text", "text": "Typography topic here."})).unwrap();
    let sid = s.doc().unwrap().doc.item(designcraft_doc::ItemId(r["id"].as_u64().unwrap())).unwrap().text_frame().unwrap().story;

    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 10})).unwrap();
    s.execute("index.addReference", &json!({})).unwrap();

    let r_idx = s.execute("index.generate", &json!({"page": 2})).unwrap();
    let idx_sid = StoryId(r_idx["story"].as_u64().unwrap());

    s.execute("text.select", &json!({"story": idx_sid.0, "anchor": 0, "focus": 5})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert!(s.doc().unwrap().doc.hyperlinks.iter().any(|h| h.id == hid));

    s.execute("index.update", &json!({})).unwrap();

    assert!(s.doc().unwrap().doc.hyperlinks.iter().all(|h| h.id != hid));
    s.doc().unwrap().doc.check().unwrap();
}

#[test]
fn refreshing_live_caption_prunes_story_hyperlinks() {
    let mut s = Session::new();
    s.execute("file.new", &json!({})).unwrap();
    let a = s.execute("frame.create", &json!({"rect": [72, 72, 272, 172]})).unwrap()["id"].as_u64().unwrap();
    s.execute("object.altText", &json!({"text": "Initial photo caption", "ids": [a]})).unwrap();
    let r = s.execute("object.caption", &json!({"ids": [a], "text": "Photo: {altText}", "live": true})).unwrap();
    let cid = designcraft_doc::ItemId(r["ids"][0].as_u64().unwrap());
    let sid = s.doc().unwrap().doc.item(cid).unwrap().text_frame().unwrap().story;

    s.execute("text.select", &json!({"story": sid.0, "anchor": 0, "focus": 5})).unwrap();
    let hid = s.execute("hyperlink.create", &json!({"url": "https://example.com"})).unwrap()["ids"][0].as_u64().unwrap();
    assert!(s.doc().unwrap().doc.hyperlinks.iter().any(|h| h.id == hid));

    s.execute("object.altText", &json!({"text": "Updated photo caption", "ids": [a]})).unwrap();

    assert!(s.doc().unwrap().doc.hyperlinks.iter().all(|h| h.id != hid));
    s.doc().unwrap().doc.check().unwrap();
}