fix(master): status; add comments / ToDos

Author: singerla

__tests__/pptx-templates/SlideMasters.pptx

@@ -385,8 +385,7 @@ export default class Automizer implements IPresentationProps {
    */
   public async writeSlides(): Promise<void> {
     await this.rootTemplate.countExistingSlides();
-    this.status.max =
-      this.rootTemplate.slides.length + this.rootTemplate.masters.length;
+    this.status.max = this.rootTemplate.slides.length;
 
     for (const slide of this.rootTemplate.slides) {
       await this.rootTemplate.appendSlide(slide);

src/automizer.ts

@@ -112,7 +112,7 @@ export class Master implements IMaster {
    */
   unsupportedTags = [
     'p:custDataLst',
-    //'mc:AlternateContent',
+    'mc:AlternateContent',
     //'a14:imgProps',
   ];
 
@@ -195,7 +195,7 @@ export class Master implements IMaster {
     this.targetRelsPath = `ppt/slideMasters/_rels/slideMaster${this.targetNumber}.xml.rels`;
     this.sourceArchive = await this.sourceTemplate.archive;
 
-    this.status.info = 'Appending slideMaster ' + this.targetNumber;
+    console.log('Importing slideMaster ' + this.targetNumber);
 
     await this.copySlideFiles();
     await this.copyRelatedLayouts();
@@ -208,18 +208,27 @@ export class Master implements IMaster {
     }
 
     await this.applyModifications();
-    await this.cleanSlide();
-
-    this.status.increment();
+    await this.cleanSlide(this.targetPath);
+
+    /**
+     * ToDo: Integrity checks could be used in many places
+     * to log warnings in case we have skipped out related contents from copying
+     * to the target archive.
+     *
+     * By now, this is disabled because appendToSlideRels() could leave some
+     * artifacts from unused relations.
+     */
+    // await this.checkIntegrity();
   }
 
   async copyRelatedLayouts(): Promise<Target[]> {
-    const targetHelper = await new XmlRelationshipHelper().initialize(
+    const masterToLayout = await new XmlRelationshipHelper().initialize(
       this.targetArchive,
-      `ppt/slideMasters/_rels/slideMaster${this.targetNumber}.xml.rels`,
+      `slideMaster${this.targetNumber}.xml.rels`,
+      `ppt/slideMasters/_rels`,
     );
 
-    const targets = targetHelper.getTargetsByPrefix(
+    const targets = masterToLayout.getTargetsByPrefix(
       '../slideLayouts/slideLayout',
     );
 
@@ -245,12 +254,18 @@ export class Master implements IMaster {
 
       const layoutTargetHelper = await new XmlRelationshipHelper().initialize(
         this.targetArchive,
-        `ppt/slideLayouts/_rels/slideLayout${nextSlideLayoutNumber}.xml.rels`,
+        `slideLayout${nextSlideLayoutNumber}.xml.rels`,
+        `ppt/slideLayouts/_rels`,
       );
       const layoutToMaster = layoutTargetHelper.getTargetsByPrefix(
         '../slideMasters/slideMaster',
       );
       layoutToMaster[0].updateTargetIndex(this.targetNumber);
+      await layoutTargetHelper.checkTargets(this.sourceArchive);
+
+      await this.cleanSlide(
+        `ppt/slideLayouts/slideLayout${nextSlideLayoutNumber}.xml`,
+      );
 
       await this.appendSlideLayoutToContentType(
         this.targetArchive,
@@ -261,6 +276,15 @@ export class Master implements IMaster {
     return targets;
   }
 
+  async checkIntegrity(): Promise<void> {
+    const masterToLayout = await new XmlRelationshipHelper().initialize(
+      this.targetArchive,
+      `slideMaster${this.targetNumber}.xml.rels`,
+      `ppt/slideMasters/_rels`,
+    );
+    await masterToLayout.checkTargets(this.sourceArchive);
+  }
+
   async copyThemeFiles() {
     const targets = await XmlHelper.getRelationshipTargetsByPrefix(
       this.targetArchive,
@@ -665,17 +689,17 @@ export class Master implements IMaster {
   }
 
   /**
-   * ToDo: This equals the corresponding method in slide.ts
+   * ToDo: This *almost* equals the corresponding method in slide.ts
    *
    * Removes all unsupported tags from slide xml.
    * E.g. added relations & tags by Thinkcell cannot
    * be processed by pptx-automizer at the moment.
    * @internal
    */
-  async cleanSlide(): Promise<void> {
+  async cleanSlide(targetPath: string): Promise<void> {
     const xml = await XmlHelper.getXmlFromArchive(
       this.targetArchive,
-      this.targetPath,
+      targetPath,
     );
 
     this.unsupportedTags.forEach((tag) => {
@@ -685,7 +709,7 @@ export class Master implements IMaster {
         XmlHelper.sliceCollection(drop, 0);
       }
     });
-    XmlHelper.writeXmlToArchive(this.targetArchive, this.targetPath, xml);
+    XmlHelper.writeXmlToArchive(this.targetArchive, targetPath, xml);
   }
 
   /**

src/classes/master.ts

@@ -38,13 +38,11 @@ const run = async () => {
     .load('SlidesWithAdditionalMaster.pptx')
 
     // We can disable .addMaster according to "autoImportSlideMasters: true"
-    // .addMaster('SlidesWithAdditionalMaster.pptx', 1)
+    // .addMaster('SlideMasters.pptx', 1)
 
-    .addSlide('SlideMasters.pptx', 3, (slide) => {
-      // We can also disable "slide.useSlideLayout()"
-      // with "autoImportSlideMasters: true"
-      // slide.useSlideLayout();
-    })
+    .addSlide('SlideMasters.pptx', 1)
+    .addSlide('SlideMasters.pptx', 2)
+    .addSlide('SlideMasters.pptx', 3)
     .write(`add-slide-master-auto-import.test.pptx`);
 };
 

src/dev.ts

@@ -125,7 +125,11 @@ export class FileHelper {
     FileHelper.check(sourceArchive, sourceFile);
     contentTracker.trackFile(targetFile);
 
-    const content = await sourceArchive.read(sourceFile, 'nodebuffer');
+    const content = await sourceArchive
+      .read(sourceFile, 'nodebuffer')
+      .catch((e) => {
+        throw e;
+      });
 
     return targetArchive.write(targetFile || sourceFile, content);
   }

src/helper/file-helper.ts

@@ -4,10 +4,12 @@ import IArchive from '../interfaces/iarchive';
 import { XmlHelper } from './xml-helper';
 import { last, vd } from './general-helper';
 import { ElementSubtype } from '../enums/element-type';
+import { FileHelper } from './file-helper';
 
 export class XmlRelationshipHelper {
   archive: IArchive;
   file: string;
+  path: string;
   tag: string;
   xml: XmlDocument;
   xmlTargets: XmlElement[] = [];
@@ -21,21 +23,21 @@ export class XmlRelationshipHelper {
     return this;
   }
 
-  async initialize(archive: IArchive, file: string) {
+  async initialize(archive: IArchive, file: string, path: string) {
     this.archive = archive;
     this.file = file;
+    this.path = path + '/';
     const fileProxy = await this.archive;
-    this.xml = await XmlHelper.getXmlFromArchive(fileProxy, this.file);
+    this.xml = await XmlHelper.getXmlFromArchive(
+      fileProxy,
+      this.path + this.file,
+    );
 
     await this.readTargets();
 
     return this;
   }
 
-  async writeArchive() {
-    await XmlHelper.writeXmlToArchive(this.archive, this.file, this.xml);
-  }
-
   setXml(xml) {
     this.xml = xml;
     return this;
@@ -101,6 +103,30 @@ export class XmlRelationshipHelper {
     return this;
   }
 
+  async checkTargets(sourceArchive) {
+    for (const xmlTarget of this.xmlTargets) {
+      const targetFile = xmlTarget.getAttribute('Target');
+      const targetPath = targetFile.replace('../', 'ppt/');
+
+      if (this.archive.fileExists(targetPath) === false) {
+        console.error(
+          'Relation target @' + this.file + ' does not exist: ' + targetPath,
+        );
+
+        // This could be activated to assure all contents being available in
+        // the target archive.
+
+        // await FileHelper.zipCopy(
+        //   sourceArchive,
+        //   targetPath,
+        //   this.archive,
+        //   targetPath + '.fixed',
+        // );
+        // xmlTarget.setAttribute('Target', targetFile + '.fixed');
+      }
+    }
+  }
+
   static parseRelationTarget(
     element: XmlElement,
     prefix?: string,
@@ -187,7 +213,8 @@ export class XmlRelationshipHelper {
   static async getSlideLayoutNumber(sourceArchive, slideId: number) {
     const slideToLayoutHelper = await new XmlRelationshipHelper().initialize(
       sourceArchive,
-      `ppt/slides/_rels/slide${slideId}.xml.rels`,
+      `slide${slideId}.xml.rels`,
+      `ppt/slides/_rels`,
     );
     const slideToLayout = slideToLayoutHelper.getTargetsByPrefix(
       '../slideLayouts/slideLayout',
@@ -198,7 +225,8 @@ export class XmlRelationshipHelper {
   static async getSlideMasterNumber(sourceArchive, slideLayoutId: number) {
     const layoutToMasterHelper = await new XmlRelationshipHelper().initialize(
       sourceArchive,
-      `ppt/slideLayouts/_rels/slideLayout${slideLayoutId}.xml.rels`,
+      `slideLayout${slideLayoutId}.xml.rels`,
+      `ppt/slideLayouts/_rels`,
     );
     const layoutToMaster = layoutToMasterHelper.getTargetsByPrefix(
       '../slideMasters/slideMaster',

src/helper/xml-relationship-helper.ts

@@ -127,6 +127,12 @@ export class Image extends Shape implements IImage {
     await this.appendImageExtensionToContentType(this.extension);
   }
 
+  /**
+   * ToDo: This will always append a new relation, and never replace an
+   * existing relation. At the end of creation process, unused relations will
+   * remain existing in the .xml.rels file. PowerPoint will not complain, but
+   * integrity checks will not be valid by this.
+   */
   async appendToSlideRels(): Promise<HelperElement> {
     const targetRelFile = `ppt/${this.targetType}s/_rels/${this.targetType}${this.targetSlideNumber}.xml.rels`;
     this.createdRid = await XmlHelper.getNextRelId(