@measurequick/measurequick-report-generator 1.0.96 → 1.0.98

package/index.js

@@ -3,6 +3,7 @@ import * as mqSystemVitalsReportGenerator from "./mq-system-vitals-report-genera
 import * as mqSystemVitalsHeatingReportGenerator from "./mq-system-vitals-heating-report-generator.js";
 import * as mqPtcsReportGenerator from "./mq-ptcs-report-generator.js";
 import * as pdfSigner from "./sign-pdf.js";
+import * as mqStandardReportGenerator from "./mq-standard-report-generator.js";
 
 export function generateReport(reportType, payload) {
     if (reportType == "mqStandard") reportType = "mqCooling";
@@ -12,6 +13,7 @@ export function generateReport(reportType, payload) {
         case "mqSystemVitals":         return mqSystemVitalsReportGenerator.generateReport(payload);
         case "mqSystemVitalsHeating":         return mqSystemVitalsHeatingReportGenerator.generateReport(payload);
         case "PTCS":                 return mqPtcsReportGenerator.generateReport(payload);
+        case "mQ Standard":  return mqStandardReportGenerator.generateReport(payload);
         default:                       return false;
     }
 }

package/mq-standard-report-generator.js

@@ -0,0 +1,207 @@
+import { PDFDocument } from 'pdf-lib';
+import * as base64 from './graphics.js';
+
+export async function generateReport(payload) {
+
+    // fetch and load form
+    const formPdfBytes = _base64ToArrayBuffer(base64.mqStandardPdfTemplate);
+    const pdfDoc =       await PDFDocument.load(formPdfBytes);
+
+    // fetch resources
+    const iconRangeGreenBytes = _base64ToArrayBuffer(base64.iconRangeGreen);
+    const iconRangeRedBytes =   _base64ToArrayBuffer(base64.iconRangeRed);
+    const iconFlagBlackBytes =  _base64ToArrayBuffer(base64.iconFlagBlack);
+    const iconFlagGreenBytes =  _base64ToArrayBuffer(base64.iconFlagGreen);
+    const iconFlagRedBytes =    _base64ToArrayBuffer(base64.iconFlagRed);
+    const iconFlagYellowBytes = _base64ToArrayBuffer(base64.iconFlagYellow);
+    const iconStabilityBytes =  _base64ToArrayBuffer(base64.iconStability);
+    const iconThumbprintGreenBytes = _base64ToArrayBuffer(base64.iconThumbprintGreen);
+    const iconThumbprintRedBytes =  _base64ToArrayBuffer(base64.iconThumbprintRed);
+
+    // load resources
+    const iconRangeGreen =  await pdfDoc.embedPng(iconRangeGreenBytes);
+    const iconRangeRed =    await pdfDoc.embedPng(iconRangeRedBytes);
+    const iconFlagBlack =   await pdfDoc.embedPng(iconFlagBlackBytes);
+    const iconFlagGreen =   await pdfDoc.embedPng(iconFlagGreenBytes);
+    const iconFlagRed =     await pdfDoc.embedPng(iconFlagRedBytes);
+    const iconFlagYellow =  await pdfDoc.embedPng(iconFlagYellowBytes);
+    const iconStability =   await pdfDoc.embedPng(iconStabilityBytes);
+    const iconThumbprintGreen =  await pdfDoc.embedPng(iconThumbprintGreenBytes);
+    const iconThumbprintRed =   await pdfDoc.embedPng(iconThumbprintRedBytes);
+
+    // get form for filling
+    const form = pdfDoc.getForm();
+
+    // cover page
+    form.getTextField("Report Title").setText();
+    form.getTextField("Technician Name").setText();
+    form.getTextField("Date of Service Cover").setText();
+    form.getTextField("Time of Service Cover").setText();
+
+    // inject vitals report here
+
+    /******************************************/
+
+    let scoreDeduction = 0;
+    if (payload.test.diagnostics.multi_point_analysis && payload.test.diagnostics.multi_point_analysis.length > 0) {
+        for (let i = 0; i < 9; i++) {
+            let d = payload.test.diagnostics.multi_point_analysis[i];
+            if (d) {
+                let diagnosticIcon = iconFlagBlack;
+                if (d.type === 'stability')
+                    diagnosticIcon = iconStability;
+                else if (d.score > 1 && d.score < 10) {
+                    diagnosticIcon = iconFlagRed;
+                    scoreDeduction += d.score;
+                } else if (d.score >= 10 && d.score < 15)
+                    diagnosticIcon = iconFlagYellow;
+                form.getButton(`ImageDiagnostics${i+1}_af_image`).setImage(diagnosticIcon);
+                form.getTextField(`SystemDiagnostics${i+1}`).setText(`${d.title}`);
+                form.getTextField(`SystemDiagnostics${i+1}a`).setText(`${d.score}`);
+            }
+        }
+    } else {
+        form.getButton("ImageDiagnostics1_af_image").setImage(iconFlagGreen);
+        form.getTextField("SystemDiagnostics1").setText("No system-wide issues were detected.");
+    }
+    if (payload.test.score_deduction) {
+        scoreDeduction = payload.test.score_deduction;
+    }
+
+    let systemScorePercentage = +(100 - +(scoreDeduction.toFixed(0)));
+    let systemScoreGrade = getGradeFromScore(systemScorePercentage);
+    let systemScoreColor = getColorFromGrade(systemScoreGrade);
+
+    // get text fields
+    let textFields = getTextFields(payload);
+
+    // print customer data
+    let dateTimePlacement = "Upper";
+    let e = "";
+    let d = "";
+
+    let date = new Date();
+    if (textFields.cName && textFields.address && textFields.city && textFields.state && textFields.zip) {
+        dateTimePlacement = "Lower";
+        form.getTextField('Name').setText(`${textFields.cName}`);
+        form.getTextField('Address1').setText(`${textFields.address}`);
+        if (textFields.address2) {
+            form.getTextField('Address2').setText(`${textFields.address2}`);
+            form.getTextField('CityStateZip').setText(`${textFields.city}${textFields.state}${textFields.zip}`);
+        } else form.getTextField('Address2').setText(`${textFields.city}${textFields.state}${textFields.zip}`);
+        form.getTextField('DateOfServiceLabelUpper').setText("");
+        form.getTextField('TimeOfServiceLabelUpper').setText("");
+        form.getTextField('DateOfServiceLabelLower').setText("Date of Service:");
+        form.getTextField('TimeOfServiceLabelLower').setText("Time of Service:");
+        form.getTextField('DateOfServiceLower').setText(date.toLocaleDateString("en-US"));
+        form.getTextField('TimeOfServiceLower').setText(date.toLocaleTimeString("en-US"));
+    } else {
+        form.getTextField('DateOfServiceLabelLower').setText("");
+        form.getTextField('TimeOfServiceLabelLower').setText("");
+        form.getTextField('DateOfServiceLabelUpper').setText("Date of Service:");
+        form.getTextField('TimeOfServiceLabelUpper').setText("Time of Service:");
+        form.getTextField('DateOfServiceUpper').setText(date.toLocaleDateString("en-US"));
+        form.getTextField('TimeOfServiceUpper').setText(date.toLocaleTimeString("en-US"));
+    }
+
+    // print measurement data (first page)
+    form.getTextField(`YourSystemScore${systemScoreColor}`).setText(`${systemScorePercentage}% ${systemScoreGrade}`);
+    form.getTextField('Superheat').setText(`${textFields.superheat} °${payload.units.temperature}`);
+    form.getTextField('Subcooling').setText(`${textFields.subcooling} °${payload.units.temperature}`);
+    form.getTextField('CondenserApproach').setText(`${textFields.approach} °${payload.units.temperature}`);
+    form.getTextField('TemperatureSplit').setText(`${textFields.tempSplit} °${payload.units.temperature}`);
+    form.getTextField('TotalExternalStaticPressure').setText(`${textFields.tesp} inH2O`);
+    form.getTextField('FilterFaceVelocity').setText(`${textFields.fltrFace} FPM`);
+
+    // print losses data (second page)
+    let lossColor = textFields.ageLosses < 3 ? "Green" : "Red";
+    form.getTextField(`AgeLosses${lossColor}`).setText(`- ${textFields.ageLosses}`);
+    lossColor = textFields.tempSplitLosses < 3 ? "Green" : "Red";
+    form.getTextField(`TemperatureSplitLosses${lossColor}`).setText(`- ${textFields.tempSplitLosses}`);
+    lossColor = textFields.staticLosses < 3 ? "Green" : "Red";
+    form.getTextField(`StaticPressureLosses${lossColor}`).setText(`- ${textFields.staticLosses}`);
+    lossColor = textFields.approachLosses < 3 ? "Green" : "Red";
+    form.getTextField(`ApproachLosses${lossColor}`).setText(`- ${textFields.approachLosses}`);
+    lossColor = textFields.refChargeLosses < 3 ? "Green" : "Red";
+    form.getTextField(`RefrigerantChargeIssues${lossColor}`).setText(`- ${textFields.refChargeLosses}`);
+    form.getTextField('YourSystemScorePage2').setText(`${systemScorePercentage}% ${systemScoreGrade}`);
+
+    // print targets and range icons
+    const measureLabels = ["Superheat", "Subcooling", "Condenser", "TempSplit", "Tesp", "FilterFace"];
+    const targetKeys = ["superheat", "subcooling", "approach", "temperature_split", "pressure_static_total_external", "velocity_face_filter1"];
+    for (let i = 0; i < measureLabels.length; i++) {
+        let iconPlacement = "Mid";
+        let icon = iconRangeRed;
+        let actual = +payload.test.data[targetKeys[i]];
+        let mid = +payload.test.targets[targetKeys[i]];
+        let low = +payload.test.targets[`${targetKeys[i]}_ideal_low`];
+        let high = +payload.test.targets[`${targetKeys[i]}_ideal_high`];
+        low = mid - low;
+        high = mid + high;
+        if (targetKeys[i] == "pressure_static_total_external") high = mid * 1.4;
+        else if (targetKeys[i] == "velocity_face_filter1") high = 500;
+        if (actual < low && targetKeys[i] != "velocity_face_filter1") iconPlacement = "Low";
+        else if (actual > high) iconPlacement = "High";
+        else icon = iconRangeGreen;
+        form.getButton(`Image${measureLabels[i]}${iconPlacement}_af_image`).setImage(icon);
+        let targetZone = "";
+        if (targetKeys[i] == "pressure_static_total_external" || targetKeys[i] == "velocity_face_filter1") targetZone = `(< ${high})`;
+        else if (!isNaN(low) && low != "NaN" && !isNaN(high) && high != "NaN" ) targetZone = `(${low.toFixed(1)} - ${high.toFixed(1)})`;
+        form.getTextField(`${measureLabels[i]}Target`).setText(targetZone);
+    }
+
+    // print pass fail measures
+    let passFails = ["electrical_system_pass_fail", "air_distribution_system_pass_fail", "air_filtration_system_pass_fail", "condensate_drain_system_pass_fail", "refrigerant_charge_pass_fail", "outdoor_equipment_pass_fail", "indoor_equipment_pass_fail", "cooling_capacity_pass_fail", "cooling_electrical_efficiency_pass_fail"];
+    for (let i = 1; i <= passFails.length; i++) {
+        let meas = payload.test[passFails[i - 1]];
+        let icon = meas == "Pass" || meas == "High" || meas == "Mid"  ? iconRangeGreen : iconRangeRed;
+        form.getButton(`ImageSubsystem${i}_af_image`).setImage(icon);
+    }
+
+    /******************************************/
+
+    // equipment information page
+    form.getTextField(`EI Title 1`).setText();
+    form.getTextField(`EI Title 2`).setText();
+    form.getTextField(`EI Title 3`).setText();
+    for (let fieldNum = 1; fieldNum <= 41; fieldNum++) {
+        form.getTextField(`Equip_Info-Field ${fieldNum}a`).setText();
+        form.getTextField(`Equip_Info-Field ${fieldNum}b`).setText();
+    }
+
+    // system review page
+    for (let catNum = 1; catNum <= 10; catNum++) {
+        for (let fieldNum = 1; fieldNum <= 5; fieldNum++) {
+            form.getTextField(`SR Title ${catNum}`).setText();
+            form.getTextField(`Category ${catNum} Field ${fieldNum}a`).setText();
+            form.getTextField(`Category ${catNum} Field ${fieldNum}b`).setText();
+        }
+    }
+
+    // measurement details page
+    let numCols = payload.meta.numberOfColumns;
+    for (let rowNum = 1; rowNum <= 35; rowNum++) {
+        for (let colNum = 1; colNum <= numCols; colNum++) {
+            form.getTextField(`MD${numCols} ${rowNum}${colNum}`).setText();
+        }
+    }
+
+    // photos page: take code from standard report
+
+
+    form.flatten();
+    const pdfBase64 = await pdfDoc.saveAsBase64({ dataUri: true });
+    return pdfBase64;
+}
+
+function _base64ToArrayBuffer(base64) {
+    if (!base64) return "";
+    base64 = base64.replace(/^[^,]+,/, '').replace(/\s/g, '');
+    var binary_string = window.atob(base64);
+    var len = binary_string.length;
+    var bytes = new Uint8Array(len);
+    for (var i = 0; i < len; i++) {
+        bytes[i] = binary_string.charCodeAt(i);
+    }
+    return bytes.buffer;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@measurequick/measurequick-report-generator",
-  "version": "1.0.96",
+  "version": "1.0.98",
   "description": "Generates PDF documents for various MeasureQuick applications.",
   "main": "index.js",
   "scripts": {