Make hyperlinks declarative

src/file/file.ts

@@ -17,7 +17,7 @@ import { Footer, Header } from "./header";
 import { HeaderWrapper, IDocumentHeader } from "./header-wrapper";
 import { Media } from "./media";
 import { Numbering } from "./numbering";
-import { Bookmark, Hyperlink, Paragraph } from "./paragraph";
+import { Bookmark, Hyperlink, HyperlinkRef, Paragraph } from "./paragraph";
 import { Relationships } from "./relationships";
 import { TargetModeType } from "./relationships/relationship/relationship";
 import { Settings } from "./settings";
@@ -61,13 +61,13 @@ export class File {
     private readonly contentTypes: ContentTypes;
     private readonly appProperties: AppProperties;
     private readonly styles: Styles;
+    private readonly hyperlinkCache: { readonly [key: string]: Hyperlink };
 
     constructor(
         options: IPropertiesOptions = {
             creator: "Un-named",
             revision: "1",
             lastModifiedBy: "Un-named",
-            footnotes: [],
         },
         fileProperties: IFileProperties = {},
         sections: ISectionOptions[] = [],
@@ -134,6 +134,12 @@ export class File {
             this.document.Body.addSection(section.properties ? section.properties : {});
 
             for (const child of section.children) {
+                if (child instanceof HyperlinkRef) {
+                    const hyperlink = this.hyperlinkCache[child.id];
+                    this.document.add(hyperlink);
+                    continue;
+                }
+
                 this.document.add(child);
             }
         }
@@ -143,18 +149,21 @@ export class File {
                 this.footNotes.createFootNote(paragraph);
             }
         }
-    }
 
-    public createHyperlink(link: string, text?: string): Hyperlink {
-        const newText = text === undefined ? link : text;
-        const hyperlink = new Hyperlink(newText, shortid.generate().toLowerCase());
-        this.docRelationships.createRelationship(
-            hyperlink.linkId,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink",
-            link,
-            TargetModeType.EXTERNAL,
-        );
-        return hyperlink;
+        if (options.hyperlinks) {
+            const cache = {};
+
+            for (const key in options.hyperlinks) {
+                if (!options.hyperlinks[key]) {
+                    continue;
+                }
+
+                const hyperlink = this.createHyperlink(options.hyperlinks[key].link, options.hyperlinks[key].text);
+                cache[key] = hyperlink;
+            }
+
+            this.hyperlinkCache = cache;
+        }
     }
 
     public createInternalHyperLink(anchor: string, text?: string): Hyperlink {
@@ -194,6 +203,12 @@ export class File {
         });
 
         for (const child of children) {
+            if (child instanceof HyperlinkRef) {
+                const hyperlink = this.hyperlinkCache[child.id];
+                this.document.add(hyperlink);
+                continue;
+            }
+
             this.document.add(child);
         }
     }
@@ -204,6 +219,18 @@ export class File {
         }
     }
 
+    private createHyperlink(link: string, text?: string): Hyperlink {
+        const newText = text === undefined ? link : text;
+        const hyperlink = new Hyperlink(newText, shortid.generate().toLowerCase());
+        this.docRelationships.createRelationship(
+            hyperlink.linkId,
+            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink",
+            link,
+            TargetModeType.EXTERNAL,
+        );
+        return hyperlink;
+    }
+
     private createHeader(header: Header): HeaderWrapper {
         const wrapper = new HeaderWrapper(this.media, this.currentRelationshipId++);
 
@@ -336,4 +363,8 @@ export class File {
     public get Settings(): Settings {
         return this.settings;
     }
+
+    public get HyperlinkCache(): { readonly [key: string]: Hyperlink } {
+        return this.hyperlinkCache;
+    }
 }