@elisra-devops/docgen-skins 0.3.4 → 0.4.0

package/src/models/json/JSONRun.ts

@@ -1,80 +1,80 @@
-import { Run, WIProperty, StyleOptions } from "./wordJsonModels";
-import { defaultJsonRun } from "./default";
-import striphtml from "string-strip-html";
-import logger from "../../services/logger";
-
-const replaceBr = ({ tag, deleteFrom, deleteTo, rangesArr }) => {
-  if (tag.name === `br`) {
-    rangesArr.push(deleteFrom, deleteTo, "\n");
-  } else {
-    rangesArr.push(deleteFrom, deleteTo, " ");
-  }
-};
-
-export default class JSONRun {
-  runs: Run[];
-
-  constructor(value: string, styles: StyleOptions, fieldtype?: string) {
-    this.runs = this.generateJsonRun(value, styles, fieldtype);
-  } //constructor
-
-  generateJsonRun(value: string, style: StyleOptions, fieldtype?: string): Run[] {
-    let runs: Run[] = [];
-    let rowArray;
-    try {
-      rowArray = value.split("\n");
-      //try iterating the array
-      rowArray.forEach((text, i) => {
-        let run: Run = defaultJsonRun;
-        if (fieldtype !== "SuiteHeaderParagraphTitle") {
-          text = `${striphtml(text.toString(), { cb: replaceBr })}` || "";
-      }
-        run.text = text;
-        run.Bold = style.isBold;
-        run.Italic = style.IsItalic;
-        run.Underline = style.IsUnderline;
-        run.Size = style.Size;
-        if (run.Uri === "") {
-          run.Uri = null;
-        } else {
-          run.Uri = style.Uri;
-        }
-        run.Font = style.Font;
-        if (rowArray.length == 1) {
-          run.InsertLineBreak = style.InsertLineBreak;
-        } else {
-          run.InsertLineBreak = false;
-        }
-        if (rowArray.length - 1 == i) {
-          run.InsertLineBreak = style.InsertLineBreak;
-        }
-        run.InsertSpace = style.InsertSpace;
-        runs.push(JSON.parse(JSON.stringify(run)));
-      });
-    } catch (e) {
-      logger.silly(`${value} - cannot be splitted`);
-      runs[0] = defaultJsonRun;
-      runs[0].text = value
-        ? `${striphtml(value.toString(), { cb: replaceBr })}`
-        : ``;
-      runs[0].Bold = style.isBold;
-      runs[0].Italic = style.IsItalic;
-      runs[0].Underline = style.IsUnderline;
-      runs[0].Size = style.Size;
-      if (runs[0].Uri === "") {
-        runs[0].Uri = null;
-      } else {
-        runs[0].Uri = style.Uri;
-      }
-      runs[0].Font = style.Font;
-      runs[0].InsertLineBreak = style.InsertLineBreak;
-      runs[0].InsertSpace = style.InsertSpace;
-    }
-
-    return runs;
-  } //generateJsonRun
-
-  getRun(): Run[] {
-    return this.runs;
-  }
-} //class
+import { Run, WIProperty, StyleOptions } from "./wordJsonModels";
+import { defaultJsonRun } from "./default";
+import striphtml from "string-strip-html";
+import logger from "../../services/logger";
+
+const replaceBr = ({ tag, deleteFrom, deleteTo, rangesArr }) => {
+  if (tag.name === `br`) {
+    rangesArr.push(deleteFrom, deleteTo, "\n");
+  } else {
+    rangesArr.push(deleteFrom, deleteTo, " ");
+  }
+};
+
+export default class JSONRun {
+  runs: Run[];
+
+  constructor(value: string, styles: StyleOptions, fieldtype?: string) {
+    this.runs = this.generateJsonRun(value, styles, fieldtype);
+  } //constructor
+
+  generateJsonRun(value: string, style: StyleOptions, fieldtype?: string): Run[] {
+    let runs: Run[] = [];
+    let rowArray;
+    try {
+      rowArray = value.split("\n");
+      //try iterating the array
+      rowArray.forEach((text, i) => {
+        let run: Run = defaultJsonRun;
+        if (fieldtype !== "SuiteHeaderParagraphTitle") {
+          text = `${striphtml(text.toString(), { cb: replaceBr })}` || "";
+      }
+        run.text = text;
+        run.Bold = style.isBold;
+        run.Italic = style.IsItalic;
+        run.Underline = style.IsUnderline;
+        run.Size = style.Size;
+        if (run.Uri === "") {
+          run.Uri = null;
+        } else {
+          run.Uri = style.Uri;
+        }
+        run.Font = style.Font;
+        if (rowArray.length == 1) {
+          run.InsertLineBreak = style.InsertLineBreak;
+        } else {
+          run.InsertLineBreak = false;
+        }
+        if (rowArray.length - 1 == i) {
+          run.InsertLineBreak = style.InsertLineBreak;
+        }
+        run.InsertSpace = style.InsertSpace;
+        runs.push(JSON.parse(JSON.stringify(run)));
+      });
+    } catch (e) {
+      logger.silly(`${value} - cannot be splitted`);
+      runs[0] = defaultJsonRun;
+      runs[0].text = value
+        ? `${striphtml(value.toString(), { cb: replaceBr })}`
+        : ``;
+      runs[0].Bold = style.isBold;
+      runs[0].Italic = style.IsItalic;
+      runs[0].Underline = style.IsUnderline;
+      runs[0].Size = style.Size;
+      if (runs[0].Uri === "") {
+        runs[0].Uri = null;
+      } else {
+        runs[0].Uri = style.Uri;
+      }
+      runs[0].Font = style.Font;
+      runs[0].InsertLineBreak = style.InsertLineBreak;
+      runs[0].InsertSpace = style.InsertSpace;
+    }
+
+    return runs;
+  } //generateJsonRun
+
+  getRun(): Run[] {
+    return this.runs;
+  }
+} //class

