Merge pull request #53 from singerla/feature-import-master

Feature import master

Author: singerla

README.md

@@ -0,0 +1,31 @@
+import Automizer from '../src/automizer';
+import { ModifyTextHelper } from '../src';
+
+test('Auto-import source slideLayout and -master', async () => {
+  const automizer = new Automizer({
+    templateDir: `${__dirname}/pptx-templates`,
+    outputDir: `${__dirname}/pptx-output`,
+    autoImportSlideMasters: true,
+  });
+
+  const pres = await automizer
+    .loadRoot(`EmptyTemplate.pptx`)
+    .load('SlidesWithAdditionalMaster.pptx')
+    .load('SlideMasters.pptx')
+
+    // We can disable .addMaster according to "autoImportSlideMasters: true"
+    // .addMaster('SlidesWithAdditionalMaster.pptx', 1)
+
+    .addSlide('SlidesWithAdditionalMaster.pptx', 3, (slide) => {
+      // We can also disable "slide.useSlideLayout()"
+      // with "autoImportSlideMasters: true"
+      // slide.useSlideLayout();
+    })
+    .addSlide('SlideMasters.pptx', 1)
+    .addSlide('SlidesWithAdditionalMaster.pptx', 1)
+    .addSlide('SlideMasters.pptx', 3)
+    .addSlide('SlideMasters.pptx', 2)
+    .write(`add-slide-master-auto-import.test.pptx`);
+
+  expect(pres.masters).toBe(5);
+});

__tests__/add-slide-master-auto-import.test.ts

@@ -0,0 +1,55 @@
+import Automizer from '../src/automizer';
+import { ModifyTextHelper } from '../src';
+
+test('Append and modify slideMastes and use slideLayouts', async () => {
+  const automizer = new Automizer({
+    templateDir: `${__dirname}/pptx-templates`,
+    outputDir: `${__dirname}/pptx-output`,
+  });
+
+  const pres = await automizer
+    .loadRoot(`EmptyTemplate.pptx`)
+    .load(`SlideWithNotes.pptx`, 'notes')
+    .load('SlidesWithAdditionalMaster.pptx')
+    .load('SlideWithShapes.pptx')
+    .load('SlideWithCharts.pptx')
+
+    // Import another slide master and all its slide layouts:
+    .addMaster('SlidesWithAdditionalMaster.pptx', 1, (master) => {
+      master.modifyElement(
+        `MasterRectangle`,
+        ModifyTextHelper.setText('my text on master'),
+      );
+      master.addElement(`SlideWithCharts.pptx`, 1, 'StackedBars');
+    })
+    .addMaster('SlidesWithAdditionalMaster.pptx', 2, (master) => {
+      master.addElement('SlideWithShapes.pptx', 1, 'Cloud 1');
+    })
+
+    // Add a slide (which might require an imported master):
+    .addSlide('SlidesWithAdditionalMaster.pptx', 3, (slide) => {
+      // To use the original master from 'SlidesWithAdditionalMaster.pptx',
+      // we can skip the argument. The required slideMaster & layout will be
+      // auto imported.
+      slide.useSlideLayout();
+    })
+
+    // Add a slide and use the source slideLayout:
+    .addSlide('SlidesWithAdditionalMaster.pptx', 3, (slide) => {
+      // To use the original master from 'SlidesWithAdditionalMaster.pptx',
+      // we can skip the argument.
+      slide.useSlideLayout();
+    })
+
+    // Add a slide (which might require an imported master):
+    .addSlide('notes', 1, (slide) => {
+      // use another master, e.g. the imported one from 'SlidesWithAdditionalMaster.pptx'
+      // You need to pass the index of the desired layout after all
+      // related layouts of all imported masters have been added to rootTemplate.
+      slide.useSlideLayout(26);
+    })
+
+    .write(`add-slide-master.test.pptx`);
+
+  expect(pres.masters).toBe(3);
+});

__tests__/add-slide-master.test.ts

@@ -3,7 +3,7 @@ import {
   AutomizerParams,
   AutomizerSummary,
   ArchiveParams,
-  SourceSlideIdentifier,
+  SourceIdentifier,
   StatusTracker,
 } from './types/types';
 import { IPresentationProps } from './interfaces/ipresentation-props';
