Merge pull request #158 from singerla/main

sync with main

Author: singerla

__tests__/remove-slides.test.ts

@@ -0,0 +1,38 @@
+import Automizer from '../src/automizer';
+import ModifyPresentationHelper from '../src/helper/modify-presentation-helper';
+
+test('Remove slides while and after modifying.', async () => {
+  const automizer = new Automizer({
+    templateDir: `${__dirname}/pptx-templates`,
+    outputDir: `${__dirname}/pptx-output`,
+  });
+
+  const pres = automizer
+    .loadRoot(`RootTemplate.pptx`)
+    .load(`EmptySlide.pptx`, 'empty')
+    .load(`SlideWithCharts.pptx`, 'charts')
+    .load(`SlideWithImages.pptx`, 'images');
+
+  pres
+    .addSlide('charts', 2, (slide) => {})
+    .addSlide('images', 2, (slide) => {
+      // Pass the current slide index to remove a slide.
+      slide.remove(3);
+      // You can as well remove another slide.
+      slide.remove(1);
+    })
+    .addSlide('empty', 1, (slide) => {})
+    .addSlide('empty', 1, (slide) => {})
+    .addSlide('images', 1, (slide) => {
+      // Calling
+      slide.remove(1);
+    });
+
+  // Eventually remove some slides.
+  pres.modify(ModifyPresentationHelper.removeSlides([1, 3]));
+
+  const result = await pres.write(`remove-slides.test.pptx`);
+
+  // ToDo: decrement counter
+  expect(result.slides).toBe(6);
+});

src/automizer.ts

@@ -28,7 +28,6 @@ import { ISlide } from './interfaces/islide';
 import { IMaster } from './interfaces/imaster';
 import { ContentTypeExtension } from './enums/content-type-map';
 import slugify from 'slugify';
-import PptxGenJS from 'pptxgenjs';
 
 /**
  * Automizer

src/classes/slide.ts

@@ -9,6 +9,7 @@ import { XmlRelationshipHelper } from '../helper/xml-relationship-helper';
 import { IMaster } from '../interfaces/imaster';
 import HasShapes from './has-shapes';
 import { Master } from './master';
+import ModifyPresentationHelper from '../helper/modify-presentation-helper';
 
 export class Slide extends HasShapes implements ISlide {
   targetType: ShapeTargetType = 'slide';
@@ -232,4 +233,13 @@ export class Slide extends HasShapes implements ISlide {
       `ppt/slides/_rels/slide${this.targetNumber}.xml.rels`,
     );
   }
+
+  /**
+   * Remove a slide from presentation's slide list.
+   * ToDo: Find the current count for this slide;
+   * ToDo: this.targetNumber is undefined at this point.
+   */
+  remove(slide: number): void {
+    this.root.modify(ModifyPresentationHelper.removeSlides([slide]));
+  }
 }

src/helper/modify-presentation-helper.ts

@@ -27,6 +27,20 @@ export default class ModifyPresentationHelper {
     XmlHelper.sortCollection(slides, order);
   };
 
+  /**
+   * Pass an array of slide numbers to remove from slide sortation.
+   * @order Array of slide numbers, starting by 1
+   */
+  static removeSlides = (numbers: number[]) => (xml: XmlDocument) => {
+    const slides = ModifyPresentationHelper.getSlidesCollection(xml);
+    numbers.map((index, i) => numbers[i]--);
+    for (let i = 0; i <= slides.length; i++) {
+      if (numbers.includes(i)) {
+        XmlHelper.remove(slides[i]);
+      }
+    }
+  };
+
   /**
    * Set ids to prevent corrupted pptx.
    * Must start with 256 and increment by one.

src/interfaces/ipresentation-props.ts

@@ -2,6 +2,8 @@ import { AutomizerParams, StatusTracker } from '../types/types';
 import { PresTemplate } from './pres-template';
 import { RootPresTemplate } from './root-pres-template';
 import { ContentTracker } from '../helper/content-tracker';
+import { ModifyXmlCallback } from '../types/xml-types';
+import Automizer from '../automizer';
 
 export interface IPresentationProps {
   rootTemplate: RootPresTemplate;
@@ -10,5 +12,8 @@ export interface IPresentationProps {
   timer: number;
   status?: StatusTracker;
   content?: ContentTracker;
+
   getTemplate(name: string): PresTemplate;
+
+  modify(cb: ModifyXmlCallback): Automizer;
 }

src/interfaces/islide.ts

@@ -73,7 +73,9 @@ export interface ISlide {
   getDimensions(): Promise<{ width: number; height: number }>;
 
   /**
-   * Drop the current slide
+   * Remove a slide from output. The slide will be calculated, but
+   * eventually withdrawn from slide list.
+   * Slide number starts by 1.
    */
-  drop(): void;
+  remove(number: number): void;
 }