feat(pres): remove slides from presentation's slide list

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/has-shapes.ts

@@ -425,15 +425,12 @@ export default class HasShapes {
           // For hyperlinks, we need to handle them differently
           if (info.target) {
             await new Hyperlink(
-              info, 
-              this.targetType, 
+              info,
+              this.targetType,
               this.sourceArchive,
               info.target.isExternal ? 'external' : 'internal',
-              info.target.file
-            )[info.mode](
-              this.targetTemplate, 
-              this.targetNumber
-            );
+              info.target.file,
+            )[info.mode](this.targetTemplate, this.targetNumber);
           }
           break;
         default:
@@ -803,7 +800,7 @@ export default class HasShapes {
           sourceArchive: this.sourceArchive,
           sourceSlideNumber: this.sourceNumber,
         },
-        this.targetType
+        this.targetType,
       ).modifyOnAddedSlide(this.targetTemplate, this.targetNumber);
     }
 
@@ -816,11 +813,14 @@ export default class HasShapes {
           sourceArchive: this.sourceArchive,
           sourceSlideNumber: this.sourceNumber,
         },
-        this.targetType
+        this.targetType,
       ).modifyOnAddedSlide(this.targetTemplate, this.targetNumber);
     }
 
-    const oleObjects = await OLEObject.getAllOnSlide(this.sourceArchive, this.relsPath);
+    const oleObjects = await OLEObject.getAllOnSlide(
+      this.sourceArchive,
+      this.relsPath,
+    );
     for (const oleObject of oleObjects) {
       await new OLEObject(
         {
@@ -830,12 +830,15 @@ export default class HasShapes {
           sourceSlideNumber: this.sourceNumber,
         },
         this.targetType,
-        this.sourceArchive
+        this.sourceArchive,
       ).modifyOnAddedSlide(this.targetTemplate, this.targetNumber, oleObjects);
     }
 
     // Copy hyperlinks
-    const hyperlinks = await Hyperlink.getAllOnSlide(this.sourceArchive, this.relsPath);
+    const hyperlinks = await Hyperlink.getAllOnSlide(
+      this.sourceArchive,
+      this.relsPath,
+    );
     for (const hyperlink of hyperlinks) {
       // Create a new hyperlink with the correct target information
       const hyperlinkInstance = new Hyperlink(
@@ -848,14 +851,18 @@ export default class HasShapes {
         this.targetType,
         this.sourceArchive,
         hyperlink.isExternal ? 'external' : 'internal',
-        hyperlink.file
+        hyperlink.file,
       );
-      
+
       // Ensure the target property is properly set
       hyperlinkInstance.target = hyperlink;
-      
+
       // Process the hyperlink
-      await hyperlinkInstance.modifyOnAddedSlide(this.targetTemplate, this.targetNumber, hyperlinks);
+      await hyperlinkInstance.modifyOnAddedSlide(
+        this.targetTemplate,
+        this.targetNumber,
+        hyperlinks,
+      );
     }
   }
 

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';
@@ -226,4 +227,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

@@ -13,9 +13,13 @@ import { ElementInfo } from '../types/xml-types';
 export interface ISlide {
   sourceArchive: IArchive;
   sourceNumber: SourceIdentifier;
+
   modify(callback: SlideModificationCallback): void;
+
   modifyRelations(callback: SlideModificationCallback): void;
+
   append(targetTemplate: RootPresTemplate): Promise<void>;
+
   /**
    * Add an element from one of the loaded templates to this slide.
    * @param presName Filename or custom name of source template
@@ -29,6 +33,7 @@ export interface ISlide {
     selector: FindElementSelector,
     callback?: ModificationCallback | ModificationCallback[],
   ): ISlide;
+
   /**
    * Modify an element on the current slide.
    * @param selector The name or element creationID of the element on current slide
@@ -38,24 +43,39 @@ export interface ISlide {
     selector: FindElementSelector,
     callback: ModificationCallback | ModificationCallback[],
   ): ISlide;
+
   /**
    * Use PptxGenJs to generate a new element from scratch on this slide.
    * @param generate Pass a callback to create an element on current slide
    * @param objectName Give a custom name for this element or automizer will create a random uuid
    */
   generate(generate: GenerateOnSlideCallback, objectName?: string): ISlide;
+
   /**
    * You can remove an element on the current slide.
    * @param selector Pass element name or creationId to find target element.
    */
   removeElement(selector: FindElementSelector): ISlide;
+
   useSlideLayout(targetLayout?: number | string): ISlide;
+
   getElement(selector: FindElementSelector): Promise<ElementInfo>;
+
   getAllElements(filterTags?: string[]): Promise<ElementInfo[]>;
+
   getAllTextElementIds(): Promise<string[]>;
+
   getGeneratedElements(): GenerateElements[];
+
   /**
    * Asynchronously retrieves the dimensions of a slide.
    */
   getDimensions(): Promise<{ width: number; height: number }>;
+
+  /**
+   * Remove a slide from output. The slide will be calculated, but
+   * eventually withdrawn from slide list.
+   * Slide number starts by 1.
+   */
+  remove(number: number): void;
 }