feat(diagram): basic handler for diagrams (aka smartart)

Author: singerla

__tests__/add-slide-diagrams.test.ts

@@ -0,0 +1,24 @@
+import Automizer from '../src/automizer';
+
+test('create presentation and append diagrams', async () => {
+  const automizer = new Automizer({
+    templateDir: `${__dirname}/pptx-templates`,
+    outputDir: `${__dirname}/pptx-output`,
+  });
+
+  const pres = automizer
+    .loadRoot(`RootTemplate.pptx`)
+    .load(`EmptySlide.pptx`, 'empty')
+    .load(`SlideWithDiagrams.pptx`, 'diagrams');
+
+  pres.addSlide('diagrams', 1);
+  pres.addSlide('diagrams', 2);
+
+  pres.addSlide('empty', 1, (slide) => {
+    slide.addElement('diagrams', 1, 'MatrixDiagram')
+  });
+
+  const result = await pres.write(`add-slide-diagrams.test.pptx`);
+
+  expect(result.slides).toBe(4);
+});

__tests__/modify-shapes-group.test.ts

@@ -0,0 +1,21 @@
+import Automizer, { modify } from '../src/index';
+
+test('modify of grouped shapes', async () => {
+  const automizer = new Automizer({
+    templateDir: `${__dirname}/pptx-templates`,
+    outputDir: `${__dirname}/pptx-output`,
+  });
+
+  const pres = automizer
+    .loadRoot(`RootTemplate.pptx`)
+    .load(`SlideWithShapes.pptx`, 'shapes');
+
+  const result = await pres
+    .addSlide('shapes', 3, (slide) => {
+      // slide.modifyElement('Arrow', modify.setText('stays in group'));
+      slide.addElement('shapes', 3, 'Arrow', modify.setText('stays in group'));
+    })
+    .write(`modify-shapes-group.test.pptx`);
+
+  expect(result.slides).toBe(2);
+});

src/classes/has-shapes.ts

@@ -40,6 +40,7 @@ import { OLEObject } from '../shapes/ole';
 import { Hyperlink } from '../shapes/hyperlink';
 import { HyperlinkProcessor } from '../helper/hyperlink-processor';
 import { vd } from '../helper/general-helper';
