Merge pull request #58 from ghiscoding/bugfix/hasown

fix: use `prop in` instead of `.hasOwn(prop)` & add Drawings tests

Author: ghiscoding

packages/excel-builder-vanilla/src/Excel/StyleSheet.ts

@@ -677,7 +677,7 @@ export class StyleSheet {
     const node = doc.createElement('protection');
     // eslint-disable-next-line no-restricted-syntax
     for (const k in protectionData) {
-      if (protectionData.hasOwn(k)) {
+      if (k in protectionData) {
         node.setAttribute(k, protectionData[k]);
       }
     }

packages/excel-builder-vanilla/src/Excel/Workbook.ts

@@ -89,7 +89,7 @@ export class Workbook {
     this.printTitles[inSheet].left = String.fromCharCode(64 + inRowCount);
   }
 
-  addMedia(_type: string, fileName: string, fileData: any, contentType: any) {
+  addMedia(_type: string, fileName: string, fileData: any, contentType?: string | null) {
     const fileNamePieces = fileName.split('.');
     const extension = fileNamePieces[fileNamePieces.length - 1];
     if (!contentType) {
@@ -148,12 +148,12 @@ export class Workbook {
 
     const extensions: any = {};
     for (const filename in this.media) {
-      if (this.media.hasOwn(filename)) {
+      if (filename in this.media) {
         extensions[this.media[filename].extension] = this.media[filename].contentType;
       }
     }
     for (const extension in extensions) {
-      if (extensions.hasOwn(extension)) {
+      if (extension in extensions) {
         types.appendChild(
           Util.createElement(doc, 'Default', [
             ['Extension', extension],
@@ -240,27 +240,26 @@ export class Workbook {
     const definedNames = Util.createElement(doc, 'definedNames');
     let ctr = 0;
     for (const name in this.printTitles) {
-      if (!this.printTitles.hasOwn(name)) {
-        continue;
-      }
-      const entry = this.printTitles[name];
-      const definedName = doc.createElement('definedName');
-      definedName.setAttribute('name', '_xlnm.Print_Titles');
-      definedName.setAttribute('localSheetId', ctr++);
-
-      let value = '';
-      if (entry.top) {
-        value += `${name}!$1:$${entry.top}`;
+      if (name in this.printTitles) {
+        const entry = this.printTitles[name];
+        const definedName = doc.createElement('definedName');
+        definedName.setAttribute('name', '_xlnm.Print_Titles');
+        definedName.setAttribute('localSheetId', ctr++);
+
+        let value = '';
+        if (entry.top) {
+          value += `${name}!$1:$${entry.top}`;
+          if (entry.left) {
+            value += ',';
+          }
+        }
         if (entry.left) {
-          value += ',';
+          value += `${name}!$A:$${entry.left}`;
         }
-      }
-      if (entry.left) {
-        value += `${name}!$A:$${entry.left}`;
-      }
 
-      definedName.appendChild(doc.createTextNode(value));
-      definedNames.appendChild(definedName);
+        definedName.appendChild(doc.createTextNode(value));
+        definedNames.appendChild(definedName);
+      }
     }
     wb.appendChild(definedNames);
 
@@ -293,7 +292,7 @@ export class Workbook {
     }
 
     for (const fileName in this.media) {
-      if (this.media.hasOwn(fileName)) {
+      if (fileName in this.media) {
         const media = this.media[fileName];
         files[`/xl/media/${fileName}`] = media.data;
         Paths[fileName] = `/xl/media/${fileName}`;

packages/excel-builder-vanilla/src/Excel/Worksheet.ts

@@ -111,9 +111,9 @@ export class Worksheet {
     this.relations.addRelation(table, 'table');
   }
 
-  addDrawings(table: Table) {
-    this._drawings.push(table);
-    this.relations.addRelation(table, 'drawingRelationship');
+  addDrawings(drawings: Drawings) {
+    this._drawings.push(drawings);
+    this.relations.addRelation(drawings, 'drawingRelationship');
   }
 
   setRowInstructions(rowIndex: number, instructions: ExcelStyleInstruction) {

packages/excel-builder-vanilla/src/__tests__/excel-builder.spec.ts

@@ -1,6 +1,6 @@
 import { describe, expect, test } from 'vitest';
 
-import { Table, Workbook } from '../Excel';
+import { Drawings, Picture, Positioning, Table, Workbook } from '../Excel';
 import { createWorkbook } from '../factory';
 
 describe('Excel-Builder-Vanilla', () => {
@@ -1026,4 +1026,76 @@ describe('Excel-Builder-Vanilla', () => {
       'xmlns:mc': 'http://schemas.openxmlformats.org/markup-compatibility/2006',
     });
   });
+
+  test('Drawings', async () => {
+    const fruitWorkbook = createWorkbook();
+    const berryList = fruitWorkbook.createWorksheet({ name: 'Berry List' });
+    const picRef1 = fruitWorkbook.addMedia('image', 'file1.jpeg', new Blob());
+    const picRef2 = fruitWorkbook.addMedia('image', 'file2.gif', new Blob());
+    const picRef3 = fruitWorkbook.addMedia('image', 'file3.png', new Blob());
+    const picRef4 = fruitWorkbook.addMedia('image', 'file4.txt', new Blob());
+
+    expect(picRef1.contentType).toBe('image/jpeg');
+    expect(picRef2.contentType).toBe('image/gif');
+    expect(picRef3.contentType).toBe('image/png');
+    expect(picRef4.contentType).toBe(null);
+
+    const drawings = new Drawings();
+    const strawberryPicture1 = new Picture();
+    strawberryPicture1.createAnchor('twoCellAnchor', {
+      from: {
+        x: 0,
+        y: 0,
+      },
+      to: {
+        x: 3,
+        y: 3,
+      },
+    });
+
+    strawberryPicture1.setMedia(picRef1);
+    drawings.addDrawing(strawberryPicture1);
+
+    const strawberryPicture2 = new Picture();
+    strawberryPicture2.createAnchor('absoluteAnchor', {
+      x: Positioning.pixelsToEMUs(300),
+      y: Positioning.pixelsToEMUs(300),
+      width: Positioning.pixelsToEMUs(300),
+      height: Positioning.pixelsToEMUs(300),
+    });
+
+    strawberryPicture2.setMedia(picRef1);
+    drawings.addDrawing(strawberryPicture2);
+
+    const strawberryPicture3 = new Picture();
+    strawberryPicture3.createAnchor('oneCellAnchor', {
+      x: 1,
+      y: 4,
+      width: Positioning.pixelsToEMUs(300),
+      height: Positioning.pixelsToEMUs(300),
+    });
+
+    strawberryPicture3.setMedia(picRef1);
+    drawings.addDrawing(strawberryPicture3);
+
+    berryList.addDrawings(drawings);
+    fruitWorkbook.addDrawings(drawings);
+    fruitWorkbook.addWorksheet(berryList);
+
+    const file = await fruitWorkbook.generateFiles();
+    const dwgs = fruitWorkbook.drawings;
+
+    expect(file).toBeTruthy();
+    expect(dwgs[0].drawings.length).toBe(3);
+
+    // print titles offset of 2 => left B and top 2
+    fruitWorkbook.setPrintTitleLeft('sheet1', 2);
+    fruitWorkbook.setPrintTitleTop('sheet1', 2);
+
+    const titles = fruitWorkbook.printTitles;
+    expect(titles).toEqual({ sheet1: { left: 'B', top: 2 } });
+
+    const wsXML = fruitWorkbook.toXML();
+    expect(wsXML.documentElement.children.length).toBe(2);
+  });
 });