@elisra-devops/docgen-skins 0.4.0 → 0.5.0

package/src/models/json/table/JSONTableCell.ts

@@ -1,79 +1,83 @@
-import { extname } from "path";
+import { extname } from 'path';
 import {
   TableCell,
+  Shading,
   Run,
   Attachment,
   WIProperty,
   MultipeValuesWIProperty,
   StyleOptions,
   JsonHtml,
-} from "../wordJsonModels";
-import JSONRun from "../JSONRun";
-import logger from "../../../services/logger";
+} from '../wordJsonModels';
+import JSONRun from '../JSONRun';
+import logger from '../../../services/logger';
 
 export default class JSONTableCell {
   cell: TableCell;
-  constructor(data: WIProperty, tableStyles: StyleOptions) {
-    this.cell = this.generateJsonCell(data, tableStyles);
+  constructor(data: WIProperty, tableStyles: StyleOptions, retrieveOriginal = false, shading = undefined) {
+    this.cell = this.generateJsonCell(data, tableStyles, retrieveOriginal, shading);
+  }
+
+  private removeFileExtension(filePath) {
+    const lastDotIndex = filePath.lastIndexOf('.');
+    if (lastDotIndex > 0) {
+      return filePath.slice(0, lastDotIndex);
+    }
+    return filePath; // If there's no extension, return the original file path
   }
 
   generateJsonCell(
     data: WIProperty | MultipeValuesWIProperty,
-    styles
+    styles,
+    retrieveOriginal,
+    shading: Shading
   ): TableCell {
     let runs: Run[] = [];
     let attachments: Attachment[] = [];
-    let HtmlData: string = ""
-
+    let HtmlData: string = '';
     //multiple values
-    if (
-      typeof data.value !== "string" &&
-      typeof data.value !== "number" &&
-      data.value
-    ) {
+    if (typeof data.value !== 'string' && typeof data.value !== 'number' && data.value) {
       data.value.forEach((runData) => {
         //check if photo type
-        if (this.isPictureUri(runData.tableCellAttachmentLink)) {
-          let attachment = {
-            type: "Picture",
-            path: runData.tableCellAttachmentLink,
-          };
-          attachments.push(attachment);
-        } 
-        else if(/<[^>]*>/.test(runData.value)) {
-          HtmlData = runData.value || "";
-        }
-        else {
-          styles.Uri = runData.relativeUrl
-            ? runData.relativeUrl
-            : runData.Uri
-            ? runData.Uri
-            : null;
+        if (runData.attachmentLink) {
+          let attachmentLink = retrieveOriginal ? runData.attachmentLink : runData.tableCellAttachmentLink;
+          if (this.isPictureUri(attachmentLink)) {
+            let attachment = {
+              type: 'Picture',
+              path: attachmentLink,
+              name: this.removeFileExtension(runData.attachmentFileName),
+            };
+            attachments.push(attachment);
+          } else {
+            let attachment = {
+              type: 'File',
+              path: runData.attachmentLink,
+              name: this.removeFileExtension(runData.attachmentFileName),
+            };
+            attachments.push(attachment);
+          }
+        } else if (/<[^>]*>/.test(runData.value)) {
+          HtmlData = runData.value || '';
+        } else {
+          styles.Uri = runData.relativeUrl ? runData.relativeUrl : runData.Uri ? runData.Uri : null;
           styles.InsertLineBreak = false;
           let jsonRun = new JSONRun(runData.value, styles);
           runs = [...runs, ...jsonRun.getRun()];
         }
       });
-    }
-    else if(/<[^>]*>/.test(data.value)) {
-      HtmlData = data.value || "";
-    }
-     else {
-      styles.Uri = data.relativeUrl
-        ? data.relativeUrl
-        : data.url
-        ? data.url
-        : null;
-      let text = data.value || "";
+    } else if (/<[^>]*>/.test(data.value)) {
+      HtmlData = data.value || '';
+    } else {
+      styles.Uri = data.relativeUrl ? data.relativeUrl : data.url ? data.url : null;
+      let text = data.value || '';
       let jsonRun = new JSONRun(`${text}`, styles);
       runs = [...runs, ...jsonRun.getRun()];
     }
-    if (HtmlData!= "")
-    {
-      let Html:JsonHtml = {
-        type:"html",
-        Html:HtmlData
-      }
+    if (HtmlData != '') {
+      let Html: JsonHtml = {
+        type: 'html',
+        Html: HtmlData,
+      };
       return {
         attachments: attachments,
         Paragraphs: [
@@ -81,26 +85,32 @@ export default class JSONTableCell {
             Runs: runs,
           },
         ],
-        Html
+        Html,
+        shading: shading,
       };
-    }
-    else{
+    } else {
       return {
         attachments: attachments,
-      Paragraphs: [
-        {
-          Runs: runs,
-        },
-      ],
-    };
-  }
-} //generateJsonCells
+        Paragraphs: [
+          {
+            Runs: runs,
+          },
+        ],
+        shading: shading,
+      };
+    }
+  } //generateJsonCells
 
   isPictureUri(uri: string) {
     try {
       let fileExt = extname(uri);
       logger.debug(`attachment extension: ${fileExt}`);
-      if (fileExt == ".PNG" || fileExt == ".jpg") {
+      if (
+        fileExt.toUpperCase() == '.PNG' ||
+        fileExt.toUpperCase() == '.JPG' ||
+        fileExt.toUpperCase() == '.JPEG' ||
+        fileExt.toUpperCase() == '.GIF'
+      ) {
         return true;
       } else {
         return false;

package/src/models/json/table/JSONTableRow.ts

@@ -1,27 +1,26 @@
-import {
-  TableRow,
-  TableCell,
-  WIData,
-  WIProperty,
-  StyleOptions
-} from "../wordJsonModels";
-import JSONTableCell from "./JSONTableCell";
+import { TableRow, TableCell, WIData, WIProperty, StyleOptions, Shading } from '../wordJsonModels';
+import JSONTableCell from './JSONTableCell';
 
 export default class JSONTableRow {
   row: TableRow;
 
-  constructor(data: WIData, tableStyles: StyleOptions) {
-    this.row = this.generateJsonRow(data, tableStyles);
+  constructor(
+    data: WIData,
+    tableStyles: StyleOptions,
+    retrieveOriginal = false,
+    shading: Shading = undefined
+  ) {
+    this.row = this.generateJsonRow(data, tableStyles, retrieveOriginal, shading);
   } //constructor
 
-  generateJsonRow(data: WIData, styles: StyleOptions): TableRow {
+  generateJsonRow(data: WIData, styles: StyleOptions, retrieveOriginal: boolean, shading: Shading): TableRow {
     let tableCells: TableCell[] = [];
 
     data.fields.forEach((wiProperty: WIProperty) => {
-      if (wiProperty.name === "id") {
+      if (wiProperty.name === 'id') {
         styles.Uri = data.url;
       }
-      let jsonTableCell = new JSONTableCell(wiProperty, styles);
+      let jsonTableCell = new JSONTableCell(wiProperty, styles, retrieveOriginal, shading);
       tableCells.push(JSON.parse(JSON.stringify(jsonTableCell.getJsonCell())));
     });
 

package/src/models/json/wordJsonModels.ts

@@ -28,10 +28,18 @@ export interface TableCell {
   Paragraphs: [
     {
       Runs: Run[];
-    }
+    },
   ];
-  Html?:JsonHtml
+  shading?: Shading;
+  Html?: JsonHtml;
 }
+
+export interface Shading {
+  color: string;
+  fill: string;
+  themeFillShade: string;
+}
+
 export interface Paragraph {
   type: string;
   headingLevel?: number;

package/src/snippets/free-runs.ts

@@ -1,23 +1,35 @@
-import Skins from "../index";
+import Skins from '../index';
 
 let main = async () => {
+  let headerStyles = {
+    isBold: true,
+    IsItalic: false,
+    IsUnderline: false,
+    Size: 12,
+    Uri: null,
+    Font: 'Arial',
+    InsertLineBreak: false,
+    InsertSpace: true,
+  };
+
   let styles = {
     isBold: false,
     IsItalic: false,
     IsUnderline: false,
     Size: 12,
     Uri: null,
-    Font: "Arial",
+    Font: 'Arial',
     InsertLineBreak: false,
     InsertSpace: true,
   };
 
-  let skins = new Skins("json", "c:\test.dotx");
-  const QueryData = require("../../samples/mock-data/queries/flat-query-data.json");
+  let skins = new Skins('json', 'c:\test.dotx');
+  const QueryData = require('../../samples/mock-data/queries/flat-query-data.json');
   await skins.addNewContentToDocumentSkin(
-    "test",
+    'test',
     skins.SKIN_TYPE_PARAGRAPH,
     QueryData,
+    headerStyles,
     styles,
     4
   );

package/src/test/skins.test.ts

@@ -1,5 +1,5 @@
-import { writeFileSync } from "fs";
-import Skins from "../index";
+import { writeFileSync } from 'fs';
+import Skins from '../index';
 jest.setTimeout(300000);
 const styles = {
   isBold: false,
@@ -7,47 +7,61 @@ const styles = {
   IsUnderline: false,
   Size: 10,
   Uri: null,
-  Font: "New Times Roman",
+  Font: 'New Times Roman',
   InsertLineBreak: true,
   InsertSpace: true,
 };
 
-describe("Generate json skins from queries - tests", () => {
-  test("generate table skin - flat query", async () => {
-    let skins = new Skins("json", "c:\test.dotx");
-    const QueryData = require("../../samples/mock-data/queries/flat-query-data.json");
+const headerStyles = {
+  isBold: true,
+  IsItalic: false,
+  IsUnderline: false,
+  Size: 12,
+  Uri: null,
+  Font: 'Arial',
+  InsertLineBreak: false,
+  InsertSpace: true,
+};
+
+describe('Generate json skins from queries - tests', () => {
+  test('generate table skin - flat query', async () => {
+    let skins = new Skins('json', 'c:\test.dotx');
+    const QueryData = require('../../samples/mock-data/queries/flat-query-data.json');
     await skins.addNewContentToDocumentSkin(
-      "test",
+      'test',
       skins.SKIN_TYPE_TABLE,
       QueryData,
+      headerStyles,
       styles,
       4
     );
     const documentSkin: any = skins.getDocumentSkin();
-    const SnapShot = require("../../samples/snapshots/queries/flat-query-table-snapshot.json");
+    const SnapShot = require('../../samples/snapshots/queries/flat-query-table-snapshot.json');
     expect(documentSkin).toMatchObject(SnapShot);
   });
-  test("generate table skin - tree query", async () => {
-    let skins = new Skins("json", "c:\test.dotx");
-    const QueryData = require("../../samples/mock-data/queries/tree-query-data.json");
+  test('generate table skin - tree query', async () => {
+    let skins = new Skins('json', 'c:\test.dotx');
+    const QueryData = require('../../samples/mock-data/queries/tree-query-data.json');
     await skins.addNewContentToDocumentSkin(
-      "test",
+      'test',
       skins.SKIN_TYPE_TABLE,
       QueryData,
+      headerStyles,
       styles,
       4
     );
     const documentSkin: any = skins.getDocumentSkin();
-    const SnapShot = require("../../samples/snapshots/queries/tree-query-table-snapshot.json");
+    const SnapShot = require('../../samples/snapshots/queries/tree-query-table-snapshot.json');
     expect(documentSkin).toMatchObject(SnapShot);
   });
-  test("generate paragraph skin - flat query", async () => {
-    let skins = new Skins("json", "c:\test.dotx");
-    const QueryData = require("../../samples/mock-data/queries/flat-query-data.json");
+  test('generate paragraph skin - flat query', async () => {
+    let skins = new Skins('json', 'c:\test.dotx');
+    const QueryData = require('../../samples/mock-data/queries/flat-query-data.json');
     await skins.addNewContentToDocumentSkin(
-      "test",
+      'test',
       skins.SKIN_TYPE_PARAGRAPH,
       QueryData,
+      headerStyles,
       styles,
       4
     );
@@ -56,116 +70,120 @@ describe("Generate json skins from queries - tests", () => {
     //   "flat-query-paragraph-snapshot.json",
     //   JSON.stringify(documentSkin)
     // );
-    const SnapShot = require("../../samples/snapshots/queries/flat-query-paragraph-snapshot.json");
+    const SnapShot = require('../../samples/snapshots/queries/flat-query-paragraph-snapshot.json');
     expect(documentSkin).toMatchObject(SnapShot);
   });
-  test("generate paragraph skin - tree query", async () => {
-    let skins = new Skins("json", "c:\test.dotx");
-    const QueryData = require("../../samples/mock-data/queries/tree-query-data.json");
+  test('generate paragraph skin - tree query', async () => {
+    let skins = new Skins('json', 'c:\test.dotx');
+    const QueryData = require('../../samples/mock-data/queries/tree-query-data.json');
     await skins.addNewContentToDocumentSkin(
-      "test",
+      'test',
       skins.SKIN_TYPE_PARAGRAPH,
       QueryData,
+      headerStyles,
       styles,
       4
     );
     const documentSkin: any = skins.getDocumentSkin();
     // writeFileSync("tree-query-data.json", JSON.stringify(documentSkin));
-    const SnapShot = require("../../samples/snapshots/queries/tree-query-paragraph-snapshot.json");
+    const SnapShot = require('../../samples/snapshots/queries/tree-query-paragraph-snapshot.json');
     expect(documentSkin).toMatchObject(SnapShot);
   });
 });
-describe("Generate json skins from testData - tests", () => {
-  test("generate std skin - testData", async () => {
-    let skins = new Skins("json", "c:\\\\test\\\\test.dotx");
-    const QueryData = require("../../samples/mock-data/test-data/testContentData.json");
+describe('Generate json skins from testData - tests', () => {
+  test('generate std skin - testData', async () => {
+    let skins = new Skins('json', 'c:\\\\test\\\\test.dotx');
+    const QueryData = require('../../samples/mock-data/test-data/testContentData.json');
     await skins.addNewContentToDocumentSkin(
-      "system-capabilities",
+      'system-capabilities',
       skins.SKIN_TYPE_TEST_PLAN,
       QueryData,
+      headerStyles,
       styles,
       4
     );
     const documentSkin: any = skins.getDocumentSkin();
 
-    const SnapShot = require("../../samples/snapshots/tests/flat-test-std-snapshot.json");
+    const SnapShot = require('../../samples/snapshots/tests/flat-test-std-snapshot.json');
     expect(documentSkin).toMatchObject(SnapShot);
   });
-  test("generate std skin - complex testData", async () => {
-    let skins = new Skins(
-      "json",
-      "C:\\\\docgen\\\\documents\\\\181020205911\\\\test.dotx"
-    );
-    const QueryData = require("../../samples/mock-data/test-data/complex-test-data-with-attachments.json");
+  test('generate std skin - complex testData', async () => {
+    let skins = new Skins('json', 'C:\\\\docgen\\\\documents\\\\181020205911\\\\test.dotx');
+    const QueryData = require('../../samples/mock-data/test-data/complex-test-data-with-attachments.json');
     await skins.addNewContentToDocumentSkin(
-      "system-capabilities",
+      'system-capabilities',
       skins.SKIN_TYPE_TEST_PLAN,
       QueryData,
+      headerStyles,
       styles,
       4
     );
     const documentSkin: any = skins.getDocumentSkin();
-    const SnapShot = require("../../samples/snapshots/tests/complex-test-std-snapshot.json");
+    const SnapShot = require('../../samples/snapshots/tests/complex-test-std-snapshot.json');
     expect(documentSkin).toMatchObject(SnapShot);
   });
-  test("generate trace table skin", async () => {
-    let skins = new Skins("json", "c:\\test\\test.dotx");
-    const QueryData = require("../../samples/mock-data/test-data/test-trace-table-data.json");
+  test('generate trace table skin', async () => {
+    let skins = new Skins('json', 'c:\\test\\test.dotx');
+    const QueryData = require('../../samples/mock-data/test-data/test-trace-table-data.json');
 
     await skins.addNewContentToDocumentSkin(
-      "system-capabilities",
+      'system-capabilities',
       skins.SKIN_TYPE_TABLE,
       QueryData,
+      headerStyles,
       styles,
       4
     );
     const documentSkin: any = skins.getDocumentSkin();
-    const SnapShot = require("../../samples/snapshots/tests/test-trace-table-snapshot.json");
+    const SnapShot = require('../../samples/snapshots/tests/test-trace-table-snapshot.json');
     expect(documentSkin).toMatchObject(SnapShot);
   });
 });
-describe("Generate json skins svd - tests", () => {
-  test("generate changes between releases skin", async () => {
-    let skins = new Skins("json", "c:\\test\\test.dotx");
-    const adoptedChangesData = require("../../samples/mock-data/changes/adoptedChanges.json");
+describe('Generate json skins svd - tests', () => {
+  test('generate changes between releases skin', async () => {
+    let skins = new Skins('json', 'c:\\test\\test.dotx');
+    const adoptedChangesData = require('../../samples/mock-data/changes/adoptedChanges.json');
 
     for (let i = 0; i < adoptedChangesData.length; i++) {
       let artifactChangesData = adoptedChangesData[i];
       await skins.addNewContentToDocumentSkin(
-        "change-description-content-control",
+        'change-description-content-control',
         skins.SKIN_TYPE_PARAGRAPH,
         artifactChangesData.artifact,
+        headerStyles,
         styles,
         4
       );
 
       await skins.addNewContentToDocumentSkin(
-        "change-description-content-control",
+        'change-description-content-control',
         skins.SKIN_TYPE_TABLE,
         artifactChangesData.artifactChanges,
+        headerStyles,
         styles,
         4
       );
     }
 
     const documentSkin: any = skins.getDocumentSkin();
-    const SnapShot = require("../../samples/snapshots/changes/changes-table-release-snapshot.json");
+    const SnapShot = require('../../samples/snapshots/changes/changes-table-release-snapshot.json');
     expect(documentSkin).toMatchObject(SnapShot);
   });
 });
-describe("Common functions - tests", () => {
-  test("generate richText skin", async () => {
-    let skins = new Skins("json", "c:\\\\test\\\\test.dotx");
-    const QueryData = require("../../samples/mock-data/test-data/testContentDataWithRichText.json");
+describe('Common functions - tests', () => {
+  test('generate richText skin', async () => {
+    let skins = new Skins('json', 'c:\\\\test\\\\test.dotx');
+    const QueryData = require('../../samples/mock-data/test-data/testContentDataWithRichText.json');
     await skins.addNewContentToDocumentSkin(
-      "system-capabilities",
+      'system-capabilities',
       skins.SKIN_TYPE_TEST_PLAN,
       QueryData,
+      headerStyles,
       styles,
       4
     );
     const documentSkin: any = skins.getDocumentSkin();
-    const SnapShot = require("../../samples/snapshots/common/rich-text-test-std.json");
+    const SnapShot = require('../../samples/snapshots/common/rich-text-test-std.json');
     expect(documentSkin).toMatchObject(SnapShot);
   });
 });