fix(text): fix internal links; refactor tests; fixes #180

singerla · singerla · commit c2c0a01c8a85 · 2025-11-13T15:17:38.000+01:00
diff --git a/__tests__/htmlToMultiText-hyperlinks.test.ts b/__tests__/htmlToMultiText-hyperlinks.test.ts
@@ -1,4 +1,6 @@
-import Automizer, { modify } from '../src/index';
+import Automizer, { modify, XmlElement } from '../src/index';
+import { HtmlToMultiTextHelper } from '../src/helper/html-to-multitext-helper';
+import { ModifyTextHelper } from '../src';
 
 test('create presentation with external hyperlinks using htmlToMultiText', async () => {
   const automizer = new Automizer({
@@ -10,7 +12,7 @@ test('create presentation with external hyperlinks using htmlToMultiText', async
   const pres = automizer.loadRoot(`RootTemplate.pptx`).load(`TextReplace.pptx`);
 
   const html =
-    '<p>Visit our <a href="https://example.com">website</a> for more information</p>';
+    '<body><p>Visit our <a href="https://example.com">website</a> for more information</p></body>';
 
   const result = await pres
     .addSlide('TextReplace.pptx', 1, (slide) => {
@@ -21,26 +23,6 @@ test('create presentation with external hyperlinks using htmlToMultiText', async
   // Test passes if file is written successfully
 });
 
-test('create presentation with internal slide hyperlinks using htmlToMultiText', async () => {
-  const automizer = new Automizer({
-    templateDir: `${__dirname}/pptx-templates`,
-    outputDir: `${__dirname}/pptx-output`,
-    removeExistingSlides: true,
-  });
-
-  const pres = automizer.loadRoot(`RootTemplate.pptx`).load(`TextReplace.pptx`);
-
-  const html = '<p>See <a href="3">slide 3</a> for details</p>';
-
-  const result = await pres
-    .addSlide('TextReplace.pptx', 1, (slide) => {
-      slide.modifyElement('setText', modify.htmlToMultiText(html));
-    })
-    .write(`htmlToMultiText-internal-hyperlinks.test.pptx`);
-
-  // Test passes if file is written successfully
-});
-
 test('create presentation with multiple hyperlinks using htmlToMultiText', async () => {
   const automizer = new Automizer({
     templateDir: `${__dirname}/pptx-templates`,
@@ -50,10 +32,11 @@ test('create presentation with multiple hyperlinks using htmlToMultiText', async
 
   const pres = automizer.loadRoot(`RootTemplate.pptx`).load(`TextReplace.pptx`);
 
+  // Please make sure that the internally linked slide does exist, otherwise the link will not be active.
   const html =
     '<html><body>' +
     '<p>Check out <a href="https://google.com">Google</a> or <a href="https://github.com">GitHub</a></p>' +
-    '<p>Jump to <a href="2">slide 2</a> or <a href="5">slide 5</a></p>' +
+    '<p>Jump to <a href="2">slide 2</a> or <a href="5">slide 5 not existing</a></p>' +
     '</body></html>';
 
   const result = await pres
@@ -103,7 +86,7 @@ test('create presentation with hyperlinks in bullet lists using htmlToMultiText'
     '<ul>' +
     '<li><a href="https://site1.com">First link</a></li>' +
     '<li><a href="https://site2.com">Second link</a></li>' +
-    '<li>Regular bullet with <a href="3">internal link</a></li>' +
+    '<li>Regular bullet with <a href="1">internal link</a></li>' +
     '</ul>' +
     '</body></html>';
 
@@ -130,7 +113,7 @@ test('create presentation with mixed external and internal hyperlinks', async ()
     '<p>Visit <a href="https://example.com">example.com</a> or go to <a href="2">slide 2</a></p>' +
     '<ul>' +
     '<li>External: <a href="https://google.com">Google</a></li>' +
-    '<li>Internal: <a href="4">Jump to slide 4</a></li>' +
+    '<li>Internal: <a href="1">Jump to slide 1</a></li>' +
     '<li>More info: <a href="https://github.com">GitHub</a></li>' +
     '</ul>' +
     '</body></html>';
@@ -144,48 +127,6 @@ test('create presentation with mixed external and internal hyperlinks', async ()
   // Test passes if file is written successfully
 });
 
-test('verify hyperlink relationships are created correctly', async () => {
-  const automizer = new Automizer({
-    templateDir: `${__dirname}/pptx-templates`,
-    outputDir: `${__dirname}/pptx-output`,
-    removeExistingSlides: true,
-  });
-
-  const pres = automizer.loadRoot(`RootTemplate.pptx`).load(`TextReplace.pptx`);
-
-  const html = '<p>Visit <a href="https://example.com">our website</a></p>';
-
-  const result = await pres
-    .addSlide('TextReplace.pptx', 1, async (slide) => {
-      slide.modifyElement('setText', modify.htmlToMultiText(html));
-    })
-    .write(`htmlToMultiText-verify-relationships.test.pptx`);
-
-  // Test passes if file is written successfully
-  // Test passes if file is written successfully
-});
-
-test('verify internal slide hyperlink relationships are created correctly', async () => {
-  const automizer = new Automizer({
-    templateDir: `${__dirname}/pptx-templates`,
-    outputDir: `${__dirname}/pptx-output`,
-    removeExistingSlides: true,
-  });
-
-  const pres = automizer.loadRoot(`RootTemplate.pptx`).load(`TextReplace.pptx`);
-
-  const html = '<p>Go to <a href="3">slide 3</a></p>';
-
-  const result = await pres
-    .addSlide('TextReplace.pptx', 1, async (slide) => {
-      slide.modifyElement('setText', modify.htmlToMultiText(html));
-    })
-    .write(`htmlToMultiText-verify-internal-relationships.test.pptx`);
-
-  // Test passes if file is written successfully
-  // Test passes if file is written successfully
-});
-
 test('htmlToMultiText with hyperlinks but no relation element should log warning', async () => {
   const automizer = new Automizer({
     templateDir: `${__dirname}/pptx-templates`,
@@ -196,14 +137,18 @@ test('htmlToMultiText with hyperlinks but no relation element should log warning
 
   const pres = automizer.loadRoot(`RootTemplate.pptx`).load(`TextReplace.pptx`);
 
-  const html = '<p>Visit <a href="https://example.com">website</a></p>';
+  const html = '<body><p>Visit <a href="https://example.com">website</a></p></body>';
 
   // This should complete without error, but hyperlinks won't be created
   const result = await pres
     .addSlide('TextReplace.pptx', 1, (slide) => {
       // Directly calling htmlToMultiText without relation element access
       // would normally skip hyperlink creation
-      slide.modifyElement('setText', modify.htmlToMultiText(html));
+      // A repair message is displayed on opening in PowerPoint.
+      const paragraphs = new HtmlToMultiTextHelper().run(html);
+      return (element: XmlElement): void => {
+        ModifyTextHelper.setMultiText(paragraphs)(element);
+      };
     })
     .write(`htmlToMultiText-no-relation-warning.test.pptx`);
 
diff --git a/__tests__/htmlToMultiText-internal-hyperlinks.test.ts b/__tests__/htmlToMultiText-internal-hyperlinks.test.ts
@@ -0,0 +1,30 @@
+import Automizer, { modify } from '../src/index';
+
+test('create presentation with internal slide hyperlinks using htmlToMultiText', async () => {
+  const automizer = new Automizer({
+    templateDir: `${__dirname}/pptx-templates`,
+    outputDir: `${__dirname}/pptx-output`,
+    removeExistingSlides: true,
+  });
+
+  const pres = automizer.loadRoot(`RootTemplate.pptx`).load(`TextReplace.pptx`);
+
+  // Please note: You need to recalculate the target slide number and
+  // refer to the final position, including the existing slides.
+  // Internally, we target to `slide${target}.xml`, which might be a different slide.
+  // Please make sure that the internally linked slide does exist, otherwise the link will not be active.
+
+  const html = '<body><p>See <a href="4">slide 3</a> for details</p></body>';
+
+  const result = await pres
+    .addSlide('TextReplace.pptx', 1)
+    .addSlide('TextReplace.pptx', 1, (slide) => {
+      slide.modifyElement('setText', modify.htmlToMultiText(html));
+    })
+    .addSlide('TextReplace.pptx', 1)
+    .addSlide('TextReplace.pptx', 1)
+    .addSlide('TextReplace.pptx', 1)
+    .write(`htmlToMultiText-internal-hyperlinks.test.pptx`);
+
+  // Test passes if file is written successfully
+});
diff --git a/__tests__/replace-multi-text.test.ts b/__tests__/replace-multi-text.test.ts
@@ -23,12 +23,16 @@ test('create presentation, replace multi text.', async () => {
             },
             textRuns: [
               {
-                text: 'test 0',
+                text: 'Internal Hyperlink',
                 style: {
                   color: {
                     type: 'srgbClr',
                     value: 'CCCCCC',
                   },
+                  hyperlink: {
+                    isInternal: true,
+                    target: 1
+                  }
                 },
               },
             ],
@@ -100,6 +104,9 @@ test('create presentation, replace multi text.', async () => {
                     type: 'srgbClr',
                     value: '0000FF',
                   },
+                  hyperlink: {
+                    target: 'https://github.com',
+                  }
                 },
               },
             ],
diff --git a/src/helper/html-to-multitext-helper.ts b/src/helper/html-to-multitext-helper.ts
@@ -1,6 +1,7 @@
 import { TextStyle } from '../types/modify-types';
 import { MultiTextParagraph } from '../interfaces/imulti-text';
 import { DOMParser, Node } from '@xmldom/xmldom';
+import { log } from './general-helper';
 
 type TextRun = { text: string; style?: TextStyle };
 
@@ -30,6 +31,8 @@ export class HtmlToMultiTextHelper {
           );
         }
       });
+    } else {
+      log('You need to provide a <body> tag for HtmlToMultiText', 0);
     }
 
     return paragraphs;
@@ -257,19 +260,16 @@ export class HtmlToMultiTextHelper {
       // Internal slide link: <a href="3">Link to slide 3</a>
       const slideNumber = parseInt(href);
       style.hyperlink = {
-        url: `slide${slideNumber}.xml`,
+        target: slideNumber,
         isInternal: true,
-        slideNumber: slideNumber,
       };
     } else {
       // External link: <a href="https://example.com">Link</a>
       style.hyperlink = {
-        url: href,
+        target: href,
         isInternal: false,
       };
     }
-
-    console.log("style", style);
   }
 
   /**
diff --git a/src/helper/modify-text-helper.ts b/src/helper/modify-text-helper.ts
@@ -7,6 +7,7 @@ import { MultiTextParagraph } from '../interfaces/imulti-text';
 import { MultiTextHelper } from './multitext-helper';
 import { HtmlToMultiTextHelper } from './html-to-multitext-helper';
 import { XmlHelper } from './xml-helper';
+import { vd } from './general-helper';
 
 export default class ModifyTextHelper {
   /**
diff --git a/src/helper/multitext-helper.ts b/src/helper/multitext-helper.ts
diff --git a/src/types/modify-types.ts b/src/types/modify-types.ts
