@tgwf/co2 0.11.3 → 0.12.0

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

@@ -29,77 +29,95 @@ var import_debug = __toESM(require("debug"));
 var import_constants = require("./constants/index.js");
 var import_helpers = require("./helpers/index.js");
 const log = (0, import_debug.default)("tgwf:sustainable-web-design");
-const KWH_PER_GB = 0.81;
-const END_USER_DEVICE_ENERGY = 0.52;
-const NETWORK_ENERGY = 0.14;
-const DATACENTER_ENERGY = 0.15;
-const PRODUCTION_ENERGY = 0.19;
-const GLOBAL_INTENSITY = 442;
-const RENEWABLES_INTENSITY = 50;
-const FIRST_TIME_VIEWING_PERCENTAGE = 0.75;
-const RETURNING_VISITOR_PERCENTAGE = 0.25;
-const PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD = 0.02;
 class SustainableWebDesign {
   constructor(options) {
     this.options = options;
   }
   energyPerByteByComponent(bytes) {
     const transferedBytesToGb = bytes / import_constants.fileSize.GIGABYTE;
-    const energyUsage = transferedBytesToGb * KWH_PER_GB;
+    const energyUsage = transferedBytesToGb * import_constants.KWH_PER_GB;
     return {
-      consumerDeviceEnergy: energyUsage * END_USER_DEVICE_ENERGY,
-      networkEnergy: energyUsage * NETWORK_ENERGY,
-      productionEnergy: energyUsage * PRODUCTION_ENERGY,
-      dataCenterEnergy: energyUsage * DATACENTER_ENERGY
+      consumerDeviceEnergy: energyUsage * import_constants.END_USER_DEVICE_ENERGY,
+      networkEnergy: energyUsage * import_constants.NETWORK_ENERGY,
+      productionEnergy: energyUsage * import_constants.PRODUCTION_ENERGY,
+      dataCenterEnergy: energyUsage * import_constants.DATACENTER_ENERGY
     };
   }
-  co2byComponent(energyBycomponent, carbonIntensity = GLOBAL_INTENSITY) {
+  co2byComponent(energyByComponent, carbonIntensity = import_constants.GLOBAL_GRID_INTENSITY, options = {}) {
+    let deviceCarbonIntensity = import_constants.GLOBAL_GRID_INTENSITY;
+    let networkCarbonIntensity = import_constants.GLOBAL_GRID_INTENSITY;
+    let dataCenterCarbonIntensity = import_constants.GLOBAL_GRID_INTENSITY;
+    let globalEmissions = import_constants.GLOBAL_GRID_INTENSITY;
+    if (options == null ? void 0 : options.gridIntensity) {
+      const { device, network, dataCenter } = options.gridIntensity;
+      if (device == null ? void 0 : device.value) {
+        deviceCarbonIntensity = device.value;
+      }
+      if (network == null ? void 0 : network.value) {
+        networkCarbonIntensity = network.value;
+      }
+      if (dataCenter == null ? void 0 : dataCenter.value) {
+        dataCenterCarbonIntensity = dataCenter.value;
+      }
+    }
+    if (carbonIntensity === true) {
+      dataCenterCarbonIntensity = import_constants.RENEWABLES_GRID_INTENSITY;
+    }
     const returnCO2ByComponent = {};
-    for (const [key, value] of Object.entries(energyBycomponent)) {
+    for (const [key, value] of Object.entries(energyByComponent)) {
       if (key.startsWith("dataCenterEnergy")) {
-        returnCO2ByComponent[key] = value * carbonIntensity;
+        returnCO2ByComponent[key.replace("Energy", "CO2")] = value * dataCenterCarbonIntensity;
+      } else if (key.startsWith("consumerDeviceEnergy")) {
+        returnCO2ByComponent[key.replace("Energy", "CO2")] = value * deviceCarbonIntensity;
+      } else if (key.startsWith("networkEnergy")) {
+        returnCO2ByComponent[key.replace("Energy", "CO2")] = value * networkCarbonIntensity;
       } else {
-        returnCO2ByComponent[key] = value * GLOBAL_INTENSITY;
+        returnCO2ByComponent[key.replace("Energy", "CO2")] = value * globalEmissions;
       }
     }
     return returnCO2ByComponent;
   }
-  perByte(bytes, carbonIntensity = GLOBAL_INTENSITY) {
-    const energyBycomponent = this.energyPerByteByComponent(bytes);
-    if (Boolean(carbonIntensity) === false) {
-      carbonIntensity = GLOBAL_INTENSITY;
-    }
-    if (carbonIntensity === true) {
-      carbonIntensity = RENEWABLES_INTENSITY;
+  perByte(bytes, carbonIntensity = false, segmentResults = false, options = {}) {
+    const energyBycomponent = this.energyPerByteByComponent(bytes, options);
+    if (typeof carbonIntensity !== "boolean") {
+      throw new Error(`perByte expects a boolean for the carbon intensity value. Received: ${carbonIntensity}`);
     }
-    if (typeof carbonIntensity !== "number") {
-      throw new Error(`perByte expects a numeric value or boolean for the carbon intensity value. Received: ${carbonIntensity}`);
-    }
-    const co2ValuesbyComponent = this.co2byComponent(energyBycomponent, carbonIntensity);
+    const co2ValuesbyComponent = this.co2byComponent(energyBycomponent, carbonIntensity, options);
     const co2Values = Object.values(co2ValuesbyComponent);
-    return co2Values.reduce((prevValue, currentValue) => prevValue + currentValue);
-  }
-  perVisit(bytes, carbonIntensity = GLOBAL_INTENSITY) {
-    const energyBycomponent = this.energyPerVisitByComponent(bytes);
-    if (Boolean(carbonIntensity) === false) {
-      carbonIntensity = GLOBAL_INTENSITY;
+    const co2ValuesSum = co2Values.reduce((prevValue, currentValue) => prevValue + currentValue);
+    if (segmentResults) {
+      return { ...co2ValuesbyComponent, total: co2ValuesSum };
     }
-    if (carbonIntensity === true) {
-      carbonIntensity = RENEWABLES_INTENSITY;
-    }
-    if (typeof carbonIntensity !== "number") {
-      throw new Error(`perVisit expects a numeric value or boolean for the carbon intensity value. Received: ${carbonIntensity}`);
+    return co2ValuesSum;
+  }
+  perVisit(bytes, carbonIntensity = false, segmentResults = 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}`);
     }
-    const co2ValuesbyComponent = this.co2byComponent(energyBycomponent, carbonIntensity);
+    const co2ValuesbyComponent = this.co2byComponent(energyBycomponent, carbonIntensity, options);
     const co2Values = Object.values(co2ValuesbyComponent);
-    return co2Values.reduce((prevValue, currentValue) => prevValue + currentValue);
+    const co2ValuesSum = co2Values.reduce((prevValue, currentValue) => prevValue + currentValue);
+    if (segmentResults) {
+      return { ...co2ValuesbyComponent, total: co2ValuesSum };
+    }
+    return co2ValuesSum;
   }
   energyPerByte(bytes) {
     const energyByComponent = this.energyPerByteByComponent(bytes);
     const energyValues = Object.values(energyByComponent);
     return energyValues.reduce((prevValue, currentValue) => prevValue + currentValue);
   }
-  energyPerVisitByComponent(bytes, firstView = FIRST_TIME_VIEWING_PERCENTAGE, returnView = RETURNING_VISITOR_PERCENTAGE, dataReloadRatio = PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD) {
+  energyPerVisitByComponent(bytes, options = {}, firstView = import_constants.FIRST_TIME_VIEWING_PERCENTAGE, returnView = import_constants.RETURNING_VISITOR_PERCENTAGE, dataReloadRatio = import_constants.PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD) {
+    if (options.dataReloadRatio) {
+      dataReloadRatio = options.dataReloadRatio;
+    }
+    if (options.firstVisitPercentage) {
+      firstView = options.firstVisitPercentage;
+    }
+    if (options.returnVisitPercentage) {
+      returnView = options.returnVisitPercentage;
+    }
     const energyBycomponent = this.energyPerByteByComponent(bytes);
     const cacheAdjustedSegmentEnergy = {};
     log({ energyBycomponent });
@@ -127,7 +145,7 @@ class SustainableWebDesign {
     }
     return firstVisits + subsequentVisits;
   }
-  emissionsPerVisitInGrams(energyPerVisit, carbonintensity = GLOBAL_INTENSITY) {
+  emissionsPerVisitInGrams(energyPerVisit, carbonintensity = import_constants.GLOBAL_GRID_INTENSITY) {
     return (0, import_helpers.formatNumber)(energyPerVisit * carbonintensity);
   }
   annualEnergyInKwh(energyPerVisit, monthlyVisitors = 1e3) {
@@ -138,10 +156,10 @@ class SustainableWebDesign {
   }
   annualSegmentEnergy(annualEnergy) {
     return {
-      consumerDeviceEnergy: (0, import_helpers.formatNumber)(annualEnergy * END_USER_DEVICE_ENERGY),
-      networkEnergy: (0, import_helpers.formatNumber)(annualEnergy * NETWORK_ENERGY),
-      dataCenterEnergy: (0, import_helpers.formatNumber)(annualEnergy * DATACENTER_ENERGY),
-      productionEnergy: (0, import_helpers.formatNumber)(annualEnergy * PRODUCTION_ENERGY)
+      consumerDeviceEnergy: (0, import_helpers.formatNumber)(annualEnergy * import_constants.END_USER_DEVICE_ENERGY),
+      networkEnergy: (0, import_helpers.formatNumber)(annualEnergy * import_constants.NETWORK_ENERGY),
+      dataCenterEnergy: (0, import_helpers.formatNumber)(annualEnergy * import_constants.DATACENTER_ENERGY),
+      productionEnergy: (0, import_helpers.formatNumber)(annualEnergy * import_constants.PRODUCTION_ENERGY)
     };
   }
 }

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/sustainable-web-design.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 debugFactory from \"debug\";\nconst log = debugFactory(\"tgwf:sustainable-web-design\");\n\nimport { fileSize } from \"./constants/index.js\";\nimport { formatNumber } from \"./helpers/index.js\";\n\n// this refers to the estimated total energy use for the internet around 2000 TWh,\n// divided by the total transfer it enables around 2500 exabytes\nconst KWH_PER_GB = 0.81;\n\n// these constants outline how the energy is attributed to\n// different parts of the system in the SWD model\nconst END_USER_DEVICE_ENERGY = 0.52;\nconst NETWORK_ENERGY = 0.14;\nconst DATACENTER_ENERGY = 0.15;\nconst PRODUCTION_ENERGY = 0.19;\n\n// These carbon intensity figures https://ember-climate.org/data/data-explorer\n// - Global carbon intensity for 2021\nconst GLOBAL_INTENSITY = 442;\nconst RENEWABLES_INTENSITY = 50;\n\n// Taken from: https://gitlab.com/wholegrain/carbon-api-2-0/-/blob/master/includes/carbonapi.php\n\nconst FIRST_TIME_VIEWING_PERCENTAGE = 0.75;\nconst RETURNING_VISITOR_PERCENTAGE = 0.25;\nconst PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD = 0.02;\n\nclass SustainableWebDesign {\n  constructor(options) {\n    this.options = options;\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(energyBycomponent, carbonIntensity = GLOBAL_INTENSITY) {\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] = value * carbonIntensity;\n      } else {\n        // We don't have info about the device location,\n        // nor the network path used, nor the production emissions\n        // so we revert to global figures\n        returnCO2ByComponent[key] = value * GLOBAL_INTENSITY;\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 datacentre share of the carbon intensity.\n   *\n   * @param {number} bytes - the data transferred in bytes\n   * @param {number} `carbonIntensity` the carbon intensity for datacentre (average figures, not marginal ones)\n   * @return {number} the total number in grams of CO2 equivalent emissions\n   */\n  perByte(bytes, carbonIntensity = GLOBAL_INTENSITY) {\n    const energyBycomponent = this.energyPerByteByComponent(bytes);\n\n    // when faced with falsy values, fallback to global intensity\n    if (Boolean(carbonIntensity) === false) {\n      carbonIntensity = GLOBAL_INTENSITY;\n    }\n    // if we have a boolean, we have a green result from the green web checker\n    // use the renewables intensity\n    if (carbonIntensity === true) {\n      carbonIntensity = RENEWABLES_INTENSITY;\n    }\n\n    // otherwise when faced with non numeric values throw an error\n    if (typeof carbonIntensity !== \"number\") {\n      throw new Error(\n        `perByte expects a numeric value or boolean for the carbon intensity value. Received: ${carbonIntensity}`\n      );\n    }\n\n    const co2ValuesbyComponent = this.co2byComponent(\n      energyBycomponent,\n      carbonIntensity\n    );\n\n    // pull out our values\u2026\n    const co2Values = Object.values(co2ValuesbyComponent);\n\n    // so we can return their sum\n    return co2Values.reduce(\n      (prevValue, currentValue) => prevValue + currentValue\n    );\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 {number} `carbonIntensity` the carbon intensity for datacentre (average figures, not marginal ones)\n   * @return {number} the total number in grams of CO2 equivalent emissions\n   */\n  perVisit(bytes, carbonIntensity = GLOBAL_INTENSITY) {\n    const energyBycomponent = this.energyPerVisitByComponent(bytes);\n\n    // when faced with falsy values, fallback to global intensity\n    if (Boolean(carbonIntensity) === false) {\n      carbonIntensity = GLOBAL_INTENSITY;\n    }\n    // if we have a boolean, we have a green result from the green web checker\n    // use the renewables intensity\n    if (carbonIntensity === true) {\n      carbonIntensity = RENEWABLES_INTENSITY;\n    }\n\n    // otherwise when faced with non numeric values throw an error\n    if (typeof carbonIntensity !== \"number\") {\n      throw new Error(\n        `perVisit expects a numeric value or boolean for the carbon intensity value. Received: ${carbonIntensity}`\n      );\n    }\n\n    const co2ValuesbyComponent = this.co2byComponent(\n      energyBycomponent,\n      carbonIntensity\n    );\n\n    // pull out our values\u2026\n    const co2Values = Object.values(co2ValuesbyComponent);\n\n    // so we can return their sum\n    return co2Values.reduce(\n      (prevValue, currentValue) => prevValue + currentValue\n    );\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    firstView = FIRST_TIME_VIEWING_PERCENTAGE,\n    returnView = RETURNING_VISITOR_PERCENTAGE,\n    dataReloadRatio = PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD\n  ) {\n    const energyBycomponent = this.energyPerByteByComponent(bytes);\n    const cacheAdjustedSegmentEnergy = {};\n\n    log({ energyBycomponent });\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    log({ cacheAdjustedSegmentEnergy });\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  // TODO: this method looks like it applies the carbon intensity\n  // change to the *entire* system, not just the datacenter.\n  emissionsPerVisitInGrams(energyPerVisit, carbonintensity = GLOBAL_INTENSITY) {\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\nexport { SustainableWebDesign };\nexport default SustainableWebDesign;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,mBAAyB;AAGzB,uBAAyB;AACzB,qBAA6B;AAH7B,MAAM,MAAM,0BAAa,6BAA6B;AAOtD,MAAM,aAAa;AAInB,MAAM,yBAAyB;AAC/B,MAAM,iBAAiB;AACvB,MAAM,oBAAoB;AAC1B,MAAM,oBAAoB;AAI1B,MAAM,mBAAmB;AACzB,MAAM,uBAAuB;AAI7B,MAAM,gCAAgC;AACtC,MAAM,+BAA+B;AACrC,MAAM,+CAA+C;AAErD,MAAM,qBAAqB;AAAA,EACzB,YAAY,SAAS;AACnB,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,eAAe,mBAAmB,kBAAkB,kBAAkB;AACpE,UAAM,uBAAuB,CAAC;AAC9B,eAAW,CAAC,KAAK,UAAU,OAAO,QAAQ,iBAAiB,GAAG;AAG5D,UAAI,IAAI,WAAW,kBAAkB,GAAG;AACtC,6BAAqB,OAAO,QAAQ;AAAA,MACtC,OAAO;AAIL,6BAAqB,OAAO,QAAQ;AAAA,MACtC;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAYA,QAAQ,OAAO,kBAAkB,kBAAkB;AACjD,UAAM,oBAAoB,KAAK,yBAAyB,KAAK;AAG7D,QAAI,QAAQ,eAAe,MAAM,OAAO;AACtC,wBAAkB;AAAA,IACpB;AAGA,QAAI,oBAAoB,MAAM;AAC5B,wBAAkB;AAAA,IACpB;AAGA,QAAI,OAAO,oBAAoB,UAAU;AACvC,YAAM,IAAI,MACR,wFAAwF,iBAC1F;AAAA,IACF;AAEA,UAAM,uBAAuB,KAAK,eAChC,mBACA,eACF;AAGA,UAAM,YAAY,OAAO,OAAO,oBAAoB;AAGpD,WAAO,UAAU,OACf,CAAC,WAAW,iBAAiB,YAAY,YAC3C;AAAA,EACF;AAAA,EAUA,SAAS,OAAO,kBAAkB,kBAAkB;AAClD,UAAM,oBAAoB,KAAK,0BAA0B,KAAK;AAG9D,QAAI,QAAQ,eAAe,MAAM,OAAO;AACtC,wBAAkB;AAAA,IACpB;AAGA,QAAI,oBAAoB,MAAM;AAC5B,wBAAkB;AAAA,IACpB;AAGA,QAAI,OAAO,oBAAoB,UAAU;AACvC,YAAM,IAAI,MACR,yFAAyF,iBAC3F;AAAA,IACF;AAEA,UAAM,uBAAuB,KAAK,eAChC,mBACA,eACF;AAGA,UAAM,YAAY,OAAO,OAAO,oBAAoB;AAGpD,WAAO,UAAU,OACf,CAAC,WAAW,iBAAiB,YAAY,YAC3C;AAAA,EACF;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,YAAY,+BACZ,aAAa,8BACb,kBAAkB,8CAClB;AACA,UAAM,oBAAoB,KAAK,yBAAyB,KAAK;AAC7D,UAAM,6BAA6B,CAAC;AAEpC,QAAI,EAAE,kBAAkB,CAAC;AACzB,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;AACA,QAAI,EAAE,2BAA2B,CAAC;AAElC,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,EAIA,yBAAyB,gBAAgB,kBAAkB,kBAAkB;AAC3E,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,sBAAsB;AAAA,MACxE,eAAe,iCAAa,eAAe,cAAc;AAAA,MACzD,kBAAkB,iCAAa,eAAe,iBAAiB;AAAA,MAC/D,kBAAkB,iCAAa,eAAe,iBAAiB;AAAA,IACjE;AAAA,EACF;AACF;AAGA,IAAO,iCAAQ;",
+  "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 */\nimport debugFactory from \"debug\";\nconst log = debugFactory(\"tgwf:sustainable-web-design\");\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 } from \"./helpers/index.js\";\n\nclass SustainableWebDesign {\n  constructor(options) {\n    this.options = options;\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) {\n        deviceCarbonIntensity = device.value;\n      }\n      if (network?.value) {\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) {\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 datacentre share of the carbon intensity.\n   *\n   * @param {number} bytes - the data transferred in bytes\n   * @param {number} `carbonIntensity` the carbon intensity for datacentre (average figures, not marginal ones)\n   * @return {number} the total number in grams of CO2 equivalent emissions\n   */\n  perByte(\n    bytes,\n    carbonIntensity = false,\n    segmentResults = false,\n    options = {}\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    if (segmentResults) {\n      return { ...co2ValuesbyComponent, total: co2ValuesSum };\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 {number} `carbonIntensity` the carbon intensity for datacentre (average figures, not marginal ones)\n   * @return {number} the total number in grams of CO2 equivalent emissions\n   */\n  perVisit(\n    bytes,\n    carbonIntensity = false,\n    segmentResults = 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    if (segmentResults) {\n      return { ...co2ValuesbyComponent, total: co2ValuesSum };\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) {\n      dataReloadRatio = options.dataReloadRatio;\n    }\n\n    if (options.firstVisitPercentage) {\n      firstView = options.firstVisitPercentage;\n    }\n\n    if (options.returnVisitPercentage) {\n      returnView = options.returnVisitPercentage;\n    }\n\n    const energyBycomponent = this.energyPerByteByComponent(bytes);\n    const cacheAdjustedSegmentEnergy = {};\n\n    log({ energyBycomponent });\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    log({ cacheAdjustedSegmentEnergy });\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\nexport { SustainableWebDesign };\nexport default SustainableWebDesign;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AASA,mBAAyB;AAGzB,uBAYO;AACP,qBAA6B;AAf7B,MAAM,MAAM,0BAAa,6BAA6B;AAiBtD,MAAM,qBAAqB;AAAA,EACzB,YAAY,SAAS;AACnB,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,iCAAQ,OAAO;AACjB,gCAAwB,OAAO;AAAA,MACjC;AACA,UAAI,mCAAS,OAAO;AAClB,iCAAyB,QAAQ;AAAA,MACnC;AAEA,UAAI,yCAAY,OAAO;AACrB,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,EAYA,QACE,OACA,kBAAkB,OAClB,iBAAiB,OACjB,UAAU,CAAC,GACX;AACA,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,gBAAgB;AAClB,aAAO,EAAE,GAAG,sBAAsB,OAAO,aAAa;AAAA,IACxD;AAEA,WAAO;AAAA,EACT;AAAA,EAUA,SACE,OACA,kBAAkB,OAClB,iBAAiB,OACjB,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,gBAAgB;AAClB,aAAO,EAAE,GAAG,sBAAsB,OAAO,aAAa;AAAA,IACxD;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,iBAAiB;AAC3B,wBAAkB,QAAQ;AAAA,IAC5B;AAEA,QAAI,QAAQ,sBAAsB;AAChC,kBAAY,QAAQ;AAAA,IACtB;AAEA,QAAI,QAAQ,uBAAuB;AACjC,mBAAa,QAAQ;AAAA,IACvB;AAEA,UAAM,oBAAoB,KAAK,yBAAyB,KAAK;AAC7D,UAAM,6BAA6B,CAAC;AAEpC,QAAI,EAAE,kBAAkB,CAAC;AACzB,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;AACA,QAAI,EAAE,2BAA2B,CAAC;AAElC,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;AACF;AAGA,IAAO,iCAAQ;",
   "names": []
 }

package/dist/esm/co2.js

@@ -1,6 +1,11 @@
 "use strict";
 import OneByte from "./1byte.js";
 import SustainableWebDesign from "./sustainable-web-design.js";
+import {
+  GLOBAL_GRID_INTENSITY,
+  RENEWABLES_GRID_INTENSITY
+} from "./constants/index.js";
+import { parseOptions } from "./helpers/index.js";
 class CO2 {
   constructor(options) {
     this.model = new SustainableWebDesign();
@@ -12,16 +17,77 @@ class CO2 {
       throw new Error(`"${options.model}" is not a valid model. Please use "1byte" for the OneByte model, and "swd" for the Sustainable Web Design model.
 See https://developers.thegreenwebfoundation.org/co2js/models/ to learn more about the models available in CO2.js.`);
     }
+    if ((options == null ? void 0 : options.results) === "segment") {
+      this.model.results = {
+        segment: true
+      };
+    } else {
+      this.model.results = {
+        segment: false
+      };
+    }
   }
-  perByte(bytes, green) {
-    return this.model.perByte(bytes, green);
+  perByte(bytes, green = false) {
+    return this.model.perByte(bytes, green, this.model.results.segment);
   }
-  perVisit(bytes, green) {
+  perVisit(bytes, green = false) {
     var _a;
     if ((_a = this.model) == null ? void 0 : _a.perVisit) {
-      return this.model.perVisit(bytes, green);
+      return this.model.perVisit(bytes, green, this.model.results.segment);
     } else {
       throw new Error(`The perVisit() method is not supported in the model you are using. Try using perByte() instead.
+See https://developers.thegreenwebfoundation.org/co2js/methods/ to learn more about the methods available in CO2.js.`);
+    }
+  }
+  perByteTrace(bytes, green = false, options = {}) {
+    var _a, _b, _c, _d, _e, _f;
+    let adjustments = {};
+    if (options) {
+      adjustments = parseOptions(options);
+    }
+    return {
+      co2: this.model.perByte(bytes, green, this.model.results.segment, adjustments),
+      green,
+      variables: {
+        description: "Below are the variables used to calculate this CO2 estimate.",
+        bytes,
+        gridIntensity: {
+          description: "The grid intensity (grams per kilowatt-hour) used to calculate this CO2 estimate.",
+          network: ((_b = (_a = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _a.network) == null ? void 0 : _b.value) || GLOBAL_GRID_INTENSITY,
+          dataCenter: green ? RENEWABLES_GRID_INTENSITY : ((_d = (_c = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _c.dataCenter) == null ? void 0 : _d.value) || GLOBAL_GRID_INTENSITY,
+          production: GLOBAL_GRID_INTENSITY,
+          device: ((_f = (_e = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _e.device) == null ? void 0 : _f.value) || GLOBAL_GRID_INTENSITY
+        }
+      }
+    };
+  }
+  perVisitTrace(bytes, green = false, options = {}) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    if ((_a = this.model) == null ? void 0 : _a.perVisit) {
+      let adjustments = {};
+      if (options) {
+        adjustments = parseOptions(options);
+      }
+      return {
+        co2: this.model.perVisit(bytes, green, this.model.results.segment, adjustments),
+        green,
+        variables: {
+          description: "Below are the variables used to calculate this CO2 estimate.",
+          bytes,
+          gridIntensity: {
+            description: "The grid intensity (grams per kilowatt-hour) used to calculate this CO2 estimate.",
+            network: ((_c = (_b = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _b.network) == null ? void 0 : _c.value) || GLOBAL_GRID_INTENSITY,
+            dataCenter: green ? RENEWABLES_GRID_INTENSITY : ((_e = (_d = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _d.dataCenter) == null ? void 0 : _e.value) || GLOBAL_GRID_INTENSITY,
+            production: GLOBAL_GRID_INTENSITY,
+            device: ((_g = (_f = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _f.device) == null ? void 0 : _g.value) || GLOBAL_GRID_INTENSITY
+          },
+          dataReloadRatio: (adjustments == null ? void 0 : adjustments.dataReloadRatio) || 0.02,
+          firstVisitPercentage: (adjustments == null ? void 0 : adjustments.firstVisitPercentage) || 0.75,
+          returnVisitPercentage: (adjustments == null ? void 0 : adjustments.returnVisitPercentage) || 0.25
+        }
+      };
+    } else {
+      throw new Error(`The perVisitDetailed() method is not supported in the model you are using. Try using perByte() instead.
 See https://developers.thegreenwebfoundation.org/co2js/methods/ to learn more about the methods available in CO2.js.`);
     }
   }

package/dist/esm/constants/index.js

@@ -1,4 +1,26 @@
 import fileSize from "./file-size.js";
+import testConstants from "./test-constants.js";
+const KWH_PER_GB = 0.81;
+const END_USER_DEVICE_ENERGY = 0.52;
+const NETWORK_ENERGY = 0.14;
+const DATACENTER_ENERGY = 0.15;
+const PRODUCTION_ENERGY = 0.19;
+const GLOBAL_GRID_INTENSITY = 442;
+const RENEWABLES_GRID_INTENSITY = 50;
+const FIRST_TIME_VIEWING_PERCENTAGE = 0.75;
+const RETURNING_VISITOR_PERCENTAGE = 0.25;
+const PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD = 0.02;
 export {
-  fileSize
+  DATACENTER_ENERGY,
+  END_USER_DEVICE_ENERGY,
+  FIRST_TIME_VIEWING_PERCENTAGE,
+  GLOBAL_GRID_INTENSITY,
+  KWH_PER_GB,
+  NETWORK_ENERGY,
+  PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD,
+  PRODUCTION_ENERGY,
+  RENEWABLES_GRID_INTENSITY,
+  RETURNING_VISITOR_PERCENTAGE,
+  fileSize,
+  testConstants
 };

package/dist/esm/helpers/index.js

@@ -1,4 +1,147 @@
+import { averageIntensity } from "../index.js";
+import {
+  GLOBAL_GRID_INTENSITY,
+  PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD,
+  FIRST_TIME_VIEWING_PERCENTAGE,
+  RETURNING_VISITOR_PERCENTAGE
+} from "../constants/index.js";
 const formatNumber = (num) => parseFloat(num.toFixed(2));
+function parseOptions(options) {
+  var _a, _b, _c, _d, _e, _f;
+  if (typeof options !== "object") {
+    throw new Error("Options must be an object");
+  }
+  const adjustments = {};
+  if (options == null ? void 0 : options.gridIntensity) {
+    adjustments.gridIntensity = {};
+    const { device, dataCenter, network } = options.gridIntensity;
+    if (device) {
+      if (typeof device === "object") {
+        if (!averageIntensity.data[(_a = device.country) == null ? void 0 : _a.toUpperCase()]) {
+          console.warn(`"${device.country}" is not a valid country. Please use a valid 3 digit ISO 3166 country code. 
+See https://developers.thegreenwebfoundation.org/co2js/data/ for more information. 
+Falling back to global average grid intensity.`);
+          adjustments.gridIntensity["device"] = {
+            value: GLOBAL_GRID_INTENSITY
+          };
+        }
+        adjustments.gridIntensity["device"] = {
+          country: device.country,
+          value: parseFloat(averageIntensity.data[(_b = device.country) == null ? void 0 : _b.toUpperCase()])
+        };
+      } else if (typeof device === "number") {
+        adjustments.gridIntensity["device"] = {
+          value: device
+        };
+      } else {
+        adjustments.gridIntensity["device"] = {
+          value: GLOBAL_GRID_INTENSITY
+        };
+        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.`);
+      }
+    }
+    if (dataCenter) {
+      if (typeof dataCenter === "object") {
+        if (!averageIntensity.data[(_c = dataCenter.country) == null ? void 0 : _c.toUpperCase()]) {
+          console.warn(`"${dataCenter.country}" is not a valid country. Please use a valid 3 digit ISO 3166 country code. 
+See https://developers.thegreenwebfoundation.org/co2js/data/ for more information.  
+Falling back to global average grid intensity.`);
+          adjustments.gridIntensity["dataCenter"] = {
+            value: GLOBAL_GRID_INTENSITY
+          };
+        }
+        adjustments.gridIntensity["dataCenter"] = {
+          country: dataCenter.country,
+          value: parseFloat(averageIntensity.data[(_d = dataCenter.country) == null ? void 0 : _d.toUpperCase()])
+        };
+      } else if (typeof dataCenter === "number") {
+        adjustments.gridIntensity["dataCenter"] = {
+          value: dataCenter
+        };
+      } else {
+        adjustments.gridIntensity["dataCenter"] = {
+          value: GLOBAL_GRID_INTENSITY
+        };
+        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.`);
+      }
+    }
+    if (network) {
+      if (typeof network === "object") {
+        if (!averageIntensity.data[(_e = network.country) == null ? void 0 : _e.toUpperCase()]) {
+          console.warn(`"${network.country}" is not a valid country. Please use a valid 3 digit ISO 3166 country code. 
+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: GLOBAL_GRID_INTENSITY
+          };
+        }
+        adjustments.gridIntensity["network"] = {
+          country: network.country,
+          value: parseFloat(averageIntensity.data[(_f = network.country) == null ? void 0 : _f.toUpperCase()])
+        };
+      } else if (typeof network === "number") {
+        adjustments.gridIntensity["network"] = {
+          value: network
+        };
+      } else {
+        adjustments.gridIntensity["network"] = {
+          value: GLOBAL_GRID_INTENSITY
+        };
+        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.`);
+      }
+    }
+  }
+  if (options == null ? void 0 : options.dataReloadRatio) {
+    if (typeof options.dataReloadRatio === "number") {
+      if (options.dataReloadRatio >= 0 && options.dataReloadRatio <= 1) {
+        adjustments.dataReloadRatio = options.dataReloadRatio;
+      } else {
+        adjustments.dataReloadRatio = PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD;
+        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 = PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD;
+      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) {
+    if (typeof options.firstVisitPercentage === "number") {
+      if (options.firstVisitPercentage >= 0 && options.firstVisitPercentage <= 1) {
+        adjustments.firstVisitPercentage = options.firstVisitPercentage;
+      } else {
+        adjustments.firstVisitPercentage = FIRST_TIME_VIEWING_PERCENTAGE;
+        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 = FIRST_TIME_VIEWING_PERCENTAGE;
+      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) {
+    if (typeof options.returnVisitPercentage === "number") {
+      if (options.returnVisitPercentage >= 0 && options.returnVisitPercentage <= 1) {
+        adjustments.returnVisitPercentage = options.returnVisitPercentage;
+      } else {
+        adjustments.returnVisitPercentage = RETURNING_VISITOR_PERCENTAGE;
+        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 = RETURNING_VISITOR_PERCENTAGE;
+      console.warn(`The returnVisitPercentage option must be a number. You passed in a ${typeof options.returnVisitPercentage}. 
+Falling back to default value.`);
+    }
+  }
+  return adjustments;
+}
 export {
-  formatNumber
+  formatNumber,
+  parseOptions
 };

package/dist/esm/hosting-api.js

@@ -18,10 +18,6 @@ async function checkDomainsAgainstAPI(domains) {
     const apiPath = "https://api.thegreenwebfoundation.org/v2/greencheckmulti";
     const domainsString = JSON.stringify(domains);
     const req = await fetch(`${apiPath}/${domainsString}`);
-    log(`${apiPath}/${domainsString}`);
-    log({ req });
-    const textResult = await req.text();
-    log({ textResult });
     const allGreenCheckResults = await req.json();
     return greenDomainsFromResults(allGreenCheckResults);
   } catch (e) {