@measurequick/measurequick-report-generator 1.0.52 → 1.0.53

package/index.js

@@ -1,466 +1,12 @@
-import * as graphics from "./templates/js/graphics.js";
-import * as templates from "./templates/js/templates.js";
-import * as request from "./templates/js/request.js";
-import { PDFDocument } from 'pdf-lib';
-import * as mqStandardRawData from "./scripts/raw-data-pdf-gen/mq-standard-raw-data.js";
-import * as mqStandardFillable from "./scripts/fillable-pdf-gen/mq-standard-fillable.js";
-import * as mqSystemVitalsFillable from "./scripts/fillable-pdf-gen/mq-system-vitals-fillable.js";
+import * as mqReportGenerator from "./jspdf/mq-report-generator.js";
+import * as mqSystemVitalsReportGenerator from "./pdflib/mq-system-vitals-report-generator.js";
 
-let jsPDF = require("jspdf");
-let doc = new jsPDF(templates.docOptions);
-let reportData;
-let currentSnapshot;
-
-export function getMqStandardReport(generationMethod, payload) {
-    // let report;
-    // if      (generationMethod == "rawData")  report = mqStandardRawData.generateReport(payload);
-    // else if (generationMethod == "fillable") report = mqStandardFillable.generateReport(payload);
-    // return report;
-}
-
-export function getMqSystemVitalsReport(payload) {
-    let report = mqSystemVitalsFillable.generateReport(payload);
-    return report;
-}
-
-export async function getFillableReport() {
-    const dataUri = templates.mqStandardFillablePdfBase64;
-    const pdfDoc = await PDFDocument.load(dataUri);
-    return pdfDoc;
-}
-
-export function getReport(data=null) {
-    try {
-        reportData = (data == null) ?
-                    JSON.parse(JSON.stringify(request.body)) :
-                    JSON.parse(JSON.stringify(data));
-        let testNumber = 0;
-        for (currentSnapshot in reportData.snapshots) {
-            if (testNumber > 0) doc.addPage();
-            printBoilerPlateStandard();
-            printHeaderData();
-            printBodyData(currentSnapshot);
-            printFooterData();
-            resizeAndPrintStaticImages();
-            testNumber++;
-        }
-        printDiagnosticPage();
-        printInfoPage();
-        printPhotoPages();
-        return doc.output("datauristring");
-    } catch (e) {
-        return doc.output("datauristring");
-    }
-}
-
-function printBoilerPlateStandard() {
-    doc.addImage(graphics.headerMeasureQuick, "JPEG", 0, 0, 8.5, 1);
-    doc.addImage(graphics.footerMeasureQuick, "JPEG", 0, 7.75, 8.5, 4.5);
-    let mqLogo = graphics.companyLogoMeasureQuickLight;
-    if (reportData.meta.reportTheme == "light")
-        mqLogo = graphics.companyLogoMeasureQuickDark;
-    doc.addImage(mqLogo, "JPEG", .25, 10, 2.15625, .5);
-    doc.setLineWidth(0.025);
-    doc.setDrawColor(0);
-    doc.setFillColor(242, 242, 242);
-    doc.rect(.125, 1.125, 2.667, 3, "F");
-    doc.rect(2.917, 1.125, 2.667, 3, "F");
-    doc.rect(5.709, 1.125, 2.667, 3, "F");
-    doc.rect(.125, 4.25, 4.0625, 3.375, "F");
-    doc.addImage(graphics.iconSunshine, "JPEG", .4585, 1.625, 2, 2);
-    doc.addImage(graphics.iconHouse, "JPEG", 3.252, 1.625, 2, 2);
-    doc.addImage(graphics.iconInfo, "JPEG", 6.044, 1.625, 2, 2);
-    doc.addImage(graphics.iconPerformance, "JPEG", 1.15625, 4.9375, 2, 2);
-    doc.setFontStyle("bold");
-    doc.setFontSize(9);
-    doc.text("Outdoor Measurements", .25, 1.33);
-    doc.text("Indoor Measurements", 3.042, 1.33);
-    doc.text("Weather Data", 5.834, 1.33);
-    doc.text("Performance Calculations", .25, 4.435);
-    doc.setFontSize(8);
-    doc.text("Capacity Calculations", .25, 4.655);
-    doc.text("Air-side Performance", 2.25, 4.655);
-    doc.text("Energy Efficiency", 2.25, 5.655);
-    doc.setFontSize(6.5);
-    doc.setFontStyle("bolditalic");
-    doc.setTextColor(255, 255, 255);
-    let disclaimer = `Disclaimer: This report was prepared by your service technician who is solely responsible for its content.  This report is provided “as-is” excluding all warranties expressed or implied including without limitation the warranty of merchantability. ©2017-${new Date().getFullYear()} Manifold Cloud Services Ltd.`;
-    disclaimer = doc.splitTextToSize(disclaimer.toUpperCase(), 8);
-    doc.text(disclaimer, .125, 10.66);
-}
-
-function printBoilerPlateDiagnostic() {
-    doc.addImage(graphics.headerMeasureQuick, "JPEG", 0, 0, 8.5, 1);
-    doc.setLineWidth(0.025);
-    doc.setDrawColor(0);
-    doc.setFillColor(242, 242, 242);
-    doc.setTextColor(0, 0, 0);
-    doc.setFontSize(9);
-    doc.setFontStyle('bold');
-    doc.rect(.125, 3.3, 8.25, 7.6, "F");
-    doc.rect(.125, .6, 4.0625, 2.6, "F");
-    doc.rect(4.3125, .6, 4.0625, 2.6, "F");
-    doc.text("System Diagnostics", 4.4375, .8);
-    doc.text("Subsystem Review", .25, .8);
-    doc.text('Corrective Actions', .25, 3.5);
-    doc.setFontSize(8);
-    doc.setFontStyle('normal');
-
-}
-
-function printHeaderData() {
-    let size = 13.5;
-    do { size -= .5; } while ((doc.getStringUnitWidth(reportData.meta.reportName) * size / 72) > 4.5);
-    doc.setFontSize(size);
-    doc.setFontStyle("bold");
-    doc.text(reportData.meta.reportName, 0.25, .75);
-}
-
-function printBodyData(currentSnapshot) {
-    doc.setTextColor(0, 0, 0);
-    doc.setFontType("normal");
-    doc.setFontSize(8);
-    printBodySection(currentSnapshot, "outdoorMeasurements", .25, 2.317, 1.55);
-    printBodySection(currentSnapshot, "indoorMeasurements", 3.042, 5.109, 1.55);
-    printBodySection(currentSnapshot, "systemProfileWeatherData", 5.834, 7.9, 1.55);
-    printBodySection(currentSnapshot, "performanceData", .25, 2, 4.855);
-    printGeolocationMap();
-}
-
-function printBodySection(currentSnapshot, measurementSection, xLeft, xRight, y) {
-    let dataPoints = JSON.parse(reportData.snapshots[currentSnapshot][measurementSection]);
-    let printRangeIcons = true;
-    let units = "";
-    let labelText = "";
-    let valueText = "";
-    let yTop = y;
-    let s = .18;
-    let sMultiplier = measurementSection == "performanceData" ? 2 : 1;
-
-    for (let key in dataPoints.values) {
-        let dataPoint = dataPoints.values[key];
-        let valueBeforeEditing = dataPoint;
-        let templateRef = templates[measurementSection][key];
-        if (templateRef) {
-            if (templateRef.hasOwnProperty("units"))
-                units = Array.isArray(templateRef.units) ? `(${templateRef.units[0]} / ${templateRef.units[1]})` : `(${templateRef.units})`;
-            else units = "";
-            labelText = `${templateRef.label} ${units}:`;
-            if (templateRef.hasOwnProperty("roundTo")) {
-                dataPoint *= 1;
-                dataPoint = dataPoint.toFixed(templateRef.roundTo);
-            }
-            if (templateRef.hasOwnProperty("secondaryValue")) {
-                let secondaryDataPoint = dataPoints.values[templateRef.secondaryValue];
-                if (templateRef.hasOwnProperty("roundTo")) {
-                    secondaryDataPoint *= 1;
-                    secondaryDataPoint = secondaryDataPoint.toFixed(templateRef.roundTo);
-                }
-                valueText = `${dataPoint} / ${secondaryDataPoint}`;
-            } else valueText = `${dataPoint}`;
-            if (templateRef.label) doc.text(labelText, xLeft, y);
-            doc.text(valueText, alignRight(valueText, xRight, 8), y);
-            if (printRangeIcons) {
-                let rangeIconRef = getRangeIcon(key, valueBeforeEditing, currentSnapshot);
-                if (rangeIconRef) doc.addImage(graphics[rangeIconRef], "JPEG", xRight + .05, y - .12, .16, .16);
-            }
-            let toolIconRef = getToolIcon(reportData.snapshots[currentSnapshot].toolIcons[key]);
-            if (toolIconRef) doc.addImage(graphics[toolIconRef], "JPEG", xRight + .25, y - .12, .16, .16);
-            y += (s * sMultiplier);
-        } else if (key == "newColumn") {
-            sMultiplier = 1;
-            xLeft = 2.25;
-            xRight = 3.9;
-            y = yTop;
-        } else if (key == "newRow") {
-            y += .35;
-        }
+export function generateReport(reportType, payload) {
+    if (reportType == "mqStandard") reportType = "mqCooling";
+    switch (reportType) {
+        case "mqCooling":
+        case "mqHeating":              return mqReportGenerator.generateReport(reportType, payload);
+        case "mqSystemVitalsFillable": return mqSystemVitalsReportGenerator.generateReport(payload);
+        default:                       return false;
     }
 }
-
-function printGeolocationMap() {
-    doc.addImage(reportData.staticPhotos.geolocationMap, "PNG", 4.3125, 4.25, 4.0625, 3.375);
-}
-
-function printProfilePicture() {
-    let coords = templates.profilePictureCoordinates[reportData.meta.profilePicturePlacement];
-    doc.addImage(reportData.staticPhotos.profilePicture, "JPEG", coords.x, coords.y, coords.w, coords.h);
-    doc.text(reportData.meta.techName, alignRight(reportData.meta.techName, 8.4, 8), coords.y + 1.2);
-}
-
-function printCompanyLogo() {
-    let coords = templates.companyLogoCoordinates[reportData.meta.companyLogoPlacement];
-    doc.addImage(reportData.staticPhotos.companyLogo, "JPEG", coords.x, coords.y, coords.w, coords.h);
-}
-
-function printFooterData() {
-    let s = .15;
-    let x = .2;
-    let y = 8;
-    let equipmentLabels = ["Make", "Model", "Serial"];
-    let i = -1;
-    doc.setTextColor(255, 255, 255);
-    doc.setFontType("bold");
-    doc.setFontSize(12);
-    doc.text("Customer", x, y);
-    doc.text("Equipment", x + 2.5, y);
-    doc.setFontSize(8);
-    y += .2;
-    doc.setFontSize(10);
-    y += .05;
-    let footer = JSON.parse(reportData.footerData);
-    for (let key in footer) {
-        doc.setFontType("normal");
-        if (key.includes("header")) {
-            i = 0;
-            doc.setFontStyle("bold");
-            y += .1;
-        } else if (key == "systemCoords") {
-            s = .12;
-            x += 2.5;
-            y = 8.2;
-            doc.setFontStyle("bold");
-            doc.setFontSize(8);
-            doc.text("ID", x, y);
-            doc.setFontStyle("normal");
-            y += s;
-        }
-        let prefix = "";
-        if (i > -1) {
-            prefix = `${equipmentLabels[i]}: `;
-            i++;
-        }
-        doc.text(`${prefix}${footer[key]}`, x, y);
-        y += s;
-    }
-}
-
-function printDiagnosticPage() {
-    doc.addPage();
-    printBoilerPlateDiagnostic();
-    printSubsystemReview();
-    printSystemDiagnostics();
-    printCorrectiveActions();
-}
-
-function printSubsystemReview() {
-    let y = 1;
-    let ssr = JSON.parse(reportData.subsystemReview);
-    for (let i = 0; i < Object.keys(ssr).length; i++) {
-        let key = Object.keys(ssr)[i];
-        doc.text(templates.coolingSubsystemReview[key], .25, y);
-        doc.text(ssr[key], 3, y);
-        y += .15;
-    };
-}
-
-function printSystemDiagnostics() {
-    let y = 1;
-    let diagnostics = JSON.parse(reportData.systemDiagnostics);
-    for (let i = 0; i < Object.keys(diagnostics).length; i++) {
-        let key = Object.keys(diagnostics)[i];
-        // let score = diagnostics[key].score;
-        // let diagnosticIcon = null;
-        // //if (type === 'stability') icon = stability;
-        // if (score > 1 && score < 10) diagnosticIcon = graphics.iconFlagRed;
-        // else if (score >= 10 && score < 15) diagnosticIcon = graphics.iconFlagYellow;
-        // else if (score >= 15) diagnosticIcon = graphics.iconFlagBlack;
-        // if (diagnosticIcon) doc.addImage(graphics[diagnosticIcon], "JPEG", 7.8, y, .25, .25);
-        y += .2;
-        doc.text(diagnostics[key].title, 4.4375, y);
-        doc.text(`${diagnostics[key].score}`, 7.5, y);
-    }
-}
-
-function printCorrectiveActions() {
-    let y = 3.8;
-    doc.setFontSize(9);
-    let ca = JSON.parse(reportData.correctiveActions);
-    for (let i = 0; i < Object.keys(ca).length; i++) {
-        let sectionKey = Object.keys(ca)[i];
-        for (let j = 0; j < Object.keys(ca[sectionKey]).length; j++) {
-            let actionKey = Object.keys(ca[sectionKey])[j];
-            let action = ca[sectionKey][actionKey];
-            if (actionKey == "header") {
-                doc.setFontSize(10);
-                doc.setFontStyle("bold");
-                doc.text(action, .25, y);
-            } else {
-                doc.setFontSize(8);
-                doc.setFontStyle("normal");
-                doc.text(actionKey, .25, y);
-            }
-            y += .18;
-        }
-        y += .1;
-    }
-}
-
-function printPhotoPages() {
-    let photoSectionMapping = ["project", "equipment", "site", "customer"];
-    let x, y, header, currentQuadrant, currentSection;
-    for (let i = 0; i < 4; i++) { // loops through the 4 main sections of photos, listed above (photoSectionMapping)
-        currentSection = reportData[`${photoSectionMapping[i]}Photos`];
-        if (Object.keys(currentSection).length > 0) doc.addPage();
-        else break;
-        currentQuadrant = 1;
-        x = templates.photoCoordinates[`quadrant${currentQuadrant}`].x;
-        y = templates.photoCoordinates[`quadrant${currentQuadrant}`].y;
-        doc.setFontStyle("bold");
-        doc.text(`${photoSectionMapping[i][0].toUpperCase()}${photoSectionMapping[i].slice(1)} Photos`, x, y - .2);
-        doc.setFontStyle("normal");
-        for (let key in currentSection) { // loops through the "subsections" of each main photo section
-            if (currentSection[key].photos) {
-                for (let j = 0; j < currentSection[key].photos.length; j++) { // loops through the photos[] array within each subsection, of each main photo section
-                    let currentPhoto = currentSection[key].photos[j];
-                    if (currentQuadrant === 3) {
-                        doc.setLineWidth(0.025);
-                        doc.setDrawColor(194, 197, 204);
-                        doc.line(.25, 5.5, 8.25, 5.5);
-                    } else if (currentQuadrant === 5) {
-                        doc.addPage();
-                        currentQuadrant = 1;
-                    }
-                    x = templates.photoCoordinates[`quadrant${currentQuadrant}`].x;
-                    y = templates.photoCoordinates[`quadrant${currentQuadrant}`].y;
-                    if (currentPhoto.base64) {
-                        doc.text(getPhotoSectionNameFromTag(currentPhoto.tag), x, y);
-                        let wPicMax = 3.75,
-                            hPicMax = 4,
-                            wPic = wPicMax,
-                            hPic = hPicMax,
-                            r = currentPhoto.aspect_ratio * 1;
-                        if (r >= 1) { // logo is a landscape image
-                            wPic = wPicMax;
-                            hPic = wPic / r;
-                            if (hPic > hPicMax) { // calculated h is too large for the available space
-                                hPic = hPicMax;
-                                wPic = hPic * r;
-                            }
-                        } else { // logo is a portrait image
-                            hPic = hPicMax;
-                            wPic = hPic * r;
-                            if (wPic > wPicMax) { // calculated w is too large for the available space
-                                wPic = wPicMax;
-                                hPic = wPic / r;
-                            }
-                        }
-                        doc.addImage(currentPhoto.base64, "JPEG", x, y + .1, wPic, hPic);
-                    }
-                    currentQuadrant++;
-                }
-                // if (currentSection[key].hasNotes && currentSection[key].notes != "") {
-                //     let notes = doc.splitTextToSize(`${currentSection[key].notes}`, 7.5);
-                //     doc.setFontStyle("bold");
-                //     doc.text("Notes:", x, y + hPic + .3);
-                //     doc.setFontStyle("normal");
-                //     doc.text(notes, x, y + hPic + .4);
-                // }
-            }
-        }
-    }
-}
-
-function printInfoPage() {
-    let infoPage = templates[`${reportData.meta.reportType}InfoPage`];
-    doc.addPage();
-    doc.setTextColor(0, 0, 0);
-    doc.setFontStyle("bold");
-    doc.setFontSize(14);
-    doc.text(infoPage.header, .5, .6);
-    doc.setFontSize(12);
-    for (let i = 0; i < infoPage.subheader.length; i++) {
-        let y = infoPage.y[i];
-        doc.setFontStyle("bold");
-        doc.text(infoPage.subheader[i], .5, y);
-        y += .2;
-        doc.setFontStyle("normal");
-        doc.text(doc.splitTextToSize(infoPage.body[i], 7.5), .5, y);
-    }
-}
-
-function getPhotoSectionNameFromTag(tag) {
-    let tagPrefixRemoved = tag.substr(tag.indexOf('_'));
-    let tagUnderscoresReplaced = tagPrefixRemoved.replaceAll('_', ' ');
-    let sectionName = `${tagUnderscoresReplaced.charAt(0).toUpperCase()}${tagUnderscoresReplaced.slice(1)}`;
-    return sectionName;
-}
-
-function resizeAndPrintStaticImages() {
-    let wMax = 2.25,
-        hMax = .7,
-        x_profile = 6.9,
-        y_profile = 8.13,
-        size_profile = 1.25,
-        x_name = 8.15,
-        y_name = 8.025,
-        r = reportData.meta.companyLogoAspectRatio,
-        xOffset = 0,
-        yOffset = 0,
-        w = 0,
-        h = 0,
-        x = 6,
-        y = .2;
-    if (reportData.meta.companyLogoPlacement !== "header") {
-        x = 6;
-        y = 8;
-        x_profile = 7.375;
-        y_profile = .15;
-        size_profile = reportData.meta.reportTheme === 'dark' ? .8 : .9;
-        x_name = 7.25;
-        y_name = .5;
-        wMax = 2.25;
-        hMax = .8
-    }
-    if (r >= 1) {
-        w = wMax;
-        h = w / r;
-        if (h > hMax) {
-            h = hMax;
-            w = h * r;
-        }
-    } else {
-        h = hMax;
-        w = h * r;
-        if (w > wMax) {
-            w = wMax;
-            h = w / r;
-        }
-    }
-    if (w < wMax) x = 8.5 - .25 - w;
-    doc.setFontSize(12);
-    doc.setFontType("bold");
-    doc.setTextColor(255, 255, 255);
-    if (reportData.meta.companyLogoPlacement == "Header" && h < hMax)
-        y = y + ((hMax - h) / 2);
-    doc.addImage(reportData.staticPhotos.companyLogo, "JPEG", x, y, w, h);
-    doc.addImage(reportData.staticPhotos.profilePicture, "JPEG", x_profile, y_profile, size_profile, size_profile);
-}
-
-function getToolIcon(measurementSource) {
-    switch (measurementSource) {
-        case "Fieldpiece": return "companyLogoFieldpiece";
-        default: return null;
-    }
-}
-
-function getRangeIcon(key, actualValue, currentSnapshot) {
-    let ranges = JSON.parse(reportData.snapshots[currentSnapshot].rangeIcons);
-    let target = null, low = null, high = null;
-    let rangeIconRef = null;
-    if (ranges[key]) {
-        target = parseFloat(ranges[key]);
-        if (ranges[`${key}_ideal_low`]) low = target - parseFloat(ranges[`${key}_ideal_low`]);
-        if (ranges[`${key}_ideal_high`]) high = target + parseFloat(ranges[`${key}_ideal_high`]);
-        if (target && low && high) {
-            if (actualValue < low) rangeIconRef = "iconRangeLow";
-            else if (actualValue > high) rangeIconRef = "iconRangeHigh";
-            else rangeIconRef = "iconRangeNormal";
-        }
-    }
-    return rangeIconRef;
-}
-
-function alignRight(text, rightAlign, fontSize) {
-    return rightAlign - doc.getStringUnitWidth(text) * fontSize / 72;
-}