chore(xml): add ModifyXmlCallback; add sortCollection

Author: singerla

src/automizer.ts

@@ -10,7 +10,7 @@ import { IPresentationProps } from './interfaces/ipresentation-props';
 import { PresTemplate } from './interfaces/pres-template';
 import { RootPresTemplate } from './interfaces/root-pres-template';
 import { Template } from './classes/template';
-import { ModifyPresentationCallback, TemplateInfo } from './types/xml-types';
+import { ModifyXmlCallback, TemplateInfo } from './types/xml-types';
 import { vd } from './helper/general-helper';
 import { Master } from './classes/master';
 import path from 'path';
@@ -41,7 +41,7 @@ export default class Automizer implements IPresentationProps {
   params: AutomizerParams;
   status: StatusTracker;
 
-  modifyPresentation: ModifyPresentationCallback[];
+  modifyPresentation: ModifyXmlCallback[];
 
   /**
    * Creates an instance of `pptx-automizer`.
@@ -177,7 +177,7 @@ export default class Automizer implements IPresentationProps {
     return templateCreationId;
   }
 
-  public async modify(cb: ModifyPresentationCallback): Promise<this> {
+  public modify(cb: ModifyXmlCallback): this {
     this.modifyPresentation.push(cb);
     return this;
   }
@@ -284,23 +284,6 @@ export default class Automizer implements IPresentationProps {
     );
   }
 
-  async applyModifyPresentationCallbacks() {
-    const presentationXml = await XmlHelper.getXmlFromArchive(
-      await this.rootTemplate.archive,
-      `ppt/presentation.xml`,
-    );
-
-    for (const cb of this.modifyPresentation) {
-      cb(presentationXml);
-    }
-
-    await XmlHelper.writeXmlToArchive(
-      await this.rootTemplate.archive,
-      `ppt/presentation.xml`,
-      presentationXml,
-    );
-  }
-
   /**
    * Write all slides into archive.
    */
@@ -317,6 +300,18 @@ export default class Automizer implements IPresentationProps {
     }
   }
 
+  /**
+   * Applies all callbacks in this.modifyPresentation-array.
+   * The callback array can be pushed by this.modify()
+   */
+  async applyModifyPresentationCallbacks(): Promise<void> {
+    await XmlHelper.modifyXmlInArchive(
+      this.rootTemplate.archive,
+      `ppt/presentation.xml`,
+      this.modifyPresentation,
+    );
+  }
+
   /**
    * Applies path prefix to given location string.
    * @param location path and/or filename

src/dev.ts

@@ -6,6 +6,7 @@ import Automizer, {
   XmlHelper,
 } from './index';
 import { vd } from './helper/general-helper';
+import ModifyPresentationHelper from './helper/modify-presentation-helper';
 
 const automizer = new Automizer({
   templateDir: `${__dirname}/../__tests__/pptx-templates`,
@@ -20,29 +21,11 @@ const run = async () => {
     .load(`SlideWithImages.pptx`, 'images');
 
   ppt.addSlide('charts', 1);
+  ppt.addSlide('charts', 2);
   ppt.addSlide('images', 1);
   ppt.addSlide('images', 2);
 
-  ppt.modify((xml: XMLDocument) => {
-    // Dump before to console
-    XmlHelper.dump(xml);
-
-    const sldIdLst = xml.getElementsByTagName('p:sldIdLst')[0];
-    const existingSlides = sldIdLst.getElementsByTagName('p:sldId');
-
-    // reordering logic here
-    const order = [3, 2, 1];
-    let id = 256;
-    order.forEach((sourceSlideNumber) => {
-      const slide = existingSlides[sourceSlideNumber - 1];
-      slide.setAttribute('id', String(id));
-      sldIdLst.appendChild(slide);
-      id++;
-    });
-
-    // Dump after to console
-    XmlHelper.dump(sldIdLst);
-  });
+  ppt.modify(ModifyPresentationHelper.sortSlides([3, 1, 2, 4]));
 
   const summary = await ppt.write('reorder.pptx');
 };

src/helper/modify-presentation-helper.ts

@@ -0,0 +1,22 @@
+import { XmlHelper } from './xml-helper';
+import { vd } from './general-helper';
+
+export default class ModifyPresentationHelper {
+  /**
+   * Pass an array of slide numbers to define a target sort order.
+   * First slide starts by 1.
+   * @order Array of slide numbers, starting by 1
+   */
+  static sortSlides = (order: number[]) => (xml: XMLDocument) => {
+    order.map((index, i) => order[i]--);
+    const slides = xml.getElementsByTagName('p:sldId');
+    const firstId = 256;
+    XmlHelper.sortCollection(slides, order, (slide: Element, i) => {
+      slide.setAttribute('id', String(firstId + i));
+    });
+
+    // XmlHelper.dump(
+    //   xml.getElementsByTagName('p:sldId')[0].parentNode as Element,
+    // );
+  };
+}

src/helper/xml-helper.ts

@@ -7,6 +7,7 @@ import {
   OverrideAttribute,
   RelationshipAttribute,
   HelperElement,
+  ModifyXmlCallback,
 } from '../types/xml-types';
 import { TargetByRelIdMap } from '../constants/constants';
 import { XmlPrettyPrint } from './xml-pretty-print';
@@ -19,6 +20,20 @@ import { XmlTemplateHelper } from './xml-template-helper';
 import { vd } from './general-helper';
 
 export class XmlHelper {
+  static async modifyXmlInArchive(
+    archive: Promise<JSZip>,
+    file: string,
+    callbacks: ModifyXmlCallback[],
+  ): Promise<JSZip> {
+    const xml = await XmlHelper.getXmlFromArchive(await archive, file);
+
+    for (const callback of callbacks) {
+      callback(xml);
+    }
+
+    return await XmlHelper.writeXmlToArchive(await archive, file, xml);
+  }
+
   static async getXmlFromArchive(
     archive: JSZip,
     file: string,
@@ -403,6 +418,29 @@ export class XmlHelper {
     }
   }
 
+  static sortCollection(
+    collection: HTMLCollectionOf<Element>,
+    order: number[],
+    callback?: ModifyXmlCallback,
+  ): void {
+    if (collection.length === 0) {
+      return;
+    }
+    const parent = collection[0].parentNode;
+    order.forEach((index, i) => {
+      if (!collection[index]) {
+        vd('sortCollection index not found' + index);
+        return;
+      }
+
+      const item = collection[index];
+      if (callback) {
+        callback(item, i);
+      }
+      parent.appendChild(item);
+    });
+  }
+
   static dump(element: XMLDocument | Element): void {
     const s = new XMLSerializer();
     const xmlBuffer = s.serializeToString(element);

src/types/types.ts

@@ -29,6 +29,10 @@ export type AutomizerParams = {
    * You can set a path here.
    */
   outputDir?: string;
+  /**
+   * Buffer unzipped pptx on disk
+   */
+  cacheDir?: string;
   rootTemplate?: string;
   presTemplates?: string[];
   useCreationIds?: boolean;

src/types/xml-types.ts

@@ -63,4 +63,7 @@ export type ElementInfo = {
   };
 };
 
-export type ModifyPresentationCallback = (xml: XMLDocument) => void;
+export type ModifyXmlCallback = (
+  xml: XMLDocument | Element,
+  index?: number,
+) => void;