@elisra-devops/docgen-skins 0.3.3

package/.github/sonar-project.properties

@@ -0,0 +1,5 @@
+sonar.sources=src
+sonar.language=typescript
+# sonar.javascript.lcov.reportPaths=coverage\SonarQube.xml
+# sonar.typescript.lcov.reportPaths=coverage\SonarQube.xml
+sonar.coverageReportPaths=coverage/SonarQube.xml

package/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: "🚀 ci"
+
+on: [pull_request]
+
+jobs:
+  build_and_test:
+    name: 🚀 build  and test
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📚 checkout
+        uses: actions/checkout@v2
+      - name: 🟢 node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org
+      - run: npm install
+      - run: npm run build
+        env:
+          ORG_URL: ${{secrets.AZDO_ORG_URL}}
+          PAT: ${{secrets.AZDO_PAT}}

package/.github/workflows/release.yml

@@ -0,0 +1,31 @@
+name: "🚀 publish"
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: 🚀 publish
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📚 checkout
+        uses: actions/checkout@v2
+      - name: 🟢 node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org
+      - run: npm install
+      - run: npm run build
+      - name: "Automated Version Bump"
+        uses: "phips28/gh-action-bump-version@master"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          commit-message: "CI: bumps version to {{version}} [skip ci]"
+      - name: 🚀 publish
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}

package/Readme.md

@@ -0,0 +1,6 @@
+# Skins for Docgen JSON
+
+Can be outputed in various types:
+
+- JSON - default
+- HTML

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@elisra-devops/docgen-skins",
+  "version": "0.3.3",
+  "description": "Can be outputed in various types:",
+  "main": "./bin/index.js",
+  "types": "./bin/index.d.ts",
+  "scripts": {
+    "start": "node ./bin/server.js",
+    "build": "tsc",
+    "test": "jest --coverage --runInBand --forceExit"
+  },
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@types/node": "^14.0.5",
+    "moment": "^2.26.0",
+    "string-strip-html": "^4.5.1",
+    "winston": "^3.2.1"
+  },
+  "devDependencies": {
+    "@types/babel__traverse": "^7.20.2",
+    "@types/jest": "^25.2.3",
+    "jest": "^25.5.4",
+    "jest-junit": "^10.0.0",
+    "ts-jest": "^25.5.1",
+    "typescript": "^5.2.2"
+  },
+  "jest": {
+    "testEnvironment": "node",
+    "preset": "ts-jest",
+    "testPathIgnorePatterns": [
+      "/bin/"
+    ],
+    "reporters": [
+      "default",
+      "jest-junit"
+    ]
+  },
+  "jest-junit": {
+    "output": "./junit.xml"
+  }
+}

package/samples/document-skins-examples/document-attchament-table.json

