@tgwf/co2 0.16.6 → 0.16.7

package/dist/cjs/hosting-json.js.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../src/hosting-json.js"],
   "sourcesContent": ["\"use strict\";\n\n/**\n * Check if a string or array of domains has been provided\n * @param {string|array} domain - The domain to check, or an array of domains to be checked.\n */\nasync function check(domain, db) {\n  // is it a single domain or an array of them?\n  if (typeof domain === \"string\") {\n    return checkInJSON(domain, db);\n  } else {\n    return checkDomainsInJSON(domain, db);\n  }\n}\n\n/**\n * Check if a domain is hosted by a green web host by querying the database.\n * @param {string} domain - The domain to check.\n * @param {object} db - The database to check against.\n * @returns {boolean} - A boolean indicating whether the domain is hosted by a green web host.\n */\nfunction checkInJSON(domain, db) {\n  if (db.indexOf(domain) > -1) {\n    return true;\n  }\n  return false;\n}\n\n/**\n * Extract the green domains from the results of a green check.\n * @param {object} greenResults - The results of a green check.\n * @returns {array} - An array of domains that are hosted by a green web host.\n */\nfunction greenDomainsFromResults(greenResults) {\n  const entries = Object.entries(greenResults);\n  const greenEntries = entries.filter(([key, val]) => val.green);\n\n  return greenEntries.map(([key, val]) => val.url);\n}\n\n/**\n * Check if an array of domains is hosted by a green web host by querying the database.\n * @param {array} domains - An array of domains to check.\n * @param {object} db - The database to check against.\n * @returns {array} - An array of domains that are hosted by a green web host.\n */\nfunction checkDomainsInJSON(domains, db) {\n  let greenDomains = [];\n\n  for (let domain of domains) {\n    if (db.indexOf(domain) > -1) {\n      greenDomains.push(domain);\n    }\n  }\n  return greenDomains;\n}\n\n/**\n * Find the provided information a string or array of domains\n * @param {string|array} domain - The domain to check, or an array of domains to be checked.\n */\nfunction find(domain, db) {\n  // is it a single domain or an array of them?\n  if (typeof domain === \"string\") {\n    return findInJSON(domain, db);\n  } else {\n    return findDomainsInJSON(domain, db);\n  }\n}\n\n/**\n * Check if a domain is hosted by a green web host by querying the database.\n * @param {string} domain - The domain to check.\n * @param {object} db - The database to check against.\n * @returns {object} - An object representing the domain provided host information.\n */\nfunction findInJSON(domain, db) {\n  if (db.indexOf(domain) > -1) {\n    return domain;\n  }\n  return {\n    url: domain,\n    green: false,\n  };\n}\n\n/**\n * Check if an array of domains is hosted by a green web host by querying the database.\n * @param {array} domains - An array of domains to check.\n * @param {object} db - The database to check against.\n * @returns {array} - A dictionary of domain to provided host information.\n */\nfunction findDomainsInJSON(domains, db) {\n  const result = {};\n  for (let domain of domains) {\n    result[domain] = findInJSON(domain, db);\n  }\n  return result;\n}\n\nmodule.exports = {\n  check,\n  greenDomainsFromResults,\n  find,\n};\n"],
-  "mappings": ";AAMA,eAAe,MAAM,QAAQ,IAAI;AAE/B,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,YAAY,QAAQ,EAAE;AAAA,EAC/B,OAAO;AACL,WAAO,mBAAmB,QAAQ,EAAE;AAAA,EACtC;AACF;AAQA,SAAS,YAAY,QAAQ,IAAI;AAC/B,MAAI,GAAG,QAAQ,MAAM,IAAI,IAAI;AAC3B,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAOA,SAAS,wBAAwB,cAAc;AAC7C,QAAM,UAAU,OAAO,QAAQ,YAAY;AAC3C,QAAM,eAAe,QAAQ,OAAO,CAAC,CAAC,KAAK,GAAG,MAAM,IAAI,KAAK;AAE7D,SAAO,aAAa,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM,IAAI,GAAG;AACjD;AAQA,SAAS,mBAAmB,SAAS,IAAI;AACvC,MAAI,eAAe,CAAC;AAEpB,WAAS,UAAU,SAAS;AAC1B,QAAI,GAAG,QAAQ,MAAM,IAAI,IAAI;AAC3B,mBAAa,KAAK,MAAM;AAAA,IAC1B;AAAA,EACF;AACA,SAAO;AACT;AAMA,SAAS,KAAK,QAAQ,IAAI;AAExB,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,WAAW,QAAQ,EAAE;AAAA,EAC9B,OAAO;AACL,WAAO,kBAAkB,QAAQ,EAAE;AAAA,EACrC;AACF;AAQA,SAAS,WAAW,QAAQ,IAAI;AAC9B,MAAI,GAAG,QAAQ,MAAM,IAAI,IAAI;AAC3B,WAAO;AAAA,EACT;AACA,SAAO;AAAA,IACL,KAAK;AAAA,IACL,OAAO;AAAA,EACT;AACF;AAQA,SAAS,kBAAkB,SAAS,IAAI;AACtC,QAAM,SAAS,CAAC;AAChB,WAAS,UAAU,SAAS;AAC1B,WAAO,UAAU,WAAW,QAAQ,EAAE;AAAA,EACxC;AACA,SAAO;AACT;AAEA,OAAO,UAAU;AAAA,EACf;AAAA,EACA;AAAA,EACA;AACF;",
+  "mappings": ";AAMA,eAAe,MAAM,QAAQ,IAAI;AAE/B,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,YAAY,QAAQ,EAAE;AAAA,EAC/B,OAAO;AACL,WAAO,mBAAmB,QAAQ,EAAE;AAAA,EACtC;AACF;AAQA,SAAS,YAAY,QAAQ,IAAI;AAC/B,MAAI,GAAG,QAAQ,MAAM,IAAI,IAAI;AAC3B,WAAO;AAAA,EACT;AACA,SAAO;AACT;AAOA,SAAS,wBAAwB,cAAc;AAC7C,QAAM,UAAU,OAAO,QAAQ,YAAY;AAC3C,QAAM,eAAe,QAAQ,OAAO,CAAC,CAAC,KAAK,GAAG,MAAM,IAAI,KAAK;AAE7D,SAAO,aAAa,IAAI,CAAC,CAAC,KAAK,GAAG,MAAM,IAAI,GAAG;AACjD;AAQA,SAAS,mBAAmB,SAAS,IAAI;AACvC,MAAI,eAAe,CAAC;AAEpB,WAAS,UAAU,SAAS;AAC1B,QAAI,GAAG,QAAQ,MAAM,IAAI,IAAI;AAC3B,mBAAa,KAAK,MAAM;AAAA,IAC1B;AAAA,EACF;AACA,SAAO;AACT;AAMA,SAAS,KAAK,QAAQ,IAAI;AAExB,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,WAAW,QAAQ,EAAE;AAAA,EAC9B,OAAO;AACL,WAAO,kBAAkB,QAAQ,EAAE;AAAA,EACrC;AACF;AAQA,SAAS,WAAW,QAAQ,IAAI;AAC9B,MAAI,GAAG,QAAQ,MAAM,IAAI,IAAI;AAC3B,WAAO;AAAA,EACT;AACA,SAAO;AAAA,IACL,KAAK;AAAA,IACL,OAAO;AAAA,EACT;AACF;AAQA,SAAS,kBAAkB,SAAS,IAAI;AACtC,QAAM,SAAS,CAAC;AAChB,WAAS,UAAU,SAAS;AAC1B,WAAO,MAAM,IAAI,WAAW,QAAQ,EAAE;AAAA,EACxC;AACA,SAAO;AACT;AAEA,OAAO,UAAU;AAAA,EACf;AAAA,EACA;AAAA,EACA;AACF;",
   "names": []
 }

package/dist/cjs/hosting-json.node.js

@@ -14,6 +14,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));

