@aclymatepackages/modules 1.0.14 → 1.0.16

package/dist/components/EmissionsChart.js

@@ -349,7 +349,7 @@ const EmissionsChart = _ref13 => {
     startDate,
     convertCarbonUnits,
     displayUnitLabel,
-    scopes
+    branding
   } = _ref13;
   const {
     chartLabelsArray,
@@ -358,7 +358,7 @@ const EmissionsChart = _ref13 => {
     subcategoriesArray,
     period,
     groupedEmissions
-  } = (0, _chartHelpers.buildEmissionGroupData)(emissions, graphPeriod, startDate, scopes);
+  } = (0, _chartHelpers.buildEmissionGroupData)(emissions, graphPeriod, startDate, branding);
   const isDataProjected = findIsDataProjected(latestEmissionDate);
   const isFirstPeriodEstimated = findIsFirstPeriodEstimated(chartLabelsArray, graphPeriod);
   const buildProjectionObj = viewMode === "subcategories" ? buildSubcategoriesProjectionObj : buildScopesProjectionObj;

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/EmissionsSummarySentence.js

@@ -7,7 +7,6 @@ exports.default = void 0;
 var _react = _interopRequireDefault(require("react"));
 var _material = require("@mui/material");
 var _atoms = require("@aclymatepackages/atoms");
-var _formatters = require("@aclymatepackages/formatters");
 var _otherHelpers = require("@aclymatepackages/other-helpers");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const EmissionsSummarySentence = _ref => {
@@ -31,6 +30,9 @@ const EmissionsSummarySentence = _ref => {
     item: true
   }, /*#__PURE__*/_react.default.createElement(_material.Typography, {
     variant: "body2"
-  }, label, ": ", (0, _formatters.formatDecimal)((0, _otherHelpers.sumTonsCo2e)(emissions)), " tons CO2e")));
+  }, (0, _otherHelpers.buildEmissionsSummarySentence)({
+    label,
+    emissions
+  }))));
 };
 var _default = exports.default = EmissionsSummarySentence;

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,6 +1,6 @@
 {
   "name": "@aclymatepackages/modules",
-  "version": "1.0.14",
+  "version": "1.0.16",
   "description": "Aclymate modules",
   "author": "William Loopesko",
   "main": "dist/index.js",
@@ -16,7 +16,7 @@
     "@aclymatepackages/formatters": "^1.0.0",
     "@aclymatepackages/lists": "^1.0.0",
     "@aclymatepackages/multi-part-form": "1.0.1",
-    "@aclymatepackages/other-helpers": "^1.0.0",
+    "@aclymatepackages/other-helpers": "^1.0.2",
     "@aclymatepackages/reg-exp": "^1.0.0",
     "@aclymatepackages/themes": "^1.0.0",
     "@babel/preset-react": "^7.16.7",

package/src/components/EmissionsChart.js

@@ -412,7 +412,7 @@ const EmissionsChart = ({
   startDate,
   convertCarbonUnits,
   displayUnitLabel,
-  scopes,
+  branding,
 }) => {
   const {
     chartLabelsArray,
@@ -421,7 +421,7 @@ const EmissionsChart = ({
     subcategoriesArray,
     period,
     groupedEmissions,
-  } = buildEmissionGroupData(emissions, graphPeriod, startDate, scopes);
+  } = buildEmissionGroupData(emissions, graphPeriod, startDate, branding);
 
   const isDataProjected = findIsDataProjected(latestEmissionDate);
   const isFirstPeriodEstimated = findIsFirstPeriodEstimated(

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/EmissionsSummarySentence.js

@@ -3,8 +3,7 @@ import React from "react";
 import { Typography, Grid } from "@mui/material";
 
 import { CategoriesAvatar } from "@aclymatepackages/atoms";
-import { formatDecimal } from "@aclymatepackages/formatters";
-import { sumTonsCo2e } from "@aclymatepackages/other-helpers";
+import { buildEmissionsSummarySentence } from "@aclymatepackages/other-helpers";
 
 const EmissionsSummarySentence = ({ label, emissions, color, scope }) => (
   <Grid container spacing={1} alignItems="center" wrap="nowrap">
@@ -13,7 +12,7 @@ const EmissionsSummarySentence = ({ label, emissions, color, scope }) => (
     </Grid>
     <Grid item>
       <Typography variant="body2">
-        {label}: {formatDecimal(sumTonsCo2e(emissions))} tons CO2e
+        {buildEmissionsSummarySentence({ label, emissions })}
       </Typography>
     </Grid>
   </Grid>

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,
 };