[Feat?] make slide masters/layouts editable.

[MP70]

I think this would be 'not too difficult' to add; we just need to work out how to present it to the user.. maybe slide.modifyMaster()?

I appreciate the same can be achieved by re adding the master pres.addMaster() that's already there but this seems really inefficient and requires user to have already looked up the slide master relationship.

This would enable us to change text or logos that are stored in the masters. For example if a user puts the customer name and logo in the master we can still automate that without requiring them to pull them out of the master.

What do you think?

Alongside this I'd also like to work on getting slide backgrounds something we can edit.

[singerla]

Hi Matt,

I really like your idea, but I'm afraid, this is more complicated than expected. :)

It's basically because a modification applies only on adding it - regardless of a shape's location (slide or slideMaster). It can't be modified in place, this would require some more refactoring.

But I could imagine a shurtcut like this:

 const pres = await automizer
    .loadRoot(`EmptyTemplate.pptx`)
    .load('SlideWithShapes.pptx')

    // modifyMaster could wrap around addMaster:
    .modifyMaster('SlideWithShapes.pptx', 1, (master) => {
      master.modifyElement(
        `MasterRectangle`,
        ModifyTextHelper.setText('my text on master'),
      );
    })

This is similar to autoImportSlideMasters: true, which also is a wrapper for underlying fetaures.
I need to go deeper into this.

[MP70]

Yes, I agree. I was thinking something that wrapped add master that 'offloaded' looking up the relationship and deduplication (in practice i suppose addMaster actually would overwrite the existing master). If we have one master applied to many slides it should ensure we are not actually copying the master each time and it remains a single master file.

Thinking about this further though there would potentially be cases where the master is on the root template, is there a way we could edit this once, without calling .addMaster on each slide manually.

[jhaase1]

I tried adding the masters making the modifications, then removing the originals. It does add the masters then remove the old ones; however, I am running into the repair issue. I believe the issue might be that the id for the masters might be too low if there are only modified masters in the presentation because without modification the slide master ids are 2147483660 to 2147483678, but after modification are 0 & 6.

If the default master id were increased, I think it may solve the issue?

pptx-automizer/src/helper/modify-presentation-helper.ts

Line 65 in 841b33c

currentId = Number(slide.getAttribute('id'));

async function removeMasters(pres, length, from) {
  const xml = await XmlHelper.getXmlFromArchive(
    pres.rootTemplate.archive,
    `ppt/presentation.xml`,
  );

  const existingMasters = xml.getElementsByTagName('p:sldMasterId');

  XmlHelper.sliceCollection(existingMasters, length, from);

  XmlHelper.writeXmlToArchive(
    await pres.rootTemplate.archive,
    `ppt/presentation.xml`,
    xml,
  );

  await pres.modify(ModifyPresentationHelper.normalizeSlideMasterIds);
}

[jhaase1]

Big surprise it's more complicated than that. I don't think FileHelper is the correct function to use here? possibly remove from pres.rootTemplate.archive.archive.files? Or does it need to be removed from pres.rootTemplate.archive.file also?