package/dist/cjs/hosting-json.node.js.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../src/hosting-json.node.js"],
   "sourcesContent": ["\"use strict\";\n\nimport fs from \"fs\";\nimport zlib from \"zlib\";\nimport { promisify } from \"util\";\n\nconst readFile = promisify(fs.readFile);\nconst gunzip = promisify(zlib.gunzip);\n\n/**\n * Converts a readable stream to a string.\n * @param {ReadableStream} stream - The readable stream to convert.\n * @returns {Promise<string>} A promise that resolves to the string representation of the stream.\n */\nasync function streamToString(stream) {\n  return new Promise((resolve, reject) => {\n    const chunks = [];\n    stream.on(\"error\", reject);\n    stream.on(\"data\", (chunk) => chunks.push(chunk));\n    stream.on(\"end\", () => resolve(Buffer.concat(chunks)));\n  });\n}\n\n/**\n * Get the contents of a gzipped file as a JSON string.\n * @param {string} jsonPath - The path to the gzipped JSON file.\n * @returns {Promise<string>} A promise that resolves to the JSON string.\n */\nasync function getGzippedFileAsJson(jsonPath) {\n  const readStream = fs.createReadStream(jsonPath);\n  const text = await streamToString(readStream);\n  const unzipped = await gunzip(text);\n  return unzipped.toString();\n}\n\n/**\n * Loads JSON data from a file path.\n * @param {string} jsonPath - The path to the JSON file.\n * @returns {Promise<object>} A promise that resolves to the parsed JSON object.\n */\nasync function loadJSON(jsonPath) {\n  const jsonBuffer = jsonPath.endsWith(\".gz\")\n    ? await getGzippedFileAsJson(jsonPath)\n    : await readFile(jsonPath);\n  return JSON.parse(jsonBuffer);\n}\n\nmodule.exports = {\n  loadJSON,\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;AAEA,gBAAe;AACf,kBAAiB;AACjB,kBAA0B;AAE1B,MAAM,eAAW,uBAAU,UAAAA,QAAG,QAAQ;AACtC,MAAM,aAAS,uBAAU,YAAAC,QAAK,MAAM;AAOpC,eAAe,eAAe,QAAQ;AACpC,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAM,SAAS,CAAC;AAChB,WAAO,GAAG,SAAS,MAAM;AACzB,WAAO,GAAG,QAAQ,CAAC,UAAU,OAAO,KAAK,KAAK,CAAC;AAC/C,WAAO,GAAG,OAAO,MAAM,QAAQ,OAAO,OAAO,MAAM,CAAC,CAAC;AAAA,EACvD,CAAC;AACH;AAOA,eAAe,qBAAqB,UAAU;AAC5C,QAAM,aAAa,UAAAD,QAAG,iBAAiB,QAAQ;AAC/C,QAAM,OAAO,MAAM,eAAe,UAAU;AAC5C,QAAM,WAAW,MAAM,OAAO,IAAI;AAClC,SAAO,SAAS,SAAS;AAC3B;AAOA,eAAe,SAAS,UAAU;AAChC,QAAM,aAAa,SAAS,SAAS,KAAK,IACtC,MAAM,qBAAqB,QAAQ,IACnC,MAAM,SAAS,QAAQ;AAC3B,SAAO,KAAK,MAAM,UAAU;AAC9B;AAEA,OAAO,UAAU;AAAA,EACf;AACF;",
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAEA,gBAAe;AACf,kBAAiB;AACjB,kBAA0B;AAE1B,MAAM,eAAW,uBAAU,UAAAA,QAAG,QAAQ;AACtC,MAAM,aAAS,uBAAU,YAAAC,QAAK,MAAM;AAOpC,eAAe,eAAe,QAAQ;AACpC,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAM,SAAS,CAAC;AAChB,WAAO,GAAG,SAAS,MAAM;AACzB,WAAO,GAAG,QAAQ,CAAC,UAAU,OAAO,KAAK,KAAK,CAAC;AAC/C,WAAO,GAAG,OAAO,MAAM,QAAQ,OAAO,OAAO,MAAM,CAAC,CAAC;AAAA,EACvD,CAAC;AACH;AAOA,eAAe,qBAAqB,UAAU;AAC5C,QAAM,aAAa,UAAAD,QAAG,iBAAiB,QAAQ;AAC/C,QAAM,OAAO,MAAM,eAAe,UAAU;AAC5C,QAAM,WAAW,MAAM,OAAO,IAAI;AAClC,SAAO,SAAS,SAAS;AAC3B;AAOA,eAAe,SAAS,UAAU;AAChC,QAAM,aAAa,SAAS,SAAS,KAAK,IACtC,MAAM,qBAAqB,QAAQ,IACnC,MAAM,SAAS,QAAQ;AAC3B,SAAO,KAAK,MAAM,UAAU;AAC9B;AAEA,OAAO,UAAU;AAAA,EACf;AACF;",
   "names": ["fs", "zlib"]
 }

package/dist/cjs/hosting-node.js

@@ -17,6 +17,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));

package/dist/cjs/hosting-node.js.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../src/hosting-node.js"],
   "sourcesContent": ["/*\n\nWe have a separate node-specific hosting.js file for node.\nThis uses the node-specific APIs for making http requests,\nand doing lookups against local JSON and sqlite databases.\nThis is used in the CommonJS build of co2.js\n\nThis lets us keep the total library small, and dependencies minimal.\n*/\n\nimport https from \"https\";\n\nimport hostingJSON from \"./hosting-json.js\";\nimport hostingJSONNode from \"./hosting-json.node.js\";\nimport { getApiRequestHeaders } from \"./helpers/index.js\";\n\n/**\n * Accept a url and perform an http request, returning the body\n * for parsing as JSON.\n *\n * @param {string} url\n * @param {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.\n * @return {string}\n */\nasync function getBody(url, userAgentIdentifier) {\n  return new Promise(function (resolve, reject) {\n    // Do async job\n    const req = https.get(\n      url,\n      { headers: getApiRequestHeaders(userAgentIdentifier) },\n      function (res) {\n        if (res.statusCode < 200 || res.statusCode >= 300) {\n          return reject(\n            new Error(\n              `Could not get info from: ${url}. Status Code: ${res.statusCode}`\n            )\n          );\n        }\n        const data = [];\n\n        res.on(\"data\", (chunk) => {\n          data.push(chunk);\n        });\n\n        res.on(\"end\", () => resolve(Buffer.concat(data).toString()));\n      }\n    );\n    req.end();\n  });\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[] | DomainCheckOptions} optionsOrDb - Optional. An object of domain check options, or a database list to use for lookups.\n * @param {string } userAgentIdentifier - Optional. 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 */\n\nfunction check(domain, optionsOrDb, userAgentIdentifier) {\n  let db,\n    options = {};\n  if (!db && Array.isArray(optionsOrDb)) {\n    db = optionsOrDb;\n  } else {\n    options = optionsOrDb;\n    if (userAgentIdentifier) {\n      options = { ...options, userAgentIdentifier };\n    }\n    db = optionsOrDb?.db;\n  }\n\n  if (db && options?.verbose) {\n    throw new Error(\"verbose mode cannot be used with a local lookup database\");\n  }\n  if (db) {\n    return hostingJSON.check(domain, db);\n  }\n  // is it a single domain or an array of them?\n  if (typeof domain === \"string\") {\n    return checkAgainstAPI(domain, options);\n  } else {\n    return checkDomainsAgainstAPI(domain, options);\n  }\n}\n\n/**\n * Check if a domain is hosted by a green web host by querying the Green Web Foundation API.\n * @param {string} domain - The domain to check.\n * @param {DomainCheckOptions} options\n * @returns {boolean} - 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 */\nasync function checkAgainstAPI(domain, options = {}) {\n  const res = JSON.parse(\n    await getBody(\n      `https://api.thegreenwebfoundation.org/greencheck/${domain}`,\n      options.userAgentIdentifier\n    )\n  );\n  return options.verbose ? res : res.green;\n}\n\n/**\n * Check if an array of domains is hosted by a green web host by querying the Green Web Foundation API.\n * @param {array} domains - An array of domains to check.\n * @param {DomainCheckOptions} options\n * @returns {array} - 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 */\nasync function checkDomainsAgainstAPI(domains, options = {}) {\n  try {\n    const allGreenCheckResults = JSON.parse(\n      await getBody(\n        `https://api.thegreenwebfoundation.org/v2/greencheckmulti/${JSON.stringify(\n          domains\n        )}`,\n        options.userAgentIdentifier\n      )\n    );\n    return options.verbose\n      ? allGreenCheckResults\n      : hostingJSON.greenDomainsFromResults(allGreenCheckResults);\n  } catch (e) {\n    return options.verbose ? {} : [];\n  }\n}\n\nexport default {\n  check,\n  greendomains: hostingJSON.greenDomainsFromResults,\n  loadJSON: hostingJSONNode.loadJSON,\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,mBAAkB;AAElB,0BAAwB;AACxB,+BAA4B;AAC5B,qBAAqC;AAUrC,eAAe,QAAQ,KAAK,qBAAqB;AAC/C,SAAO,IAAI,QAAQ,SAAU,SAAS,QAAQ;AAE5C,UAAM,MAAM,aAAAA,QAAM;AAAA,MAChB;AAAA,MACA,EAAE,aAAS,qCAAqB,mBAAmB,EAAE;AAAA,MACrD,SAAU,KAAK;AACb,YAAI,IAAI,aAAa,OAAO,IAAI,cAAc,KAAK;AACjD,iBAAO;AAAA,YACL,IAAI;AAAA,cACF,4BAA4B,qBAAqB,IAAI;AAAA,YACvD;AAAA,UACF;AAAA,QACF;AACA,cAAM,OAAO,CAAC;AAEd,YAAI,GAAG,QAAQ,CAAC,UAAU;AACxB,eAAK,KAAK,KAAK;AAAA,QACjB,CAAC;AAED,YAAI,GAAG,OAAO,MAAM,QAAQ,OAAO,OAAO,IAAI,EAAE,SAAS,CAAC,CAAC;AAAA,MAC7D;AAAA,IACF;AACA,QAAI,IAAI;AAAA,EACV,CAAC;AACH;AAcA,SAAS,MAAM,QAAQ,aAAa,qBAAqB;AACvD,MAAI,IACF,UAAU,CAAC;AACb,MAAI,CAAC,MAAM,MAAM,QAAQ,WAAW,GAAG;AACrC,SAAK;AAAA,EACP,OAAO;AACL,cAAU;AACV,QAAI,qBAAqB;AACvB,gBAAU,EAAE,GAAG,SAAS,oBAAoB;AAAA,IAC9C;AACA,SAAK,2CAAa;AAAA,EACpB;AAEA,MAAI,OAAM,mCAAS,UAAS;AAC1B,UAAM,IAAI,MAAM,0DAA0D;AAAA,EAC5E;AACA,MAAI,IAAI;AACN,WAAO,oBAAAC,QAAY,MAAM,QAAQ,EAAE;AAAA,EACrC;AAEA,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,gBAAgB,QAAQ,OAAO;AAAA,EACxC,OAAO;AACL,WAAO,uBAAuB,QAAQ,OAAO;AAAA,EAC/C;AACF;AASA,eAAe,gBAAgB,QAAQ,UAAU,CAAC,GAAG;AACnD,QAAM,MAAM,KAAK;AAAA,IACf,MAAM;AAAA,MACJ,oDAAoD;AAAA,MACpD,QAAQ;AAAA,IACV;AAAA,EACF;AACA,SAAO,QAAQ,UAAU,MAAM,IAAI;AACrC;AASA,eAAe,uBAAuB,SAAS,UAAU,CAAC,GAAG;AAC3D,MAAI;AACF,UAAM,uBAAuB,KAAK;AAAA,MAChC,MAAM;AAAA,QACJ,4DAA4D,KAAK;AAAA,UAC/D;AAAA,QACF;AAAA,QACA,QAAQ;AAAA,MACV;AAAA,IACF;AACA,WAAO,QAAQ,UACX,uBACA,oBAAAA,QAAY,wBAAwB,oBAAoB;AAAA,EAC9D,SAAS,GAAP;AACA,WAAO,QAAQ,UAAU,CAAC,IAAI,CAAC;AAAA,EACjC;AACF;AAEA,IAAO,uBAAQ;AAAA,EACb;AAAA,EACA,cAAc,oBAAAA,QAAY;AAAA,EAC1B,UAAU,yBAAAC,QAAgB;AAC5B;",
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,mBAAkB;AAElB,0BAAwB;AACxB,+BAA4B;AAC5B,qBAAqC;AAUrC,eAAe,QAAQ,KAAK,qBAAqB;AAC/C,SAAO,IAAI,QAAQ,SAAU,SAAS,QAAQ;AAE5C,UAAM,MAAM,aAAAA,QAAM;AAAA,MAChB;AAAA,MACA,EAAE,aAAS,qCAAqB,mBAAmB,EAAE;AAAA,MACrD,SAAU,KAAK;AACb,YAAI,IAAI,aAAa,OAAO,IAAI,cAAc,KAAK;AACjD,iBAAO;AAAA,YACL,IAAI;AAAA,cACF,4BAA4B,GAAG,kBAAkB,IAAI,UAAU;AAAA,YACjE;AAAA,UACF;AAAA,QACF;AACA,cAAM,OAAO,CAAC;AAEd,YAAI,GAAG,QAAQ,CAAC,UAAU;AACxB,eAAK,KAAK,KAAK;AAAA,QACjB,CAAC;AAED,YAAI,GAAG,OAAO,MAAM,QAAQ,OAAO,OAAO,IAAI,EAAE,SAAS,CAAC,CAAC;AAAA,MAC7D;AAAA,IACF;AACA,QAAI,IAAI;AAAA,EACV,CAAC;AACH;AAcA,SAAS,MAAM,QAAQ,aAAa,qBAAqB;AACvD,MAAI,IACF,UAAU,CAAC;AACb,MAAI,CAAC,MAAM,MAAM,QAAQ,WAAW,GAAG;AACrC,SAAK;AAAA,EACP,OAAO;AACL,cAAU;AACV,QAAI,qBAAqB;AACvB,gBAAU,EAAE,GAAG,SAAS,oBAAoB;AAAA,IAC9C;AACA,SAAK,2CAAa;AAAA,EACpB;AAEA,MAAI,OAAM,mCAAS,UAAS;AAC1B,UAAM,IAAI,MAAM,0DAA0D;AAAA,EAC5E;AACA,MAAI,IAAI;AACN,WAAO,oBAAAC,QAAY,MAAM,QAAQ,EAAE;AAAA,EACrC;AAEA,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,gBAAgB,QAAQ,OAAO;AAAA,EACxC,OAAO;AACL,WAAO,uBAAuB,QAAQ,OAAO;AAAA,EAC/C;AACF;AASA,eAAe,gBAAgB,QAAQ,UAAU,CAAC,GAAG;AACnD,QAAM,MAAM,KAAK;AAAA,IACf,MAAM;AAAA,MACJ,oDAAoD,MAAM;AAAA,MAC1D,QAAQ;AAAA,IACV;AAAA,EACF;AACA,SAAO,QAAQ,UAAU,MAAM,IAAI;AACrC;AASA,eAAe,uBAAuB,SAAS,UAAU,CAAC,GAAG;AAC3D,MAAI;AACF,UAAM,uBAAuB,KAAK;AAAA,MAChC,MAAM;AAAA,QACJ,4DAA4D,KAAK;AAAA,UAC/D;AAAA,QACF,CAAC;AAAA,QACD,QAAQ;AAAA,MACV;AAAA,IACF;AACA,WAAO,QAAQ,UACX,uBACA,oBAAAA,QAAY,wBAAwB,oBAAoB;AAAA,EAC9D,SAAS,GAAG;AACV,WAAO,QAAQ,UAAU,CAAC,IAAI,CAAC;AAAA,EACjC;AACF;AAEA,IAAO,uBAAQ;AAAA,EACb;AAAA,EACA,cAAc,oBAAAA,QAAY;AAAA,EAC1B,UAAU,yBAAAC,QAAgB;AAC5B;",
   "names": ["https", "hostingJSON", "hostingJSONNode"]
 }

