@tgwf/co2 0.15.0 → 0.16.1

package/dist/cjs/helpers/index.js

@@ -19,14 +19,19 @@ var helpers_exports = {};
 __export(helpers_exports, {
   formatNumber: () => formatNumber,
   getApiRequestHeaders: () => getApiRequestHeaders,
+  lessThanEqualTo: () => lessThanEqualTo,
+  outputRating: () => outputRating,
   parseOptions: () => parseOptions
 });
 module.exports = __toCommonJS(helpers_exports);
 var import__ = require("../index.js");
 var import_constants = require("../constants/index.js");
+const SWDM4_GLOBAL_GRID_INTENSITY = import_constants.SWDV4.GLOBAL_GRID_INTENSITY;
 const formatNumber = (num) => parseFloat(num.toFixed(2));
-function parseOptions(options) {
+const lessThanEqualTo = (num, limit) => num <= limit;
+function parseOptions(options = {}, version = 3, green = false) {
   var _a, _b, _c, _d, _e, _f;
+  const globalGridIntensity = version === 4 ? SWDM4_GLOBAL_GRID_INTENSITY : import_constants.GLOBAL_GRID_INTENSITY;
   if (typeof options !== "object") {
     throw new Error("Options must be an object");
   }
@@ -41,7 +46,7 @@ function parseOptions(options) {
 See https://developers.thegreenwebfoundation.org/co2js/data/ for more information. 
 Falling back to global average grid intensity.`);
           adjustments.gridIntensity["device"] = {
-            value: import_constants.GLOBAL_GRID_INTENSITY
+            value: globalGridIntensity
           };
         }
         adjustments.gridIntensity["device"] = {
@@ -54,7 +59,7 @@ Falling back to global average grid intensity.`);
         };
       } else {
         adjustments.gridIntensity["device"] = {
-          value: import_constants.GLOBAL_GRID_INTENSITY
+          value: globalGridIntensity
         };
         console.warn(`The device grid intensity must be a number or an object. You passed in a ${typeof device}. 
 Falling back to global average grid intensity.`);
@@ -80,7 +85,7 @@ Falling back to global average grid intensity.`);
         };
       } else {
         adjustments.gridIntensity["dataCenter"] = {
-          value: import_constants.GLOBAL_GRID_INTENSITY
+          value: globalGridIntensity
         };
         console.warn(`The data center grid intensity must be a number or an object. You passed in a ${typeof dataCenter}. 
 Falling back to global average grid intensity.`);
@@ -93,7 +98,7 @@ Falling back to global average grid intensity.`);
 See https://developers.thegreenwebfoundation.org/co2js/data/ for more information.  Falling back to global average grid intensity. 
 Falling back to global average grid intensity.`);
           adjustments.gridIntensity["network"] = {
-            value: import_constants.GLOBAL_GRID_INTENSITY
+            value: globalGridIntensity
           };
         }
         adjustments.gridIntensity["network"] = {
@@ -106,61 +111,132 @@ Falling back to global average grid intensity.`);
         };
       } else {
         adjustments.gridIntensity["network"] = {
-          value: import_constants.GLOBAL_GRID_INTENSITY
+          value: globalGridIntensity
         };
         console.warn(`The network grid intensity must be a number or an object. You passed in a ${typeof network}. 
 Falling back to global average grid intensity.`);
       }
     }
+  } else {
+    adjustments.gridIntensity = {
+      device: { value: globalGridIntensity },
+      dataCenter: { value: globalGridIntensity },
+      network: { value: globalGridIntensity }
+    };
   }
   if ((options == null ? void 0 : options.dataReloadRatio) || options.dataReloadRatio === 0) {
     if (typeof options.dataReloadRatio === "number") {
       if (options.dataReloadRatio >= 0 && options.dataReloadRatio <= 1) {
         adjustments.dataReloadRatio = options.dataReloadRatio;
       } else {
-        adjustments.dataReloadRatio = import_constants.PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD;
+        adjustments.dataReloadRatio = version === 3 ? import_constants.PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD : 0;
         console.warn(`The dataReloadRatio option must be a number between 0 and 1. You passed in ${options.dataReloadRatio}. 
 Falling back to default value.`);
       }
     } else {
-      adjustments.dataReloadRatio = import_constants.PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD;
+      adjustments.dataReloadRatio = version === 3 ? import_constants.PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD : 0;
       console.warn(`The dataReloadRatio option must be a number. You passed in a ${typeof options.dataReloadRatio}. 
 Falling back to default value.`);
     }
+  } else {
+    adjustments.dataReloadRatio = version === 3 ? import_constants.PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD : 0;
+    console.warn(`The dataReloadRatio option must be a number. You passed in a ${typeof options.dataReloadRatio}. 
+Falling back to default value.`);
   }
   if ((options == null ? void 0 : options.firstVisitPercentage) || options.firstVisitPercentage === 0) {
     if (typeof options.firstVisitPercentage === "number") {
       if (options.firstVisitPercentage >= 0 && options.firstVisitPercentage <= 1) {
         adjustments.firstVisitPercentage = options.firstVisitPercentage;
       } else {
-        adjustments.firstVisitPercentage = import_constants.FIRST_TIME_VIEWING_PERCENTAGE;
+        adjustments.firstVisitPercentage = version === 3 ? import_constants.FIRST_TIME_VIEWING_PERCENTAGE : 1;
         console.warn(`The firstVisitPercentage option must be a number between 0 and 1. You passed in ${options.firstVisitPercentage}. 
 Falling back to default value.`);
       }
     } else {
-      adjustments.firstVisitPercentage = import_constants.FIRST_TIME_VIEWING_PERCENTAGE;
+      adjustments.firstVisitPercentage = version === 3 ? import_constants.FIRST_TIME_VIEWING_PERCENTAGE : 1;
       console.warn(`The firstVisitPercentage option must be a number. You passed in a ${typeof options.firstVisitPercentage}. 
 Falling back to default value.`);
     }
+  } else {
+    adjustments.firstVisitPercentage = version === 3 ? import_constants.FIRST_TIME_VIEWING_PERCENTAGE : 1;
+    console.warn(`The firstVisitPercentage option must be a number. You passed in a ${typeof options.firstVisitPercentage}. 
+Falling back to default value.`);
   }
   if ((options == null ? void 0 : options.returnVisitPercentage) || options.returnVisitPercentage === 0) {
     if (typeof options.returnVisitPercentage === "number") {
       if (options.returnVisitPercentage >= 0 && options.returnVisitPercentage <= 1) {
         adjustments.returnVisitPercentage = options.returnVisitPercentage;
       } else {
-        adjustments.returnVisitPercentage = import_constants.RETURNING_VISITOR_PERCENTAGE;
+        adjustments.returnVisitPercentage = version === 3 ? import_constants.RETURNING_VISITOR_PERCENTAGE : 0;
+        console.warn(`The returnVisitPercentage option must be a number between 0 and 1. You passed in ${options.returnVisitPercentage}. 
+Falling back to default value.`);
+      }
+    } else {
+      adjustments.returnVisitPercentage = version === 3 ? import_constants.RETURNING_VISITOR_PERCENTAGE : 0;
+      console.warn(`The returnVisitPercentage option must be a number. You passed in a ${typeof options.returnVisitPercentage}. 
+Falling back to default value.`);
+    }
+  } else {
+    adjustments.returnVisitPercentage = version === 3 ? import_constants.RETURNING_VISITOR_PERCENTAGE : 0;
+    console.warn(`The returnVisitPercentage option must be a number. You passed in a ${typeof options.returnVisitPercentage}. 
+Falling back to default value.`);
+  }
+  if ((options == null ? void 0 : options.greenHostingFactor) || options.greenHostingFactor === 0 && version === 4) {
+    if (typeof options.greenHostingFactor === "number") {
+      if (options.greenHostingFactor >= 0 && options.greenHostingFactor <= 1) {
+        adjustments.greenHostingFactor = options.greenHostingFactor;
+      } else {
+        adjustments.greenHostingFactor = 0;
         console.warn(`The returnVisitPercentage option must be a number between 0 and 1. You passed in ${options.returnVisitPercentage}. 
 Falling back to default value.`);
       }
     } else {
-      adjustments.returnVisitPercentage = import_constants.RETURNING_VISITOR_PERCENTAGE;
+      adjustments.greenHostingFactor = 0;
       console.warn(`The returnVisitPercentage option must be a number. You passed in a ${typeof options.returnVisitPercentage}. 
 Falling back to default value.`);
     }
+  } else if (version === 4) {
+    adjustments.greenHostingFactor = 0;
+  }
+  if (green) {
+    adjustments.greenHostingFactor = 1;
   }
   return adjustments;
 }
 function getApiRequestHeaders(comment = "") {
-  return { "User-Agent": `co2js/${"0.15.0"} ${comment}` };
+  return { "User-Agent": `co2js/${"0.16.1"} ${comment}` };
+}
+function outputRating(co2e, swdmVersion) {
+  let {
+    FIFTH_PERCENTILE,
+    TENTH_PERCENTILE,
+    TWENTIETH_PERCENTILE,
+    THIRTIETH_PERCENTILE,
+    FORTIETH_PERCENTILE,
+    FIFTIETH_PERCENTILE
+  } = import_constants.SWDMV3_RATINGS;
+  if (swdmVersion === 4) {
+    FIFTH_PERCENTILE = import_constants.SWDMV4_RATINGS.FIFTH_PERCENTILE;
+    TENTH_PERCENTILE = import_constants.SWDMV4_RATINGS.TENTH_PERCENTILE;
+    TWENTIETH_PERCENTILE = import_constants.SWDMV4_RATINGS.TWENTIETH_PERCENTILE;
+    THIRTIETH_PERCENTILE = import_constants.SWDMV4_RATINGS.THIRTIETH_PERCENTILE;
+    FORTIETH_PERCENTILE = import_constants.SWDMV4_RATINGS.FORTIETH_PERCENTILE;
+    FIFTIETH_PERCENTILE = import_constants.SWDMV4_RATINGS.FIFTIETH_PERCENTILE;
+  }
+  if (lessThanEqualTo(co2e, FIFTH_PERCENTILE)) {
+    return "A+";
+  } else if (lessThanEqualTo(co2e, TENTH_PERCENTILE)) {
+    return "A";
+  } else if (lessThanEqualTo(co2e, TWENTIETH_PERCENTILE)) {
+    return "B";
+  } else if (lessThanEqualTo(co2e, THIRTIETH_PERCENTILE)) {
+    return "C";
+  } else if (lessThanEqualTo(co2e, FORTIETH_PERCENTILE)) {
+    return "D";
+  } else if (lessThanEqualTo(co2e, FIFTIETH_PERCENTILE)) {
+    return "E";
+  } else {
+    return "F";
+  }
 }
 //# sourceMappingURL=index.js.map