package/src/models/json/default.ts

@@ -1,24 +1,24 @@
-import { Run, StyleOptions } from "./wordJsonModels";
-
-export let defaultJsonRun: Run = {
-  text: ``,
-  Bold: false,
-  Italic: false,
-  Underline: false,
-  Size: 12,
-  Uri: null,
-  Font: "Arial",
-  InsertLineBreak: false,
-  InsertSpace: true
-};
-
-export let DescriptionandProcedureStyle: StyleOptions = {
-  isBold: true,
-  IsItalic: false,
-  IsUnderline: true,
-  Size: 12,
-  Uri: null,
-  Font: "Arial",
-  InsertLineBreak: false,
-  InsertSpace: false,
+import { Run, StyleOptions } from "./wordJsonModels";
+
+export let defaultJsonRun: Run = {
+  text: ``,
+  Bold: false,
+  Italic: false,
+  Underline: false,
+  Size: 12,
+  Uri: null,
+  Font: "Arial",
+  InsertLineBreak: false,
+  InsertSpace: true
+};
+
+export let DescriptionandProcedureStyle: StyleOptions = {
+  isBold: true,
+  IsItalic: false,
+  IsUnderline: true,
+  Size: 12,
+  Uri: null,
+  Font: "Arial",
+  InsertLineBreak: false,
+  InsertSpace: false,
 };

package/src/models/json/html/JSONHtml.ts

@@ -1,13 +1,13 @@
-import { JsonHtml } from "../wordJsonModels";
-import JSONRun from "../JSONRun";
-
-export default class JSONHtml {
-  htmlString: string = "";
-  constructor(htmlString: string) {
-    this.htmlString = htmlString;
-  } //constructor
-
-  getJSONHtml(): JsonHtml {
-    return { type: "html", Html: this.htmlString };
-  } //getJSONTable
-} //class
+import { JsonHtml } from "../wordJsonModels";
+import JSONRun from "../JSONRun";
+
+export default class JSONHtml {
+  htmlString: string = "";
+  constructor(htmlString: string) {
+    this.htmlString = htmlString;
+  } //constructor
+
+  getJSONHtml(): JsonHtml {
+    return { type: "html", Html: this.htmlString };
+  } //getJSONTable
+} //class

package/src/models/json/paragraph/JSONParagraph.ts

@@ -1,76 +1,76 @@
-import {
-  Paragraph,
-  Run,
-  WIData,
-  WIProperty,
-  StyleOptions,
-} from "../wordJsonModels";
-import JSONRun from "../JSONRun";
-
-export default class JSONParagraph {
-  paragraphStyles: StyleOptions;
-  paragraphTemplate: Paragraph;
-  wiId: number;
-  constructor(
-    field: WIProperty,
-    paragraphStyles: StyleOptions,
-    wiId: number,
-    headingLevel: number
-  ) {
-    this.paragraphStyles = paragraphStyles;
-    this.wiId = wiId;
-    this.paragraphTemplate = {
-      type: "paragraph",
-      runs: this.generateJsonParagraphRun(field, this.paragraphStyles),
-    };
-    if (headingLevel && field.name === "Title: ") {
-      this.paragraphTemplate.headingLevel = headingLevel;
-    } else {
-      this.paragraphTemplate.headingLevel = 0;
-    }
-  } //constructor
-
-  generateJsonParagraphRun(field: WIProperty, paragraphStyles): Run[] {
-    let jsonRun: JSONRun;
-    let runs: Run[] = [];
-    let titleStyle = JSON.parse(JSON.stringify(paragraphStyles));
-
-    titleStyle.isBold = false;
-    titleStyle.IsUnderline = true;
-    titleStyle.InsertSpace = true;
-    titleStyle.InsertLineBreak = false;
-    //adds ':' to field titles
-    if (field.name !== "") {
-      field.name += ": ";
-    }
-    //exclude titles for fields that only show values
-    if (
-      field.name !== "Title: " &&
-      field.name !== "ID: " &&
-      field.name !== "Description: " &&
-      field.name !== "text: "
-    ) {
-      paragraphStyles.Uri = field.url;
-      jsonRun = new JSONRun(field.name, titleStyle);
-      runs = [...runs, ...jsonRun.runs];
-
-      paragraphStyles.InsertLineBreak = false;
-    } //end if
-
-    if (field.name === "Title: ") {
-      paragraphStyles.Uri = field.url;
-      paragraphStyles.InsertLineBreak = false;
-      jsonRun = new JSONRun(field.value, paragraphStyles);
-      runs = [...runs, ...jsonRun.runs];
-    } else {
-      paragraphStyles.Uri = field.url;
-      jsonRun = new JSONRun(field.value, paragraphStyles);
-      runs = [...runs, ...jsonRun.runs];
-    }
-    return runs;
-  } //generateJsonParagraph
-
-  getJSONParagraph(): Paragraph {
-    return this.paragraphTemplate;
-  } //getJSONTable
-} //class
+import {
+  Paragraph,
+  Run,
+  WIData,
+  WIProperty,
+  StyleOptions,
+} from "../wordJsonModels";
+import JSONRun from "../JSONRun";
+
+export default class JSONParagraph {
+  paragraphStyles: StyleOptions;
+  paragraphTemplate: Paragraph;
+  wiId: number;
+  constructor(
+    field: WIProperty,
+    paragraphStyles: StyleOptions,
+    wiId: number,
+    headingLevel: number
+  ) {
+    this.paragraphStyles = paragraphStyles;
+    this.wiId = wiId;
+    this.paragraphTemplate = {
+      type: "paragraph",
+      runs: this.generateJsonParagraphRun(field, this.paragraphStyles),
+    };
+    if (headingLevel && field.name === "Title: ") {
+      this.paragraphTemplate.headingLevel = headingLevel;
+    } else {
+      this.paragraphTemplate.headingLevel = 0;
+    }
+  } //constructor
+
+  generateJsonParagraphRun(field: WIProperty, paragraphStyles): Run[] {
+    let jsonRun: JSONRun;
+    let runs: Run[] = [];
+    let titleStyle = JSON.parse(JSON.stringify(paragraphStyles));
+
+    titleStyle.isBold = false;
+    titleStyle.IsUnderline = true;
+    titleStyle.InsertSpace = true;
+    titleStyle.InsertLineBreak = false;
+    //adds ':' to field titles
+    if (field.name !== "") {
+      field.name += ": ";
+    }
+    //exclude titles for fields that only show values
+    if (
+      field.name !== "Title: " &&
+      field.name !== "ID: " &&
+      field.name !== "Description: " &&
+      field.name !== "text: "
+    ) {
+      paragraphStyles.Uri = field.url;
+      jsonRun = new JSONRun(field.name, titleStyle);
+      runs = [...runs, ...jsonRun.runs];
+
+      paragraphStyles.InsertLineBreak = false;
+    } //end if
+
+    if (field.name === "Title: ") {
+      paragraphStyles.Uri = field.url;
+      paragraphStyles.InsertLineBreak = false;
+      jsonRun = new JSONRun(field.value, paragraphStyles);
+      runs = [...runs, ...jsonRun.runs];
+    } else {
+      paragraphStyles.Uri = field.url;
+      jsonRun = new JSONRun(field.value, paragraphStyles);
+      runs = [...runs, ...jsonRun.runs];
+    }
+    return runs;
+  } //generateJsonParagraph
+
+  getJSONParagraph(): Paragraph {
+    return this.paragraphTemplate;
+  } //getJSONTable
+} //class

package/src/models/json/paragraph/JSONRichTextParagraph.ts

@@ -1,84 +1,84 @@
-import { Run, WIProperty, StyleOptions } from "../wordJsonModels";
-import JSONHtml from "../html/JSONHtml";
-import JSONParagraph from "./JSONParagraph";
-import JSONTable from "../table/JSONTable";
-import logger from "../../../services/logger";
-
-export default class JSONRichTextParagraph {
-  paragraphStyles: StyleOptions;
-  paragraphTemplate: any;
-  wiId: number;
-  constructor(
-    field: WIProperty,
-    paragraphStyles: StyleOptions,
-    wiId: number,
-    headingLevel: number
-  ) {
-    this.paragraphStyles = paragraphStyles;
-    this.wiId = wiId;
-    this.paragraphTemplate = this.generateJsonRichTextParagraphs(
-      field,
-      this.paragraphStyles
-    );
-    if (headingLevel && field.name === "Title: ") {
-      this.paragraphTemplate.headingLevel = headingLevel;
-    } else {
-      this.paragraphTemplate.headingLevel = 0;
-    }
-  } //constructor
-
-  generateJsonRichTextParagraphs(field: WIProperty, paragraphStyles): Run[] {
-    let titleStyle = JSON.parse(JSON.stringify(paragraphStyles));
-
-    titleStyle.isBold = true;
-    titleStyle.IsUnderline = true;
-    titleStyle.InsertSpace = true;
-    titleStyle.InsertLineBreak = false;
-
-    let richTextSkin: any[] = [];
-    //handle rich text
-    try {
-      field.richText.forEach((content) => {
-        switch (content.type) {
-          case "paragraph":
-            content.data.fields.forEach((richTextField: WIProperty) => {
-              if (/<\/?[a-z][\s\S]*>/.test(richTextField.value)) {
-                let html = new JSONHtml(richTextField.value);
-                richTextSkin.push(html.getJSONHtml());
-              } else {
-                //making sure ID is not printed
-                let paragraphSkin = new JSONParagraph(
-                  richTextField,
-                  paragraphStyles,
-                  0,
-                  0
-                );
-                richTextSkin.push(paragraphSkin.getJSONParagraph());
-              }
-            });
-            break;
-          case "picture":
-            richTextSkin.push({
-              type: "picture",
-              Path: content.data,
-            });
-            break;
-          case "table":
-            if (content.data) {
-              let tableSkin = new JSONTable(content.data, paragraphStyles, 0);
-              richTextSkin.push(tableSkin.getJSONTable());
-            }
-            break;
-        }
-      });
-      return richTextSkin;
-    } catch (e) {
-      logger.warn(e);
-      return [];
-    }
-  } //generateJsonRichTextParagraphs
-
-  getJSONRichTextParagraph(): any[] {
-    return this.paragraphTemplate;
-  } //getJSONTable
-} //class
+import { Run, WIProperty, StyleOptions } from "../wordJsonModels";
+import JSONHtml from "../html/JSONHtml";
+import JSONParagraph from "./JSONParagraph";
+import JSONTable from "../table/JSONTable";
+import logger from "../../../services/logger";
+
+export default class JSONRichTextParagraph {
+  paragraphStyles: StyleOptions;
+  paragraphTemplate: any;
+  wiId: number;
+  constructor(
+    field: WIProperty,
+    paragraphStyles: StyleOptions,
+    wiId: number,
+    headingLevel: number
+  ) {
+    this.paragraphStyles = paragraphStyles;
+    this.wiId = wiId;
+    this.paragraphTemplate = this.generateJsonRichTextParagraphs(
+      field,
+      this.paragraphStyles
+    );
+    if (headingLevel && field.name === "Title: ") {
+      this.paragraphTemplate.headingLevel = headingLevel;
+    } else {
+      this.paragraphTemplate.headingLevel = 0;
+    }
+  } //constructor
+
+  generateJsonRichTextParagraphs(field: WIProperty, paragraphStyles): Run[] {
+    let titleStyle = JSON.parse(JSON.stringify(paragraphStyles));
+
+    titleStyle.isBold = true;
+    titleStyle.IsUnderline = true;
+    titleStyle.InsertSpace = true;
+    titleStyle.InsertLineBreak = false;
+
+    let richTextSkin: any[] = [];
+    //handle rich text
+    try {
+      field.richText.forEach((content) => {
+        switch (content.type) {
+          case "paragraph":
+            content.data.fields.forEach((richTextField: WIProperty) => {
+              if (/<\/?[a-z][\s\S]*>/.test(richTextField.value)) {
+                let html = new JSONHtml(richTextField.value);
+                richTextSkin.push(html.getJSONHtml());
+              } else {
+                //making sure ID is not printed
+                let paragraphSkin = new JSONParagraph(
+                  richTextField,
+                  paragraphStyles,
+                  0,
+                  0
+                );
+                richTextSkin.push(paragraphSkin.getJSONParagraph());
+              }
+            });
+            break;
+          case "picture":
+            richTextSkin.push({
+              type: "picture",
+              Path: content.data,
+            });
+            break;
+          case "table":
+            if (content.data) {
+              let tableSkin = new JSONTable(content.data, paragraphStyles, 0);
+              richTextSkin.push(tableSkin.getJSONTable());
+            }
+            break;
+        }
+      });
+      return richTextSkin;
+    } catch (e) {
+      logger.warn(e);
+      return [];
+    }
+  } //generateJsonRichTextParagraphs
+
+  getJSONRichTextParagraph(): any[] {
+    return this.paragraphTemplate;
+  } //getJSONTable
+} //class