package/dist/cjs/hosting.js

@@ -18,6 +18,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));

package/dist/cjs/hosting.js.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../src/hosting.js"],
   "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,SAAS,MAAM,QAAQ,kBAAkB;AACvC,SAAO,mBAAAA,QAAW,MAAM,QAAQ,gBAAgB;AAClD;AAEA,IAAO,kBAAQ;",
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,yBAAuB;AAiBvB,SAAS,MAAM,QAAQ,kBAAkB;AACvC,SAAO,mBAAAA,QAAW,MAAM,QAAQ,gBAAgB;AAClD;AAEA,IAAO,kBAAQ;",
   "names": ["hostingAPI"]
 }

package/dist/cjs/index-node.js

@@ -17,6 +17,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));

package/dist/cjs/index-node.js.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../src/index-node.js"],
   "sourcesContent": ["import co2 from \"./co2.js\";\nimport hosting from \"./hosting-node.js\";\nimport averageIntensity from \"./data/average-intensities.min.js\";\nimport marginalIntensity from \"./data/marginal-intensities-2021.min.js\";\nexport { co2, hosting, averageIntensity, marginalIntensity };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,yDAAAA;AAAA,EAAA,sBAAAC;AAAA,EAAA,mCAAAC;AAAA,EAAA,8DAAAC;AAAA;AAAA;AAAA,iBAAgB;AAChB,0BAAoB;AACpB,qCAA6B;AAC7B,2CAA8B;",
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,yDAAAA;AAAA,EAAA,sBAAAC;AAAA,EAAA,mCAAAC;AAAA,EAAA,8DAAAC;AAAA;AAAA;AAAA,iBAAgB;AAChB,0BAAoB;AACpB,qCAA6B;AAC7B,2CAA8B;",
   "names": ["averageIntensity", "co2", "hosting", "marginalIntensity"]
 }

package/dist/cjs/index.js

@@ -17,22 +17,26 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   averageIntensity: () => import_average_intensities_min.default,
   co2: () => import_co2.default,
-  default: () => src_default,
+  default: () => index_default,
   hosting: () => import_hosting.default,
   marginalIntensity: () => import_marginal_intensities_2021_min.default
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 var import_co2 = __toESM(require("./co2.js"));
 var import_hosting = __toESM(require("./hosting.js"));
 var import_average_intensities_min = __toESM(require("./data/average-intensities.min.js"));
 var import_marginal_intensities_2021_min = __toESM(require("./data/marginal-intensities-2021.min.js"));
-var src_default = { co2: import_co2.default, hosting: import_hosting.default, averageIntensity: import_average_intensities_min.default, marginalIntensity: import_marginal_intensities_2021_min.default };
+var index_default = { co2: import_co2.default, hosting: import_hosting.default, averageIntensity: import_average_intensities_min.default, marginalIntensity: import_marginal_intensities_2021_min.default };
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../src/index.js"],
   "sourcesContent": ["import co2 from \"./co2.js\";\nimport hosting from \"./hosting.js\";\nimport averageIntensity from \"./data/average-intensities.min.js\";\nimport marginalIntensity from \"./data/marginal-intensities-2021.min.js\";\n\nexport { co2, hosting, averageIntensity, marginalIntensity };\nexport default { co2, hosting, averageIntensity, marginalIntensity };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,yDAAAA;AAAA,EAAA,sBAAAC;AAAA,EAAA;AAAA,gCAAAC;AAAA,EAAA,8DAAAC;AAAA;AAAA;AAAA,iBAAgB;AAChB,qBAAoB;AACpB,qCAA6B;AAC7B,2CAA8B;AAG9B,IAAO,cAAQ,EAAE,gBAAAF,SAAK,wBAAAC,SAAS,iDAAAF,SAAkB,wDAAAG,QAAkB;",
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,yDAAAA;AAAA,EAAA,sBAAAC;AAAA,EAAA;AAAA,gCAAAC;AAAA,EAAA,8DAAAC;AAAA;AAAA;AAAA,iBAAgB;AAChB,qBAAoB;AACpB,qCAA6B;AAC7B,2CAA8B;AAG9B,IAAO,gBAAQ,EAAE,gBAAAF,SAAK,wBAAAC,SAAS,iDAAAF,SAAkB,wDAAAG,QAAkB;",
   "names": ["averageIntensity", "co2", "hosting", "marginalIntensity"]
 }

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

@@ -30,6 +30,14 @@ class SustainableWebDesign {
     this.options = options;
     this.version = 3;
   }
+  /**
+   * Accept a figure for bytes transferred and return an object representing
+   * the share of the total enrgy use of the entire system, broken down
+   * by each corresponding system component
+   *
+   * @param {number}  bytes - the data transferred in bytes
+   * @return {object} Object containing the energy in kilowatt hours, keyed by system component
+   */
   energyPerByteByComponent(bytes) {
     const transferedBytesToGb = bytes / import_constants.fileSize.GIGABYTE;
     const energyUsage = transferedBytesToGb * import_constants.KWH_PER_GB;
@@ -40,6 +48,14 @@ class SustainableWebDesign {
       dataCenterEnergy: energyUsage * import_constants.DATACENTER_ENERGY
     };
   }