@@ -17,7 +17,10 @@ import path from 'path';
 import * as fs from 'fs';
 import { XmlHelper } from './helper/xml-helper';
 import ModifyPresentationHelper from './helper/modify-presentation-helper';
-import { ContentTracker } from './helper/content-tracker';
+import {
+  contentTracker as Tracker,
+  ContentTracker,
+} from './helper/content-tracker';
 import JSZip, { OutputType } from 'jszip';
 
 /**
@@ -79,6 +82,7 @@ export default class Automizer implements IPresentationProps {
       this.rootTemplate = Template.import(
         location,
         this.archiveParams,
+        this,
       ) as RootPresTemplate;
     }
 
@@ -176,7 +180,7 @@ export default class Automizer implements IPresentationProps {
       name,
     };
 
-    const newTemplate = Template.import(location, importParams);
+    const newTemplate = Template.import(location, importParams, this);
 
     if (!this.isPresTemplate(newTemplate)) {
       this.rootTemplate = newTemplate;
@@ -227,7 +231,7 @@ export default class Automizer implements IPresentationProps {
    */
   public addSlide(
     name: string,
-    slideIdentifier: SourceSlideIdentifier,
+    slideIdentifier: SourceIdentifier,
     callback?: (slide: Slide) => void,
   ): this {
     if (this.rootTemplate === undefined) {
@@ -247,31 +251,42 @@ export default class Automizer implements IPresentationProps {
       callback(newSlide);
     }
 
+    if (this.params.autoImportSlideMasters) {
+      newSlide.useSlideLayout();
+    }
+
     this.rootTemplate.slides.push(newSlide);
 
     return this;
   }
 
   /**
-   * WIP: copy and modify a master from template to output
+   * Copy and modify a master and the associated layouts from template to output.
+   *
    * @param name
-   * @param masterNumber
+   * @param sourceIdentifier
    * @param callback
    */
   public addMaster(
     name: string,
-    masterNumber: number,
-    callback?: (slide: Slide) => void,
+    // sourceIdentifier: SourceIdentifier,
+    sourceIdentifier: number,
+    callback?: (slide: Master) => void,
   ): this {
     const template = this.getTemplate(name);
 
     const newMaster = new Master({
       presentation: this,
       template,
-      masterNumber,
+      sourceIdentifier,
     });
 
-    // this.rootTemplate.slides.push(newMaster);
+    if (callback !== undefined) {
+      newMaster.root = this;
+      callback(newMaster);
+    }
+
+    this.rootTemplate.masters.push(newMaster);
 
     return this;
   }
@@ -314,6 +329,7 @@ export default class Automizer implements IPresentationProps {
       slides: this.rootTemplate.count('slides'),
       charts: this.rootTemplate.count('charts'),
       images: this.rootTemplate.count('images'),
+      masters: this.rootTemplate.count('masters'),
     };
   }
 
@@ -349,17 +365,28 @@ export default class Automizer implements IPresentationProps {
   }
 
   async finalizePresentation() {
+    await this.writeMasterSlides();
     await this.writeSlides();
     await this.normalizePresentation();
     await this.applyModifyPresentationCallbacks();
   }
 
+  /**
+   * Write all masterSlides to archive.
+   */
+  public async writeMasterSlides(): Promise<void> {
+    for (const slide of this.rootTemplate.masters) {
+      await this.rootTemplate.appendMasterSlide(slide);
+    }
+  }
+
   /**
    * Write all slides to archive.
    */
   public async writeSlides(): Promise<void> {
     await this.rootTemplate.countExistingSlides();
-    this.status.max = this.rootTemplate.slides.length;
+    this.status.max =
+      this.rootTemplate.slides.length + this.rootTemplate.masters.length;
 
     for (const slide of this.rootTemplate.slides) {
       await this.rootTemplate.appendSlide(slide);
@@ -391,6 +418,7 @@ export default class Automizer implements IPresentationProps {
    */
   async normalizePresentation(): Promise<void> {
     this.modify(ModifyPresentationHelper.normalizeSlideIds);
+    this.modify(ModifyPresentationHelper.normalizeSlideMasterIds);
 
     if (this.params.cleanup) {
       if (this.params.removeExistingSlides) {