feat(generate): interface for supported pptxGenJS items; auto-insert objectName

Author: singerla

__tests__/generate-pptxgenjs-charts.test.ts

@@ -27,13 +27,12 @@ test('generate a chart with pptxgenjs and add it to a template slide', async ()
 
   pres.addSlide('empty', 1, (slide) => {
     // Use pptxgenjs to add generated contents from scratch:
-    slide.generate((pSlide, objectName, pptxGenJs) => {
+    slide.generate((pSlide, pptxGenJs) => {
       pSlide.addChart(pptxGenJs.ChartType.line, dataChartAreaLine, {
         x: 1,
         y: 1,
         w: 8,
         h: 4,
-        objectName,
       });
     });
   });

__tests__/generate-pptxgenjs-image.test.ts

@@ -13,12 +13,11 @@ test('insert an image with pptxgenjs on a template slide', async () => {
 
   pres.addSlide('empty', 1, (slide) => {
     // Use pptxgenjs to add image from file:
-    slide.generate((pptxGenJSSlide, objectName) => {
+    slide.generate((pptxGenJSSlide) => {
       pptxGenJSSlide.addImage({
         path: `${__dirname}/media/test.png`,
         x: 1,
         y: 2,
-        objectName,
       });
     });
   });

__tests__/generate-pptxgenjs-text.test.ts

@@ -13,12 +13,13 @@ test('insert a textbox with pptxgenjs on a template slide', async () => {
 
   pres.addSlide('empty', 1, (slide) => {
     // Use pptxgenjs to add text from scratch:
-    slide.generate((pptxGenJSSlide, objectName) => {
+    slide.generate((pptxGenJSSlide) => {
       pptxGenJSSlide.addText('Test', {
         x: 1,
         y: 1,
+        h: 5,
+        w: 10,
         color: '363636',
-        objectName,
       });
     }, 'custom object name');
   });

src/helper/generate/generate-pptxgenjs.ts

@@ -3,9 +3,8 @@ import PptxGenJS from 'pptxgenjs';
 import fs from 'fs';
 import { ISlide } from '../../interfaces/islide';
 import Automizer from '../../automizer';
-import { GenerateElements } from '../../types/types';
+import { GenerateElements, SupportedPptxGenJSSlide } from '../../types/types';
 import { IGenerator } from '../../interfaces/igenerator';
-import { vd } from '../general-helper';
 
 export default class GeneratePptxGenJs implements IGenerator {
   tmpFile: string;
@@ -51,8 +50,7 @@ export default class GeneratePptxGenJs implements IGenerator {
       generateElement.objectName = generateElement.objectName || randomUUID();
       generateElement.tmpSlideNumber = this.countSlides;
       generateElement.callback(
-        pgenSlide,
-        generateElement.objectName,
+        this.supportedSlideItems(pgenSlide, generateElement.objectName),
         this.generator,
       );
       slide.addElement(
@@ -63,6 +61,37 @@ export default class GeneratePptxGenJs implements IGenerator {
     });
   }
 
+  supportedSlideItems = (
+    pgenSlide: PptxGenJS.Slide,
+    objectName: string,
+  ): SupportedPptxGenJSSlide => {
+    return {
+      addChart: (type, data, options) => {
+        pgenSlide.addChart(type, data, this.getOptions(options, objectName));
+      },
+      addImage: (options) => {
+        pgenSlide.addImage(this.getOptions(options, objectName));
+      },
+      addShape: (shapeName, options?) => {
+        pgenSlide.addShape(shapeName, this.getOptions(options, objectName));
+      },
+      addTable: (tableRows, options?) => {
+        pgenSlide.addTable(tableRows, this.getOptions(options, objectName));
+      },
+      addText: (text, options?) => {
+        pgenSlide.addText(text, this.getOptions(options, objectName));
+      },
+    };
+  };
+
+  getOptions = (options, objectName) => {
+    options = options || {};
+    return {
+      ...options,
+      objectName,
+    };
+  };
+
   appendPptxGenSlide(): PptxGenJS.Slide {
     return this.generator.addSlide();
   }

src/types/types.ts

@@ -225,9 +225,65 @@ export type ImportElement = {
   callback?: ShapeModificationCallback | ShapeModificationCallback[];
   info?: any;
 };
+
+export interface SupportedPptxGenJSSlide {
+  /**
+   * Add chart to Slide
+   * @param {CHART_NAME|IChartMulti[]} type - chart type
+   * @param {object[]} data - data object
+   * @param {IChartOpts} options - chart options
+   * @return {Slide} this Slide
+   * @type {Function}
+   */
+  addChart(
+    type: PptxGenJS.CHART_NAME | PptxGenJS['IChartMulti'][],
+    data: any[],
+    options?: PptxGenJS.IChartOpts,
+  ): void;
+
+  /**
+   * Add image to Slide
+   * @param {ImageProps} options - image options
+   * @return {Slide} this Slide
+   */
+  addImage(options: PptxGenJS.ImageProps): void;
+
+  /**
+   * Add shape to Slide
+   * @param {SHAPE_NAME} shapeName - shape name
+   * @param {ShapeProps} options - shape options
+   * @return {Slide} this Slide
+   */
+  addShape(
+    shapeName: PptxGenJS.SHAPE_NAME,
+    options?: PptxGenJS.ShapeProps,
+  ): void;
+
+  /**
+   * Add table to Slide
+   * @param {TableRow[]} tableRows - table rows
+   * @param {TableProps} options - table options
+   * @return {Slide} this Slide
+   */
+  addTable(
+    tableRows: PptxGenJS.TableRow[],
+    options?: PptxGenJS.TableProps,
+  ): void;
+
+  /**
+   * Add text to Slide
+   * @param {string|TextProps[]} text - text string or complex object
+   * @param {TextPropsOptions} options - text options
+   * @return {Slide} this Slide
+   */
+  addText(
+    text: string | PptxGenJS.TextProps[],
+    options?: PptxGenJS.TextPropsOptions,
+  ): void;
+}
+
 export type GenerateOnSlideCallback = (
-  pptxGenJSSlide: PptxGenJS.Slide,
-  objectName: string,
+  pptxGenJSSlide: SupportedPptxGenJSSlide,
   pptxGenJS: PptxGenJS,
 ) => void;
 export type GenerateElements = {