feature(status): use statusTracker to show progress during generation

Author: singerla

src/automizer.ts

@@ -1,13 +1,18 @@
 import { Slide } from './classes/slide';
 import { FileHelper } from './helper/file-helper';
-import {AutomizerParams, AutomizerSummary, SourceSlideIdentifier} from './types/types';
+import {
+  AutomizerParams,
+  AutomizerSummary,
+  SourceSlideIdentifier,
+  StatusTracker,
+} from './types/types';
 import { IPresentationProps } from './interfaces/ipresentation-props';
 import { PresTemplate } from './interfaces/pres-template';
 import { RootPresTemplate } from './interfaces/root-pres-template';
 import { Template } from './classes/template';
 import { TemplateInfo } from './types/xml-types';
 import { vd } from './helper/general-helper';
-import {Master} from './classes/master';
+import { Master } from './classes/master';
 
 /**
  * Automizer
@@ -30,6 +35,7 @@ export default class Automizer implements IPresentationProps {
    */
   timer: number;
   params: AutomizerParams;
+  status: StatusTracker;
 
   /**
    * Creates an instance of `pptx-automizer`.
@@ -43,6 +49,7 @@ export default class Automizer implements IPresentationProps {
     this.outputDir = params?.outputDir ? params.outputDir + '/' : '';
 
     this.timer = Date.now();
+    this.setStatusTracker(params?.statusTracker);
 
     if (params.rootTemplate) {
       const location = this.getLocation(params.rootTemplate, 'template');
@@ -58,6 +65,32 @@ export default class Automizer implements IPresentationProps {
     }
   }
 
+  setStatusTracker(statusTracker: StatusTracker['next']): void {
+    const defaultStatusTracker = (status: StatusTracker) => {
+      console.log(status.info + '(' + status.share + '%)');
+    };
+
+    this.status = {
+      current: 0,
+      max: 0,
+      share: 0,
+      info: undefined,
+      increment: () => {
+        this.status.current++;
+        const nextShare =
+          this.status.max > 0
+            ? Math.round((this.status.current / this.status.max) * 100)
+            : 0;
+
+        if (this.status.share !== nextShare) {
+          this.status.share = nextShare;
+          this.status.next(this.status);
+        }
+      },
+      next: statusTracker || defaultStatusTracker,
+    };
+  }
+
   /**
 
    */