async function removeMasters(pres, length, from) {
  const xml = await XmlHelper.getXmlFromArchive(
    pres.rootTemplate.archive,
    `ppt/presentation.xml`,
  );

  for (let i = 0; i < length; i += 1) {
    const layouts = await new XmlRelationshipHelper().initialize(
      pres.rootTemplate.archive,
      `slideMaster${from + i + 1}.xml.rels`,
      `ppt/slideMasters/_rels`,
      '../slideLayouts/slideLayout',
    );

    const layoutFiles = layouts.map((f) =>
      f.file, // path.resolve(`ppt/presentation.xml/${f.file}`),
    );

    await FileHelper.removeFromDirectory(
      pres.rootTemplate.archive,
      '../slideLayouts/',
      (file) => {
        return !layoutFiles.includes(file.relativePath);
      },
    );

    const themes = await new XmlRelationshipHelper().initialize(
      pres.rootTemplate.archive,
      `slideMaster${from + i + 1}.xml.rels`,
      `ppt/slideMasters/_rels`,
      '../theme/theme',
    );

    const themesFiles = themes.map((f) =>
      f.file, // path.resolve(`ppt/presentation.xml/${f.file}`),
    );

    await FileHelper.removeFromDirectory(
      pres.rootTemplate.archive,
      '../theme/',
      (file) => {
        return !themesFiles.includes(file.relativePath);
      },
    );
  }

  const existingMasters = xml.getElementsByTagName('p:sldMasterId');

  XmlHelper.sliceCollection(existingMasters, length, from);

  XmlHelper.writeXmlToArchive(
    await pres.rootTemplate.archive,
    `ppt/presentation.xml`,
    xml,
  );

  // await pres.modify(ModifyPresentationHelper.normalizeSlideMasterIds);
}

[singerla]

Hi @jhaase1!

Thanks a lot for your code. I've edited it a little and moved it to

pptx-automizer/src/helper/modify-presentation-helper.ts

Lines 190 to 200 in 7948705

	static removeSlideMaster =
	(length: number, from: number, pres: Automizer) =>
	async (presXml: XmlDocument) => {
	for (let i = 0; i < length; i += 1) {
	const targetMasterId = from + i + 1;
	const masterToRemove = `slideMaster${targetMasterId}.xml`;
	const layouts = (await new XmlRelationshipHelper().initialize(
	pres.rootTemplate.archive,
	`${masterToRemove}.rels`,
	`ppt/slideMasters/_rels`,

Please check out feature-remove-master branch to test and improve it.

Some thoughts on it:

• It is really tricky to figure out a proper Id for the first master. Please also see my comments here:

  pptx-automizer/src/helper/modify-presentation-helper.ts

  Lines 46 to 54 in 7948705

  	* Update slideMaster ids to prevent corrupted pptx.
  	* - Take first slideMaster id from presentation.xml to start,
  	* - then update incremental ids of each p:sldLayoutId in slideMaster[i].xml
  	* (starting by slideMasterId + 1)
  	* - and update next slideMaster id with previous p:sldLayoutId + 1
  	*
  	* p:sldMasterId-ids and p:sldLayoutId-ids need to be in a row, otherwise
  	* PowerPoint will complain on any p:sldLayoutId-id lower than its
  	* corresponding slideMaster-id. omg.

• I could not figure out why deleting the theme files causes a corrupted pptx on.
• This will eventually not remove e.g. the images placed on a removed slide master.

Please let me know if this is useful!

[jhaase1]

I manually removed a slide master!

Steps:

• Delete theme1
• Delete slideMaster1
• Delete slideMaster1.xml.rels
• Delete slideLayout1-8.xml
• Delete slideLayout1-8.xml.rels
• Presentation.xml.rels delete reference to theme1 and master1
• Presentation.xml sldMasterIdLst reference to rId1 - delete

original.pptx

master-removed.pptx

[singerla]

Cool, @jhaase1!

Did you also try this:

pptx-automizer/__tests__/add-slide-master.test.ts

Line 57 in 7948705

pres.removeMasters(1, 0);

It is available in branch feature-remove-master. I was wondering if this is applicable to your case.

[jhaase1]

I thought you were saying the function was not working because there was something missing. That's why I was doing the manual editing to try and figure out what we needed to add.

I'll test this out!

[jhaase1]

Thank you! That's exactly what I was hoping for :-)

[jhaase1]

After looking move closely I realized that you had broken the test to get the POC working. I went back and changed things around to make the removeMasters match other functions such as addSlide by adding a return value. This fixed the error that pres.masters did not exist; however, I cannot figure out where that is actually being set because the value should be 2?

#142

Additionally, do pres.templates and pres.rootTemplate need to be updated inside of ModifyPresentationHelper.removeSlideMaster?