+  /**
+   * Accept an object keys by the different system components, and
+   * return an object with the co2 figures key by the each component
+   *
+   * @param {object} energyByComponent - energy grouped by the four system components
+   * @param {number} [carbonIntensity] - carbon intensity to apply to the datacentre values
+   * @return {number} the total number in grams of CO2 equivalent emissions
+   */
   co2byComponent(energyByComponent, carbonIntensity = import_constants.GLOBAL_GRID_INTENSITY, options = {}) {
     let deviceCarbonIntensity = import_constants.GLOBAL_GRID_INTENSITY;
     let networkCarbonIntensity = import_constants.GLOBAL_GRID_INTENSITY;
@@ -74,6 +90,19 @@ class SustainableWebDesign {
     }
     return returnCO2ByComponent;
   }
+  /**
+   * Accept a figure for bytes transferred and return a single figure for CO2
+   * emissions. Where information exists about the origin data is being
+   * fetched from, a different carbon intensity figure
+   * is applied for the data centre share of the carbon intensity.
+   *
+   * @param {number} bytes - the data transferred in bytes
+   * @param {boolean} carbonIntensity - a boolean indicating whether the data center is green or not
+   * @param {boolean} segmentResults - a boolean indicating whether to return the results broken down by component
+   * @param {boolean} ratingResults - a boolean indicating whether to return the rating based on the Sustainable Web Design Model
+   * @param {object} options - an object containing the grid intensity and first/return visitor values
+   * @return {number|object} the total number in grams of CO2 equivalent emissions, or an object containing the breakdown by component
+   */
   perByte(bytes, carbonIntensity = false, segmentResults = false, ratingResults = false, options = {}) {
     if (bytes < 1) {
       bytes = 0;
@@ -112,6 +141,17 @@ class SustainableWebDesign {
     }
     return co2ValuesSum;
   }
+  /**
+   * Accept a figure for bytes transferred and return a single figure for CO2
+   * emissions. This method applies caching assumptions from the original Sustainable Web Design model.
+   *
+   * @param {number} bytes - the data transferred in bytes
+   * @param {boolean} carbonIntensity - a boolean indicating whether the data center is green or not
+   * @param {boolean} segmentResults - a boolean indicating whether to return the results broken down by component
+   * @param {boolean} ratingResults - a boolean indicating whether to return the rating based on the Sustainable Web Design Model
+   * @param {object} options - an object containing the grid intensity and first/return visitor values
+   * @return {number|object} the total number in grams of CO2 equivalent emissions, or an object containing the breakdown by component
+   */
   perVisit(bytes, carbonIntensity = false, segmentResults = false, ratingResults = false, options = {}) {
     const energyBycomponent = this.energyPerVisitByComponent(bytes, options);
     if (typeof carbonIntensity !== "boolean") {
@@ -147,6 +187,13 @@ class SustainableWebDesign {
     }
     return co2ValuesSum;
   }
+  /**
+   * Accept a figure for bytes transferred and return the number of kilowatt hours used
+   * by the total system for this data transfer
+   *
+   * @param {number} bytes
+   * @return {number} the number of kilowatt hours used
+   */
   energyPerByte(bytes) {
     const energyByComponent = this.energyPerByteByComponent(bytes);
     const energyValues = Object.values(energyByComponent);
@@ -154,6 +201,20 @@ class SustainableWebDesign {
       (prevValue, currentValue) => prevValue + currentValue
     );
   }
+  /**
+   * Accept a figure for bytes transferred, and return an object containing figures
+   * per system component, with the caching assumptions applied. This tries to account
+   * for webpages being loaded from a cache by browsers, so if you had a thousand page views,
+   * and tried to work out the energy per visit, the numbers would reflect the reduced amounts
+   * of transfer.
+   *
+   * @param {number} bytes - the data transferred in bytes for loading a webpage
+   * @param {number} firstView - what percentage of visits are loading this page for the first time
+   * @param {number} returnView - what percentage of visits are loading this page for subsequent times
+   * @param {number} dataReloadRatio - what percentage of a page is reloaded on each subsequent page view
+   *
+   * @return {object} Object containing the energy in kilowatt hours, keyed by system component
+   */
   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 || options.dataReloadRatio === 0) {
       dataReloadRatio = options.dataReloadRatio;
@@ -173,6 +234,13 @@ class SustainableWebDesign {
     }
     return cacheAdjustedSegmentEnergy;
   }
+  /**
+   * Accept a figure for bytes, and return the total figure for energy per visit
+   * using the default caching assumptions for loading a single website
+   *
+   * @param {number} bytes
+   * @return {number} the total energy use for the visit, after applying the caching assumptions
+   */
   energyPerVisit(bytes) {
     let firstVisits = 0;
     let subsequentVisits = 0;
@@ -208,6 +276,12 @@ class SustainableWebDesign {
       productionEnergy: (0, import_helpers.formatNumber)(annualEnergy * import_constants.PRODUCTION_ENERGY)
     };
   }
+  /**
+   * Determines the rating of a website's sustainability based on its CO2 emissions.
+   *
+   * @param {number} co2e - The CO2 emissions of the website in grams.
+   * @returns {string} The sustainability rating, ranging from "A+" (best) to "F" (worst).
+   */
   ratingScale(co2e) {
     return (0, import_helpers.outputRating)(co2e, this.version);
   }

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

@@ -2,6 +2,6 @@
   "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,WAAW,IAAI,QAAQ;AAEhD,WAAI,iCAAQ,WAAS,iCAAQ,WAAU,GAAG;AACxC,gCAAwB,OAAO;AAAA,MACjC;AACA,WAAI,mCAAS,WAAS,mCAAS,WAAU,GAAG;AAC1C,iCAAyB,QAAQ;AAAA,MACnC;AAEA,WAAI,yCAAY,WAAS,yCAAY,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,KAAK,KAAK,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;AAAA,QACR,uEAAuE;AAAA,MACzE;AAAA,IACF;AAEA,UAAM,uBAAuB,KAAK;AAAA,MAChC;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAGA,UAAM,YAAY,OAAO,OAAO,oBAAoB;AACpD,UAAM,eAAe,UAAU;AAAA,MAC7B,CAAC,WAAW,iBAAiB,YAAY;AAAA,IAC3C;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;AAAA,QACR,wEAAwE;AAAA,MAC1E;AAAA,IACF;AAEA,UAAM,uBAAuB,KAAK;AAAA,MAChC;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAGA,UAAM,YAAY,OAAO,OAAO,oBAAoB;AACpD,UAAM,eAAe,UAAU;AAAA,MAC7B,CAAC,WAAW,iBAAiB,YAAY;AAAA,IAC3C;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;AAAA,MAClB,CAAC,WAAW,iBAAiB,YAAY;AAAA,IAC3C;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,KAAK,KAAK,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;AAAA,MAC/B,KAAK,0BAA0B,KAAK;AAAA,IACtC;AAEA,eAAW,CAAC,KAAK,GAAG,KAAK,mBAAmB;AAC1C,UAAI,IAAI,QAAQ,OAAO,IAAI,GAAG;AAC5B,uBAAe;AAAA,MACjB;AAAA,IACF;AAEA,eAAW,CAAC,KAAK,GAAG,KAAK,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,eAAO,6BAAa,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,0BAAsB,6BAAa,eAAe,uCAAsB;AAAA,MACxE,mBAAe,6BAAa,eAAe,+BAAc;AAAA,MACzD,sBAAkB,6BAAa,eAAe,kCAAiB;AAAA,MAC/D,sBAAkB,6BAAa,eAAe,kCAAiB;AAAA,IACjE;AAAA,EACF;AAAA,EAQA,YAAY,MAAM;AAChB,eAAO,6BAAa,MAAM,KAAK,OAAO;AAAA,EACxC;AACF;AAGA,IAAO,oCAAQ;",
+  "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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;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,WAAW,IAAI,QAAQ;AAEhD,WAAI,iCAAQ,WAAS,iCAAQ,WAAU,GAAG;AACxC,gCAAwB,OAAO;AAAA,MACjC;AACA,WAAI,mCAAS,WAAS,mCAAS,WAAU,GAAG;AAC1C,iCAAyB,QAAQ;AAAA,MACnC;AAEA,WAAI,yCAAY,WAAS,yCAAY,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,KAAK,KAAK,OAAO,QAAQ,iBAAiB,GAAG;AAG5D,UAAI,IAAI,WAAW,kBAAkB,GAAG;AACtC,6BAAqB,IAAI,QAAQ,UAAU,KAAK,CAAC,IAC/C,QAAQ;AAAA,MACZ,WAAW,IAAI,WAAW,sBAAsB,GAAG;AACjD,6BAAqB,IAAI,QAAQ,UAAU,KAAK,CAAC,IAC/C,QAAQ;AAAA,MACZ,WAAW,IAAI,WAAW,eAAe,GAAG;AAC1C,6BAAqB,IAAI,QAAQ,UAAU,KAAK,CAAC,IAC/C,QAAQ;AAAA,MACZ,OAAO;AAEL,6BAAqB,IAAI,QAAQ,UAAU,KAAK,CAAC,IAC/C,QAAQ;AAAA,MACZ;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;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;AAAA,QACR,uEAAuE,eAAe;AAAA,MACxF;AAAA,IACF;AAEA,UAAM,uBAAuB,KAAK;AAAA,MAChC;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAGA,UAAM,YAAY,OAAO,OAAO,oBAAoB;AACpD,UAAM,eAAe,UAAU;AAAA,MAC7B,CAAC,WAAW,iBAAiB,YAAY;AAAA,IAC3C;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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;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;AAAA,QACR,wEAAwE,eAAe;AAAA,MACzF;AAAA,IACF;AAEA,UAAM,uBAAuB,KAAK;AAAA,MAChC;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAGA,UAAM,YAAY,OAAO,OAAO,oBAAoB;AACpD,UAAM,eAAe,UAAU;AAAA,MAC7B,CAAC,WAAW,iBAAiB,YAAY;AAAA,IAC3C;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;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,cAAc,OAAO;AACnB,UAAM,oBAAoB,KAAK,yBAAyB,KAAK;AAG7D,UAAM,eAAe,OAAO,OAAO,iBAAiB;AAGpD,WAAO,aAAa;AAAA,MAClB,CAAC,WAAW,iBAAiB,YAAY;AAAA,IAC3C;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;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,KAAK,KAAK,OAAO,QAAQ,iBAAiB,GAAG;AAE5D,iCAA2B,GAAG,GAAG,UAAU,IAAI,QAAQ;AAGvD,iCAA2B,GAAG,GAAG,eAAe,IAC9C,QAAQ,aAAa;AAAA,IACzB;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,eAAe,OAAO;AAIpB,QAAI,cAAc;AAClB,QAAI,mBAAmB;AAEvB,UAAM,oBAAoB,OAAO;AAAA,MAC/B,KAAK,0BAA0B,KAAK;AAAA,IACtC;AAEA,eAAW,CAAC,KAAK,GAAG,KAAK,mBAAmB;AAC1C,UAAI,IAAI,QAAQ,OAAO,IAAI,GAAG;AAC5B,uBAAe;AAAA,MACjB;AAAA,IACF;AAEA,eAAW,CAAC,KAAK,GAAG,KAAK,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,eAAO,6BAAa,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,0BAAsB,6BAAa,eAAe,uCAAsB;AAAA,MACxE,mBAAe,6BAAa,eAAe,+BAAc;AAAA,MACzD,sBAAkB,6BAAa,eAAe,kCAAiB;AAAA,MAC/D,sBAAkB,6BAAa,eAAe,kCAAiB;AAAA,IACjE;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,YAAY,MAAM;AAChB,eAAO,6BAAa,MAAM,KAAK,OAAO;AAAA,EACxC;AACF;AAGA,IAAO,oCAAQ;",
   "names": []
 }

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