@@ -98,9 +131,11 @@ export default class Automizer implements IPresentationProps {
   private loadTemplate(location: string, name?: string): this {
     location = this.getLocation(location, 'template');
 
-    const alreadyLoaded = this.templates.find(template => template.name === name)
-    if(alreadyLoaded) {
-      return this
+    const alreadyLoaded = this.templates.find(
+      (template) => template.name === name,
+    );
+    if (alreadyLoaded) {
+      return this;
     }
 
     const newTemplate = Template.import(location, name);
@@ -123,7 +158,8 @@ export default class Automizer implements IPresentationProps {
   public async setCreationIds(): Promise<TemplateInfo[]> {
     const templateCreationId = [];
     for (const template of this.templates) {
-      const creationIds = template.creationIds || await template.setCreationIds()
+      const creationIds =
+        template.creationIds || (await template.setCreationIds());
       templateCreationId.push({
         name: template.name,
         slides: creationIds,
@@ -177,12 +213,17 @@ export default class Automizer implements IPresentationProps {
     return this;
   }
 
+  /**
+   * WIP: copy and modify a master from template to output
+   * @param name
+   * @param masterNumber
+   * @param callback
+   */
   public addMaster(
     name: string,
     masterNumber: number,
     callback?: (slide: Slide) => void,
   ): this {
-
     const template = this.getTemplate(name);
 
     const newMaster = new Master({
@@ -218,6 +259,7 @@ export default class Automizer implements IPresentationProps {
   public async write(location: string): Promise<AutomizerSummary> {
     const rootArchive = await this.rootTemplate.archive;
 
+    this.status.max = this.rootTemplate.slides.length;
     for (const slide of this.rootTemplate.slides) {
       await this.rootTemplate.appendSlide(slide);
     }

src/classes/slide.ts

@@ -7,7 +7,9 @@ import {
   ImportedElement,
   ImportElement,
   SlideModificationCallback,
-  ShapeModificationCallback, SourceSlideIdentifier,
+  ShapeModificationCallback,
+  SourceSlideIdentifier,
+  StatusTracker,
 } from '../types/types';
 import { ISlide } from '../interfaces/islide';
 import { IPresentationProps } from '../interfaces/ipresentation-props';
@@ -22,7 +24,7 @@ import {
 import { Image } from '../shapes/image';
 import { Chart } from '../shapes/chart';
 import { GenericShape } from '../shapes/generic';
-import {GeneralHelper, vd} from '../helper/general-helper';
+import { GeneralHelper, vd } from '../helper/general-helper';
 
 export class Slide implements ISlide {
   /**
@@ -95,6 +97,7 @@ export class Slide implements ISlide {
    * @internal
    */
   targetRelsPath: string;
+  status: StatusTracker;
 
   constructor(params: {
     presentation: IPresentationProps;
@@ -112,6 +115,8 @@ export class Slide implements ISlide {
 
     this.modifications = [];
     this.importElements = [];
+
+    this.status = params.presentation.status;
   }
 
   /**
@@ -122,17 +127,25 @@ export class Slide implements ISlide {
    * @slideNumber SourceSlideIdentifier
    * @returns number
    */
-  getSlideNumber(template: PresTemplate, slideIdentifier: SourceSlideIdentifier): number {
+  getSlideNumber(
+    template: PresTemplate,
+    slideIdentifier: SourceSlideIdentifier,
+  ): number {
     if (template.creationIds !== undefined) {
-      const matchCreationId =  template.creationIds.find(
+      const matchCreationId = template.creationIds.find(
         (slideInfo) => slideInfo.id === Number(slideIdentifier),
-      )
+      );
 
-      if(matchCreationId) {
-        return matchCreationId.number
+      if (matchCreationId) {
+        return matchCreationId.number;
       }
 
-      throw('Could not find slide number for creationId: ' + slideIdentifier + '@' + template.name)
+      throw (
+        'Could not find slide number for creationId: ' +
+        slideIdentifier +
+        '@' +
+        template.name
+      );
     }
     return slideIdentifier as number;
   }
@@ -152,7 +165,7 @@ export class Slide implements ISlide {
     this.targetRelsPath = `ppt/slides/_rels/slide${this.targetNumber}.xml.rels`;
     this.sourceArchive = await this.sourceTemplate.archive;
 
-    console.log('Appending slide ' + this.targetNumber)
+    this.status.info = 'Appending slide ' + this.targetNumber;
 
     await this.copySlideFiles();
     await this.copyRelatedContent();
@@ -173,10 +186,12 @@ export class Slide implements ISlide {
     }
 
     await this.applyModifications();
+
+    this.status.increment();
   }
 
   /**
-   * Modifys slide
+   * Modifies slide
    * @internal
    * @param callback
    */

src/interfaces/ipresentation-props.ts

@@ -1,4 +1,4 @@
-import { AutomizerParams } from '../types/types';
+import { AutomizerParams, StatusTracker } from '../types/types';
 import { PresTemplate } from './pres-template';
 import { RootPresTemplate } from './root-pres-template';
 
@@ -7,6 +7,7 @@ export interface IPresentationProps {
   templates: PresTemplate[];
   params: AutomizerParams;
   timer: number;
+  status?: StatusTracker;
 
   getTemplate(name: string): PresTemplate;
 }

src/types/types.ts

@@ -1,7 +1,7 @@
 import JSZip from 'jszip';
 import { ElementType } from '../enums/element-type';
 
-export type SourceSlideIdentifier = number | string
+export type SourceSlideIdentifier = number | string;
 export type SlideModificationCallback = (document: Document) => void;
 export type ShapeModificationCallback = (
   XMLDocument: XMLDocument | Element,
@@ -27,6 +27,20 @@ export type AutomizerParams = {
   rootTemplate?: string;
   presTemplates?: string[];
   useCreationIds?: boolean;
+
+  /**
+   * statusTracker will be triggered on each appended slide.
+   * You can e.g. attach a custom callback to a progress bar.
+   */
+  statusTracker?: StatusTracker['next'];
+};
+export type StatusTracker = {
+  current: number;
+  max: number;
+  share: number;
+  info: string | undefined;
+  next: (tracker: StatusTracker) => void;
+  increment: () => void;
 };
 export type AutomizerSummary = {
   status: string;