package/dist/cjs/helpers/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/helpers/index.js"],
-  "sourcesContent": ["import { averageIntensity } from \"../index.js\";\nimport {\n  GLOBAL_GRID_INTENSITY,\n  PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD,\n  FIRST_TIME_VIEWING_PERCENTAGE,\n  RETURNING_VISITOR_PERCENTAGE,\n} from \"../constants/index.js\";\n\n// Shared type definitions to be used across different files\n\n/**\n * @typedef {Object} DomainCheckOptions options to control the behavior when checking a domain\n * @property {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.\n * @property {boolean} verbose - Optional. Whether to return a verbose response.\n * @property {string[]} db - Optional. A database list to use for lookups.\n */\n\nconst formatNumber = (num) => parseFloat(num.toFixed(2));\n\nfunction parseOptions(options) {\n  // CHeck that it is an object\n  if (typeof options !== \"object\") {\n    throw new Error(\"Options must be an object\");\n  }\n\n  const adjustments = {};\n\n  if (options?.gridIntensity) {\n    adjustments.gridIntensity = {};\n    const { device, dataCenter, network } = options.gridIntensity;\n    if (device || device === 0) {\n      if (typeof device === \"object\") {\n        if (!averageIntensity.data[device.country?.toUpperCase()]) {\n          console.warn(\n            `\"${device.country}\" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \\nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information. \\nFalling back to global average grid intensity.`\n          );\n          adjustments.gridIntensity[\"device\"] = {\n            value: GLOBAL_GRID_INTENSITY,\n          };\n        }\n        adjustments.gridIntensity[\"device\"] = {\n          country: device.country,\n          value: parseFloat(\n            averageIntensity.data[device.country?.toUpperCase()]\n          ),\n        };\n      } else if (typeof device === \"number\") {\n        adjustments.gridIntensity[\"device\"] = {\n          value: device,\n        };\n      } else {\n        adjustments.gridIntensity[\"device\"] = {\n          value: GLOBAL_GRID_INTENSITY,\n        };\n        console.warn(\n          `The device grid intensity must be a number or an object. You passed in a ${typeof device}. \\nFalling back to global average grid intensity.`\n        );\n      }\n    }\n    if (dataCenter || dataCenter === 0) {\n      if (typeof dataCenter === \"object\") {\n        if (!averageIntensity.data[dataCenter.country?.toUpperCase()]) {\n          console.warn(\n            `\"${dataCenter.country}\" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \\nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information.  \\nFalling back to global average grid intensity.`\n          );\n          adjustments.gridIntensity[\"dataCenter\"] = {\n            value: GLOBAL_GRID_INTENSITY,\n          };\n        }\n        adjustments.gridIntensity[\"dataCenter\"] = {\n          country: dataCenter.country,\n          value: parseFloat(\n            averageIntensity.data[dataCenter.country?.toUpperCase()]\n          ),\n        };\n      } else if (typeof dataCenter === \"number\") {\n        adjustments.gridIntensity[\"dataCenter\"] = {\n          value: dataCenter,\n        };\n      } else {\n        adjustments.gridIntensity[\"dataCenter\"] = {\n          value: GLOBAL_GRID_INTENSITY,\n        };\n        console.warn(\n          `The data center grid intensity must be a number or an object. You passed in a ${typeof dataCenter}. \\nFalling back to global average grid intensity.`\n        );\n      }\n    }\n    if (network || network === 0) {\n      if (typeof network === \"object\") {\n        if (!averageIntensity.data[network.country?.toUpperCase()]) {\n          console.warn(\n            `\"${network.country}\" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \\nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information.  Falling back to global average grid intensity. \\nFalling back to global average grid intensity.`\n          );\n          adjustments.gridIntensity[\"network\"] = {\n            value: GLOBAL_GRID_INTENSITY,\n          };\n        }\n        adjustments.gridIntensity[\"network\"] = {\n          country: network.country,\n          value: parseFloat(\n            averageIntensity.data[network.country?.toUpperCase()]\n          ),\n        };\n      } else if (typeof network === \"number\") {\n        adjustments.gridIntensity[\"network\"] = {\n          value: network,\n        };\n      } else {\n        adjustments.gridIntensity[\"network\"] = {\n          value: GLOBAL_GRID_INTENSITY,\n        };\n        console.warn(\n          `The network grid intensity must be a number or an object. You passed in a ${typeof network}. \\nFalling back to global average grid intensity.`\n        );\n      }\n    }\n  }\n\n  if (options?.dataReloadRatio || options.dataReloadRatio === 0) {\n    if (typeof options.dataReloadRatio === \"number\") {\n      if (options.dataReloadRatio >= 0 && options.dataReloadRatio <= 1) {\n        adjustments.dataReloadRatio = options.dataReloadRatio;\n      } else {\n        adjustments.dataReloadRatio =\n          PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD;\n        console.warn(\n          `The dataReloadRatio option must be a number between 0 and 1. You passed in ${options.dataReloadRatio}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.dataReloadRatio =\n        PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD;\n      console.warn(\n        `The dataReloadRatio option must be a number. You passed in a ${typeof options.dataReloadRatio}. \\nFalling back to default value.`\n      );\n    }\n  }\n\n  if (options?.firstVisitPercentage || options.firstVisitPercentage === 0) {\n    if (typeof options.firstVisitPercentage === \"number\") {\n      if (\n        options.firstVisitPercentage >= 0 &&\n        options.firstVisitPercentage <= 1\n      ) {\n        adjustments.firstVisitPercentage = options.firstVisitPercentage;\n      } else {\n        adjustments.firstVisitPercentage = FIRST_TIME_VIEWING_PERCENTAGE;\n        console.warn(\n          `The firstVisitPercentage option must be a number between 0 and 1. You passed in ${options.firstVisitPercentage}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.firstVisitPercentage = FIRST_TIME_VIEWING_PERCENTAGE;\n      console.warn(\n        `The firstVisitPercentage option must be a number. You passed in a ${typeof options.firstVisitPercentage}. \\nFalling back to default value.`\n      );\n    }\n  }\n\n  if (options?.returnVisitPercentage || options.returnVisitPercentage === 0) {\n    if (typeof options.returnVisitPercentage === \"number\") {\n      if (\n        options.returnVisitPercentage >= 0 &&\n        options.returnVisitPercentage <= 1\n      ) {\n        adjustments.returnVisitPercentage = options.returnVisitPercentage;\n      } else {\n        adjustments.returnVisitPercentage = RETURNING_VISITOR_PERCENTAGE;\n        console.warn(\n          `The returnVisitPercentage option must be a number between 0 and 1. You passed in ${options.returnVisitPercentage}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.returnVisitPercentage = RETURNING_VISITOR_PERCENTAGE;\n      console.warn(\n        `The returnVisitPercentage option must be a number. You passed in a ${typeof options.returnVisitPercentage}. \\nFalling back to default value.`\n      );\n    }\n  }\n\n  return adjustments;\n}\n\n/**\n * Returns an object containing all the HTTP headers to use when making a request to the Green Web Foundation API.\n * @param {string} comment - Optional. The app, site, or organisation that is making the request.\n *\n * @returns {import('http').OutgoingHttpHeaders}\n */\nfunction getApiRequestHeaders(comment = \"\") {\n  return { \"User-Agent\": `co2js/${process.env.CO2JS_VERSION} ${comment}` };\n}\n\nexport { formatNumber, parseOptions, getApiRequestHeaders };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,eAAiC;AACjC,uBAKO;AAWP,MAAM,eAAe,CAAC,QAAQ,WAAW,IAAI,QAAQ,CAAC,CAAC;AAEvD,sBAAsB,SAAS;AAnB/B;AAqBE,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAM,IAAI,MAAM,2BAA2B;AAAA,EAC7C;AAEA,QAAM,cAAc,CAAC;AAErB,MAAI,mCAAS,eAAe;AAC1B,gBAAY,gBAAgB,CAAC;AAC7B,UAAM,EAAE,QAAQ,YAAY,YAAY,QAAQ;AAChD,QAAI,UAAU,WAAW,GAAG;AAC1B,UAAI,OAAO,WAAW,UAAU;AAC9B,YAAI,CAAC,0BAAiB,KAAK,aAAO,YAAP,mBAAgB,gBAAgB;AACzD,kBAAQ,KACN,IAAI,OAAO;AAAA;AAAA,+CACb;AACA,sBAAY,cAAc,YAAY;AAAA,YACpC,OAAO;AAAA,UACT;AAAA,QACF;AACA,oBAAY,cAAc,YAAY;AAAA,UACpC,SAAS,OAAO;AAAA,UAChB,OAAO,WACL,0BAAiB,KAAK,aAAO,YAAP,mBAAgB,cACxC;AAAA,QACF;AAAA,MACF,WAAW,OAAO,WAAW,UAAU;AACrC,oBAAY,cAAc,YAAY;AAAA,UACpC,OAAO;AAAA,QACT;AAAA,MACF,OAAO;AACL,oBAAY,cAAc,YAAY;AAAA,UACpC,OAAO;AAAA,QACT;AACA,gBAAQ,KACN,4EAA4E,OAAO;AAAA,+CACrF;AAAA,MACF;AAAA,IACF;AACA,QAAI,cAAc,eAAe,GAAG;AAClC,UAAI,OAAO,eAAe,UAAU;AAClC,YAAI,CAAC,0BAAiB,KAAK,iBAAW,YAAX,mBAAoB,gBAAgB;AAC7D,kBAAQ,KACN,IAAI,WAAW;AAAA;AAAA,+CACjB;AACA,sBAAY,cAAc,gBAAgB;AAAA,YACxC,OAAO;AAAA,UACT;AAAA,QACF;AACA,oBAAY,cAAc,gBAAgB;AAAA,UACxC,SAAS,WAAW;AAAA,UACpB,OAAO,WACL,0BAAiB,KAAK,iBAAW,YAAX,mBAAoB,cAC5C;AAAA,QACF;AAAA,MACF,WAAW,OAAO,eAAe,UAAU;AACzC,oBAAY,cAAc,gBAAgB;AAAA,UACxC,OAAO;AAAA,QACT;AAAA,MACF,OAAO;AACL,oBAAY,cAAc,gBAAgB;AAAA,UACxC,OAAO;AAAA,QACT;AACA,gBAAQ,KACN,iFAAiF,OAAO;AAAA,+CAC1F;AAAA,MACF;AAAA,IACF;AACA,QAAI,WAAW,YAAY,GAAG;AAC5B,UAAI,OAAO,YAAY,UAAU;AAC/B,YAAI,CAAC,0BAAiB,KAAK,cAAQ,YAAR,mBAAiB,gBAAgB;AAC1D,kBAAQ,KACN,IAAI,QAAQ;AAAA;AAAA,+CACd;AACA,sBAAY,cAAc,aAAa;AAAA,YACrC,OAAO;AAAA,UACT;AAAA,QACF;AACA,oBAAY,cAAc,aAAa;AAAA,UACrC,SAAS,QAAQ;AAAA,UACjB,OAAO,WACL,0BAAiB,KAAK,cAAQ,YAAR,mBAAiB,cACzC;AAAA,QACF;AAAA,MACF,WAAW,OAAO,YAAY,UAAU;AACtC,oBAAY,cAAc,aAAa;AAAA,UACrC,OAAO;AAAA,QACT;AAAA,MACF,OAAO;AACL,oBAAY,cAAc,aAAa;AAAA,UACrC,OAAO;AAAA,QACT;AACA,gBAAQ,KACN,6EAA6E,OAAO;AAAA,+CACtF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,MAAI,oCAAS,oBAAmB,QAAQ,oBAAoB,GAAG;AAC7D,QAAI,OAAO,QAAQ,oBAAoB,UAAU;AAC/C,UAAI,QAAQ,mBAAmB,KAAK,QAAQ,mBAAmB,GAAG;AAChE,oBAAY,kBAAkB,QAAQ;AAAA,MACxC,OAAO;AACL,oBAAY,kBACV;AACF,gBAAQ,KACN,8EAA8E,QAAQ;AAAA,+BACxF;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,kBACV;AACF,cAAQ,KACN,gEAAgE,OAAO,QAAQ;AAAA,+BACjF;AAAA,IACF;AAAA,EACF;AAEA,MAAI,oCAAS,yBAAwB,QAAQ,yBAAyB,GAAG;AACvE,QAAI,OAAO,QAAQ,yBAAyB,UAAU;AACpD,UACE,QAAQ,wBAAwB,KAChC,QAAQ,wBAAwB,GAChC;AACA,oBAAY,uBAAuB,QAAQ;AAAA,MAC7C,OAAO;AACL,oBAAY,uBAAuB;AACnC,gBAAQ,KACN,mFAAmF,QAAQ;AAAA,+BAC7F;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,uBAAuB;AACnC,cAAQ,KACN,qEAAqE,OAAO,QAAQ;AAAA,+BACtF;AAAA,IACF;AAAA,EACF;AAEA,MAAI,oCAAS,0BAAyB,QAAQ,0BAA0B,GAAG;AACzE,QAAI,OAAO,QAAQ,0BAA0B,UAAU;AACrD,UACE,QAAQ,yBAAyB,KACjC,QAAQ,yBAAyB,GACjC;AACA,oBAAY,wBAAwB,QAAQ;AAAA,MAC9C,OAAO;AACL,oBAAY,wBAAwB;AACpC,gBAAQ,KACN,oFAAoF,QAAQ;AAAA,+BAC9F;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,wBAAwB;AACpC,cAAQ,KACN,sEAAsE,OAAO,QAAQ;AAAA,+BACvF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;AAQA,8BAA8B,UAAU,IAAI;AAC1C,SAAO,EAAE,cAAc,SAAS,YAA6B,UAAU;AACzE;",
+  "sourcesContent": ["import { averageIntensity } from \"../index.js\";\nimport {\n  GLOBAL_GRID_INTENSITY as SWDM3_GLOBAL_GRID_INTENSITY,\n  SWDV4,\n  PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD,\n  FIRST_TIME_VIEWING_PERCENTAGE,\n  RETURNING_VISITOR_PERCENTAGE,\n  SWDMV3_RATINGS,\n  SWDMV4_RATINGS,\n} from \"../constants/index.js\";\n\nconst SWDM4_GLOBAL_GRID_INTENSITY = SWDV4.GLOBAL_GRID_INTENSITY;\n// Shared type definitions to be used across different files\n\n/**\n * @typedef {Object} DomainCheckOptions options to control the behavior when checking a domain\n * @property {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.\n * @property {boolean} verbose - Optional. Whether to return a verbose response.\n * @property {string[]} db - Optional. A database list to use for lookups.\n */\n\nconst formatNumber = (num) => parseFloat(num.toFixed(2));\n\nconst lessThanEqualTo = (num, limit) => num <= limit;\n\nfunction parseOptions(options = {}, version = 3, green = false) {\n  const globalGridIntensity =\n    version === 4 ? SWDM4_GLOBAL_GRID_INTENSITY : SWDM3_GLOBAL_GRID_INTENSITY;\n  // CHeck that it is an object\n  if (typeof options !== \"object\") {\n    throw new Error(\"Options must be an object\");\n  }\n\n  const adjustments = {};\n\n  if (options?.gridIntensity) {\n    adjustments.gridIntensity = {};\n    const { device, dataCenter, network } = options.gridIntensity;\n    if (device || device === 0) {\n      if (typeof device === \"object\") {\n        if (!averageIntensity.data[device.country?.toUpperCase()]) {\n          console.warn(\n            `\"${device.country}\" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \\nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information. \\nFalling back to global average grid intensity.`\n          );\n          adjustments.gridIntensity[\"device\"] = {\n            value: globalGridIntensity,\n          };\n        }\n        adjustments.gridIntensity[\"device\"] = {\n          country: device.country,\n          value: parseFloat(\n            averageIntensity.data[device.country?.toUpperCase()]\n          ),\n        };\n      } else if (typeof device === \"number\") {\n        adjustments.gridIntensity[\"device\"] = {\n          value: device,\n        };\n      } else {\n        adjustments.gridIntensity[\"device\"] = {\n          value: globalGridIntensity,\n        };\n        console.warn(\n          `The device grid intensity must be a number or an object. You passed in a ${typeof device}. \\nFalling back to global average grid intensity.`\n        );\n      }\n    }\n    if (dataCenter || dataCenter === 0) {\n      if (typeof dataCenter === \"object\") {\n        if (!averageIntensity.data[dataCenter.country?.toUpperCase()]) {\n          console.warn(\n            `\"${dataCenter.country}\" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \\nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information.  \\nFalling back to global average grid intensity.`\n          );\n          adjustments.gridIntensity[\"dataCenter\"] = {\n            value: SWDM3_GLOBAL_GRID_INTENSITY,\n          };\n        }\n        adjustments.gridIntensity[\"dataCenter\"] = {\n          country: dataCenter.country,\n          value: parseFloat(\n            averageIntensity.data[dataCenter.country?.toUpperCase()]\n          ),\n        };\n      } else if (typeof dataCenter === \"number\") {\n        adjustments.gridIntensity[\"dataCenter\"] = {\n          value: dataCenter,\n        };\n      } else {\n        adjustments.gridIntensity[\"dataCenter\"] = {\n          value: globalGridIntensity,\n        };\n        console.warn(\n          `The data center grid intensity must be a number or an object. You passed in a ${typeof dataCenter}. \\nFalling back to global average grid intensity.`\n        );\n      }\n    }\n    if (network || network === 0) {\n      if (typeof network === \"object\") {\n        if (!averageIntensity.data[network.country?.toUpperCase()]) {\n          console.warn(\n            `\"${network.country}\" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \\nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information.  Falling back to global average grid intensity. \\nFalling back to global average grid intensity.`\n          );\n          adjustments.gridIntensity[\"network\"] = {\n            value: globalGridIntensity,\n          };\n        }\n        adjustments.gridIntensity[\"network\"] = {\n          country: network.country,\n          value: parseFloat(\n            averageIntensity.data[network.country?.toUpperCase()]\n          ),\n        };\n      } else if (typeof network === \"number\") {\n        adjustments.gridIntensity[\"network\"] = {\n          value: network,\n        };\n      } else {\n        adjustments.gridIntensity[\"network\"] = {\n          value: globalGridIntensity,\n        };\n        console.warn(\n          `The network grid intensity must be a number or an object. You passed in a ${typeof network}. \\nFalling back to global average grid intensity.`\n        );\n      }\n    }\n  } else {\n    adjustments.gridIntensity = {\n      device: { value: globalGridIntensity },\n      dataCenter: { value: globalGridIntensity },\n      network: { value: globalGridIntensity },\n    };\n  }\n\n  if (options?.dataReloadRatio || options.dataReloadRatio === 0) {\n    if (typeof options.dataReloadRatio === \"number\") {\n      if (options.dataReloadRatio >= 0 && options.dataReloadRatio <= 1) {\n        adjustments.dataReloadRatio = options.dataReloadRatio;\n      } else {\n        adjustments.dataReloadRatio =\n          version === 3 ? PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD : 0;\n        console.warn(\n          `The dataReloadRatio option must be a number between 0 and 1. You passed in ${options.dataReloadRatio}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.dataReloadRatio =\n        version === 3 ? PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD : 0;\n      console.warn(\n        `The dataReloadRatio option must be a number. You passed in a ${typeof options.dataReloadRatio}. \\nFalling back to default value.`\n      );\n    }\n  } else {\n    adjustments.dataReloadRatio =\n      version === 3 ? PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD : 0;\n    console.warn(\n      `The dataReloadRatio option must be a number. You passed in a ${typeof options.dataReloadRatio}. \\nFalling back to default value.`\n    );\n  }\n\n  if (options?.firstVisitPercentage || options.firstVisitPercentage === 0) {\n    if (typeof options.firstVisitPercentage === \"number\") {\n      if (\n        options.firstVisitPercentage >= 0 &&\n        options.firstVisitPercentage <= 1\n      ) {\n        adjustments.firstVisitPercentage = options.firstVisitPercentage;\n      } else {\n        adjustments.firstVisitPercentage =\n          version === 3 ? FIRST_TIME_VIEWING_PERCENTAGE : 1;\n        console.warn(\n          `The firstVisitPercentage option must be a number between 0 and 1. You passed in ${options.firstVisitPercentage}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.firstVisitPercentage =\n        version === 3 ? FIRST_TIME_VIEWING_PERCENTAGE : 1;\n      console.warn(\n        `The firstVisitPercentage option must be a number. You passed in a ${typeof options.firstVisitPercentage}. \\nFalling back to default value.`\n      );\n    }\n  } else {\n    adjustments.firstVisitPercentage =\n      version === 3 ? FIRST_TIME_VIEWING_PERCENTAGE : 1;\n    console.warn(\n      `The firstVisitPercentage option must be a number. You passed in a ${typeof options.firstVisitPercentage}. \\nFalling back to default value.`\n    );\n  }\n\n  if (options?.returnVisitPercentage || options.returnVisitPercentage === 0) {\n    if (typeof options.returnVisitPercentage === \"number\") {\n      if (\n        options.returnVisitPercentage >= 0 &&\n        options.returnVisitPercentage <= 1\n      ) {\n        adjustments.returnVisitPercentage = options.returnVisitPercentage;\n      } else {\n        adjustments.returnVisitPercentage =\n          version === 3 ? RETURNING_VISITOR_PERCENTAGE : 0;\n        console.warn(\n          `The returnVisitPercentage option must be a number between 0 and 1. You passed in ${options.returnVisitPercentage}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.returnVisitPercentage =\n        version === 3 ? RETURNING_VISITOR_PERCENTAGE : 0;\n      console.warn(\n        `The returnVisitPercentage option must be a number. You passed in a ${typeof options.returnVisitPercentage}. \\nFalling back to default value.`\n      );\n    }\n  } else {\n    adjustments.returnVisitPercentage =\n      version === 3 ? RETURNING_VISITOR_PERCENTAGE : 0;\n    console.warn(\n      `The returnVisitPercentage option must be a number. You passed in a ${typeof options.returnVisitPercentage}. \\nFalling back to default value.`\n    );\n  }\n\n  if (\n    options?.greenHostingFactor ||\n    (options.greenHostingFactor === 0 && version === 4)\n  ) {\n    if (typeof options.greenHostingFactor === \"number\") {\n      if (options.greenHostingFactor >= 0 && options.greenHostingFactor <= 1) {\n        adjustments.greenHostingFactor = options.greenHostingFactor;\n      } else {\n        adjustments.greenHostingFactor = 0;\n        console.warn(\n          `The returnVisitPercentage option must be a number between 0 and 1. You passed in ${options.returnVisitPercentage}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.greenHostingFactor = 0;\n      console.warn(\n        `The returnVisitPercentage option must be a number. You passed in a ${typeof options.returnVisitPercentage}. \\nFalling back to default value.`\n      );\n    }\n  } else if (version === 4) {\n    adjustments.greenHostingFactor = 0;\n  }\n\n  if (green) {\n    adjustments.greenHostingFactor = 1;\n  }\n\n  return adjustments;\n}\n\n/**\n * Returns an object containing all the HTTP headers to use when making a request to the Green Web Foundation API.\n * @param {string} comment - Optional. The app, site, or organisation that is making the request.\n *\n * @returns {import('http').OutgoingHttpHeaders}\n */\nfunction getApiRequestHeaders(comment = \"\") {\n  return { \"User-Agent\": `co2js/${process.env.CO2JS_VERSION} ${comment}` };\n}\n\n/**\n * Returns the SWDM rating for a given CO2e value and version of the SWDM.\n * @param {number} co2e - The CO2e value to rate.\n * @param {number} swdmVersion - The version of the SWDM to use. Defaults to version 3.\n * @returns {string} The SWDM rating.\n */\nfunction outputRating(co2e, swdmVersion) {\n  let {\n    FIFTH_PERCENTILE,\n    TENTH_PERCENTILE,\n    TWENTIETH_PERCENTILE,\n    THIRTIETH_PERCENTILE,\n    FORTIETH_PERCENTILE,\n    FIFTIETH_PERCENTILE,\n  } = SWDMV3_RATINGS;\n\n  if (swdmVersion === 4) {\n    FIFTH_PERCENTILE = SWDMV4_RATINGS.FIFTH_PERCENTILE;\n    TENTH_PERCENTILE = SWDMV4_RATINGS.TENTH_PERCENTILE;\n    TWENTIETH_PERCENTILE = SWDMV4_RATINGS.TWENTIETH_PERCENTILE;\n    THIRTIETH_PERCENTILE = SWDMV4_RATINGS.THIRTIETH_PERCENTILE;\n    FORTIETH_PERCENTILE = SWDMV4_RATINGS.FORTIETH_PERCENTILE;\n    FIFTIETH_PERCENTILE = SWDMV4_RATINGS.FIFTIETH_PERCENTILE;\n  }\n\n  if (lessThanEqualTo(co2e, FIFTH_PERCENTILE)) {\n    return \"A+\";\n  } else if (lessThanEqualTo(co2e, TENTH_PERCENTILE)) {\n    return \"A\";\n  } else if (lessThanEqualTo(co2e, TWENTIETH_PERCENTILE)) {\n    return \"B\";\n  } else if (lessThanEqualTo(co2e, THIRTIETH_PERCENTILE)) {\n    return \"C\";\n  } else if (lessThanEqualTo(co2e, FORTIETH_PERCENTILE)) {\n    return \"D\";\n  } else if (lessThanEqualTo(co2e, FIFTIETH_PERCENTILE)) {\n    return \"E\";\n  } else {\n    return \"F\";\n  }\n}\n\nexport {\n  formatNumber,\n  parseOptions,\n  getApiRequestHeaders,\n  lessThanEqualTo,\n  outputRating,\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,eAAiC;AACjC,uBAQO;AAEP,MAAM,8BAA8B,uBAAM;AAU1C,MAAM,eAAe,CAAC,QAAQ,WAAW,IAAI,QAAQ,CAAC,CAAC;AAEvD,MAAM,kBAAkB,CAAC,KAAK,UAAU,OAAO;AAE/C,sBAAsB,UAAU,CAAC,GAAG,UAAU,GAAG,QAAQ,OAAO;AAzBhE;AA0BE,QAAM,sBACJ,YAAY,IAAI,8BAA8B;AAEhD,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAM,IAAI,MAAM,2BAA2B;AAAA,EAC7C;AAEA,QAAM,cAAc,CAAC;AAErB,MAAI,mCAAS,eAAe;AAC1B,gBAAY,gBAAgB,CAAC;AAC7B,UAAM,EAAE,QAAQ,YAAY,YAAY,QAAQ;AAChD,QAAI,UAAU,WAAW,GAAG;AAC1B,UAAI,OAAO,WAAW,UAAU;AAC9B,YAAI,CAAC,0BAAiB,KAAK,aAAO,YAAP,mBAAgB,gBAAgB;AACzD,kBAAQ,KACN,IAAI,OAAO;AAAA;AAAA,+CACb;AACA,sBAAY,cAAc,YAAY;AAAA,YACpC,OAAO;AAAA,UACT;AAAA,QACF;AACA,oBAAY,cAAc,YAAY;AAAA,UACpC,SAAS,OAAO;AAAA,UAChB,OAAO,WACL,0BAAiB,KAAK,aAAO,YAAP,mBAAgB,cACxC;AAAA,QACF;AAAA,MACF,WAAW,OAAO,WAAW,UAAU;AACrC,oBAAY,cAAc,YAAY;AAAA,UACpC,OAAO;AAAA,QACT;AAAA,MACF,OAAO;AACL,oBAAY,cAAc,YAAY;AAAA,UACpC,OAAO;AAAA,QACT;AACA,gBAAQ,KACN,4EAA4E,OAAO;AAAA,+CACrF;AAAA,MACF;AAAA,IACF;AACA,QAAI,cAAc,eAAe,GAAG;AAClC,UAAI,OAAO,eAAe,UAAU;AAClC,YAAI,CAAC,0BAAiB,KAAK,iBAAW,YAAX,mBAAoB,gBAAgB;AAC7D,kBAAQ,KACN,IAAI,WAAW;AAAA;AAAA,+CACjB;AACA,sBAAY,cAAc,gBAAgB;AAAA,YACxC,OAAO;AAAA,UACT;AAAA,QACF;AACA,oBAAY,cAAc,gBAAgB;AAAA,UACxC,SAAS,WAAW;AAAA,UACpB,OAAO,WACL,0BAAiB,KAAK,iBAAW,YAAX,mBAAoB,cAC5C;AAAA,QACF;AAAA,MACF,WAAW,OAAO,eAAe,UAAU;AACzC,oBAAY,cAAc,gBAAgB;AAAA,UACxC,OAAO;AAAA,QACT;AAAA,MACF,OAAO;AACL,oBAAY,cAAc,gBAAgB;AAAA,UACxC,OAAO;AAAA,QACT;AACA,gBAAQ,KACN,iFAAiF,OAAO;AAAA,+CAC1F;AAAA,MACF;AAAA,IACF;AACA,QAAI,WAAW,YAAY,GAAG;AAC5B,UAAI,OAAO,YAAY,UAAU;AAC/B,YAAI,CAAC,0BAAiB,KAAK,cAAQ,YAAR,mBAAiB,gBAAgB;AAC1D,kBAAQ,KACN,IAAI,QAAQ;AAAA;AAAA,+CACd;AACA,sBAAY,cAAc,aAAa;AAAA,YACrC,OAAO;AAAA,UACT;AAAA,QACF;AACA,oBAAY,cAAc,aAAa;AAAA,UACrC,SAAS,QAAQ;AAAA,UACjB,OAAO,WACL,0BAAiB,KAAK,cAAQ,YAAR,mBAAiB,cACzC;AAAA,QACF;AAAA,MACF,WAAW,OAAO,YAAY,UAAU;AACtC,oBAAY,cAAc,aAAa;AAAA,UACrC,OAAO;AAAA,QACT;AAAA,MACF,OAAO;AACL,oBAAY,cAAc,aAAa;AAAA,UACrC,OAAO;AAAA,QACT;AACA,gBAAQ,KACN,6EAA6E,OAAO;AAAA,+CACtF;AAAA,MACF;AAAA,IACF;AAAA,EACF,OAAO;AACL,gBAAY,gBAAgB;AAAA,MAC1B,QAAQ,EAAE,OAAO,oBAAoB;AAAA,MACrC,YAAY,EAAE,OAAO,oBAAoB;AAAA,MACzC,SAAS,EAAE,OAAO,oBAAoB;AAAA,IACxC;AAAA,EACF;AAEA,MAAI,oCAAS,oBAAmB,QAAQ,oBAAoB,GAAG;AAC7D,QAAI,OAAO,QAAQ,oBAAoB,UAAU;AAC/C,UAAI,QAAQ,mBAAmB,KAAK,QAAQ,mBAAmB,GAAG;AAChE,oBAAY,kBAAkB,QAAQ;AAAA,MACxC,OAAO;AACL,oBAAY,kBACV,YAAY,IAAI,gEAA+C;AACjE,gBAAQ,KACN,8EAA8E,QAAQ;AAAA,+BACxF;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,kBACV,YAAY,IAAI,gEAA+C;AACjE,cAAQ,KACN,gEAAgE,OAAO,QAAQ;AAAA,+BACjF;AAAA,IACF;AAAA,EACF,OAAO;AACL,gBAAY,kBACV,YAAY,IAAI,gEAA+C;AACjE,YAAQ,KACN,gEAAgE,OAAO,QAAQ;AAAA,+BACjF;AAAA,EACF;AAEA,MAAI,oCAAS,yBAAwB,QAAQ,yBAAyB,GAAG;AACvE,QAAI,OAAO,QAAQ,yBAAyB,UAAU;AACpD,UACE,QAAQ,wBAAwB,KAChC,QAAQ,wBAAwB,GAChC;AACA,oBAAY,uBAAuB,QAAQ;AAAA,MAC7C,OAAO;AACL,oBAAY,uBACV,YAAY,IAAI,iDAAgC;AAClD,gBAAQ,KACN,mFAAmF,QAAQ;AAAA,+BAC7F;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,uBACV,YAAY,IAAI,iDAAgC;AAClD,cAAQ,KACN,qEAAqE,OAAO,QAAQ;AAAA,+BACtF;AAAA,IACF;AAAA,EACF,OAAO;AACL,gBAAY,uBACV,YAAY,IAAI,iDAAgC;AAClD,YAAQ,KACN,qEAAqE,OAAO,QAAQ;AAAA,+BACtF;AAAA,EACF;AAEA,MAAI,oCAAS,0BAAyB,QAAQ,0BAA0B,GAAG;AACzE,QAAI,OAAO,QAAQ,0BAA0B,UAAU;AACrD,UACE,QAAQ,yBAAyB,KACjC,QAAQ,yBAAyB,GACjC;AACA,oBAAY,wBAAwB,QAAQ;AAAA,MAC9C,OAAO;AACL,oBAAY,wBACV,YAAY,IAAI,gDAA+B;AACjD,gBAAQ,KACN,oFAAoF,QAAQ;AAAA,+BAC9F;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,wBACV,YAAY,IAAI,gDAA+B;AACjD,cAAQ,KACN,sEAAsE,OAAO,QAAQ;AAAA,+BACvF;AAAA,IACF;AAAA,EACF,OAAO;AACL,gBAAY,wBACV,YAAY,IAAI,gDAA+B;AACjD,YAAQ,KACN,sEAAsE,OAAO,QAAQ;AAAA,+BACvF;AAAA,EACF;AAEA,MACE,oCAAS,uBACR,QAAQ,uBAAuB,KAAK,YAAY,GACjD;AACA,QAAI,OAAO,QAAQ,uBAAuB,UAAU;AAClD,UAAI,QAAQ,sBAAsB,KAAK,QAAQ,sBAAsB,GAAG;AACtE,oBAAY,qBAAqB,QAAQ;AAAA,MAC3C,OAAO;AACL,oBAAY,qBAAqB;AACjC,gBAAQ,KACN,oFAAoF,QAAQ;AAAA,+BAC9F;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,qBAAqB;AACjC,cAAQ,KACN,sEAAsE,OAAO,QAAQ;AAAA,+BACvF;AAAA,IACF;AAAA,EACF,WAAW,YAAY,GAAG;AACxB,gBAAY,qBAAqB;AAAA,EACnC;AAEA,MAAI,OAAO;AACT,gBAAY,qBAAqB;AAAA,EACnC;AAEA,SAAO;AACT;AAQA,8BAA8B,UAAU,IAAI;AAC1C,SAAO,EAAE,cAAc,SAAS,YAA6B,UAAU;AACzE;AAQA,sBAAsB,MAAM,aAAa;AACvC,MAAI;AAAA,IACF;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,MACE;AAEJ,MAAI,gBAAgB,GAAG;AACrB,uBAAmB,gCAAe;AAClC,uBAAmB,gCAAe;AAClC,2BAAuB,gCAAe;AACtC,2BAAuB,gCAAe;AACtC,0BAAsB,gCAAe;AACrC,0BAAsB,gCAAe;AAAA,EACvC;AAEA,MAAI,gBAAgB,MAAM,gBAAgB,GAAG;AAC3C,WAAO;AAAA,EACT,WAAW,gBAAgB,MAAM,gBAAgB,GAAG;AAClD,WAAO;AAAA,EACT,WAAW,gBAAgB,MAAM,oBAAoB,GAAG;AACtD,WAAO;AAAA,EACT,WAAW,gBAAgB,MAAM,oBAAoB,GAAG;AACtD,WAAO;AAAA,EACT,WAAW,gBAAgB,MAAM,mBAAmB,GAAG;AACrD,WAAO;AAAA,EACT,WAAW,gBAAgB,MAAM,mBAAmB,GAAG;AACrD,WAAO;AAAA,EACT,OAAO;AACL,WAAO;AAAA,EACT;AACF;",
   "names": []
 }

package/dist/cjs/hosting.js

@@ -28,7 +28,5 @@ var import_hosting_api = __toESM(require("./hosting-api.js"));
 function check(domain, optionsOrAgentId) {
   return import_hosting_api.default.check(domain, optionsOrAgentId);
 }
-var hosting_default = {
-  check
-};
+var hosting_default = check;
 //# sourceMappingURL=hosting.js.map

package/dist/cjs/hosting.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/hosting.js"],
-  "sourcesContent": ["\"use strict\";\n\nimport hostingAPI from \"./hosting-api.js\";\n\n/**\n * Check if a domain is hosted by a green web host.\n * @param {string|array} domain - The domain to check, or an array of domains to be checked.\n * @param {string} optionsOrAgentId - Optional. An object of domain check options, or a string\n *   representing the app, site, or organisation that is making the request.\n * @returns - A boolean if a string was provided, or an array of booleans if an array of domains was provided.\n *   if a string was provided for `domain`: a boolean indicating whether the domain is hosted by a green web host if `options.verbose` is false,\n *     otherwise an object representing the domain host information.\n *   if an array was provided for `domain`: an array of domains that are hosted by a green web host if `options.verbose` is false,\n *     otherwise a dictionary of domain to host information.\n */\nfunction check(domain, optionsOrAgentId) {\n  return hostingAPI.check(domain, optionsOrAgentId);\n}\n\nexport default {\n  check,\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,yBAAuB;AAavB,eAAe,QAAQ,kBAAkB;AACvC,SAAO,2BAAW,MAAM,QAAQ,gBAAgB;AAClD;AAEA,IAAO,kBAAQ;AAAA,EACb;AACF;",
+  "sourcesContent": ["\"use strict\";\n\nimport hostingAPI from \"./hosting-api.js\";\n\n/**\n * @module hosting\n */\n\n/**\n * Check if a domain is hosted by a green web host.\n * @param {string|array} domain - The domain to check, or an array of domains to be checked.\n * @param {string} optionsOrAgentId - Optional. An object of domain check options, or a string\n *   representing the app, site, or organisation that is making the request.\n * @returns - A boolean if a string was provided, or an array of booleans if an array of domains was provided.\n *   if a string was provided for `domain`: a boolean indicating whether the domain is hosted by a green web host if `options.verbose` is false,\n *     otherwise an object representing the domain host information.\n *   if an array was provided for `domain`: an array of domains that are hosted by a green web host if `options.verbose` is false,\n *     otherwise a dictionary of domain to host information.\n */\nfunction check(domain, optionsOrAgentId) {\n  return hostingAPI.check(domain, optionsOrAgentId);\n}\n\nexport default check;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,yBAAuB;AAiBvB,eAAe,QAAQ,kBAAkB;AACvC,SAAO,2BAAW,MAAM,QAAQ,gBAAgB;AAClD;AAEA,IAAO,kBAAQ;",
   "names": []
 }

package/dist/cjs/{sustainable-web-design.js → sustainable-web-design-v3.js}

@@ -16,17 +16,19 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var sustainable_web_design_exports = {};
-__export(sustainable_web_design_exports, {
+var sustainable_web_design_v3_exports = {};
+__export(sustainable_web_design_v3_exports, {
   SustainableWebDesign: () => SustainableWebDesign,
-  default: () => sustainable_web_design_default
+  default: () => sustainable_web_design_v3_default
 });
-module.exports = __toCommonJS(sustainable_web_design_exports);
+module.exports = __toCommonJS(sustainable_web_design_v3_exports);
 var import_constants = require("./constants/index.js");
 var import_helpers = require("./helpers/index.js");
 class SustainableWebDesign {
   constructor(options) {
+    this.allowRatings = true;
     this.options = options;
+    this.version = 3;
   }
   energyPerByteByComponent(bytes) {
     const transferedBytesToGb = bytes / import_constants.fileSize.GIGABYTE;
@@ -72,7 +74,7 @@ class SustainableWebDesign {
     }
     return returnCO2ByComponent;
   }
-  perByte(bytes, carbonIntensity = false, segmentResults = false, options = {}) {
+  perByte(bytes, carbonIntensity = false, segmentResults = false, ratingResults = false, options = {}) {
     if (bytes < 1) {
       bytes = 0;
     }
@@ -83,12 +85,26 @@ class SustainableWebDesign {
     const co2ValuesbyComponent = this.co2byComponent(energyBycomponent, carbonIntensity, options);
     const co2Values = Object.values(co2ValuesbyComponent);
     const co2ValuesSum = co2Values.reduce((prevValue, currentValue) => prevValue + currentValue);
+    let rating = null;
+    if (ratingResults) {
+      rating = this.ratingScale(co2ValuesSum);
+    }
     if (segmentResults) {
+      if (ratingResults) {
+        return {
+          ...co2ValuesbyComponent,
+          total: co2ValuesSum,
+          rating
+        };
+      }
       return { ...co2ValuesbyComponent, total: co2ValuesSum };
     }
+    if (ratingResults) {
+      return { total: co2ValuesSum, rating };
+    }
     return co2ValuesSum;
   }
-  perVisit(bytes, carbonIntensity = false, segmentResults = false, options = {}) {
+  perVisit(bytes, carbonIntensity = false, segmentResults = false, ratingResults = false, options = {}) {
     const energyBycomponent = this.energyPerVisitByComponent(bytes, options);
     if (typeof carbonIntensity !== "boolean") {
       throw new Error(`perVisit expects a boolean for the carbon intensity value. Received: ${carbonIntensity}`);
@@ -96,9 +112,23 @@ class SustainableWebDesign {
     const co2ValuesbyComponent = this.co2byComponent(energyBycomponent, carbonIntensity, options);
     const co2Values = Object.values(co2ValuesbyComponent);
     const co2ValuesSum = co2Values.reduce((prevValue, currentValue) => prevValue + currentValue);
+    let rating = null;
+    if (ratingResults) {
+      rating = this.ratingScale(co2ValuesSum);
+    }
     if (segmentResults) {
+      if (ratingResults) {
+        return {
+          ...co2ValuesbyComponent,
+          total: co2ValuesSum,
+          rating
+        };
+      }
       return { ...co2ValuesbyComponent, total: co2ValuesSum };
     }
+    if (ratingResults) {
+      return { total: co2ValuesSum, rating };
+    }
     return co2ValuesSum;
   }
   energyPerByte(bytes) {
@@ -158,6 +188,9 @@ class SustainableWebDesign {
       productionEnergy: (0, import_helpers.formatNumber)(annualEnergy * import_constants.PRODUCTION_ENERGY)
     };
   }
+  ratingScale(co2e) {
+    return (0, import_helpers.outputRating)(co2e, this.version);
+  }
 }
-var sustainable_web_design_default = SustainableWebDesign;
-//# sourceMappingURL=sustainable-web-design.js.map
+var sustainable_web_design_v3_default = SustainableWebDesign;
+//# sourceMappingURL=sustainable-web-design-v3.js.map

package/dist/cjs/sustainable-web-design-v3.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/sustainable-web-design-v3.js"],
+  "sourcesContent": ["\"use strict\";\n\n/**\n * Sustainable Web Design\n *\n * Updated calculations and figures from\n * https://sustainablewebdesign.org/calculating-digital-emissions/\n *\n */\n\nimport {\n  fileSize,\n  KWH_PER_GB,\n  END_USER_DEVICE_ENERGY,\n  NETWORK_ENERGY,\n  DATACENTER_ENERGY,\n  PRODUCTION_ENERGY,\n  GLOBAL_GRID_INTENSITY,\n  RENEWABLES_GRID_INTENSITY,\n  FIRST_TIME_VIEWING_PERCENTAGE,\n  RETURNING_VISITOR_PERCENTAGE,\n  PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD,\n} from \"./constants/index.js\";\nimport { formatNumber, outputRating } from \"./helpers/index.js\";\n\nclass SustainableWebDesign {\n  constructor(options) {\n    this.allowRatings = true;\n    this.options = options;\n    this.version = 3;\n  }\n\n  /**\n   * Accept a figure for bytes transferred and return an object representing\n   * the share of the total enrgy use of the entire system, broken down\n   * by each corresponding system component\n   *\n   * @param {number}  bytes - the data transferred in bytes\n   * @return {object} Object containing the energy in kilowatt hours, keyed by system component\n   */\n  energyPerByteByComponent(bytes) {\n    const transferedBytesToGb = bytes / fileSize.GIGABYTE;\n    const energyUsage = transferedBytesToGb * KWH_PER_GB;\n\n    // return the total energy, with breakdown by component\n    return {\n      consumerDeviceEnergy: energyUsage * END_USER_DEVICE_ENERGY,\n      networkEnergy: energyUsage * NETWORK_ENERGY,\n      productionEnergy: energyUsage * PRODUCTION_ENERGY,\n      dataCenterEnergy: energyUsage * DATACENTER_ENERGY,\n    };\n  }\n  /**\n   * Accept an object keys by the different system components, and\n   * return an object with the co2 figures key by the each component\n   *\n   * @param {object} energyByComponent - energy grouped by the four system components\n   * @param {number} [carbonIntensity] - carbon intensity to apply to the datacentre values\n   * @return {number} the total number in grams of CO2 equivalent emissions\n   */\n  co2byComponent(\n    energyByComponent,\n    carbonIntensity = GLOBAL_GRID_INTENSITY,\n    options = {}\n  ) {\n    let deviceCarbonIntensity = GLOBAL_GRID_INTENSITY;\n    let networkCarbonIntensity = GLOBAL_GRID_INTENSITY;\n    let dataCenterCarbonIntensity = GLOBAL_GRID_INTENSITY;\n\n    let globalEmissions = GLOBAL_GRID_INTENSITY;\n\n    if (options?.gridIntensity) {\n      const { device, network, dataCenter } = options.gridIntensity;\n\n      if (device?.value || device?.value === 0) {\n        deviceCarbonIntensity = device.value;\n      }\n      if (network?.value || network?.value === 0) {\n        networkCarbonIntensity = network.value;\n      }\n      // If the user has set a carbon intensity value for the datacentre, then that overrides everything and is used\n      if (dataCenter?.value || dataCenter?.value === 0) {\n        dataCenterCarbonIntensity = dataCenter.value;\n      }\n    }\n\n    // If the user passes in a TRUE value (green web host), then use the renewables intensity value\n    if (carbonIntensity === true) {\n      dataCenterCarbonIntensity = RENEWABLES_GRID_INTENSITY;\n    }\n\n    const returnCO2ByComponent = {};\n    for (const [key, value] of Object.entries(energyByComponent)) {\n      // we update the datacentre, as that's what we have information\n      // about.\n      if (key.startsWith(\"dataCenterEnergy\")) {\n        returnCO2ByComponent[key.replace(\"Energy\", \"CO2\")] =\n          value * dataCenterCarbonIntensity;\n      } else if (key.startsWith(\"consumerDeviceEnergy\")) {\n        returnCO2ByComponent[key.replace(\"Energy\", \"CO2\")] =\n          value * deviceCarbonIntensity;\n      } else if (key.startsWith(\"networkEnergy\")) {\n        returnCO2ByComponent[key.replace(\"Energy\", \"CO2\")] =\n          value * networkCarbonIntensity;\n      } else {\n        // Use the global intensity for the remaining segments\n        returnCO2ByComponent[key.replace(\"Energy\", \"CO2\")] =\n          value * globalEmissions;\n      }\n    }\n\n    return returnCO2ByComponent;\n  }\n\n  /**\n   * Accept a figure for bytes transferred and return a single figure for CO2\n   * emissions. Where information exists about the origin data is being\n   * fetched from, a different carbon intensity figure\n   * is applied for the data centre share of the carbon intensity.\n   *\n   * @param {number} bytes - the data transferred in bytes\n   * @param {boolean} carbonIntensity - a boolean indicating whether the data center is green or not\n   * @param {boolean} segmentResults - a boolean indicating whether to return the results broken down by component\n   * @param {boolean} ratingResults - a boolean indicating whether to return the rating based on the Sustainable Web Design Model\n   * @param {object} options - an object containing the grid intensity and first/return visitor values\n   * @return {number|object} the total number in grams of CO2 equivalent emissions, or an object containing the breakdown by component\n   */\n  perByte(\n    bytes,\n    carbonIntensity = false,\n    segmentResults = false,\n    ratingResults = false,\n    options = {}\n  ) {\n    if (bytes < 1) {\n      bytes = 0;\n    }\n\n    const energyBycomponent = this.energyPerByteByComponent(bytes, options);\n\n    // otherwise when faced with non numeric values throw an error\n    if (typeof carbonIntensity !== \"boolean\") {\n      throw new Error(\n        `perByte expects a boolean for the carbon intensity value. Received: ${carbonIntensity}`\n      );\n    }\n\n    const co2ValuesbyComponent = this.co2byComponent(\n      energyBycomponent,\n      carbonIntensity,\n      options\n    );\n\n    // pull out our values\u2026\n    const co2Values = Object.values(co2ValuesbyComponent);\n    const co2ValuesSum = co2Values.reduce(\n      (prevValue, currentValue) => prevValue + currentValue\n    );\n\n    let rating = null;\n    if (ratingResults) {\n      rating = this.ratingScale(co2ValuesSum);\n    }\n\n    if (segmentResults) {\n      if (ratingResults) {\n        return {\n          ...co2ValuesbyComponent,\n          total: co2ValuesSum,\n          rating: rating,\n        };\n      }\n\n      return { ...co2ValuesbyComponent, total: co2ValuesSum };\n    }\n\n    if (ratingResults) {\n      return { total: co2ValuesSum, rating: rating };\n    }\n\n    return co2ValuesSum;\n  }\n\n  /**\n   * Accept a figure for bytes transferred and return a single figure for CO2\n   * emissions. This method applies caching assumptions from the original Sustainable Web Design model.\n   *\n   * @param {number} bytes - the data transferred in bytes\n   * @param {boolean} carbonIntensity - a boolean indicating whether the data center is green or not\n   * @param {boolean} segmentResults - a boolean indicating whether to return the results broken down by component\n   * @param {boolean} ratingResults - a boolean indicating whether to return the rating based on the Sustainable Web Design Model\n   * @param {object} options - an object containing the grid intensity and first/return visitor values\n   * @return {number|object} the total number in grams of CO2 equivalent emissions, or an object containing the breakdown by component\n   */\n  perVisit(\n    bytes,\n    carbonIntensity = false,\n    segmentResults = false,\n    ratingResults = false,\n    options = {}\n  ) {\n    const energyBycomponent = this.energyPerVisitByComponent(bytes, options);\n\n    if (typeof carbonIntensity !== \"boolean\") {\n      // otherwise when faced with non numeric values throw an error\n      throw new Error(\n        `perVisit expects a boolean for the carbon intensity value. Received: ${carbonIntensity}`\n      );\n    }\n\n    const co2ValuesbyComponent = this.co2byComponent(\n      energyBycomponent,\n      carbonIntensity,\n      options\n    );\n\n    // pull out our values\u2026\n    const co2Values = Object.values(co2ValuesbyComponent);\n    const co2ValuesSum = co2Values.reduce(\n      (prevValue, currentValue) => prevValue + currentValue\n    );\n\n    let rating = null;\n    if (ratingResults) {\n      rating = this.ratingScale(co2ValuesSum);\n    }\n\n    if (segmentResults) {\n      if (ratingResults) {\n        return {\n          ...co2ValuesbyComponent,\n          total: co2ValuesSum,\n          rating: rating,\n        };\n      }\n      return { ...co2ValuesbyComponent, total: co2ValuesSum };\n    }\n\n    if (ratingResults) {\n      return { total: co2ValuesSum, rating: rating };\n    }\n\n    // so we can return their sum\n    return co2ValuesSum;\n  }\n\n  /**\n   * Accept a figure for bytes transferred and return the number of kilowatt hours used\n   * by the total system for this data transfer\n   *\n   * @param {number} bytes\n   * @return {number} the number of kilowatt hours used\n   */\n  energyPerByte(bytes) {\n    const energyByComponent = this.energyPerByteByComponent(bytes);\n\n    // pull out our values\u2026\n    const energyValues = Object.values(energyByComponent);\n\n    // so we can return their sum\n    return energyValues.reduce(\n      (prevValue, currentValue) => prevValue + currentValue\n    );\n  }\n\n  /**\n   * Accept a figure for bytes transferred, and return an object containing figures\n   * per system component, with the caching assumptions applied. This tries to account\n   * for webpages being loaded from a cache by browsers, so if you had a thousand page views,\n   * and tried to work out the energy per visit, the numbers would reflect the reduced amounts\n   * of transfer.\n   *\n   * @param {number} bytes - the data transferred in bytes for loading a webpage\n   * @param {number} firstView - what percentage of visits are loading this page for the first time\n   * @param {number} returnView - what percentage of visits are loading this page for subsequent times\n   * @param {number} dataReloadRatio - what percentage of a page is reloaded on each subsequent page view\n   *\n   * @return {object} Object containing the energy in kilowatt hours, keyed by system component\n   */\n  energyPerVisitByComponent(\n    bytes,\n    options = {},\n    firstView = FIRST_TIME_VIEWING_PERCENTAGE,\n    returnView = RETURNING_VISITOR_PERCENTAGE,\n    dataReloadRatio = PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD\n  ) {\n    if (options.dataReloadRatio || options.dataReloadRatio === 0) {\n      dataReloadRatio = options.dataReloadRatio;\n    }\n\n    if (options.firstVisitPercentage || options.firstVisitPercentage === 0) {\n      firstView = options.firstVisitPercentage;\n    }\n\n    if (options.returnVisitPercentage || options.returnVisitPercentage === 0) {\n      returnView = options.returnVisitPercentage;\n    }\n\n    const energyBycomponent = this.energyPerByteByComponent(bytes);\n    const cacheAdjustedSegmentEnergy = {};\n\n    const energyValues = Object.values(energyBycomponent);\n\n    // for this, we want\n    for (const [key, value] of Object.entries(energyBycomponent)) {\n      // represent the first load\n      cacheAdjustedSegmentEnergy[`${key} - first`] = value * firstView;\n\n      // then represent the subsequent load\n      cacheAdjustedSegmentEnergy[`${key} - subsequent`] =\n        value * returnView * dataReloadRatio;\n    }\n\n    return cacheAdjustedSegmentEnergy;\n  }\n\n  /**\n   * Accept a figure for bytes, and return the total figure for energy per visit\n   * using the default caching assumptions for loading a single website\n   *\n   * @param {number} bytes\n   * @return {number} the total energy use for the visit, after applying the caching assumptions\n   */\n  energyPerVisit(bytes) {\n    // fetch the values using the default caching assumptions\n    // const energyValues = Object.values(this.energyPerVisitByComponent(bytes));\n\n    let firstVisits = 0;\n    let subsequentVisits = 0;\n\n    const energyBycomponent = Object.entries(\n      this.energyPerVisitByComponent(bytes)\n    );\n\n    for (const [key, val] of energyBycomponent) {\n      if (key.indexOf(\"first\") > 0) {\n        firstVisits += val;\n      }\n    }\n\n    for (const [key, val] of energyBycomponent) {\n      if (key.indexOf(\"subsequent\") > 0) {\n        subsequentVisits += val;\n      }\n    }\n\n    return firstVisits + subsequentVisits;\n  }\n\n  emissionsPerVisitInGrams(\n    energyPerVisit,\n    carbonintensity = GLOBAL_GRID_INTENSITY\n  ) {\n    return formatNumber(energyPerVisit * carbonintensity);\n  }\n\n  annualEnergyInKwh(energyPerVisit, monthlyVisitors = 1000) {\n    return energyPerVisit * monthlyVisitors * 12;\n  }\n\n  annualEmissionsInGrams(co2grams, monthlyVisitors = 1000) {\n    return co2grams * monthlyVisitors * 12;\n  }\n\n  annualSegmentEnergy(annualEnergy) {\n    return {\n      consumerDeviceEnergy: formatNumber(annualEnergy * END_USER_DEVICE_ENERGY),\n      networkEnergy: formatNumber(annualEnergy * NETWORK_ENERGY),\n      dataCenterEnergy: formatNumber(annualEnergy * DATACENTER_ENERGY),\n      productionEnergy: formatNumber(annualEnergy * PRODUCTION_ENERGY),\n    };\n  }\n\n  /**\n   * Determines the rating of a website's sustainability based on its CO2 emissions.\n   *\n   * @param {number} co2e - The CO2 emissions of the website in grams.\n   * @returns {string} The sustainability rating, ranging from \"A+\" (best) to \"F\" (worst).\n   */\n  ratingScale(co2e) {\n    return outputRating(co2e, this.version);\n  }\n}\n\nexport { SustainableWebDesign };\nexport default SustainableWebDesign;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,uBAYO;AACP,qBAA2C;AAE3C,MAAM,qBAAqB;AAAA,EACzB,YAAY,SAAS;AACnB,SAAK,eAAe;AACpB,SAAK,UAAU;AACf,SAAK,UAAU;AAAA,EACjB;AAAA,EAUA,yBAAyB,OAAO;AAC9B,UAAM,sBAAsB,QAAQ,0BAAS;AAC7C,UAAM,cAAc,sBAAsB;AAG1C,WAAO;AAAA,MACL,sBAAsB,cAAc;AAAA,MACpC,eAAe,cAAc;AAAA,MAC7B,kBAAkB,cAAc;AAAA,MAChC,kBAAkB,cAAc;AAAA,IAClC;AAAA,EACF;AAAA,EASA,eACE,mBACA,kBAAkB,wCAClB,UAAU,CAAC,GACX;AACA,QAAI,wBAAwB;AAC5B,QAAI,yBAAyB;AAC7B,QAAI,4BAA4B;AAEhC,QAAI,kBAAkB;AAEtB,QAAI,mCAAS,eAAe;AAC1B,YAAM,EAAE,QAAQ,SAAS,eAAe,QAAQ;AAEhD,UAAI,kCAAQ,UAAS,kCAAQ,WAAU,GAAG;AACxC,gCAAwB,OAAO;AAAA,MACjC;AACA,UAAI,oCAAS,UAAS,oCAAS,WAAU,GAAG;AAC1C,iCAAyB,QAAQ;AAAA,MACnC;AAEA,UAAI,0CAAY,UAAS,0CAAY,WAAU,GAAG;AAChD,oCAA4B,WAAW;AAAA,MACzC;AAAA,IACF;AAGA,QAAI,oBAAoB,MAAM;AAC5B,kCAA4B;AAAA,IAC9B;AAEA,UAAM,uBAAuB,CAAC;AAC9B,eAAW,CAAC,KAAK,UAAU,OAAO,QAAQ,iBAAiB,GAAG;AAG5D,UAAI,IAAI,WAAW,kBAAkB,GAAG;AACtC,6BAAqB,IAAI,QAAQ,UAAU,KAAK,KAC9C,QAAQ;AAAA,MACZ,WAAW,IAAI,WAAW,sBAAsB,GAAG;AACjD,6BAAqB,IAAI,QAAQ,UAAU,KAAK,KAC9C,QAAQ;AAAA,MACZ,WAAW,IAAI,WAAW,eAAe,GAAG;AAC1C,6BAAqB,IAAI,QAAQ,UAAU,KAAK,KAC9C,QAAQ;AAAA,MACZ,OAAO;AAEL,6BAAqB,IAAI,QAAQ,UAAU,KAAK,KAC9C,QAAQ;AAAA,MACZ;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA,EAeA,QACE,OACA,kBAAkB,OAClB,iBAAiB,OACjB,gBAAgB,OAChB,UAAU,CAAC,GACX;AACA,QAAI,QAAQ,GAAG;AACb,cAAQ;AAAA,IACV;AAEA,UAAM,oBAAoB,KAAK,yBAAyB,OAAO,OAAO;AAGtE,QAAI,OAAO,oBAAoB,WAAW;AACxC,YAAM,IAAI,MACR,uEAAuE,iBACzE;AAAA,IACF;AAEA,UAAM,uBAAuB,KAAK,eAChC,mBACA,iBACA,OACF;AAGA,UAAM,YAAY,OAAO,OAAO,oBAAoB;AACpD,UAAM,eAAe,UAAU,OAC7B,CAAC,WAAW,iBAAiB,YAAY,YAC3C;AAEA,QAAI,SAAS;AACb,QAAI,eAAe;AACjB,eAAS,KAAK,YAAY,YAAY;AAAA,IACxC;AAEA,QAAI,gBAAgB;AAClB,UAAI,eAAe;AACjB,eAAO;AAAA,UACL,GAAG;AAAA,UACH,OAAO;AAAA,UACP;AAAA,QACF;AAAA,MACF;AAEA,aAAO,EAAE,GAAG,sBAAsB,OAAO,aAAa;AAAA,IACxD;AAEA,QAAI,eAAe;AACjB,aAAO,EAAE,OAAO,cAAc,OAAe;AAAA,IAC/C;AAEA,WAAO;AAAA,EACT;AAAA,EAaA,SACE,OACA,kBAAkB,OAClB,iBAAiB,OACjB,gBAAgB,OAChB,UAAU,CAAC,GACX;AACA,UAAM,oBAAoB,KAAK,0BAA0B,OAAO,OAAO;AAEvE,QAAI,OAAO,oBAAoB,WAAW;AAExC,YAAM,IAAI,MACR,wEAAwE,iBAC1E;AAAA,IACF;AAEA,UAAM,uBAAuB,KAAK,eAChC,mBACA,iBACA,OACF;AAGA,UAAM,YAAY,OAAO,OAAO,oBAAoB;AACpD,UAAM,eAAe,UAAU,OAC7B,CAAC,WAAW,iBAAiB,YAAY,YAC3C;AAEA,QAAI,SAAS;AACb,QAAI,eAAe;AACjB,eAAS,KAAK,YAAY,YAAY;AAAA,IACxC;AAEA,QAAI,gBAAgB;AAClB,UAAI,eAAe;AACjB,eAAO;AAAA,UACL,GAAG;AAAA,UACH,OAAO;AAAA,UACP;AAAA,QACF;AAAA,MACF;AACA,aAAO,EAAE,GAAG,sBAAsB,OAAO,aAAa;AAAA,IACxD;AAEA,QAAI,eAAe;AACjB,aAAO,EAAE,OAAO,cAAc,OAAe;AAAA,IAC/C;AAGA,WAAO;AAAA,EACT;AAAA,EASA,cAAc,OAAO;AACnB,UAAM,oBAAoB,KAAK,yBAAyB,KAAK;AAG7D,UAAM,eAAe,OAAO,OAAO,iBAAiB;AAGpD,WAAO,aAAa,OAClB,CAAC,WAAW,iBAAiB,YAAY,YAC3C;AAAA,EACF;AAAA,EAgBA,0BACE,OACA,UAAU,CAAC,GACX,YAAY,gDACZ,aAAa,+CACb,kBAAkB,+DAClB;AACA,QAAI,QAAQ,mBAAmB,QAAQ,oBAAoB,GAAG;AAC5D,wBAAkB,QAAQ;AAAA,IAC5B;AAEA,QAAI,QAAQ,wBAAwB,QAAQ,yBAAyB,GAAG;AACtE,kBAAY,QAAQ;AAAA,IACtB;AAEA,QAAI,QAAQ,yBAAyB,QAAQ,0BAA0B,GAAG;AACxE,mBAAa,QAAQ;AAAA,IACvB;AAEA,UAAM,oBAAoB,KAAK,yBAAyB,KAAK;AAC7D,UAAM,6BAA6B,CAAC;AAEpC,UAAM,eAAe,OAAO,OAAO,iBAAiB;AAGpD,eAAW,CAAC,KAAK,UAAU,OAAO,QAAQ,iBAAiB,GAAG;AAE5D,iCAA2B,GAAG,iBAAiB,QAAQ;AAGvD,iCAA2B,GAAG,sBAC5B,QAAQ,aAAa;AAAA,IACzB;AAEA,WAAO;AAAA,EACT;AAAA,EASA,eAAe,OAAO;AAIpB,QAAI,cAAc;AAClB,QAAI,mBAAmB;AAEvB,UAAM,oBAAoB,OAAO,QAC/B,KAAK,0BAA0B,KAAK,CACtC;AAEA,eAAW,CAAC,KAAK,QAAQ,mBAAmB;AAC1C,UAAI,IAAI,QAAQ,OAAO,IAAI,GAAG;AAC5B,uBAAe;AAAA,MACjB;AAAA,IACF;AAEA,eAAW,CAAC,KAAK,QAAQ,mBAAmB;AAC1C,UAAI,IAAI,QAAQ,YAAY,IAAI,GAAG;AACjC,4BAAoB;AAAA,MACtB;AAAA,IACF;AAEA,WAAO,cAAc;AAAA,EACvB;AAAA,EAEA,yBACE,gBACA,kBAAkB,wCAClB;AACA,WAAO,iCAAa,iBAAiB,eAAe;AAAA,EACtD;AAAA,EAEA,kBAAkB,gBAAgB,kBAAkB,KAAM;AACxD,WAAO,iBAAiB,kBAAkB;AAAA,EAC5C;AAAA,EAEA,uBAAuB,UAAU,kBAAkB,KAAM;AACvD,WAAO,WAAW,kBAAkB;AAAA,EACtC;AAAA,EAEA,oBAAoB,cAAc;AAChC,WAAO;AAAA,MACL,sBAAsB,iCAAa,eAAe,uCAAsB;AAAA,MACxE,eAAe,iCAAa,eAAe,+BAAc;AAAA,MACzD,kBAAkB,iCAAa,eAAe,kCAAiB;AAAA,MAC/D,kBAAkB,iCAAa,eAAe,kCAAiB;AAAA,IACjE;AAAA,EACF;AAAA,EAQA,YAAY,MAAM;AAChB,WAAO,iCAAa,MAAM,KAAK,OAAO;AAAA,EACxC;AACF;AAGA,IAAO,oCAAQ;",
+  "names": []
+}

package/dist/cjs/sustainable-web-design-v4.js

@@ -0,0 +1,218 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var sustainable_web_design_v4_exports = {};
+__export(sustainable_web_design_v4_exports, {
+  SustainableWebDesign: () => SustainableWebDesign,
+  default: () => sustainable_web_design_v4_default
+});
+module.exports = __toCommonJS(sustainable_web_design_v4_exports);
+var import_constants = require("./constants/index.js");
+var import_helpers = require("./helpers/index.js");
+const {
+  OPERATIONAL_KWH_PER_GB_DATACENTER,
+  OPERATIONAL_KWH_PER_GB_NETWORK,
+  OPERATIONAL_KWH_PER_GB_DEVICE,
+  EMBODIED_KWH_PER_GB_DATACENTER,
+  EMBODIED_KWH_PER_GB_NETWORK,
+  EMBODIED_KWH_PER_GB_DEVICE,
+  GLOBAL_GRID_INTENSITY
+} = import_constants.SWDV4;
+function outputSegments(operationalEmissions, embodiedEmissions) {
+  const totalOperationalCO2e = operationalEmissions.dataCenter + operationalEmissions.network + operationalEmissions.device;
+  const totalEmbodiedCO2e = embodiedEmissions.dataCenter + embodiedEmissions.network + embodiedEmissions.device;
+  const dataCenterCO2e = operationalEmissions.dataCenter + embodiedEmissions.dataCenter;
+  const networkCO2e = operationalEmissions.network + embodiedEmissions.network;
+  const consumerDeviceCO2e = operationalEmissions.device + embodiedEmissions.device;
+  return {
+    dataCenterOperationalCO2e: operationalEmissions.dataCenter,
+    networkOperationalCO2e: operationalEmissions.network,
+    consumerDeviceOperationalCO2e: operationalEmissions.device,
+    dataCenterEmbodiedCO2e: embodiedEmissions.dataCenter,
+    networkEmbodiedCO2e: embodiedEmissions.network,
+    consumerDeviceEmbodiedCO2e: embodiedEmissions.device,
+    totalEmbodiedCO2e,
+    totalOperationalCO2e,
+    dataCenterCO2e,
+    networkCO2e,
+    consumerDeviceCO2e
+  };
+}
+function getGreenHostingFactor(green, options) {
+  if (green) {
+    return 1;
+  } else if ((options == null ? void 0 : options.greenHostingFactor) || (options == null ? void 0 : options.greenHostingFactor) === 0) {
+    return options.greenHostingFactor;
+  }
+  return 0;
+}
+class SustainableWebDesign {
+  constructor(options) {
+    this.allowRatings = true;
+    this.options = options;
+    this.version = 4;
+  }
+  operationalEnergyPerSegment(bytes) {
+    const transferedBytesToGb = bytes / import_constants.fileSize.GIGABYTE;
+    const dataCenter = transferedBytesToGb * OPERATIONAL_KWH_PER_GB_DATACENTER;
+    const network = transferedBytesToGb * OPERATIONAL_KWH_PER_GB_NETWORK;
+    const device = transferedBytesToGb * OPERATIONAL_KWH_PER_GB_DEVICE;
+    return {
+      dataCenter,
+      network,
+      device
+    };
+  }
+  operationalEmissions(bytes, options = {}) {
+    const { dataCenter, network, device } = this.operationalEnergyPerSegment(bytes);
+    let dataCenterGridIntensity = GLOBAL_GRID_INTENSITY;
+    let networkGridIntensity = GLOBAL_GRID_INTENSITY;
+    let deviceGridIntensity = GLOBAL_GRID_INTENSITY;
+    if (options == null ? void 0 : options.gridIntensity) {
+      const { device: device2, network: network2, dataCenter: dataCenter2 } = options.gridIntensity;
+      if ((device2 == null ? void 0 : device2.value) || (device2 == null ? void 0 : device2.value) === 0) {
+        deviceGridIntensity = device2.value;
+      }
+      if ((network2 == null ? void 0 : network2.value) || (network2 == null ? void 0 : network2.value) === 0) {
+        networkGridIntensity = network2.value;
+      }
+      if ((dataCenter2 == null ? void 0 : dataCenter2.value) || (dataCenter2 == null ? void 0 : dataCenter2.value) === 0) {
+        dataCenterGridIntensity = dataCenter2.value;
+      }
+    }
+    const dataCenterEmissions = dataCenter * dataCenterGridIntensity;
+    const networkEmissions = network * networkGridIntensity;
+    const deviceEmissions = device * deviceGridIntensity;
+    return {
+      dataCenter: dataCenterEmissions,
+      network: networkEmissions,
+      device: deviceEmissions
+    };
+  }
+  embodiedEnergyPerSegment(bytes) {
+    const transferedBytesToGb = bytes / import_constants.fileSize.GIGABYTE;
+    const dataCenter = transferedBytesToGb * EMBODIED_KWH_PER_GB_DATACENTER;
+    const network = transferedBytesToGb * EMBODIED_KWH_PER_GB_NETWORK;
+    const device = transferedBytesToGb * EMBODIED_KWH_PER_GB_DEVICE;
+    return {
+      dataCenter,
+      network,
+      device
+    };
+  }
+  embodiedEmissions(bytes) {
+    const { dataCenter, network, device } = this.embodiedEnergyPerSegment(bytes);
+    const dataCenterGridIntensity = GLOBAL_GRID_INTENSITY;
+    const networkGridIntensity = GLOBAL_GRID_INTENSITY;
+    const deviceGridIntensity = GLOBAL_GRID_INTENSITY;
+    const dataCenterEmissions = dataCenter * dataCenterGridIntensity;
+    const networkEmissions = network * networkGridIntensity;
+    const deviceEmissions = device * deviceGridIntensity;
+    return {
+      dataCenter: dataCenterEmissions,
+      network: networkEmissions,
+      device: deviceEmissions
+    };
+  }
+  perByte(bytes, green = false, segmented = false, ratingResults = false, options = {}) {
+    if (bytes < 1) {
+      return 0;
+    }
+    const operationalEmissions = this.operationalEmissions(bytes, options);
+    const embodiedEmissions = this.embodiedEmissions(bytes);
+    const greenHostingFactor = getGreenHostingFactor(green, options);
+    const totalEmissions = {
+      dataCenter: operationalEmissions.dataCenter * (1 - greenHostingFactor) + embodiedEmissions.dataCenter,
+      network: operationalEmissions.network + embodiedEmissions.network,
+      device: operationalEmissions.device + embodiedEmissions.device
+    };
+    const total = totalEmissions.dataCenter + totalEmissions.network + totalEmissions.device;
+    let rating = null;
+    if (ratingResults) {
+      rating = this.ratingScale(total);
+    }
+    if (segmented) {
+      const segments = {
+        ...outputSegments(operationalEmissions, embodiedEmissions)
+      };
+      if (ratingResults) {
+        return {
+          ...segments,
+          total,
+          rating
+        };
+      }
+      return { ...segments, total };
+    }
+    if (ratingResults) {
+      return { total, rating };
+    }
+    return total;
+  }
+  perVisit(bytes, green = false, segmented = false, ratingResults = false, options = {}) {
+    let firstViewRatio = 1;
+    let returnViewRatio = 0;
+    let dataReloadRatio = 0;
+    const greenHostingFactor = getGreenHostingFactor(green, options);
+    const operationalEmissions = this.operationalEmissions(bytes, options);
+    const embodiedEmissions = this.embodiedEmissions(bytes);
+    if (bytes < 1) {
+      return 0;
+    }
+    if (options.firstVisitPercentage || options.firstVisitPercentage === 0) {
+      firstViewRatio = options.firstVisitPercentage;
+    }
+    if (options.returnVisitPercentage || options.returnVisitPercentage === 0) {
+      returnViewRatio = options.returnVisitPercentage;
+    }
+    if (options.dataReloadRatio || options.dataReloadRatio === 0) {
+      dataReloadRatio = options.dataReloadRatio;
+    }
+    const firstVisitEmissions = operationalEmissions.dataCenter * (1 - greenHostingFactor) + embodiedEmissions.dataCenter + operationalEmissions.network + embodiedEmissions.network + operationalEmissions.device + embodiedEmissions.device;
+    const returnVisitEmissions = (operationalEmissions.dataCenter * (1 - greenHostingFactor) + embodiedEmissions.dataCenter + operationalEmissions.network + embodiedEmissions.network + operationalEmissions.device + embodiedEmissions.device) * (1 - dataReloadRatio);
+    const total = firstVisitEmissions * firstViewRatio + returnVisitEmissions * returnViewRatio;
+    let rating = null;
+    if (ratingResults) {
+      rating = this.ratingScale(total);
+    }
+    if (segmented) {
+      const segments = {
+        ...outputSegments(operationalEmissions, embodiedEmissions),
+        firstVisitCO2e: firstVisitEmissions,
+        returnVisitCO2e: returnVisitEmissions
+      };
+      if (ratingResults) {
+        return {
+          ...segments,
+          total,
+          rating
+        };
+      }
+      return { ...segments, total };
+    }
+    if (ratingResults) {
+      return { total, rating };
+    }
+    return total;
+  }
+  ratingScale(co2e) {
+    return (0, import_helpers.outputRating)(co2e, this.version);
+  }
+}
+var sustainable_web_design_v4_default = SustainableWebDesign;
+//# sourceMappingURL=sustainable-web-design-v4.js.map