@aclymatepackages/modules 1.0.15 → 1.0.17

package/dist/components/EmissionsChart.js

@@ -15,8 +15,6 @@ var _dayOfYear = _interopRequireDefault(require("dayjs/plugin/dayOfYear"));
 var _recharts = require("recharts");
 var _material = require("@mui/material");
 var _formatters = require("@aclymatepackages/formatters");
-var _dateHelpers = require("@aclymatepackages/date-helpers");
-var _constants = require("@aclymatepackages/constants");
 var _otherHelpers = require("@aclymatepackages/other-helpers");
 var _EmissionsCustomTooltip = _interopRequireDefault(require("./EmissionsCustomTooltip"));
 var _useChartWarningLabels = _interopRequireDefault(require("./useChartWarningLabels"));
@@ -34,164 +32,19 @@ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key i
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 _dayjs.default.extend(_dayOfYear.default);
-const DAYS_IN_QUARTER = _constants.DAYS_PER_YEAR / 4;
 const findObjectValuesSum = object => Object.values(object).reduce((sum, value) => sum + value, 0);
-const findLabelDate = (period, label) => {
-  if (period === "quarter") {
-    return (0, _dateHelpers.findQuarterDate)(label);
-  }
-  if (period === "year") {
-    return (0, _dateHelpers.findYearFirstDate)(label);
-  }
-  return (0, _dayjs.default)(label, "MM-YY");
-};
-const isDateFirstDateOfPeriod = (date, period) => {
-  if (period === "quarter") {
-    const quarterFirstDate = (0, _dateHelpers.findQuarterDate)(date);
-    return (0, _dayjs.default)(date).isSame(quarterFirstDate, "day");
-  }
-  if (period === "year") {
-    const yearFirstDate = (0, _dateHelpers.findYearFirstDate)(date);
-    return (0, _dayjs.default)(date).isSame(yearFirstDate, "day");
-  }
-  return (0, _dayjs.default)(date).date() === 1;
-};
-const findIsEstimatedFirstDateLabel = _ref => {
+const buildGroupedChartData = _ref => {
   let {
-    startDate,
-    earliestEmissionDate,
-    label,
-    period
-  } = _ref;
-  const labelDate = findLabelDate(period, label);
-  const labelStartDateDifference = (0, _dateHelpers.findInclusiveDateDifference)(labelDate, startDate, period);
-  const labelDateIsFirstOfPeriod = isDateFirstDateOfPeriod(earliestEmissionDate, period);
-  return labelStartDateDifference === 1 && !labelDateIsFirstOfPeriod;
-};
-const findIsFirstPeriodEstimated = (chartLabelsArray, period) => !chartLabelsArray.reduce((acc, label) => acc && !findIsEstimatedFirstDateLabel({
-  label,
-  period
-}), true);
-const findIsDataProjected = latestEmissionDate => {
-  if (!(0, _dayjs.default)(latestEmissionDate).isSame((0, _dayjs.default)(), "month")) {
-    return false;
-  }
-  return (0, _dayjs.default)(latestEmissionDate).date() !== (0, _dayjs.default)().daysInMonth();
-};
-const findProjectedSubcategoryValueFromEmissions = _ref2 => {
-  let {
-    emissions,
-    projectionMultiplier
-  } = _ref2;
-  return subcategory => {
-    const recurringSubcategoryEmissionsSum = (0, _chartHelpers.sumEmissionsTonsBySubcategory)(emissions, subcategory);
-    return projectionMultiplier * recurringSubcategoryEmissionsSum;
-  };
-};
-const buildSubcategoriesProjectionObj = (emissions, projectionMultiplier) => {
-  const findProjectedSubcategoryValue = findProjectedSubcategoryValueFromEmissions({
-    emissions,
-    projectionMultiplier
-  });
-  return {
-    "commuting-auto_projected": findProjectedSubcategoryValue("commuting-auto"),
-    "home-office_projected": findProjectedSubcategoryValue("home-office"),
-    utilities_projected: findProjectedSubcategoryValue("utilities")
-  };
-};
-const buildScopesProjectionObj = (emissions, projectionMultiplier) => {
-  const findProjectedSubcategoryValue = findProjectedSubcategoryValueFromEmissions({
-    emissions,
-    projectionMultiplier
-  });
-  const projectedCommutingEmissionsTons = findProjectedSubcategoryValue("commuting-auto");
-  const projectedHomeOfficeEmissionsTons = findProjectedSubcategoryValue("homeOffice");
-  const projectedElectricityEmissionsTons = findProjectedSubcategoryValue("electricity");
-  const projectedGasEmissionsTons = findProjectedSubcategoryValue("gas");
-  return {
-    scope1_projected: projectedGasEmissionsTons,
-    scope2_projected: projectedElectricityEmissionsTons,
-    scope3_projected: projectedHomeOfficeEmissionsTons + projectedCommutingEmissionsTons
-  };
-};
-const buildGroupedChartData = _ref3 => {
-  let {
-    startDate = "",
-    period,
-    isDataProjected,
-    isFirstPeriodEstimated,
     groupedEmissions,
-    buildProjectionObj,
-    buildRealDataObj,
-    showProjection
-  } = _ref3;
-  const findPeriodPosition = idx => {
-    if (!idx) {
-      return "first";
-    }
-    if (idx === groupedEmissions.length - 1) {
-      return "last";
-    }
-    return "middle";
-  };
-  const forwardProjectionPeriodFraction = period => {
-    if (period === "month") {
-      const daysInMonth = (0, _dayjs.default)().daysInMonth();
-      return (0, _dayjs.default)().date() / daysInMonth;
-    }
-    if (period === "quarter") {
-      const firstDayInQuarter = (0, _dateHelpers.findQuarterDate)((0, _dayjs.default)());
-      const currentDaysIntoQuarter = (0, _dayjs.default)().diff(firstDayInQuarter, "day");
-      return currentDaysIntoQuarter / DAYS_IN_QUARTER;
-    }
-    const currentDaysIntoYear = (0, _dayjs.default)().dayOfYear();
-    return currentDaysIntoYear / _constants.DAYS_PER_YEAR;
-  };
-  const backwardsProjectionPeriodFraction = period => {
-    const formattedStartDate = (0, _dayjs.default)(startDate);
-    if (period === "month") {
-      const daysInMonth = formattedStartDate.daysInMonth();
-      const daysFromEndOfMonth = daysInMonth - formattedStartDate.date();
-      return daysFromEndOfMonth / daysInMonth;
-    }
-    if (period === "quarter") {
-      const lastDateInQuarter = (0, _dateHelpers.findQuarterDate)(startDate, false);
-      const daysFromEndOfQuarter = Math.abs(formattedStartDate.diff(lastDateInQuarter, "day")) + 1;
-      return daysFromEndOfQuarter / DAYS_IN_QUARTER;
-    }
-    const daysFromEndOfYear = Math.abs(formattedStartDate.diff((0, _dayjs.default)(new Date(formattedStartDate.year(), 12, 31)), "day"));
-    return daysFromEndOfYear / _constants.DAYS_PER_YEAR;
-  };
-  const findPeriodProjectionMultiplier = _ref4 => {
-    let {
-      period,
-      position
-    } = _ref4;
-    if (!showProjection || position === "middle" || position === "first" && !isFirstPeriodEstimated || position === "last" && !isDataProjected) {
-      return 0;
-    }
-
-    //TODO: -UPDATE: this projection function doesn't take into account closed offices or terminated employee, so we probably need to rethink it
-    const projectionFraction = position === "first" ? backwardsProjectionPeriodFraction(period) : forwardProjectionPeriodFraction(period);
-    return 1 / projectionFraction - 1;
-  };
+    buildRealDataObj
+  } = _ref;
   return groupedEmissions.map((emissionsArray, idx) => {
-    const position = findPeriodPosition(idx, groupedEmissions);
-    const projectionMultiplier = findPeriodProjectionMultiplier({
-      startDate,
-      position,
-      period,
-      isDataProjected,
-      isFirstPeriodEstimated
-    });
-    const projectedCategoriesObj = buildProjectionObj(emissionsArray, projectionMultiplier);
     const subcategoriesObj = buildRealDataObj(emissionsArray, _subcategories.allSubcategoriesWithOther);
-    const chartCategoriesObj = _objectSpread(_objectSpread({}, projectedCategoriesObj), subcategoriesObj);
     const buildWarningObj = () => {
-      const singleEmissionWarning = emissionsArray.find(_ref5 => {
+      const singleEmissionWarning = emissionsArray.find(_ref2 => {
         let {
           warning
-        } = _ref5;
+        } = _ref2;
         return !!warning;
       });
       if (!singleEmissionWarning) {
@@ -202,27 +55,26 @@ const buildGroupedChartData = _ref3 => {
       } = singleEmissionWarning;
       return warning;
     };
-    return _objectSpread(_objectSpread({}, chartCategoriesObj), {}, {
+    return _objectSpread(_objectSpread({}, subcategoriesObj), {}, {
       warning: buildWarningObj(),
       id: "emissions-chart-group-".concat(idx),
       emissionsSumTons: (0, _otherHelpers.sumTonsCo2e)(emissionsArray),
-      totalEmissionsSumTons: findObjectValuesSum(chartCategoriesObj),
-      projectedEmissionsSumTons: findObjectValuesSum(projectedCategoriesObj)
+      totalEmissionsSumTons: findObjectValuesSum(subcategoriesObj)
     });
   });
 };
 const addTrendlineToChartData = chartData => {
   const averageX = (chartData.length - 1) / 2;
-  const averageY = chartData.reduce((sum, _ref6) => {
+  const averageY = chartData.reduce((sum, _ref3) => {
     let {
       totalEmissionsSumTons
-    } = _ref6;
+    } = _ref3;
     return Number(sum) + Number(totalEmissionsSumTons);
   }, 0) / chartData.length;
-  const trendLineCalcData = chartData.map((_ref7, idx) => {
+  const trendLineCalcData = chartData.map((_ref4, idx) => {
     let {
       totalEmissionsSumTons
-    } = _ref7;
+    } = _ref4;
     const xDifferenceFromMean = idx - averageX;
     const yDifferenceFromMean = totalEmissionsSumTons - averageY;
     const xDifferenceSquared = xDifferenceFromMean * xDifferenceFromMean;
@@ -232,32 +84,32 @@ const addTrendlineToChartData = chartData => {
       xyDifferenceFromMean
     };
   });
-  const xDifferenceSquaredSum = trendLineCalcData.reduce((sum, _ref8) => {
+  const xDifferenceSquaredSum = trendLineCalcData.reduce((sum, _ref5) => {
     let {
       xDifferenceSquared
-    } = _ref8;
+    } = _ref5;
     return sum + xDifferenceSquared;
   }, 0);
-  const xyDifferenceFromMeanSum = trendLineCalcData.reduce((sum, _ref9) => {
+  const xyDifferenceFromMeanSum = trendLineCalcData.reduce((sum, _ref6) => {
     let {
       xyDifferenceFromMean
-    } = _ref9;
+    } = _ref6;
     return sum + xyDifferenceFromMean;
   }, 0);
   const trendlineSlope = xyDifferenceFromMeanSum / xDifferenceSquaredSum;
   const trendlineIntercept = averageY - trendlineSlope * averageX;
   const findTrendlineValue = x => trendlineSlope * x + trendlineIntercept;
-  return chartData.map((_ref10, idx) => {
+  return chartData.map((_ref7, idx) => {
     let {
         totalEmissionsSumTons
-      } = _ref10,
-      otherProps = _objectWithoutProperties(_ref10, _excluded);
+      } = _ref7,
+      otherProps = _objectWithoutProperties(_ref7, _excluded);
     return _objectSpread(_objectSpread({}, otherProps), {}, {
       trendline: findTrendlineValue(idx)
     });
   });
 };
-const LabeledEmissionsChart = _ref11 => {
+const LabeledEmissionsChart = _ref8 => {
   var _data$, _data;
   let {
     data,
@@ -267,7 +119,7 @@ const LabeledEmissionsChart = _ref11 => {
     chartArray,
     aspect = 3,
     showTooltip = true
-  } = _ref11;
+  } = _ref8;
   const {
     palette
   } = (0, _material.useTheme)();
@@ -307,12 +159,12 @@ const LabeledEmissionsChart = _ref11 => {
       categoriesArray: chartArray,
       displayUnitLabel: displayUnitLabel
     })
-  }), chartArray.map(_ref12 => {
+  }), chartArray.map(_ref9 => {
     let {
         subcategory,
         color
-      } = _ref12,
-      otherProps = _objectWithoutProperties(_ref12, _excluded2);
+      } = _ref9,
+      otherProps = _objectWithoutProperties(_ref9, _excluded2);
     return /*#__PURE__*/_react.default.createElement(ChartElement, _extends({
       key: "emissions-chart-element-".concat(subcategory),
       type: "monotone",
@@ -332,7 +184,7 @@ const LabeledEmissionsChart = _ref11 => {
     strokeDasharray: "5 5"
   }))), warningLabels);
 };
-const EmissionsChart = _ref13 => {
+const EmissionsChart = _ref10 => {
   let {
     dataArray: emissions,
     type,
@@ -340,7 +192,6 @@ const EmissionsChart = _ref13 => {
     graphPeriod,
     chartRef,
     showTrendline,
-    showProjection,
     displayUnit,
     unitConverter,
     aspect,
@@ -349,74 +200,54 @@ const EmissionsChart = _ref13 => {
     startDate,
     convertCarbonUnits,
     displayUnitLabel,
-    scopes
-  } = _ref13;
+    branding
+  } = _ref10;
   const {
     chartLabelsArray,
-    latestEmissionDate,
     scopesArray,
     subcategoriesArray,
-    period,
     groupedEmissions
-  } = (0, _chartHelpers.buildEmissionGroupData)(emissions, graphPeriod, startDate, scopes);
-  const isDataProjected = findIsDataProjected(latestEmissionDate);
-  const isFirstPeriodEstimated = findIsFirstPeriodEstimated(chartLabelsArray, graphPeriod);
-  const buildProjectionObj = viewMode === "subcategories" ? buildSubcategoriesProjectionObj : buildScopesProjectionObj;
+  } = (0, _chartHelpers.buildEmissionGroupData)(emissions, graphPeriod, startDate, branding);
   const buildRealDataObj = viewMode === "subcategories" ? _chartHelpers.buildSubcategoriesDataObj : _chartHelpers.buildScopesRealDataObj;
   const buildChartData = () => {
     const preliminaryChartData = buildGroupedChartData({
-      startDate,
-      period,
-      isDataProjected,
-      isFirstPeriodEstimated,
       groupedEmissions,
-      buildProjectionObj,
-      buildRealDataObj,
-      showProjection
-    });
-    const formattedLabels = chartLabelsArray.map((label, idx) => {
-      if (idx === chartLabelsArray.length - 1 && isDataProjected) {
-        return "".concat(label, "*");
-      }
-      if (idx || !isFirstPeriodEstimated) {
-        return label;
-      }
-      return "".concat(label, "**");
+      buildRealDataObj
     });
-    const convertChartDataObject = (chartDataObj, converter) => Object.fromEntries(Object.entries(chartDataObj).map(_ref14 => {
-      let [key, value] = _ref14;
+    const convertChartDataObject = (chartDataObj, converter) => Object.fromEntries(Object.entries(chartDataObj).map(_ref11 => {
+      let [key, value] = _ref11;
       if (typeof value !== "number") {
         return [key, value];
       }
       return [key, converter(value)];
     }));
     const labelChartData = chartData => chartData.map((data, idx) => _objectSpread(_objectSpread({}, data), {}, {
-      label: formattedLabels[idx]
+      label: chartLabelsArray[idx]
     }));
     if (isPercentageChart) {
       const percentageConvertedChartData = preliminaryChartData.map(chartDataObj => {
-        const objectSubcategoryProperties = Object.keys(chartDataObj).filter(key => _subcategories.subcategories.find(_ref15 => {
+        const objectSubcategoryProperties = Object.keys(chartDataObj).filter(key => _subcategories.subcategories.find(_ref12 => {
           let {
             subcategory
-          } = _ref15;
+          } = _ref12;
           return subcategory === key;
         }));
         const objectSubcategoryValues = objectSubcategoryProperties.map(subcategory => ({
           key: subcategory,
           value: chartDataObj[subcategory]
         }));
-        const periodEmissionsSum = objectSubcategoryValues.reduce((sum, _ref16) => {
+        const periodEmissionsSum = objectSubcategoryValues.reduce((sum, _ref13) => {
           let {
             value
-          } = _ref16;
+          } = _ref13;
           return value + sum;
         }, 0);
         const percentageConverter = value => value / periodEmissionsSum * 100;
-        const newObject = Object.fromEntries(objectSubcategoryValues.map(_ref17 => {
+        const newObject = Object.fromEntries(objectSubcategoryValues.map(_ref14 => {
           let {
             key,
             value
-          } = _ref17;
+          } = _ref14;
           return [key, value];
         }));
         return convertChartDataObject(newObject, percentageConverter);
@@ -445,22 +276,6 @@ const EmissionsChart = _ref13 => {
     chartArray: chartArray,
     aspect: aspect,
     showTooltip: showTooltip
-  })), (isDataProjected || isFirstPeriodEstimated) && /*#__PURE__*/_react.default.createElement(_material.Grid, {
-    item: true,
-    container: true,
-    justifyContent: "flex-end"
-  }, /*#__PURE__*/_react.default.createElement(_material.Grid, {
-    item: true
-  }, isDataProjected && showProjection && /*#__PURE__*/_react.default.createElement(_material.Typography, {
-    variant: "caption",
-    color: "textSecondary",
-    display: "block",
-    align: "right"
-  }, "*Data in the most recent period is projected since this period isn't complete yet."), isFirstPeriodEstimated && showProjection && /*#__PURE__*/_react.default.createElement(_material.Typography, {
-    variant: "caption",
-    color: "textSecondary",
-    display: "block",
-    align: "right"
-  }, "**Data in the first period is estimated since your start date is in the middle of this period."))));
+  })));
 };
 var _default = exports.default = EmissionsChart;

package/dist/components/EmissionsPieChart.js

@@ -64,10 +64,10 @@ const EmissionsPieChart = _ref2 => {
     dataArray: emissions,
     viewMode = "subcategories",
     pieChartRef,
-    scopes
+    branding
   } = _ref2;
   const subcategoriesArray = (0, _subcategories.buildSubcategoriesArray)(emissions);
-  const scopesArray = scopes || (0, _subcategories.buildScopesArray)();
+  const scopesArray = (0, _subcategories.buildScopesWithColors)(branding);
   const emissionsSum = (0, _otherHelpers.sumTonsCo2e)(emissions);
   const formatChartPieSlices = () => {
     const filterFunction = subcategory => emission => {

package/dist/components/ReportSummaryBlock.js

@@ -12,19 +12,21 @@ require("core-js/modules/es.regexp.to-string.js");
 require("core-js/modules/es.array.sort.js");
 var _react = _interopRequireDefault(require("react"));
 var _material = require("@mui/material");
-var _modules = require("@aclymatepackages/modules");
 var _otherHelpers = require("@aclymatepackages/other-helpers");
 var _emissionsCalcs = require("@aclymatepackages/emissions-calcs");
 var _converters = require("@aclymatepackages/converters");
 var _themes = _interopRequireDefault(require("@aclymatepackages/themes"));
 var _subcategories = require("@aclymatepackages/subcategories");
-var _EmissionsSummarySentence = _interopRequireDefault(require("./EmissionsSummarySentence"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+// import ReportGraphContentLayout from "./ReportGraphContentLayout";
+// import EmissionsPieChart from "./EmissionsPieChart";
+// import EmissionsSummarySentence from "./EmissionsSummarySentence";
+
 const adjustHexColorHue = function adjustHexColorHue(hexColor) {
   let hueChange = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 20;
   const rgbaColor = (0, _converters.hexToRgba)(hexColor);
@@ -147,55 +149,66 @@ const adjustHexColorHue = function adjustHexColorHue(hexColor) {
   };
   return hslToHex(adjustedHue);
 };
-const ReportSummaryBlock = _ref => {
+
+//Sort emissions by scope
+//Calculate total tons for emissions
+
+//define colors for scopes
+//use branding colors OR theme colors
+//if branding colors: Primary = scope 1, modifedPrimary = scope 2, secondary = scope 3
+
+//build projected scope categories/colors
+//Build a function to lighten colors for projections
+
+const buildScopesArrayWithColors = (emissions, branding) => {
+  const colorizeScopesArray = (scopesArray, colorsArray) => scopesArray.map((scopeObj, idx) => _objectSpread(_objectSpread({}, scopeObj), {}, {
+    color: colorsArray[idx]
+  }));
+  const scopesArray = [1, 2, 3].map(scope => {
+    const scopeEmissions = (0, _emissionsCalcs.filterEmissionsByScope)(emissions, scope);
+    const totalTonsCo2e = (0, _otherHelpers.sumTonsCo2e)(scopeEmissions);
+    return {
+      scope,
+      subcategory: "scope".concat(scope),
+      name: "Scope ".concat(scope),
+      emissions: scopeEmissions,
+      totalTonsCo2e,
+      icon: /*#__PURE__*/_react.default.createElement(_material.Typography, {
+        variant: "h6"
+      }, scope)
+    };
+  });
+  if (!branding) {
+    const colorsArray = _subcategories.scopesList.map(_ref => {
+      var _mainTheme$palette$co;
+      let {
+        color
+      } = _ref;
+      return (_mainTheme$palette$co = _themes.default.palette[color]) === null || _mainTheme$palette$co === void 0 ? void 0 : _mainTheme$palette$co.main;
+    });
+    return colorizeScopesArray(scopesArray, colorsArray);
+  }
+  const {
+    primaryColor,
+    secondaryColor
+  } = branding;
+  if (!primaryColor || !secondaryColor) {
+    return scopesArray;
+  }
+  const sortedScopes = scopesArray.sort((a, b) => b.totalTonsCo2e - a.totalTonsCo2e);
+  const adjustedPrimaryColor = adjustHexColorHue(primaryColor);
+  const colorsArray = [primaryColor, secondaryColor, adjustedPrimaryColor];
+  return colorizeScopesArray(sortedScopes, colorsArray).sort((a, b) => a.scope - b.scope);
+};
+const ReportSummaryBlock = _ref2 => {
   let {
     emissions,
     interval,
     branding
-  } = _ref;
-  const buildScopesArrayWithColors = () => {
-    const colorizeScopesArray = (scopesArray, colorsArray) => scopesArray.map((scopeObj, idx) => _objectSpread(_objectSpread({}, scopeObj), {}, {
-      color: colorsArray[idx]
-    }));
-    const scopesArray = [1, 2, 3].map(scope => {
-      const scopeEmissions = (0, _emissionsCalcs.filterEmissionsByScope)(emissions, scope);
-      const totalTonsCo2e = (0, _otherHelpers.sumTonsCo2e)(scopeEmissions);
-      return {
-        scope,
-        subcategory: "scope".concat(scope),
-        name: "Scope ".concat(scope),
-        emissions: scopeEmissions,
-        totalTonsCo2e,
-        icon: /*#__PURE__*/_react.default.createElement(_material.Typography, {
-          variant: "h6"
-        }, scope)
-      };
-    });
-    if (!branding) {
-      const colorsArray = _subcategories.scopesList.map(_ref2 => {
-        var _mainTheme$palette$co;
-        let {
-          color
-        } = _ref2;
-        return (_mainTheme$palette$co = _themes.default.palette[color]) === null || _mainTheme$palette$co === void 0 ? void 0 : _mainTheme$palette$co.main;
-      });
-      return colorizeScopesArray(scopesArray, colorsArray);
-    }
-    const {
-      primaryColor,
-      secondaryColor
-    } = branding;
-    if (!primaryColor || !secondaryColor) {
-      return scopesArray;
-    }
-    const sortedScopes = scopesArray.sort((a, b) => b.totalTonsCo2e - a.totalTonsCo2e);
-    const adjustedPrimaryColor = adjustHexColorHue(primaryColor);
-    const colorsArray = [primaryColor, secondaryColor, adjustedPrimaryColor];
-    return colorizeScopesArray(sortedScopes, colorsArray).sort((a, b) => a.scope - b.scope);
-  };
+  } = _ref2;
   const scopesWithColors = buildScopesArrayWithColors();
   const chartScopes = branding ? scopesWithColors : null;
-  return /*#__PURE__*/_react.default.createElement(_modules.ReportGraphContentLayout, {
+  return /*#__PURE__*/_react.default.createElement(ReportGraphContentLayout, {
     scopes: chartScopes,
     contentTitle: (0, _otherHelpers.buildEmissionsSummarySentence)({
       label: "Total Emissions",
@@ -203,7 +216,7 @@ const ReportSummaryBlock = _ref => {
     }),
     interval: interval,
     emissions: emissions,
-    contentRows: [/*#__PURE__*/_react.default.createElement(_modules.EmissionsPieChart, {
+    contentRows: [/*#__PURE__*/_react.default.createElement(EmissionsPieChart, {
       dataArray: emissions,
       viewMode: "scopes",
       scopes: chartScopes
@@ -215,7 +228,7 @@ const ReportSummaryBlock = _ref => {
         emissions,
         color
       } = _ref3;
-      return /*#__PURE__*/_react.default.createElement(_EmissionsSummarySentence.default, {
+      return /*#__PURE__*/_react.default.createElement(EmissionsSummarySentence, {
         key: "summary-sentence-".concat(idx),
         label: "Total Scope ".concat(scope),
         emissions: emissions,

package/dist/index.js

@@ -51,6 +51,12 @@ Object.defineProperty(exports, "EmissionsReductionGraph", {
     return _EmissionsReductionGraph.default;
   }
 });
+Object.defineProperty(exports, "EmissionsSummarySentence", {
+  enumerable: true,
+  get: function get() {
+    return _EmissionsSummarySentence.default;
+  }
+});
 Object.defineProperty(exports, "EmissionsSummaryTable", {
   enumerable: true,
   get: function get() {
@@ -136,4 +142,5 @@ var _useChartWarningLabels = _interopRequireDefault(require("./components/useCha
 var _EmissionsSummaryTable = _interopRequireDefault(require("./components/EmissionsSummaryTable"));
 var _ReportSummaryBlock = _interopRequireDefault(require("./components/ReportSummaryBlock"));
 var _ReportGraphContentLayout = _interopRequireDefault(require("./components/ReportGraphContentLayout"));
+var _EmissionsSummarySentence = _interopRequireDefault(require("./components/EmissionsSummarySentence"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/package.json

@@ -1,29 +1,26 @@
 {
   "name": "@aclymatepackages/modules",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "Aclymate modules",
   "author": "William Loopesko",
   "main": "dist/index.js",
   "dependencies": {
     "@aclymatepackages/array-immutability-helpers": "^1.0.0",
     "@aclymatepackages/atoms": "^1.0.10",
-    "@aclymatepackages/chart-helpers": "^1.0.6",
-    "@aclymatepackages/constants": "^1.0.0",
+    "@aclymatepackages/chart-helpers": "^1.0.10",
     "@aclymatepackages/converters": "^1.0.0",
-    "@aclymatepackages/date-helpers": "^1.0.0",
     "@aclymatepackages/emissions-calcs": "^1.1.1",
     "@aclymatepackages/fetch-aclymate-api": "^1.0.0",
     "@aclymatepackages/formatters": "^1.0.0",
     "@aclymatepackages/lists": "^1.0.0",
     "@aclymatepackages/multi-part-form": "1.0.1",
-    "@aclymatepackages/other-helpers": "^1.0.2",
+    "@aclymatepackages/other-helpers": "^1.0.3",
     "@aclymatepackages/reg-exp": "^1.0.0",
     "@aclymatepackages/themes": "^1.0.0",
     "@babel/preset-react": "^7.16.7",
     "@emotion/react": "^11.11.1",
     "@emotion/styled": "^11.11.0",
     "@fortawesome/react-fontawesome": "^0.1.18",
-    "@mui/icons-material": "^5.11.16",
     "@mui/lab": "^5.0.0-alpha.134",
     "@mui/material": "^5.13.6",
     "@stripe/react-stripe-js": "^2.1.0",
@@ -32,7 +29,6 @@
     "dayjs": "^1.11.7",
     "npm": "^8.19.4",
     "peopledatalabs": "^5.0.4",
-    "react-cookie": "^6.1.0",
     "react-countup": "^4.4.0",
     "recharts": "^2.10.4",
     "typewriter-effect": "^2.18.2"

package/src/components/EmissionsChart.js

@@ -14,15 +14,9 @@ import {
   Tooltip as ChartTooltip,
 } from "recharts";
 
-import { Grid, Typography, Box, useTheme } from "@mui/material";
+import { Grid, Box, useTheme } from "@mui/material";
 
 import { formatDecimal } from "@aclymatepackages/formatters";
-import {
-  findInclusiveDateDifference,
-  findYearFirstDate,
-  findQuarterDate,
-} from "@aclymatepackages/date-helpers";
-import { DAYS_PER_YEAR } from "@aclymatepackages/constants";
 import { sumTonsCo2e } from "@aclymatepackages/other-helpers";
 
 import EmissionsCustomTooltip from "./EmissionsCustomTooltip";
@@ -31,7 +25,6 @@ import useChartWarningLabels from "./useChartWarningLabels";
 import {
   buildScopesRealDataObj,
   buildSubcategoriesDataObj,
-  sumEmissionsTonsBySubcategory,
   buildEmissionGroupData,
 } from "@aclymatepackages/chart-helpers";
 import {
@@ -41,223 +34,16 @@ import {
 
 dayjs.extend(dayOfYear);
 
-const DAYS_IN_QUARTER = DAYS_PER_YEAR / 4;
-
 const findObjectValuesSum = (object) =>
   Object.values(object).reduce((sum, value) => sum + value, 0);
 
-const findLabelDate = (period, label) => {
-  if (period === "quarter") {
-    return findQuarterDate(label);
-  }
-
-  if (period === "year") {
-    return findYearFirstDate(label);
-  }
-
-  return dayjs(label, "MM-YY");
-};
-
-const isDateFirstDateOfPeriod = (date, period) => {
-  if (period === "quarter") {
-    const quarterFirstDate = findQuarterDate(date);
-    return dayjs(date).isSame(quarterFirstDate, "day");
-  }
-
-  if (period === "year") {
-    const yearFirstDate = findYearFirstDate(date);
-    return dayjs(date).isSame(yearFirstDate, "day");
-  }
-
-  return dayjs(date).date() === 1;
-};
-
-const findIsEstimatedFirstDateLabel = ({
-  startDate,
-  earliestEmissionDate,
-  label,
-  period,
-}) => {
-  const labelDate = findLabelDate(period, label);
-  const labelStartDateDifference = findInclusiveDateDifference(
-    labelDate,
-    startDate,
-    period
-  );
-  const labelDateIsFirstOfPeriod = isDateFirstDateOfPeriod(
-    earliestEmissionDate,
-    period
-  );
-
-  return labelStartDateDifference === 1 && !labelDateIsFirstOfPeriod;
-};
-
-const findIsFirstPeriodEstimated = (chartLabelsArray, period) =>
-  !chartLabelsArray.reduce(
-    (acc, label) => acc && !findIsEstimatedFirstDateLabel({ label, period }),
-    true
-  );
-
-const findIsDataProjected = (latestEmissionDate) => {
-  if (!dayjs(latestEmissionDate).isSame(dayjs(), "month")) {
-    return false;
-  }
-  return dayjs(latestEmissionDate).date() !== dayjs().daysInMonth();
-};
-
-const findProjectedSubcategoryValueFromEmissions =
-  ({ emissions, projectionMultiplier }) =>
-  (subcategory) => {
-    const recurringSubcategoryEmissionsSum = sumEmissionsTonsBySubcategory(
-      emissions,
-      subcategory
-    );
-
-    return projectionMultiplier * recurringSubcategoryEmissionsSum;
-  };
-
-const buildSubcategoriesProjectionObj = (emissions, projectionMultiplier) => {
-  const findProjectedSubcategoryValue =
-    findProjectedSubcategoryValueFromEmissions({
-      emissions,
-      projectionMultiplier,
-    });
-
-  return {
-    "commuting-auto_projected": findProjectedSubcategoryValue("commuting-auto"),
-    "home-office_projected": findProjectedSubcategoryValue("home-office"),
-    utilities_projected: findProjectedSubcategoryValue("utilities"),
-  };
-};
-
-const buildScopesProjectionObj = (emissions, projectionMultiplier) => {
-  const findProjectedSubcategoryValue =
-    findProjectedSubcategoryValueFromEmissions({
-      emissions,
-      projectionMultiplier,
-    });
-
-  const projectedCommutingEmissionsTons =
-    findProjectedSubcategoryValue("commuting-auto");
-  const projectedHomeOfficeEmissionsTons =
-    findProjectedSubcategoryValue("homeOffice");
-  const projectedElectricityEmissionsTons =
-    findProjectedSubcategoryValue("electricity");
-  const projectedGasEmissionsTons = findProjectedSubcategoryValue("gas");
-
-  return {
-    scope1_projected: projectedGasEmissionsTons,
-    scope2_projected: projectedElectricityEmissionsTons,
-    scope3_projected:
-      projectedHomeOfficeEmissionsTons + projectedCommutingEmissionsTons,
-  };
-};
-
-const buildGroupedChartData = ({
-  startDate = "",
-  period,
-  isDataProjected,
-  isFirstPeriodEstimated,
-  groupedEmissions,
-  buildProjectionObj,
-  buildRealDataObj,
-  showProjection,
-}) => {
-  const findPeriodPosition = (idx) => {
-    if (!idx) {
-      return "first";
-    }
-    if (idx === groupedEmissions.length - 1) {
-      return "last";
-    }
-    return "middle";
-  };
-
-  const forwardProjectionPeriodFraction = (period) => {
-    if (period === "month") {
-      const daysInMonth = dayjs().daysInMonth();
-      return dayjs().date() / daysInMonth;
-    }
-
-    if (period === "quarter") {
-      const firstDayInQuarter = findQuarterDate(dayjs());
-      const currentDaysIntoQuarter = dayjs().diff(firstDayInQuarter, "day");
-      return currentDaysIntoQuarter / DAYS_IN_QUARTER;
-    }
-
-    const currentDaysIntoYear = dayjs().dayOfYear();
-    return currentDaysIntoYear / DAYS_PER_YEAR;
-  };
-
-  const backwardsProjectionPeriodFraction = (period) => {
-    const formattedStartDate = dayjs(startDate);
-    if (period === "month") {
-      const daysInMonth = formattedStartDate.daysInMonth();
-      const daysFromEndOfMonth = daysInMonth - formattedStartDate.date();
-      return daysFromEndOfMonth / daysInMonth;
-    }
-
-    if (period === "quarter") {
-      const lastDateInQuarter = findQuarterDate(startDate, false);
-      const daysFromEndOfQuarter =
-        Math.abs(formattedStartDate.diff(lastDateInQuarter, "day")) + 1;
-      return daysFromEndOfQuarter / DAYS_IN_QUARTER;
-    }
-
-    const daysFromEndOfYear = Math.abs(
-      formattedStartDate.diff(
-        dayjs(new Date(formattedStartDate.year(), 12, 31)),
-        "day"
-      )
-    );
-
-    return daysFromEndOfYear / DAYS_PER_YEAR;
-  };
-
-  const findPeriodProjectionMultiplier = ({ period, position }) => {
-    if (
-      !showProjection ||
-      position === "middle" ||
-      (position === "first" && !isFirstPeriodEstimated) ||
-      (position === "last" && !isDataProjected)
-    ) {
-      return 0;
-    }
-
-    //TODO: -UPDATE: this projection function doesn't take into account closed offices or terminated employee, so we probably need to rethink it
-    const projectionFraction =
-      position === "first"
-        ? backwardsProjectionPeriodFraction(period)
-        : forwardProjectionPeriodFraction(period);
-
-    return 1 / projectionFraction - 1;
-  };
-
+const buildGroupedChartData = ({ groupedEmissions, buildRealDataObj }) => {
   return groupedEmissions.map((emissionsArray, idx) => {
-    const position = findPeriodPosition(idx, groupedEmissions);
-    const projectionMultiplier = findPeriodProjectionMultiplier({
-      startDate,
-      position,
-      period,
-      isDataProjected,
-      isFirstPeriodEstimated,
-    });
-
-    const projectedCategoriesObj = buildProjectionObj(
-      emissionsArray,
-      projectionMultiplier
-    );
-
     const subcategoriesObj = buildRealDataObj(
       emissionsArray,
       allSubcategoriesWithOther
     );
 
-    const chartCategoriesObj = {
-      ...projectedCategoriesObj,
-      ...subcategoriesObj,
-    };
-
     const buildWarningObj = () => {
       const singleEmissionWarning = emissionsArray.find(
         ({ warning }) => !!warning
@@ -272,12 +58,11 @@ const buildGroupedChartData = ({
     };
 
     return {
-      ...chartCategoriesObj,
+      ...subcategoriesObj,
       warning: buildWarningObj(),
       id: `emissions-chart-group-${idx}`,
       emissionsSumTons: sumTonsCo2e(emissionsArray),
-      totalEmissionsSumTons: findObjectValuesSum(chartCategoriesObj),
-      projectedEmissionsSumTons: findObjectValuesSum(projectedCategoriesObj),
+      totalEmissionsSumTons: findObjectValuesSum(subcategoriesObj),
     };
   });
 };
@@ -403,7 +188,6 @@ const EmissionsChart = ({
   graphPeriod,
   chartRef,
   showTrendline,
-  showProjection,
   displayUnit,
   unitConverter,
   aspect,
@@ -412,27 +196,14 @@ const EmissionsChart = ({
   startDate,
   convertCarbonUnits,
   displayUnitLabel,
-  scopes,
+  branding,
 }) => {
   const {
     chartLabelsArray,
-    latestEmissionDate,
     scopesArray,
     subcategoriesArray,
-    period,
     groupedEmissions,
-  } = buildEmissionGroupData(emissions, graphPeriod, startDate, scopes);
-
-  const isDataProjected = findIsDataProjected(latestEmissionDate);
-  const isFirstPeriodEstimated = findIsFirstPeriodEstimated(
-    chartLabelsArray,
-    graphPeriod
-  );
-
-  const buildProjectionObj =
-    viewMode === "subcategories"
-      ? buildSubcategoriesProjectionObj
-      : buildScopesProjectionObj;
+  } = buildEmissionGroupData(emissions, graphPeriod, startDate, branding);
 
   const buildRealDataObj =
     viewMode === "subcategories"
@@ -441,26 +212,8 @@ const EmissionsChart = ({
 
   const buildChartData = () => {
     const preliminaryChartData = buildGroupedChartData({
-      startDate,
-      period,
-      isDataProjected,
-      isFirstPeriodEstimated,
       groupedEmissions,
-      buildProjectionObj,
       buildRealDataObj,
-      showProjection,
-    });
-
-    const formattedLabels = chartLabelsArray.map((label, idx) => {
-      if (idx === chartLabelsArray.length - 1 && isDataProjected) {
-        return `${label}*`;
-      }
-
-      if (idx || !isFirstPeriodEstimated) {
-        return label;
-      }
-
-      return `${label}**`;
     });
 
     const convertChartDataObject = (chartDataObj, converter) =>
@@ -476,7 +229,7 @@ const EmissionsChart = ({
     const labelChartData = (chartData) =>
       chartData.map((data, idx) => ({
         ...data,
-        label: formattedLabels[idx],
+        label: chartLabelsArray[idx],
       }));
 
     if (isPercentageChart) {
@@ -545,34 +298,6 @@ const EmissionsChart = ({
           showTooltip={showTooltip}
         />
       </Grid>
-      {(isDataProjected || isFirstPeriodEstimated) && (
-        <Grid item container justifyContent="flex-end">
-          <Grid item>
-            {isDataProjected && showProjection && (
-              <Typography
-                variant="caption"
-                color="textSecondary"
-                display="block"
-                align="right"
-              >
-                *Data in the most recent period is projected since this period
-                isn't complete yet.
-              </Typography>
-            )}
-            {isFirstPeriodEstimated && showProjection && (
-              <Typography
-                variant="caption"
-                color="textSecondary"
-                display="block"
-                align="right"
-              >
-                **Data in the first period is estimated since your start date is
-                in the middle of this period.
-              </Typography>
-            )}
-          </Grid>
-        </Grid>
-      )}
     </Grid>
   );
 };

package/src/components/EmissionsPieChart.js

@@ -15,7 +15,7 @@ import { formatDecimal } from "@aclymatepackages/formatters";
 import { sumTonsCo2e } from "@aclymatepackages/other-helpers";
 import {
   buildSubcategoriesArray,
-  buildScopesArray,
+  buildScopesWithColors,
 } from "@aclymatepackages/subcategories";
 
 const PieChartCustomTooltip = ({ payload: passedPayload }) => {
@@ -49,10 +49,10 @@ const EmissionsPieChart = ({
   dataArray: emissions,
   viewMode = "subcategories",
   pieChartRef,
-  scopes,
+  branding,
 }) => {
   const subcategoriesArray = buildSubcategoriesArray(emissions);
-  const scopesArray = scopes || buildScopesArray();
+  const scopesArray = buildScopesWithColors(branding);
 
   const emissionsSum = sumTonsCo2e(emissions);
 

package/src/components/ReportSummaryBlock.js

@@ -2,10 +2,6 @@ import React from "react";
 
 import { Typography } from "@mui/material";
 
-import {
-  EmissionsPieChart,
-  ReportGraphContentLayout,
-} from "@aclymatepackages/modules";
 import {
   buildEmissionsSummarySentence,
   sumTonsCo2e,
@@ -15,7 +11,9 @@ import { hexToRgba } from "@aclymatepackages/converters";
 import mainTheme from "@aclymatepackages/themes";
 import { scopesList } from "@aclymatepackages/subcategories";
 
-import EmissionsSummarySentence from "./EmissionsSummarySentence";
+// import ReportGraphContentLayout from "./ReportGraphContentLayout";
+// import EmissionsPieChart from "./EmissionsPieChart";
+// import EmissionsSummarySentence from "./EmissionsSummarySentence";
 
 const adjustHexColorHue = (hexColor, hueChange = 20) => {
   const rgbaColor = hexToRgba(hexColor);
@@ -135,51 +133,61 @@ const adjustHexColorHue = (hexColor, hueChange = 20) => {
   return hslToHex(adjustedHue);
 };
 
-const ReportSummaryBlock = ({ emissions, interval, branding }) => {
-  const buildScopesArrayWithColors = () => {
-    const colorizeScopesArray = (scopesArray, colorsArray) =>
-      scopesArray.map((scopeObj, idx) => ({
-        ...scopeObj,
-        color: colorsArray[idx],
-      }));
-
-    const scopesArray = [1, 2, 3].map((scope) => {
-      const scopeEmissions = filterEmissionsByScope(emissions, scope);
-      const totalTonsCo2e = sumTonsCo2e(scopeEmissions);
-      return {
-        scope,
-        subcategory: `scope${scope}`,
-        name: `Scope ${scope}`,
-        emissions: scopeEmissions,
-        totalTonsCo2e,
-        icon: <Typography variant="h6">{scope}</Typography>,
-      };
-    });
-
-    if (!branding) {
-      const colorsArray = scopesList.map(
-        ({ color }) => mainTheme.palette[color]?.main
-      );
-
-      return colorizeScopesArray(scopesArray, colorsArray);
-    }
+//Sort emissions by scope
+//Calculate total tons for emissions
 
-    const { primaryColor, secondaryColor } = branding;
-    if (!primaryColor || !secondaryColor) {
-      return scopesArray;
-    }
+//define colors for scopes
+//use branding colors OR theme colors
+//if branding colors: Primary = scope 1, modifedPrimary = scope 2, secondary = scope 3
 
-    const sortedScopes = scopesArray.sort(
-      (a, b) => b.totalTonsCo2e - a.totalTonsCo2e
-    );
-    const adjustedPrimaryColor = adjustHexColorHue(primaryColor);
+//build projected scope categories/colors
+//Build a function to lighten colors for projections
+
+const buildScopesArrayWithColors = (emissions, branding) => {
+  const colorizeScopesArray = (scopesArray, colorsArray) =>
+    scopesArray.map((scopeObj, idx) => ({
+      ...scopeObj,
+      color: colorsArray[idx],
+    }));
+
+  const scopesArray = [1, 2, 3].map((scope) => {
+    const scopeEmissions = filterEmissionsByScope(emissions, scope);
+    const totalTonsCo2e = sumTonsCo2e(scopeEmissions);
+    return {
+      scope,
+      subcategory: `scope${scope}`,
+      name: `Scope ${scope}`,
+      emissions: scopeEmissions,
+      totalTonsCo2e,
+      icon: <Typography variant="h6">{scope}</Typography>,
+    };
+  });
 
-    const colorsArray = [primaryColor, secondaryColor, adjustedPrimaryColor];
-    return colorizeScopesArray(sortedScopes, colorsArray).sort(
-      (a, b) => a.scope - b.scope
+  if (!branding) {
+    const colorsArray = scopesList.map(
+      ({ color }) => mainTheme.palette[color]?.main
     );
-  };
 
+    return colorizeScopesArray(scopesArray, colorsArray);
+  }
+
+  const { primaryColor, secondaryColor } = branding;
+  if (!primaryColor || !secondaryColor) {
+    return scopesArray;
+  }
+
+  const sortedScopes = scopesArray.sort(
+    (a, b) => b.totalTonsCo2e - a.totalTonsCo2e
+  );
+  const adjustedPrimaryColor = adjustHexColorHue(primaryColor);
+
+  const colorsArray = [primaryColor, secondaryColor, adjustedPrimaryColor];
+  return colorizeScopesArray(sortedScopes, colorsArray).sort(
+    (a, b) => a.scope - b.scope
+  );
+};
+
+const ReportSummaryBlock = ({ emissions, interval, branding }) => {
   const scopesWithColors = buildScopesArrayWithColors();
 
   const chartScopes = branding ? scopesWithColors : null;

package/src/index.js

@@ -17,6 +17,7 @@ import useChartWarningLabels from "./components/useChartWarningLabels";
 import EmissionsSummaryTable from "./components/EmissionsSummaryTable";
 import ReportSummaryBlock from "./components/ReportSummaryBlock";
 import ReportGraphContentLayout from "./components/ReportGraphContentLayout";
+import EmissionsSummarySentence from "./components/EmissionsSummarySentence";
 
 export {
   FootprintVideo,
@@ -38,4 +39,5 @@ export {
   EmissionsSummaryTable,
   ReportSummaryBlock,
   ReportGraphContentLayout,
+  EmissionsSummarySentence,
 };