@@ -67,6 +67,12 @@ class SustainableWebDesign {
     this.options = options;
     this.version = 4;
   }
+  /**
+   * Calculate the operational energy of data transfer for each system segment
+   *
+   * @param {number} bytes
+   * @returns {object}
+   */
   operationalEnergyPerSegment(bytes) {
     const transferedBytesToGb = bytes / import_constants.fileSize.GIGABYTE;
     const dataCenter = transferedBytesToGb * OPERATIONAL_KWH_PER_GB_DATACENTER;
@@ -78,6 +84,13 @@ class SustainableWebDesign {
       device
     };
   }
+  /**
+   * Calculate the operational emissions of data transfer for each system segment
+   *
+   * @param {number} bytes
+   * @param {object} options
+   * @returns {object}
+   */
   operationalEmissions(bytes, options = {}) {
     const { dataCenter, network, device } = this.operationalEnergyPerSegment(bytes);
     let dataCenterGridIntensity = GLOBAL_GRID_INTENSITY;
@@ -104,6 +117,12 @@ class SustainableWebDesign {
       device: deviceEmissions
     };
   }
+  /**
+   * Calculate the embodied energy of data transfer for each system segment
+   *
+   * @param {number} bytes
+   * @returns {object}
+   */
   embodiedEnergyPerSegment(bytes) {
     const transferedBytesToGb = bytes / import_constants.fileSize.GIGABYTE;
     const dataCenter = transferedBytesToGb * EMBODIED_KWH_PER_GB_DATACENTER;
@@ -115,6 +134,12 @@ class SustainableWebDesign {
       device
     };
   }
+  /**
+   * Calculate the embodied emissions of data transfer for each system segment
+   *
+   * @param {number} bytes
+   * @returns {object}
+   */
   embodiedEmissions(bytes) {
     const { dataCenter, network, device } = this.embodiedEnergyPerSegment(bytes);
     const dataCenterGridIntensity = GLOBAL_GRID_INTENSITY;
@@ -129,6 +154,7 @@ class SustainableWebDesign {
       device: deviceEmissions
     };
   }
