fix: make cleanupPlaceholders optional; seek closest parent; fixes #139

Author: singerla

README.md

@@ -178,7 +178,10 @@ const automizer = new Automizer({
 
   // Use 1 to show warnings or 2 for detailed information
   // 0 disables logging
-  verbosity: 1
+  verbosity: 1,
+
+  // Remove all unused placeholders to prevent unwanted overlays:
+  cleanupPlaceholders: false
 });
 
 // Now we can start and load a pptx template.

src/classes/has-shapes.ts

@@ -137,7 +137,12 @@ export default class HasShapes {
   targetType: ShapeTargetType;
   params: AutomizerParams;
 
-  constructor(params) {
+  cleanupPlaceholders: boolean = false;
+
+  constructor(params: {
+    presentation: IPresentationProps;
+    template: PresTemplate;
+  }) {
     this.sourceTemplate = params.template;
 
     this.modifications = [];
@@ -147,6 +152,8 @@ export default class HasShapes {
 
     this.status = params.presentation.status;
     this.content = params.presentation.content;
+
+    this.cleanupPlaceholders = params.presentation.params.cleanupPlaceholders;
   }
 
   /**
@@ -939,7 +946,7 @@ export default class HasShapes {
       targetPath,
     );
 
-    if (sourcePlaceholderTypes) {
+    if (this.cleanupPlaceholders && sourcePlaceholderTypes) {
       this.removeDuplicatePlaceholders(xml, sourcePlaceholderTypes);
       this.normalizePlaceholderShapes(xml, sourcePlaceholderTypes);
     }
@@ -983,9 +990,14 @@ export default class HasShapes {
           (sourcePlaceholder) => sourcePlaceholder.type === usedType,
         );
         removePlaceholders.forEach((removePlaceholder) => {
-          const removePlaceholderShape = removePlaceholder.xml.parentNode
-            .parentNode.parentNode as XmlElement;
-          XmlHelper.remove(removePlaceholderShape);
+          const parentShapeTag = 'p:sp';
+          const parentShape = XmlHelper.getClosestParent(
+            parentShapeTag,
+            removePlaceholder.xml,
+          );
+          if (parentShape) {
+            XmlHelper.remove(parentShape);
+          }
         });
       }
     }

src/dev.ts

@@ -8,6 +8,7 @@ const run = async () => {
     templateDir,
     outputDir,
     autoImportSlideMasters: true,
+    cleanupPlaceholders: true,
   });
 
   let pres = automizer

src/helper/xml-helper.ts

@@ -548,8 +548,19 @@ export class XmlHelper {
     }
   }
 
+  static getClosestParent(tag: string, element: XmlElement): XmlElement {
+    if (element.parentNode) {
+      if (element.parentNode.nodeName === tag) {
+        return element.parentNode as XmlElement;
+      }
+      return XmlHelper.getClosestParent(tag, element.parentNode as XmlElement);
+    }
+  }
+
   static remove(toRemove: XmlElement): void {
-    toRemove.parentNode.removeChild(toRemove);
+    if (toRemove?.parentNode) {
+      toRemove.parentNode.removeChild(toRemove);
+    }
   }
 
   static moveChild(childToMove: XmlElement, insertBefore?: XmlElement): void {

src/types/types.ts

@@ -105,6 +105,10 @@ export type AutomizerParams = {
    * Eventually remove all unnecessary files from archive.
    */
   cleanup?: boolean;
+  /**
+   * Remove all unused shape placeholders from slide.
+   */
+  cleanupPlaceholders?: boolean;
   /**
    * statusTracker will be triggered on each appended slide.
    * You can e.g. attach a custom callback to a progress bar.