@@ -0,0 +1,25 @@
+{
+  "templatePath": "C:\\test\\test.dotx",
+  "contentControls": [
+    {
+      "title": "system-capabilities",
+      "wordObjects": [
+        {
+          "type": "table",
+          "rows": [
+            {
+              "cells": [
+                {
+                  "attachments": {
+                    "type": "picture",
+                    "Path": "C:\\docgen\\documents\\181020205911\\downloads\\4b63f630-d0b4-4ab8-8d60-46df23b322c9\\gif 2.PNG"
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

package/samples/document-skins-examples/documentExample.json

@@ -0,0 +1,66 @@
+{
+  "templatePath": "C:\\dev\\test.dotx",
+  "contentControls": [
+    {
+      "title": "test",
+      "wordObjects": [
+        {
+          "type": "paragraph",
+          "runs": [
+            {
+              "text": "Test!",
+              "isBold": true,
+              "IsItalic": true,
+              "IsUnderline": true,
+              "Size": 9,
+              "Uri": "http://......",
+              "Font": "Arial",
+              "InsertLineBreak": true,
+              "InsertSpace": true
+            }
+          ]
+        },
+        {
+          "type": "table",
+          "Rows": [
+            {
+              "Cells": [
+                {
+                  "Paragraphs": [
+                    {
+                      "Runs": [
+                        {
+                          "text": "Test!",
+                          "isBold": true,
+                          "IsItalic": true,
+                          "IsUnderline": true,
+                          "Size": 9,
+                          "Uri": "http://......",
+                          "Font": "Arial",
+                          "InsertLineBreak": true,
+                          "InsertSpace": true
+                        }
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "type": "file",
+          "Path": "c:\\temp\\...."
+        },
+        {
+          "type": "picture",
+          "Path": "c:\\temp\\...."
+        },
+        {
+          "type": "html",
+          "Html": "<html></html>"
+        }
+      ]
+    }
+  ]
+}

package/samples/document-skins-examples/paragraphExample.json

@@ -0,0 +1,16 @@
+{
+  "type": "paragraph",
+  "runs": [
+    {
+      "text": "Test!",
+      "isBold": true,
+      "IsItalic": true,
+      "IsUnderline": true,
+      "Size": 9,
+      "Uri": "http://......",
+      "Font": "Arial",
+      "InsertLineBreak": true,
+      "InsertSpace": true
+    }
+  ]
+}

package/samples/document-skins-examples/tableExample.json

@@ -0,0 +1,29 @@
+{
+  "type": "table",
+  "Rows": [
+    {
+      "Cells": [
+        {
+          "Paragraphs": [
+            {
+              "Runs": [
+                //for every new property we need a new run
+                {
+                  "text": "Test!",
+                  "isBold": true,
+                  "IsItalic": true,
+                  "IsUnderline": true,
+                  "Size": 9,
+                  "Uri": "http://......",
+                  "Font": "Arial",
+                  "InsertLineBreak": true,
+                  "InsertSpace": true
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

package/src/index.ts

@@ -0,0 +1,401 @@
+import {
+  DocumentSkin,
+  WIQueryResults,
+  WIData,
+  WIProperty,
+  StyleOptions,
+} from "./models/json/wordJsonModels";
+import logger from "./services/logger";
+import JSONTable from "./models/json/table/JSONTable";
+import JSONParagraph from "./models/json/paragraph/JSONParagraph";
+import JSONHeaderParagraph from "./models/json/paragraph/JSONTestSuiteHeaderParagraph";
+import JSONRichTextParagraph from "./models/json/paragraph/JSONRichTextParagraph";
+import {
+  DescriptionandProcedureStyle
+} from "./models/json/default";
+
+export default class Skins {
+  SKIN_TYPE_TABLE = "table";
+  SKIN_TYPE_PARAGRAPH = "paragraph";
+  SKIN_TYPE_TEST_PLAN = "test-plan";
+
+  documentSkin: DocumentSkin = {
+    templatePath: "",
+    contentControls: [],
+  };
+
+  skinFormat: string = "json";
+
+  constructor(skinFormat: string = "json", templatePath: string) {
+    this.documentSkin.templatePath = templatePath;
+    this.skinFormat = skinFormat;
+  }
+
+  async addNewContentToDocumentSkin(
+    contetnControlTitle: string,
+    skinType: string,
+    data: any,
+    styles: StyleOptions,
+    headingLvl: number = 0,
+    includeAttachments: boolean = true
+  ): Promise<any> {
+    try {
+      let populatedSkin;
+
+      switch (skinType) {
+        case this.SKIN_TYPE_TABLE:
+          populatedSkin = this.generateQueryBasedTable(
+            data,
+            styles,
+            headingLvl
+          );
+          if (populatedSkin === false) {
+            logger.error(
+              `Could not generate table for content control :${contetnControlTitle}`
+            );
+            return false;
+          }
+          break;
+        case this.SKIN_TYPE_PARAGRAPH:
+          populatedSkin = this.generateQueryBasedParagraphs(
+            data,
+            styles,
+            headingLvl
+          );
+          if (populatedSkin === false) {
+            logger.error(
+              `Could not generate paragraph for content control :${contetnControlTitle}`
+            );
+            return false;
+          }
+          break;
+        case this.SKIN_TYPE_TEST_PLAN:
+          populatedSkin = this.generateTestBasedSkin(
+            data,
+            styles,
+            headingLvl,
+            includeAttachments
+          );
+          if (populatedSkin === false) {
+            logger.error(
+              `Could not generate test skin for content control :${contetnControlTitle}`
+            );
+            return false;
+          }
+          break;
+        default:
+          logger.error(
+            `Unknown skinType : ${skinType} - not appended to document skin`
+          );
+          return false;
+      }
+
+      return populatedSkin;
+
+      //  await this.validateAndAppendContentControl(
+      //   contetnControlTitle,
+      //   populatedSkin
+      // );
+    } catch (error) {
+      logger.error(
+        `Fatal error happened when generate skin for : ${contetnControlTitle}`
+      );
+      return false;
+    }
+  } //addNewContentToDocumentSkin
+
+  // iterates on content controls array:
+  // if finds return true else creates content control and returns true
+  // on error returns false
+  async validateAndAppendContentControl(
+    contetnControlTitle: string,
+    populatedSkin: any
+  ): Promise<boolean> {
+    try {
+      let isContetnControlExists: boolean[] = await Promise.all(
+        this.documentSkin.contentControls.map((contentControl, i) => {
+          if (contentControl.title === contetnControlTitle) {
+            logger.debug(`Content control - ${contetnControlTitle} found on index ${i}
+          populating with: ${contetnControlTitle}`);
+            this.documentSkin.contentControls[i].wordObjects = [
+              ...this.documentSkin.contentControls[i].wordObjects,
+              ...populatedSkin,
+            ];
+            return true;
+          }
+          return false;
+        }) //.map
+      ); //Promise.all
+
+      if (!isContetnControlExists.includes(true)) {
+        let contentControlToAppend = {
+          title: contetnControlTitle,
+          wordObjects: populatedSkin,
+        };
+
+        logger.debug(`Content control - ${contetnControlTitle} not found
+           appending to document title:
+           ${JSON.stringify(contetnControlTitle)}`);
+        this.documentSkin.contentControls.unshift(contentControlToAppend);
+      }
+      logger.info(
+        `Appended new content control document:  ${contetnControlTitle}`
+      );
+      return true;
+    } catch (error) {
+      logger.error(`Error validating and appending to content control`);
+      console.log(error);
+    }
+  } //validateAndAppendContentControl
+
+  //parses data to the class skin format and returns the parsed data
+  //returns false if supplied an invalid type or error occurd during parsing
+  generateQueryBasedTable(
+    data: WIQueryResults,
+    styles: StyleOptions,
+    headingLvl: number = 0
+  ) {
+    logger.debug(`Generating table as ${this.skinFormat}`);
+
+    switch (this.skinFormat) {
+      case "json":
+        let tableSkin = new JSONTable(data, styles, headingLvl);
+        return [tableSkin.getJSONTable()];
+      case "html":
+        logger.info(`Generating html table!`);
+        break;
+      default:
+        return false;
+    } //switch
+  } //generateTable
+
+  generateQueryBasedParagraphs(
+    data: any,
+    styles: StyleOptions,
+    headingLvl: number = 0
+  ) {
+    logger.debug(`Generating paragraph as ${this.skinFormat}`);
+
+    switch (this.skinFormat) {
+      case "json":
+        let paragraphs: any[] = [];
+        data.forEach((wi: WIData) => {
+          wi.fields.forEach((field: WIProperty) => {
+            //Description and Test Description are handled in richText handler
+            if (
+              field.name === "Description: " ||
+              field.name === "Test Description:"
+            ) {       
+              let paragraphSkin = new JSONRichTextParagraph(
+                field,
+                styles,
+                wi.Source,
+                headingLvl + wi.level
+              );
+              paragraphs.push(paragraphSkin.getJSONRichTextParagraph());
+            }
+
+            //making sure ID is not printed
+            //excluding Description and Test Description are handled in richText handler
+            if (
+              field.name !== "ID" &&
+              field.name !== "Description: " &&
+              field.name !== "Test Description:"
+            ) {
+              let paragraphSkin = new JSONParagraph(
+                field,
+                styles,
+                wi.Source,
+                headingLvl + wi.level
+              );
+              paragraphs.push(paragraphSkin.getJSONParagraph());
+            }
+          });
+        });
+        return paragraphs;
+      case "html":
+        logger.info(`Generating html paragraphs!`);
+        break;
+      default:
+        return false;
+    } //switch
+  } //generateParagraph
+
+  generateTestBasedSkin(
+    data: any,
+    styles: StyleOptions,
+    headingLvl: number = 0,
+    includeAttachments: boolean = true
+  ) {
+    logger.debug(`Generating testSkin as ${this.skinFormat}`);
+    switch (this.skinFormat) {
+      case "json":
+        let testSkin: any[] = [];
+        //create suite Header pragraph
+        data.forEach((testSuite: any) => {
+          let SuiteStyles = {
+            isBold: true,
+            IsItalic: false,
+            IsUnderline: false,
+            Size: 16,
+            Uri: null,
+            Font: "Arial",
+            InsertLineBreak: false,
+            InsertSpace: true,
+          };
+          let testSuiteParagraphSkin = new JSONHeaderParagraph(
+            testSuite.suiteSkinData.fields,
+            SuiteStyles,
+            testSuite.suiteSkinData.id || 0,
+            testSuite.suiteSkinData.level
+              ? headingLvl + testSuite.suiteSkinData.level
+              : headingLvl
+              ? headingLvl
+              : 1
+          );
+          testSkin.push(testSuiteParagraphSkin.getJSONParagraph());
+
+          testSuite.testCases.forEach((testcase) => {
+            //create testcase Header paragraph
+            let testCaseHeaderFields = [
+              testcase.testCaseHeaderSkinData.fields[0],
+              testcase.testCaseHeaderSkinData.fields[1],
+            ];
+            let TestCaseStyles = {
+              isBold: true,
+              IsItalic: false,
+              IsUnderline: false,
+              Size: 14,
+              Uri: null,
+              Font: "Arial",
+              InsertLineBreak: false,
+              InsertSpace: true,
+            };
+            let testCaseParagraphSkin = new JSONHeaderParagraph(
+              testCaseHeaderFields,
+              TestCaseStyles,
+              testcase.id || 0,
+              testcase.testCaseHeaderSkinData.level
+                ? headingLvl + testcase.testCaseHeaderSkinData.level
+                : headingLvl
+                ? headingLvl
+                : 1
+            );
+            testSkin.push(testCaseParagraphSkin.getJSONParagraph());
+
+            let testDescriptionTitleParagraph = new JSONParagraph(
+              { name: "Title", value: "Test Description:" },
+              DescriptionandProcedureStyle,
+              testcase.id || 0,
+              0
+            );     
+            testSkin.push(testDescriptionTitleParagraph.getJSONParagraph());
+            let testDescriptionParagraph = new JSONRichTextParagraph(
+              testcase.testCaseHeaderSkinData.fields[2],
+              styles,
+              testcase.id || 0,
+              0
+            );
+            let richTextSkin: any[] =
+              testDescriptionParagraph.getJSONRichTextParagraph();
+            testSkin = [...testSkin, ...richTextSkin];
+            
+            if (testcase.testCaseRequirements) {
+              if (
+                testcase.testCaseRequirements.length > 0
+              ) {
+                
+                let testDescriptionTitleParagraph = new JSONParagraph(
+                  { name: "Title", value: "Covered Requirements:" },
+                  DescriptionandProcedureStyle,
+                  testcase.id || 0,
+                  0
+                );
+                testSkin.push(testDescriptionTitleParagraph.getJSONParagraph());
+                //create test steps table
+                let tableSkin = new JSONTable(
+                  testcase.testCaseRequirements,
+                  styles,
+                  headingLvl
+                );
+
+                let populatedTableSkin = tableSkin.getJSONTable();
+
+                testSkin.push(populatedTableSkin);
+              }
+            }
+            
+            try {
+              if (testcase.testCaseStepsSkinData.length > 0) {
+                let testProcedureTitleParagraph = new JSONParagraph(
+                  { name: "Title", value: "Test Procedure:" },
+                  DescriptionandProcedureStyle,
+                  testcase.id || 0,
+                  0
+                );
+                let TableContentStyles = {
+                  isBold: false,
+                  IsItalic: false,
+                  IsUnderline: false,
+                  Size: 12,
+                  Uri: null,
+                  Font: "Arial",
+                  InsertLineBreak: false,
+                  InsertSpace: true,
+                };
+                testSkin.push(testProcedureTitleParagraph.getJSONParagraph());
+                //create test steps table
+                let tableSkin = new JSONTable(
+                  testcase.testCaseStepsSkinData,
+                  TableContentStyles,
+                  headingLvl
+                );
+                let populatedTableSkin = tableSkin.getJSONTable();
+                testSkin.push(populatedTableSkin);
+              }
+            } catch (error) {
+              logger.warn(
+                `For suite id : ${testSuite.suiteSkinData.fields[0].value} , the testCaseStepsSkinData is not defined for ${testcase.testCaseHeaderSkinData.fields[0].value} `
+              );
+           }
+
+            //attachments table
+            if (testcase.testCaseAttachments) {
+              if (
+                testcase.testCaseAttachments.length > 0 &&
+                includeAttachments == true
+              ) {
+                
+                let testDescriptionTitleParagraph = new JSONParagraph(
+                  { name: "Title", value: "Test Case Attachments:" },
+                  styles,
+                  testcase.id || 0,
+                  0
+                );
+                testSkin.push(testDescriptionTitleParagraph.getJSONParagraph());
+                //create test steps table
+                let tableSkin = new JSONTable(
+                  testcase.testCaseAttachments,
+                  styles,
+                  headingLvl
+                );
+                let populatedTableSkin = tableSkin.getJSONTable();
+                testSkin.push(populatedTableSkin);
+              }
+            }
+          });
+        });
+        return testSkin;
+        break;
+      case "html":
+        logger.info(`Generating html test data!`);
+        break;
+      default:
+        return false;
+    } //switch
+  } //generateTestBasedSkin
+
+  getDocumentSkin(): DocumentSkin {
+    return this.documentSkin;
+  } //getDocumentSkin
+}