+  // NOTE: Setting green: true should result in a greenHostingFactor of 1.0
   perByte(bytes, green = false, segmented = false, ratingResults = false, options = {}) {
     if (bytes < 1) {
       return 0;
@@ -210,6 +236,12 @@ class SustainableWebDesign {
     }
     return total;
   }
+  /**
+   * Determines the rating of a website's sustainability based on its CO2 emissions.
+   *
+   * @param {number} co2e - The CO2 emissions of the website in grams.
+   * @returns {string} The sustainability rating, ranging from "A+" (best) to "F" (worst).
+   */
   ratingScale(co2e) {
     return (0, import_helpers.outputRating)(co2e, this.version);
   }

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

@@ -2,6 +2,6 @@
   "version": 3,
   "sources": ["../../src/sustainable-web-design-v4.js"],
   "sourcesContent": ["\"use strict\";\n\n/**\n * Sustainable Web Design version 4\n *\n * Updated calculations and figures from\n * https://sustainablewebdesign.org/estimating-digital-emissions/\n *\n */\n\nimport { fileSize, SWDV4 } from \"./constants/index.js\";\nimport { outputRating } from \"./helpers/index.js\";\n\nconst {\n  OPERATIONAL_KWH_PER_GB_DATACENTER,\n  OPERATIONAL_KWH_PER_GB_NETWORK,\n  OPERATIONAL_KWH_PER_GB_DEVICE,\n  EMBODIED_KWH_PER_GB_DATACENTER,\n  EMBODIED_KWH_PER_GB_NETWORK,\n  EMBODIED_KWH_PER_GB_DEVICE,\n  GLOBAL_GRID_INTENSITY,\n} = SWDV4;\n\n/**\n * Output the CO2e emissions for each system segment\n * @param {object} operationalEmissions\n * @param {object} embodiedEmissions\n * @returns {object}\n */\nfunction outputSegments(operationalEmissions, embodiedEmissions) {\n  const totalOperationalCO2e =\n    operationalEmissions.dataCenter +\n    operationalEmissions.network +\n    operationalEmissions.device;\n  const totalEmbodiedCO2e =\n    embodiedEmissions.dataCenter +\n    embodiedEmissions.network +\n    embodiedEmissions.device;\n\n  const dataCenterCO2e =\n    operationalEmissions.dataCenter + embodiedEmissions.dataCenter;\n  const networkCO2e = operationalEmissions.network + embodiedEmissions.network;\n  const consumerDeviceCO2e =\n    operationalEmissions.device + embodiedEmissions.device;\n\n  return {\n    dataCenterOperationalCO2e: operationalEmissions.dataCenter,\n    networkOperationalCO2e: operationalEmissions.network,\n    consumerDeviceOperationalCO2e: operationalEmissions.device,\n    dataCenterEmbodiedCO2e: embodiedEmissions.dataCenter,\n    networkEmbodiedCO2e: embodiedEmissions.network,\n    consumerDeviceEmbodiedCO2e: embodiedEmissions.device,\n    totalEmbodiedCO2e,\n    totalOperationalCO2e,\n    dataCenterCO2e,\n    networkCO2e,\n    consumerDeviceCO2e,\n  };\n}\n\n/**\n * Determine the green hosting factor\n * @param {boolean} green\n * @param {object} options\n * @returns {number}\n */\nfunction getGreenHostingFactor(green, options) {\n  if (green) {\n    return 1.0;\n  } else if (options?.greenHostingFactor || options?.greenHostingFactor === 0) {\n    return options.greenHostingFactor;\n  }\n  return 0;\n}\nclass SustainableWebDesign {\n  constructor(options) {\n    this.allowRatings = true;\n    this.options = options;\n    this.version = 4;\n  }\n\n  /**\n   * Calculate the operational energy of data transfer for each system segment\n   *\n   * @param {number} bytes\n   * @returns {object}\n   */\n  operationalEnergyPerSegment(bytes) {\n    const transferedBytesToGb = bytes / fileSize.GIGABYTE;\n    const dataCenter = transferedBytesToGb * OPERATIONAL_KWH_PER_GB_DATACENTER;\n    const network = transferedBytesToGb * OPERATIONAL_KWH_PER_GB_NETWORK;\n    const device = transferedBytesToGb * OPERATIONAL_KWH_PER_GB_DEVICE;\n\n    return {\n      dataCenter,\n      network,\n      device,\n    };\n  }\n\n  /**\n   * Calculate the operational emissions of data transfer for each system segment\n   *\n   * @param {number} bytes\n   * @param {object} options\n   * @returns {object}\n   */\n  operationalEmissions(bytes, options = {}) {\n    const { dataCenter, network, device } =\n      this.operationalEnergyPerSegment(bytes);\n\n    let dataCenterGridIntensity = GLOBAL_GRID_INTENSITY;\n    let networkGridIntensity = GLOBAL_GRID_INTENSITY;\n    let deviceGridIntensity = GLOBAL_GRID_INTENSITY;\n\n    if (options?.gridIntensity) {\n      const { device, network, dataCenter } = options.gridIntensity;\n\n      if (device?.value || device?.value === 0) {\n        deviceGridIntensity = device.value;\n      }\n\n      if (network?.value || network?.value === 0) {\n        networkGridIntensity = network.value;\n      }\n\n      if (dataCenter?.value || dataCenter?.value === 0) {\n        dataCenterGridIntensity = dataCenter.value;\n      }\n    }\n\n    const dataCenterEmissions = dataCenter * dataCenterGridIntensity;\n    const networkEmissions = network * networkGridIntensity;\n    const deviceEmissions = device * deviceGridIntensity;\n\n    return {\n      dataCenter: dataCenterEmissions,\n      network: networkEmissions,\n      device: deviceEmissions,\n    };\n  }\n\n  /**\n   * Calculate the embodied energy of data transfer for each system segment\n   *\n   * @param {number} bytes\n   * @returns {object}\n   */\n  embodiedEnergyPerSegment(bytes) {\n    const transferedBytesToGb = bytes / fileSize.GIGABYTE;\n    const dataCenter = transferedBytesToGb * EMBODIED_KWH_PER_GB_DATACENTER;\n    const network = transferedBytesToGb * EMBODIED_KWH_PER_GB_NETWORK;\n    const device = transferedBytesToGb * EMBODIED_KWH_PER_GB_DEVICE;\n\n    return {\n      dataCenter,\n      network,\n      device,\n    };\n  }\n\n  /**\n   * Calculate the embodied emissions of data transfer for each system segment\n   *\n   * @param {number} bytes\n   * @returns {object}\n   */\n  embodiedEmissions(bytes) {\n    const { dataCenter, network, device } =\n      this.embodiedEnergyPerSegment(bytes);\n\n    const dataCenterGridIntensity = GLOBAL_GRID_INTENSITY;\n    const networkGridIntensity = GLOBAL_GRID_INTENSITY;\n    const deviceGridIntensity = GLOBAL_GRID_INTENSITY;\n\n    // NOTE: Per the guidance in the SWDM v4, the grid intensity values for embodied emissions are fixed to the global grid intensity.\n\n    const dataCenterEmissions = dataCenter * dataCenterGridIntensity;\n    const networkEmissions = network * networkGridIntensity;\n    const deviceEmissions = device * deviceGridIntensity;\n\n    return {\n      dataCenter: dataCenterEmissions,\n      network: networkEmissions,\n      device: deviceEmissions,\n    };\n  }\n\n  // NOTE: Setting green: true should result in a greenHostingFactor of 1.0\n  perByte(\n    bytes,\n    green = false,\n    segmented = false,\n    ratingResults = false,\n    options = {}\n  ) {\n    if (bytes < 1) {\n      return 0;\n    }\n\n    const operationalEmissions = this.operationalEmissions(bytes, options);\n    const embodiedEmissions = this.embodiedEmissions(bytes);\n    const greenHostingFactor = getGreenHostingFactor(green, options);\n\n    const totalEmissions = {\n      dataCenter:\n        operationalEmissions.dataCenter * (1 - greenHostingFactor) +\n        embodiedEmissions.dataCenter,\n      network: operationalEmissions.network + embodiedEmissions.network,\n      device: operationalEmissions.device + embodiedEmissions.device,\n    };\n\n    const total =\n      totalEmissions.dataCenter +\n      totalEmissions.network +\n      totalEmissions.device;\n\n    let rating = null;\n    if (ratingResults) {\n      rating = this.ratingScale(total);\n    }\n\n    if (segmented) {\n      const segments = {\n        ...outputSegments(operationalEmissions, embodiedEmissions),\n      };\n\n      if (ratingResults) {\n        return {\n          ...segments,\n          total,\n          rating,\n        };\n      }\n      return { ...segments, total };\n    }\n\n    if (ratingResults) {\n      return { total, rating };\n    }\n\n    return total;\n  }\n\n  perVisit(\n    bytes,\n    green = false,\n    segmented = false,\n    ratingResults = false,\n    options = {}\n  ) {\n    let firstViewRatio = 1;\n    let returnViewRatio = 0;\n    let dataReloadRatio = 0;\n    const greenHostingFactor = getGreenHostingFactor(green, options);\n    const operationalEmissions = this.operationalEmissions(bytes, options);\n    const embodiedEmissions = this.embodiedEmissions(bytes);\n\n    if (bytes < 1) {\n      return 0;\n    }\n\n    if (options.firstVisitPercentage || options.firstVisitPercentage === 0) {\n      firstViewRatio = options.firstVisitPercentage;\n    }\n\n    if (options.returnVisitPercentage || options.returnVisitPercentage === 0) {\n      returnViewRatio = options.returnVisitPercentage;\n    }\n\n    if (options.dataReloadRatio || options.dataReloadRatio === 0) {\n      dataReloadRatio = options.dataReloadRatio;\n    }\n\n    // NOTE: First visit emissions are calculated as the sum of all three segments without any caching.\n\n    const firstVisitEmissions =\n      operationalEmissions.dataCenter * (1 - greenHostingFactor) +\n      embodiedEmissions.dataCenter +\n      operationalEmissions.network +\n      embodiedEmissions.network +\n      operationalEmissions.device +\n      embodiedEmissions.device;\n\n    // NOTE: First visit emissions are calculated as the sum of all three segments with caching applied.\n\n    const returnVisitEmissions =\n      (operationalEmissions.dataCenter * (1 - greenHostingFactor) +\n        embodiedEmissions.dataCenter +\n        operationalEmissions.network +\n        embodiedEmissions.network +\n        operationalEmissions.device +\n        embodiedEmissions.device) *\n      (1 - dataReloadRatio);\n\n    // NOTE: The total emissions account for the percentage of first and return visits.\n    const total =\n      firstVisitEmissions * firstViewRatio +\n      returnVisitEmissions * returnViewRatio;\n\n    let rating = null;\n    if (ratingResults) {\n      rating = this.ratingScale(total);\n    }\n\n    if (segmented) {\n      const segments = {\n        ...outputSegments(operationalEmissions, embodiedEmissions),\n        firstVisitCO2e: firstVisitEmissions,\n        returnVisitCO2e: returnVisitEmissions,\n      };\n\n      if (ratingResults) {\n        return {\n          ...segments,\n          total,\n          rating,\n        };\n      }\n\n      return { ...segments, total };\n    }\n\n    if (ratingResults) {\n      return { total, rating };\n    }\n\n    return total;\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,uBAAgC;AAChC,qBAA6B;AAE7B,MAAM;AAAA,EACJ;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,IAAI;AAQJ,SAAS,eAAe,sBAAsB,mBAAmB;AAC/D,QAAM,uBACJ,qBAAqB,aACrB,qBAAqB,UACrB,qBAAqB;AACvB,QAAM,oBACJ,kBAAkB,aAClB,kBAAkB,UAClB,kBAAkB;AAEpB,QAAM,iBACJ,qBAAqB,aAAa,kBAAkB;AACtD,QAAM,cAAc,qBAAqB,UAAU,kBAAkB;AACrE,QAAM,qBACJ,qBAAqB,SAAS,kBAAkB;AAElD,SAAO;AAAA,IACL,2BAA2B,qBAAqB;AAAA,IAChD,wBAAwB,qBAAqB;AAAA,IAC7C,+BAA+B,qBAAqB;AAAA,IACpD,wBAAwB,kBAAkB;AAAA,IAC1C,qBAAqB,kBAAkB;AAAA,IACvC,4BAA4B,kBAAkB;AAAA,IAC9C;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAQA,SAAS,sBAAsB,OAAO,SAAS;AAC7C,MAAI,OAAO;AACT,WAAO;AAAA,EACT,YAAW,mCAAS,wBAAsB,mCAAS,wBAAuB,GAAG;AAC3E,WAAO,QAAQ;AAAA,EACjB;AACA,SAAO;AACT;AACA,MAAM,qBAAqB;AAAA,EACzB,YAAY,SAAS;AACnB,SAAK,eAAe;AACpB,SAAK,UAAU;AACf,SAAK,UAAU;AAAA,EACjB;AAAA,EAQA,4BAA4B,OAAO;AACjC,UAAM,sBAAsB,QAAQ,0BAAS;AAC7C,UAAM,aAAa,sBAAsB;AACzC,UAAM,UAAU,sBAAsB;AACtC,UAAM,SAAS,sBAAsB;AAErC,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EASA,qBAAqB,OAAO,UAAU,CAAC,GAAG;AACxC,UAAM,EAAE,YAAY,SAAS,OAAO,IAClC,KAAK,4BAA4B,KAAK;AAExC,QAAI,0BAA0B;AAC9B,QAAI,uBAAuB;AAC3B,QAAI,sBAAsB;AAE1B,QAAI,mCAAS,eAAe;AAC1B,YAAM,EAAE,QAAAA,SAAQ,SAAAC,UAAS,YAAAC,YAAW,IAAI,QAAQ;AAEhD,WAAIF,WAAA,gBAAAA,QAAQ,WAASA,WAAA,gBAAAA,QAAQ,WAAU,GAAG;AACxC,8BAAsBA,QAAO;AAAA,MAC/B;AAEA,WAAIC,YAAA,gBAAAA,SAAS,WAASA,YAAA,gBAAAA,SAAS,WAAU,GAAG;AAC1C,+BAAuBA,SAAQ;AAAA,MACjC;AAEA,WAAIC,eAAA,gBAAAA,YAAY,WAASA,eAAA,gBAAAA,YAAY,WAAU,GAAG;AAChD,kCAA0BA,YAAW;AAAA,MACvC;AAAA,IACF;AAEA,UAAM,sBAAsB,aAAa;AACzC,UAAM,mBAAmB,UAAU;AACnC,UAAM,kBAAkB,SAAS;AAEjC,WAAO;AAAA,MACL,YAAY;AAAA,MACZ,SAAS;AAAA,MACT,QAAQ;AAAA,IACV;AAAA,EACF;AAAA,EAQA,yBAAyB,OAAO;AAC9B,UAAM,sBAAsB,QAAQ,0BAAS;AAC7C,UAAM,aAAa,sBAAsB;AACzC,UAAM,UAAU,sBAAsB;AACtC,UAAM,SAAS,sBAAsB;AAErC,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAQA,kBAAkB,OAAO;AACvB,UAAM,EAAE,YAAY,SAAS,OAAO,IAClC,KAAK,yBAAyB,KAAK;AAErC,UAAM,0BAA0B;AAChC,UAAM,uBAAuB;AAC7B,UAAM,sBAAsB;AAI5B,UAAM,sBAAsB,aAAa;AACzC,UAAM,mBAAmB,UAAU;AACnC,UAAM,kBAAkB,SAAS;AAEjC,WAAO;AAAA,MACL,YAAY;AAAA,MACZ,SAAS;AAAA,MACT,QAAQ;AAAA,IACV;AAAA,EACF;AAAA,EAGA,QACE,OACA,QAAQ,OACR,YAAY,OACZ,gBAAgB,OAChB,UAAU,CAAC,GACX;AACA,QAAI,QAAQ,GAAG;AACb,aAAO;AAAA,IACT;AAEA,UAAM,uBAAuB,KAAK,qBAAqB,OAAO,OAAO;AACrE,UAAM,oBAAoB,KAAK,kBAAkB,KAAK;AACtD,UAAM,qBAAqB,sBAAsB,OAAO,OAAO;AAE/D,UAAM,iBAAiB;AAAA,MACrB,YACE,qBAAqB,cAAc,IAAI,sBACvC,kBAAkB;AAAA,MACpB,SAAS,qBAAqB,UAAU,kBAAkB;AAAA,MAC1D,QAAQ,qBAAqB,SAAS,kBAAkB;AAAA,IAC1D;AAEA,UAAM,QACJ,eAAe,aACf,eAAe,UACf,eAAe;AAEjB,QAAI,SAAS;AACb,QAAI,eAAe;AACjB,eAAS,KAAK,YAAY,KAAK;AAAA,IACjC;AAEA,QAAI,WAAW;AACb,YAAM,WAAW;AAAA,QACf,GAAG,eAAe,sBAAsB,iBAAiB;AAAA,MAC3D;AAEA,UAAI,eAAe;AACjB,eAAO;AAAA,UACL,GAAG;AAAA,UACH;AAAA,UACA;AAAA,QACF;AAAA,MACF;AACA,aAAO,EAAE,GAAG,UAAU,MAAM;AAAA,IAC9B;AAEA,QAAI,eAAe;AACjB,aAAO,EAAE,OAAO,OAAO;AAAA,IACzB;AAEA,WAAO;AAAA,EACT;AAAA,EAEA,SACE,OACA,QAAQ,OACR,YAAY,OACZ,gBAAgB,OAChB,UAAU,CAAC,GACX;AACA,QAAI,iBAAiB;AACrB,QAAI,kBAAkB;AACtB,QAAI,kBAAkB;AACtB,UAAM,qBAAqB,sBAAsB,OAAO,OAAO;AAC/D,UAAM,uBAAuB,KAAK,qBAAqB,OAAO,OAAO;AACrE,UAAM,oBAAoB,KAAK,kBAAkB,KAAK;AAEtD,QAAI,QAAQ,GAAG;AACb,aAAO;AAAA,IACT;AAEA,QAAI,QAAQ,wBAAwB,QAAQ,yBAAyB,GAAG;AACtE,uBAAiB,QAAQ;AAAA,IAC3B;AAEA,QAAI,QAAQ,yBAAyB,QAAQ,0BAA0B,GAAG;AACxE,wBAAkB,QAAQ;AAAA,IAC5B;AAEA,QAAI,QAAQ,mBAAmB,QAAQ,oBAAoB,GAAG;AAC5D,wBAAkB,QAAQ;AAAA,IAC5B;AAIA,UAAM,sBACJ,qBAAqB,cAAc,IAAI,sBACvC,kBAAkB,aAClB,qBAAqB,UACrB,kBAAkB,UAClB,qBAAqB,SACrB,kBAAkB;AAIpB,UAAM,wBACH,qBAAqB,cAAc,IAAI,sBACtC,kBAAkB,aAClB,qBAAqB,UACrB,kBAAkB,UAClB,qBAAqB,SACrB,kBAAkB,WACnB,IAAI;AAGP,UAAM,QACJ,sBAAsB,iBACtB,uBAAuB;AAEzB,QAAI,SAAS;AACb,QAAI,eAAe;AACjB,eAAS,KAAK,YAAY,KAAK;AAAA,IACjC;AAEA,QAAI,WAAW;AACb,YAAM,WAAW;AAAA,QACf,GAAG,eAAe,sBAAsB,iBAAiB;AAAA,QACzD,gBAAgB;AAAA,QAChB,iBAAiB;AAAA,MACnB;AAEA,UAAI,eAAe;AACjB,eAAO;AAAA,UACL,GAAG;AAAA,UACH;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAEA,aAAO,EAAE,GAAG,UAAU,MAAM;AAAA,IAC9B;AAEA,QAAI,eAAe;AACjB,aAAO,EAAE,OAAO,OAAO;AAAA,IACzB;AAEA,WAAO;AAAA,EACT;AAAA,EAQA,YAAY,MAAM;AAChB,eAAO,6BAAa,MAAM,KAAK,OAAO;AAAA,EACxC;AACF;AAGA,IAAO,oCAAQ;",
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,uBAAgC;AAChC,qBAA6B;AAE7B,MAAM;AAAA,EACJ;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,IAAI;AAQJ,SAAS,eAAe,sBAAsB,mBAAmB;AAC/D,QAAM,uBACJ,qBAAqB,aACrB,qBAAqB,UACrB,qBAAqB;AACvB,QAAM,oBACJ,kBAAkB,aAClB,kBAAkB,UAClB,kBAAkB;AAEpB,QAAM,iBACJ,qBAAqB,aAAa,kBAAkB;AACtD,QAAM,cAAc,qBAAqB,UAAU,kBAAkB;AACrE,QAAM,qBACJ,qBAAqB,SAAS,kBAAkB;AAElD,SAAO;AAAA,IACL,2BAA2B,qBAAqB;AAAA,IAChD,wBAAwB,qBAAqB;AAAA,IAC7C,+BAA+B,qBAAqB;AAAA,IACpD,wBAAwB,kBAAkB;AAAA,IAC1C,qBAAqB,kBAAkB;AAAA,IACvC,4BAA4B,kBAAkB;AAAA,IAC9C;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAQA,SAAS,sBAAsB,OAAO,SAAS;AAC7C,MAAI,OAAO;AACT,WAAO;AAAA,EACT,YAAW,mCAAS,wBAAsB,mCAAS,wBAAuB,GAAG;AAC3E,WAAO,QAAQ;AAAA,EACjB;AACA,SAAO;AACT;AACA,MAAM,qBAAqB;AAAA,EACzB,YAAY,SAAS;AACnB,SAAK,eAAe;AACpB,SAAK,UAAU;AACf,SAAK,UAAU;AAAA,EACjB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,4BAA4B,OAAO;AACjC,UAAM,sBAAsB,QAAQ,0BAAS;AAC7C,UAAM,aAAa,sBAAsB;AACzC,UAAM,UAAU,sBAAsB;AACtC,UAAM,SAAS,sBAAsB;AAErC,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,qBAAqB,OAAO,UAAU,CAAC,GAAG;AACxC,UAAM,EAAE,YAAY,SAAS,OAAO,IAClC,KAAK,4BAA4B,KAAK;AAExC,QAAI,0BAA0B;AAC9B,QAAI,uBAAuB;AAC3B,QAAI,sBAAsB;AAE1B,QAAI,mCAAS,eAAe;AAC1B,YAAM,EAAE,QAAAA,SAAQ,SAAAC,UAAS,YAAAC,YAAW,IAAI,QAAQ;AAEhD,WAAIF,WAAA,gBAAAA,QAAQ,WAASA,WAAA,gBAAAA,QAAQ,WAAU,GAAG;AACxC,8BAAsBA,QAAO;AAAA,MAC/B;AAEA,WAAIC,YAAA,gBAAAA,SAAS,WAASA,YAAA,gBAAAA,SAAS,WAAU,GAAG;AAC1C,+BAAuBA,SAAQ;AAAA,MACjC;AAEA,WAAIC,eAAA,gBAAAA,YAAY,WAASA,eAAA,gBAAAA,YAAY,WAAU,GAAG;AAChD,kCAA0BA,YAAW;AAAA,MACvC;AAAA,IACF;AAEA,UAAM,sBAAsB,aAAa;AACzC,UAAM,mBAAmB,UAAU;AACnC,UAAM,kBAAkB,SAAS;AAEjC,WAAO;AAAA,MACL,YAAY;AAAA,MACZ,SAAS;AAAA,MACT,QAAQ;AAAA,IACV;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,yBAAyB,OAAO;AAC9B,UAAM,sBAAsB,QAAQ,0BAAS;AAC7C,UAAM,aAAa,sBAAsB;AACzC,UAAM,UAAU,sBAAsB;AACtC,UAAM,SAAS,sBAAsB;AAErC,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,kBAAkB,OAAO;AACvB,UAAM,EAAE,YAAY,SAAS,OAAO,IAClC,KAAK,yBAAyB,KAAK;AAErC,UAAM,0BAA0B;AAChC,UAAM,uBAAuB;AAC7B,UAAM,sBAAsB;AAI5B,UAAM,sBAAsB,aAAa;AACzC,UAAM,mBAAmB,UAAU;AACnC,UAAM,kBAAkB,SAAS;AAEjC,WAAO;AAAA,MACL,YAAY;AAAA,MACZ,SAAS;AAAA,MACT,QAAQ;AAAA,IACV;AAAA,EACF;AAAA;AAAA,EAGA,QACE,OACA,QAAQ,OACR,YAAY,OACZ,gBAAgB,OAChB,UAAU,CAAC,GACX;AACA,QAAI,QAAQ,GAAG;AACb,aAAO;AAAA,IACT;AAEA,UAAM,uBAAuB,KAAK,qBAAqB,OAAO,OAAO;AACrE,UAAM,oBAAoB,KAAK,kBAAkB,KAAK;AACtD,UAAM,qBAAqB,sBAAsB,OAAO,OAAO;AAE/D,UAAM,iBAAiB;AAAA,MACrB,YACE,qBAAqB,cAAc,IAAI,sBACvC,kBAAkB;AAAA,MACpB,SAAS,qBAAqB,UAAU,kBAAkB;AAAA,MAC1D,QAAQ,qBAAqB,SAAS,kBAAkB;AAAA,IAC1D;AAEA,UAAM,QACJ,eAAe,aACf,eAAe,UACf,eAAe;AAEjB,QAAI,SAAS;AACb,QAAI,eAAe;AACjB,eAAS,KAAK,YAAY,KAAK;AAAA,IACjC;AAEA,QAAI,WAAW;AACb,YAAM,WAAW;AAAA,QACf,GAAG,eAAe,sBAAsB,iBAAiB;AAAA,MAC3D;AAEA,UAAI,eAAe;AACjB,eAAO;AAAA,UACL,GAAG;AAAA,UACH;AAAA,UACA;AAAA,QACF;AAAA,MACF;AACA,aAAO,EAAE,GAAG,UAAU,MAAM;AAAA,IAC9B;AAEA,QAAI,eAAe;AACjB,aAAO,EAAE,OAAO,OAAO;AAAA,IACzB;AAEA,WAAO;AAAA,EACT;AAAA,EAEA,SACE,OACA,QAAQ,OACR,YAAY,OACZ,gBAAgB,OAChB,UAAU,CAAC,GACX;AACA,QAAI,iBAAiB;AACrB,QAAI,kBAAkB;AACtB,QAAI,kBAAkB;AACtB,UAAM,qBAAqB,sBAAsB,OAAO,OAAO;AAC/D,UAAM,uBAAuB,KAAK,qBAAqB,OAAO,OAAO;AACrE,UAAM,oBAAoB,KAAK,kBAAkB,KAAK;AAEtD,QAAI,QAAQ,GAAG;AACb,aAAO;AAAA,IACT;AAEA,QAAI,QAAQ,wBAAwB,QAAQ,yBAAyB,GAAG;AACtE,uBAAiB,QAAQ;AAAA,IAC3B;AAEA,QAAI,QAAQ,yBAAyB,QAAQ,0BAA0B,GAAG;AACxE,wBAAkB,QAAQ;AAAA,IAC5B;AAEA,QAAI,QAAQ,mBAAmB,QAAQ,oBAAoB,GAAG;AAC5D,wBAAkB,QAAQ;AAAA,IAC5B;AAIA,UAAM,sBACJ,qBAAqB,cAAc,IAAI,sBACvC,kBAAkB,aAClB,qBAAqB,UACrB,kBAAkB,UAClB,qBAAqB,SACrB,kBAAkB;AAIpB,UAAM,wBACH,qBAAqB,cAAc,IAAI,sBACtC,kBAAkB,aAClB,qBAAqB,UACrB,kBAAkB,UAClB,qBAAqB,SACrB,kBAAkB,WACnB,IAAI;AAGP,UAAM,QACJ,sBAAsB,iBACtB,uBAAuB;AAEzB,QAAI,SAAS;AACb,QAAI,eAAe;AACjB,eAAS,KAAK,YAAY,KAAK;AAAA,IACjC;AAEA,QAAI,WAAW;AACb,YAAM,WAAW;AAAA,QACf,GAAG,eAAe,sBAAsB,iBAAiB;AAAA,QACzD,gBAAgB;AAAA,QAChB,iBAAiB;AAAA,MACnB;AAEA,UAAI,eAAe;AACjB,eAAO;AAAA,UACL,GAAG;AAAA,UACH;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAEA,aAAO,EAAE,GAAG,UAAU,MAAM;AAAA,IAC9B;AAEA,QAAI,eAAe;AACjB,aAAO,EAAE,OAAO,OAAO;AAAA,IACzB;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,YAAY,MAAM;AAChB,eAAO,6BAAa,MAAM,KAAK,OAAO;AAAA,EACxC;AACF;AAGA,IAAO,oCAAQ;",
   "names": ["device", "network", "dataCenter"]
 }

package/dist/esm/1byte.js

@@ -13,6 +13,12 @@ class OneByte {
     this.options = options;
     this.KWH_PER_BYTE_FOR_NETWORK = KWH_PER_BYTE_FOR_NETWORK;
   }
+  /**
+   * Calculates the carbon footprint of a website using the OneByte model
+   * @param {number} bytes - The number of bytes to calculate the carbon footprint for
+   * @param {boolean} green - Whether the energy is green or not
+   * @returns {number} The carbon footprint in grams of CO2
+   */
   perByte(bytes, green) {
     if (bytes < 1) {
       return 0;

package/dist/esm/co2.js

@@ -45,14 +45,12 @@ class CO2 {
       }
     } else if (options == null ? void 0 : options.model) {
       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.`
+        '"'.concat(options.model, '" is not a valid model. Please use "1byte" for the OneByte model, and "swd" for the Sustainable Web Design model.\nSee https://developers.thegreenwebfoundation.org/co2js/models/ to learn more about the models available in CO2.js.')
       );
     }
     if ((options == null ? void 0 : options.rating) && typeof options.rating !== "boolean") {
       throw new Error(
-        `The rating option must be a boolean. Please use true or false.
-See https://developers.thegreenwebfoundation.org/co2js/options/ to learn more about the options available in CO2.js.`
+        "The rating option must be a boolean. Please use true or false.\nSee https://developers.thegreenwebfoundation.org/co2js/options/ to learn more about the options available in CO2.js."
       );
     }
     const allowRatings = !!this.model.allowRatings;
@@ -60,25 +58,51 @@ See https://developers.thegreenwebfoundation.org/co2js/options/ to learn more ab
     this._rating = (options == null ? void 0 : options.rating) === true;
     if (!allowRatings && this._rating) {
       throw new Error(
-        `The rating system is not supported in the model you are using. Try using the Sustainable Web Design model instead.
-See https://developers.thegreenwebfoundation.org/co2js/models/ to learn more about the models available in CO2.js.`
+        "The rating system is not supported in the model you are using. Try using the Sustainable Web Design model instead.\nSee https://developers.thegreenwebfoundation.org/co2js/models/ to learn more about the models available in CO2.js."
       );
     }
   }
