refactor(modify-helper): seperated by element type

Author: singerla

src/automizer.ts

@@ -6,6 +6,12 @@ import { PresTemplate } from './interfaces/pres-template';
 import { RootPresTemplate } from './interfaces/root-pres-template';
 import { Template } from './classes/template';
 
+/**
+ * Automizer
+ * 
+ * The basic class for `pptx-automizer` package. 
+ * This class will be exported as `Automizer` by `index.ts`.
+ */
 export default class Automizer implements IPresentationProps {
   rootTemplate: RootPresTemplate;
   templates: PresTemplate[];
@@ -15,8 +21,8 @@ export default class Automizer implements IPresentationProps {
   params: AutomizerParams;
 
   /**
-   * Parameters for Automizer constructor.
-   * @param params
+   * Creates an instance of `pptx-automizer`.
+   * @param [params] 
    */
   constructor(params?: AutomizerParams) {
     this.templates = [];
@@ -30,25 +36,32 @@ export default class Automizer implements IPresentationProps {
 
   /**
    * Load a pptx file and set it as root template.
-   * @param {string} location - Filename or path to the template. Will be prefixed with 'templateDir'
-   * @return {Automizer} Instance of Automizer
+   * @param location - Filename or path to the template. Will be prefixed with 'templateDir'
+   * @returns Instance of Automizer
    */
   public loadRoot(location: string): this {
     return this.loadTemplate(location);
   }
 
   /**
    * Load a template pptx file.
-   * @param {string} location - Filename or path to the template. Will be prefixed with 'templateDir'
-   * @param {string} name - Optional: A short name for the template. If skipped, the template will be named by its location.
-   * @return {Automizer} Instance of Automizer
+   * @param location - Filename or path to the template. Will be prefixed with 'templateDir'
+   * @param name - Optional: A short name for the template. If skipped, the template will be named by its location.
+   * @returns Instance of Automizer
    */
   public load(location: string, name?: string): this {
     name = name === undefined ? location : name;
     return this.loadTemplate(location, name);
   }
 
-  public loadTemplate(location: string, name?: string): this {
+  /**
+   * Loads a pptx file either as a root template as a template file.
+   * A name can be specified to give templates an alias.
+   * @param location 
+   * @param [name] 
+   * @returns template 
+   */
+  private loadTemplate(location: string, name?: string): this {
     location = this.getLocation(location, 'template');
 
     const newTemplate = Template.import(location, name);
@@ -62,18 +75,23 @@ export default class Automizer implements IPresentationProps {
     return this;
   }
 
-  isPresTemplate(
+  /**
+   * Determines whether template is root or default template.
+   * @param template 
+   * @returns pres template 
+   */
+  private isPresTemplate(
     template: PresTemplate | RootPresTemplate,
   ): template is PresTemplate {
     return 'name' in template;
   }
 
   /**
-   * Find imported template by given name and return a certain slide by number.
-   * @param {string} name - Name of template; must be imported by Automizer.importTemplate()
-   * @param {number} slideNumber - Number of slide in template presentation
-   * @param callback - Executed when slide is created. Passes the newly created slide
-   * @return {Automizer} Instance of Automizer
+   * Find a slide in by number in one of the imported templates.
+   * @param name - Name or alias of the template; must have been loaded with `Automizer.load()`
+   * @param slideNumber - Number of slide in template presentation
+   * @param callback - Executed after slide was added. The newly created slide will be passed to the callback as first argument.
+   * @returns Instance of Automizer
    */
   public addSlide(
     name: string,
@@ -102,7 +120,12 @@ export default class Automizer implements IPresentationProps {
     return this;
   }
 
-  public getTemplate(name: string): PresTemplate {
+  /**
+   * Searches this.templates to find template by given name.
+   * @param name Alias name if given to loaded template.
+   * @returns template 
+   */
+  private getTemplate(name: string): PresTemplate {
     const template = this.templates.find((t) => t.name === name);
     if (template === undefined) {
       throw new Error(`Template not found: ${name}`);
@@ -112,9 +135,10 @@ export default class Automizer implements IPresentationProps {
 
   /**
    * Write all imports and modifications to a file.
-   * @param {string} location - Filename or path for the file. Will be prefixed with 'outputDir'
+   * @param location - Filename or path for the file. Will be prefixed with 'outputDir'
+   * @returns summary object.
    */
-  async write(location: string): Promise<AutomizerSummary> {
+  public async write(location: string): Promise<AutomizerSummary> {
     const rootArchive = await this.rootTemplate.archive;
 
     for (const slide of this.rootTemplate.slides) {
@@ -130,6 +154,12 @@ export default class Automizer implements IPresentationProps {
     );
   }
 
+  /**
+   * Applies path prefix to given location string. 
+   * @param location path and/or filename 
+   * @param [type] template or output
+   * @returns location 
+   */
   private getLocation(location: string, type?: string): string {
     switch (type) {
       case 'template':

src/helper/modify-chart-helper.ts

@@ -0,0 +1,99 @@
+import { ModifyChart } from '../modify/modify-chart';
+import { Workbook } from '../types/types';
+import {
+  ChartData,
+  ChartBubble,
+  ChartSlot,
+  ChartCategory,
+  ChartSeries,
+} from '../types/chart-types';
+
+export const setChartData = (data: ChartData) => (
+  element: XMLDocument,
+  chart: Document,
+  workbook: Workbook,
+): void => {
+  const slots = [] as ChartSlot[];
+  data.series.forEach((series: ChartSeries, s: number) => {
+    slots.push({
+      index: s,
+      series: series,
+      targetCol: s + 1,
+      type: 'defaultSeries',
+    });
+  });
+
+  new ModifyChart(chart, workbook, data, slots).modify();
+
+  // XmlHelper.dump(chart)
+  // XmlHelper.dump(workbook.table)
+};
+
+export const setChartVerticalLines = (data: ChartData) => (
+  element: XMLDocument,
+  chart: Document,
+  workbook: Workbook,
+): void => {
+  const slots = [] as ChartSlot[];
+
+  slots.push({
+    label: `Y-Values`,
+    mapData: (point: number, category: ChartCategory) => category.y,
+    targetCol: 1,
+  });
+
+  data.series.forEach((series: ChartSeries, s: number) => {
+    slots.push({
+      index: s,
+      series: series,
+      targetCol: s + 2,
+      type: 'xySeries',
+    });
+  });
+
+  new ModifyChart(chart, workbook, data, slots).modify();
+};
+
+export const setChartBubbles = (data: ChartData) => (
+  element: XMLDocument,
+  chart: Document,
+  workbook: Workbook,
+): void => {
+  const slots = [] as ChartSlot[];
+
+  data.series.forEach((series: ChartSeries, s: number) => {
+    const colId = s * 3;
+    slots.push({
+      index: s,
+      series: series,
+      targetCol: colId + 1,
+      type: 'customSeries',
+      tag: 'c:xVal',
+      mapData: (point: ChartBubble): number => point.x,
+    });
+    slots.push({
+      label: `${series.label}-Y-Value`,
+      index: s,
+      series: series,
+      targetCol: colId + 2,
+      type: 'customSeries',
+      tag: 'c:yVal',
+      mapData: (point: ChartBubble): number => point.y,
+      isStrRef: false,
+    });
+    slots.push({
+      label: `${series.label}-Size`,
+      index: s,
+      series: series,
+      targetCol: colId + 3,
+      type: 'customSeries',
+      tag: 'c:bubbleSize',
+      mapData: (point: ChartBubble): number => point.size,
+      isStrRef: false,
+    });
+  });
+
+  new ModifyChart(chart, workbook, data, slots).modify();
+
+  // XmlHelper.dump(chart)
+};

src/helper/modify-helper.ts

@@ -1,47 +1,5 @@
 import { XmlHelper } from './xml-helper';
-import { ModifyChart } from '../modify/modify-chart';
-import { Workbook } from '../types/types';
-import {
-  ChartData,
-  ChartBubble,
-  ChartSlot,
-  ChartCategory,
-  ChartSeries,
-} from '../types/chart-types';
-import { TableData } from '../types/table-types';
-import { ShapeCoordinates } from '../types/shape-types';
 
-export const setSolidFill = (element: XMLDocument): void => {
-  element
-    .getElementsByTagName('a:solidFill')[0]
-    .getElementsByTagName('a:schemeClr')[0]
-    .setAttribute('val', 'accent6');
-};
-
-export const setText = (text: string) => (element: XMLDocument): void => {
-  element.getElementsByTagName('a:t')[0].firstChild.textContent = text;
-};
-
-// e.g. setPosition({x: 8000000, h:5000000})
-export const setPosition = (pos: ShapeCoordinates) => (
-  element: XMLDocument,
-): void => {
-  const map = {
-    x: { tag: 'a:off', attribute: 'x' },
-    y: { tag: 'a:off', attribute: 'y' },
-    w: { tag: 'a:ext', attribute: 'cx' },
-    h: { tag: 'a:ext', attribute: 'cy' },
-  };
-
-  const parent = 'a:xfrm';
-
-  Object.keys(pos).forEach((key) => {
-    element
-      .getElementsByTagName(parent)[0]
-      .getElementsByTagName(map[key].tag)[0]
-      .setAttribute(map[key].attribute, pos[key]);
-  });
-};
 
 export const setAttribute = (
   tagName: string,
@@ -54,102 +12,6 @@ export const setAttribute = (
     [count || 0].setAttribute(attribute, String(value));
 };
 
-export const setChartData = (data: ChartData) => (
-  element: XMLDocument,
-  chart: Document,
-  workbook: Workbook,
-): void => {
-  const slots = [] as ChartSlot[];
-  data.series.forEach((series: ChartSeries, s: number) => {
-    slots.push({
-      index: s,
-      series: series,
-      targetCol: s + 1,
-      type: 'defaultSeries',
-    });
-  });
-
-  new ModifyChart(chart, workbook, data, slots).modify();
-
-  // XmlHelper.dump(chart)
-  // XmlHelper.dump(workbook.table)
-};
-
-export const setChartVerticalLines = (data: ChartData) => (
-  element: XMLDocument,
-  chart: Document,
-  workbook: Workbook,
-): void => {
-  const slots = [] as ChartSlot[];
-
-  slots.push({
-    label: `Y-Values`,
-    mapData: (point: number, category: ChartCategory) => category.y,
-    targetCol: 1,
-  });
-
-  data.series.forEach((series: ChartSeries, s: number) => {
-    slots.push({
-      index: s,
-      series: series,
-      targetCol: s + 2,
-      type: 'xySeries',
-    });
-  });
-
-  new ModifyChart(chart, workbook, data, slots).modify();
-};
-
-export const setChartBubbles = (data: ChartData) => (
-  element: XMLDocument,
-  chart: Document,
-  workbook: Workbook,
-): void => {
-  const slots = [] as ChartSlot[];
-
-  data.series.forEach((series: ChartSeries, s: number) => {
-    const colId = s * 3;
-    slots.push({
-      index: s,
-      series: series,
-      targetCol: colId + 1,
-      type: 'customSeries',
-      tag: 'c:xVal',
-      mapData: (point: ChartBubble): number => point.x,
-    });
-    slots.push({
-      label: `${series.label}-Y-Value`,
-      index: s,
-      series: series,
-      targetCol: colId + 2,
-      type: 'customSeries',
-      tag: 'c:yVal',
-      mapData: (point: ChartBubble): number => point.y,
-      isStrRef: false,
-    });
-    slots.push({
-      label: `${series.label}-Size`,
-      index: s,
-      series: series,
-      targetCol: colId + 3,
-      type: 'customSeries',
-      tag: 'c:bubbleSize',
-      mapData: (point: ChartBubble): number => point.size,
-      isStrRef: false,
-    });
-  });
-
-  new ModifyChart(chart, workbook, data, slots).modify();
-
-  // XmlHelper.dump(chart)
-};
-
-export const setTableData = (data: TableData) => (
-  element: XMLDocument | Document | Element,
-): void => {
-  XmlHelper.dump(element);
-};
-
 export const dump = (element: XMLDocument | Document | Element): void => {
   XmlHelper.dump(element);
 };