+import { Diagram } from '../shapes/diagram';
 
 export default class HasShapes {
   /**
@@ -125,6 +126,8 @@ export default class HasShapes {
    */
   unsupportedTags = [
     'p:custDataLst',
+    // exclude bullet images
+    // 'a:buBlip',
     // 'p:oleObj',
     // 'mc:AlternateContent',
     // 'a14:imgProps',
@@ -888,6 +891,19 @@ export default class HasShapes {
       ).modifyOnAddedSlide(this.targetTemplate, this.targetNumber);
     }
 
+    const diagrams = await Diagram.getAllOnSlide(this.sourceArchive, this.relsPath);
+    for (const diagram of diagrams) {
+      await new Diagram(
+        {
+          mode: 'append',
+          target: diagram,
+          sourceArchive: this.sourceArchive,
+          sourceSlideNumber: this.sourceNumber,
+        },
+        this.targetType,
+      ).modifyOnAddedSlide(this.targetTemplate, this.targetNumber);
+    }
+
     const oleObjects = await OLEObject.getAllOnSlide(
       this.sourceArchive,
       this.relsPath,
@@ -994,6 +1010,19 @@ export default class HasShapes {
       } as AnalyzedElementType;
     }
 
+    const isDiagram = sourceElement.getElementsByTagName('p:nvGraphicFramePr');
+    if (isDiagram.length) {
+      return {
+        type: ElementType.Diagram,
+        target: await XmlHelper.getTargetByRelId(
+          sourceArchive,
+          relsPath,
+          sourceElement,
+          'diagram',
+        ),
+      } as AnalyzedElementType;
+    }
+
     const isOLEObject = sourceElement.getElementsByTagName('p:oleObj');
     if (isOLEObject.length) {
       const target = await XmlHelper.getTargetByRelId(

src/classes/shape.ts

@@ -1,5 +1,5 @@
 import { XmlHelper } from '../helper/xml-helper';
-import { GeneralHelper } from '../helper/general-helper';
+import { GeneralHelper, vd } from '../helper/general-helper';
 import { HyperlinkProcessor } from '../helper/hyperlink-processor';
 import {
   ChartModificationCallback,
@@ -172,20 +172,26 @@ export class Shape {
     XmlHelper.writeXmlToArchive(archive, slideFile, targetSlideXml);
   }
 
-  async updateElementsRelId(): Promise<void> {
+  async updateElementsRelId(cb?: (targetElement: XmlElement) => void): Promise<void> {
     const targetSlideXml = await XmlHelper.getXmlFromArchive(
       this.targetArchive,
       this.targetSlideFile,
     );
+
+
     const targetElements = await this.getElementsByRid(
       targetSlideXml,
       this.sourceRid,
     );
 
     targetElements.forEach((targetElement: XmlElement) => {
-      this.relParent(targetElement)
-        .getElementsByTagName(this.relRootTag)[0]
-        .setAttribute(this.relAttribute, this.createdRid);
+      if(cb && typeof cb === 'function') {
+        cb(targetElement)
+      } else {
+        this.relParent(targetElement)
+          .getElementsByTagName(this.relRootTag)[0]
+          .setAttribute(this.relAttribute, this.createdRid);
+      }
     });
 
     XmlHelper.writeXmlToArchive(

src/classes/slide.ts

@@ -233,7 +233,7 @@ export class Slide extends HasShapes implements ISlide {
     const elementsToProcess = [...unmatchedElements];
 
     elementsToProcess.forEach((element) => {
-      const bestAlternativeMatch = this.findBestAlternativeMatch(
+      const bestAlternativeMatch = XmlPlaceholderHelper.findBestTargetPlaceholderAlternative(
         element,
         targetPlaceholders,
         usedPlaceholders,
@@ -250,27 +250,6 @@ export class Slide extends HasShapes implements ISlide {
     });
   }
 
-  /**
-   * Finds the best alternative placeholder match for an unmatched element.
-   *
-   * @param element - Element that needs a placeholder match
-   * @param targetPlaceholders - Available placeholders in target layout
-   * @param usedPlaceholders - Already assigned placeholders
-   * @returns PlaceholderInfo | null - Best match or null if none found
-   * @private
-   */
-  private findBestAlternativeMatch(
-    element: ElementInfo,
-    targetPlaceholders: PlaceholderInfo[],
-    usedPlaceholders: PlaceholderInfo[],
-  ): PlaceholderInfo | null {
-    return XmlPlaceholderHelper.findBestTargetPlaceholderAlternative(
-      element,
-      targetPlaceholders,
-      usedPlaceholders,
-    );
-  }
-
   /**
    * Applies an alternative placeholder match to an element.
    *

src/classes/template.ts

@@ -98,6 +98,7 @@ export class Template implements ITemplate {
         new CountHelper('slides', newTemplate),
         new CountHelper('charts', newTemplate),
         new CountHelper('images', newTemplate),
+        new CountHelper('diagrams', newTemplate),
         new CountHelper('masters', newTemplate),
         new CountHelper('layouts', newTemplate),
         new CountHelper('themes', newTemplate),

src/constants/constants.ts

@@ -15,6 +15,11 @@ export const TargetByRelIdMap: Record<string, TargetByRelIdMapParam> = {
     relAttribute: 'r:id',
     prefix: '../charts/chartEx',
   },
+  diagram: {
+    relRootTag: 'dgm:relIds',
+    relAttribute: 'r:dm',
+    prefix: '../diagrams/data',
+  },
   image: {
     relRootTag: 'a:blip',
     relAttribute: 'r:embed',

src/dev.ts

@@ -6,25 +6,20 @@ const run = async () => {
   const outputDir = `${__dirname}/../__tests__/pptx-output`;
   const templateDir = `${__dirname}/../__tests__/pptx-templates`;
 
-  // Step 1: Create a pptx with images and a chart inside.
-  // The chart is modified by pptx-automizer
-
   const automizer = new Automizer({
     templateDir,
     outputDir,
     verbosity: 2,
     removeExistingSlides: true,
   });
 
-  const pres = automizer.loadRoot(`RootTemplate.pptx`).load(`SlideWithShapes.pptx`);
+  const pres = automizer.loadRoot(`RootTemplate.pptx`).load(`SlideWithDiagram.pptx`);
 
-  pres.addSlide("SlideWithShapes.pptx", 3, async (slide) => {
-    const infoTopLevel = await slide.getElement('TopLevelGroup')
-    const groupInfoTopLevel = infoTopLevel.getGroupInfo()
+  pres.addSlide("SlideWithDiagram.pptx", 1, async (slide) => {
 
   })
 
-  await pres.write(`modify-multi-text.test.pptx`);
+  await pres.write(`add-diagram.test.pptx`);
 };
 
 run().catch((error) => {

src/enums/element-type.ts

@@ -1,14 +1,15 @@
 export enum ElementType {
   Chart = 'Chart',
   Image = 'Image',
+  Diagram = 'Diagram',
   Shape = 'Generic',
-  OLEObject = 'OLEObject', 
+  OLEObject = 'OLEObject',
   Hyperlink = 'Hyperlink',
 }
 
 export enum ElementSubtype {
   chart = 'chart',
   chartEx = 'chartEx',
-  oleObject = 'oleObject',  
+  oleObject = 'oleObject',
   hyperlink = 'hyperlink',
 }

src/helper/count-helper.ts

@@ -63,9 +63,10 @@ export class CountHelper implements ICounter {
         return CountHelper.countCharts(presentation);
       case 'images':
         return CountHelper.countImages(presentation);
-        case 'oleObjects':  
-        return CountHelper.countOleObjects(presentation);  
-  
+      case 'diagrams':
+        return CountHelper.countDiagrams(presentation);
+      case 'oleObjects':
+        return CountHelper.countOleObjects(presentation);
     }
 
     throw new Error(`No way to count ${this.name}.`);
@@ -138,23 +139,24 @@ export class CountHelper implements ICounter {
       ).length;
   }
 
-  private static async countOleObjects(presentation: IArchive): Promise<number> {
+  private static async countOleObjects(
+    presentation: IArchive,
+  ): Promise<number> {
     const contentTypesXml = await XmlHelper.getXmlFromArchive(
       presentation,
       '[Content_Types].xml',
     );
     const overrides = contentTypesXml.getElementsByTagName('Override');
-  
+
     return Object.keys(overrides)
       .map((key) => overrides[key] as XmlElement)
       .filter(
         (o) =>
           o.getAttribute &&
           o.getAttribute('ContentType') ===
-            `application/vnd.openxmlformats-officedocument.oleObject`
+            `application/vnd.openxmlformats-officedocument.oleObject`,
       ).length;
   }
-  
 
   private static async countImages(presentation: IArchive): Promise<number> {
     const mediaFiles = await presentation.folder('ppt/media');
@@ -163,4 +165,21 @@ export class CountHelper implements ICounter {
     ).length;
     return count;
   }
+
+  private static async countDiagrams(presentation: IArchive): Promise<number> {
+    const contentTypesXml = await XmlHelper.getXmlFromArchive(
+      presentation,
+      '[Content_Types].xml',
+    );
+    const overrides = contentTypesXml.getElementsByTagName('Override');
+
+    return Object.keys(overrides)
+      .map((key) => overrides[key] as XmlElement)
+      .filter(
+        (o) =>
+          o.getAttribute &&
+          o.getAttribute('ContentType') ===
+          `application/vnd.openxmlformats-officedocument.drawingml.diagramData+xml`,
+      ).length;
+  }
 }