+  /**
+   * Accept a figure in bytes for data transfer, and a boolean for whether
+   * the domain shows as 'green', and return a CO2 figure for energy used to shift the corresponding
+   * the data transfer.
+   *
+   * @param {number} bytes
+   * @param {boolean} green
+   * @return {number|CO2EstimateComponentsPerByte} the amount of CO2 in grammes or its separate components
+   */
   perByte(bytes, green = false) {
     return this.model.perByte(bytes, green, this._segment, this._rating);
   }
+  /**
+   * Accept a figure in bytes for data transfer, and a boolean for whether
+   * the domain shows as 'green', and return a CO2 figure for energy used to shift the corresponding
+   * the data transfer.
+   *
+   * @param {number} bytes
+   * @param {boolean} green
+   * @return {number|CO2EstimateComponentsPerVisit} the amount of CO2 in grammes or its separate components
+   */
   perVisit(bytes, green = false) {
     var _a;
     if ((_a = this.model) == null ? void 0 : _a.perVisit) {
       return this.model.perVisit(bytes, green, this._segment, this._rating);
     } 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.`
+        "The perVisit() method is not supported in the model you are using. Try using perByte() instead.\nSee https://developers.thegreenwebfoundation.org/co2js/methods/ to learn more about the methods available in CO2.js."
       );
     }
   }
+  /**
+   * Accept a figure in bytes for data transfer, a boolean for whether
+   * the domain shows as 'green', and an options object.
+   * Returns an object containing CO2 figure, green boolean, and object of the variables used in calculating the CO2 figure.
+   *
+   * @param {number} bytes
+   * @param {boolean} green
+   * @param {Object} options
+   * @return {CO2EstimateTraceResultPerByte} the amount of CO2 in grammes
+   */
   perByteTrace(bytes, green = false, options = {}) {
     const adjustments = parseByteTraceOptions(
       options,
@@ -113,6 +137,16 @@ See https://developers.thegreenwebfoundation.org/co2js/methods/ to learn more ab
       }, otherVariables)
     };
   }
+  /**
+   * Accept a figure in bytes for data transfer, a boolean for whether
+   * the domain shows as 'green', and an options object.
+   * Returns an object containing CO2 figure, green boolean, and object of the variables used in calculating the CO2 figure.
+   *
+   * @param {number} bytes
+   * @param {boolean} green
+   * @param {Object} options
+   * @return {CO2EstimateTraceResultPerVisit} the amount of CO2 in grammes
+   */
   perVisitTrace(bytes, green = false, options = {}) {
     var _a;
     if ((_a = this.model) == null ? void 0 : _a.perVisit) {
@@ -141,8 +175,7 @@ See https://developers.thegreenwebfoundation.org/co2js/methods/ to learn more ab
       };
     } else {
       throw new Error(
-        `The perVisitTrace() 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.`
+        "The perVisitTrace() method is not supported in the model you are using. Try using perByte() instead.\nSee https://developers.thegreenwebfoundation.org/co2js/methods/ to learn more about the methods available in CO2.js."
       );
     }
   }