@tgwf/co2 0.9.0 → 0.10.2

package/.esbuild.browser.js

@@ -0,0 +1,11 @@
+require('esbuild').buildSync({
+  entryPoints: ['src/index.js'],
+  outdir: 'dist/iife',
+  globalName: 'co2',
+  format: 'iife',
+  platform: 'browser',
+  bundle: true,
+  sourcemap: true,
+  minify: true,
+  // target: ['es5'],
+})

package/.esbuild.esm.js

@@ -0,0 +1,25 @@
+const esbuild = require('esbuild')
+// tiny glob is a dependency of `esbuild-plugin-glob`.
+// For this build however we need to filter out some extra files
+// that are used for nodejs, but not in browsers, so we use the
+// library directly instead of using `esbuild-plugin-glob` as a plugin
+const glob = require('tiny-glob');
+
+async function main() {
+  const results = await glob('src/**/**.js')
+  // we remove node specific files here, with the assumption that
+  // the common use case is bundling into browser based web apps
+  const justBrowserCompatibleFiles = results.filter(filepath => !filepath.endsWith('node.js'))
+
+  esbuild.build({
+    entryPoints: justBrowserCompatibleFiles,
+    bundle: false,
+    minify: false,
+    sourcemap: false,
+    target: ['chrome58', 'firefox57', 'safari11', 'edge18', 'esnext'],
+    outdir: 'dist/esm',
+    outExtension: { '.js': '.js' },
+    format: 'esm'
+  })
+}
+main()

package/.esbuild.node.js

@@ -0,0 +1,16 @@
+const { globPlugin } = require('esbuild-plugin-glob');
+
+function main() {
+  require('esbuild').build({
+    entryPoints: ['src/**/**.js',],
+    bundle: false,
+    minify: false,
+    sourcemap: true,
+    target: ['node14'],
+    outdir: 'dist/cjs/',
+    outExtension: { '.js': '.js' },
+    format: 'cjs',
+    plugins: [globPlugin()]
+  })
+}
+main()

package/.gitpod.yml

@@ -0,0 +1,8 @@
+# Commands to start on workspace startup
+tasks:
+  - init: npm install
+    command: npm run gitpod
+# Ports to expose on workspace startup
+ports:
+  - port: 8000
+    onOpen: open-preview

package/CHANGELOG.md

@@ -4,10 +4,31 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
--
+
+> **Added** for new features.
+> **Changed** for changes in existing functionality.
+> **Deprecated** for soon-to-be removed features.
+> **Removed** for now removed features.
+> **Fixed** for any bug fixes.
+> **Security** in case of vulnerabilities.
 
 ## Unreleased
 
+### Added
+
+- Added the ability to set the model used by CO2.js to the Sustainable Web Design model, using a simple 'swd' string, instead of needing to pass in a class.
+
+## 0.10.1 2022-08-01
+
+This release used a version bump as previously we had released v0.10.0 under a pre-release tag.
+
+## 0.10.0 2022-06-27
+
+- Added ES import syntax as the main way for handling imports and exports of code within the module.
+- Changed eslint settings to use later version of ecmascript (2020)
+- Change the bulid tools to use esbulid with jest instead of babel
+- Added more consistent use of the debug logging library in files using the updated import syntax
+- Fixed the incorrect order of FIRST_TIME_VIEWING_PERCENTAGE and RETURNING_VISITOR_PERCENTAGE constants in the SWD model. This will result in **larger** values for calculations using the sustainable web design, and the default caching assumptions.
 
 
 # [0.9.0] - 2022-03-28

package/README.md

@@ -1,94 +1,57 @@
-# CO2
+# CO2.js
 
 <img src="https://github.com/thegreenwebfoundation/co2.js/actions/workflows/unittests.yml/badge.svg" />
 
+One day, there internet will be powered by renewable energy. Until that day comes, there’ll be a CO2 cost that comes with every byte of data that’s uploaded or downloaded. By being able to calculate these emissions, developers can be empowered to create more efficient, lower carbon apps, websites, and software.
 
-We know computers use electricity, and because most of the electricity we use comes from burning fossil fuels, there is an environmental cost to every upload and download we make over the internet.
+## [Documentation](https://developers.thegreenwebfoundation.org/co2js/overview/)
 
-We can do something about this though. The same way we use performance budgets to make apps and websites faster and cheaper to run, we can use carbon budgets to make them faster, cheaper and _greener_.
+## What is CO2.js?
 
-The CO2 package from [The Green Web Foundation][tgwf] lets you quickly estimate these emissions, to make measurable improvements as part of your workflow.
+CO2.js is a JavaScript library that enables developers a way to estimate the emissions related to use of their apps, websites, and software.
 
-### How it works
+## Why use it?
 
-It does this by implementing various models for converting the measurable usage of digital services into a figure for the estimated CO2 emissions.
+Being able to estimate the CO2 emissions associated with digital activities can be of benefit to both developers and users.
 
-This defaults to the 1byte model as used by the Shift Project, as introduced in their report on CO2 emissions from digital infrastructure, [Lean ICT: for a sober digital][soberDigital], with the [Sustainable Web Design model][swd] as a popular alternative..
+Internally, you may want to use this library to create a *carbon budget* for your site or app. It is also useful for inclusion in dashboards and monitoring tools.
 
-For more information, see the documentation [for when to use the different models, with code samples to start you off](./src/readme.md).
+For user facing applications, CO2.js could be used to check & block the uploading of carbon intensive files. Or, to present users with information about the carbon impact of their online activities (such as browsing a website).
 
-### Who uses it
+The above a just a few examples of the many and varied ways CO2.js can be applied to provide carbon estimates for data transfer. If you’re using CO2.js in production we’d love to hear how! [Contact us](https://www.thegreenwebfoundation.org/support-form/) via our website.
 
-It is currently used in the web performance tool [sitespeed.io][], [ecoping][], [Websitecarbon.com](websitecarbon), and [ecograder][] to help developers build greener, more planet friendly digital services.
+## Installation
 
-If you want to build this kind of environmental information into your own software, and want some advice, we'd be happy to hear from you - please open an issue, remembering to link to your project.
+### Using NPM
 
-This is open source software, with all the guarantees associated. So if you want professional advice, to a deadline, and you have a budget please see the services offered by the [Green Web Foundation][tgwf-services].
-
-
-[sitespeed.io]: https://sitespeed.io
-[ecoping]: https://ecoping.earth
-[ecograder]: https://ecograder.com
-[websitecarbon]: https://www.websitecarbon.com
-[tgwf]: https://www.thegreenwebfoundation.org
-[tgwf-services]: https://www.thegreenwebfoundation.org/services
-[swd]: https://sustainablewebdesign.org/calculating-digital-emissions
-[soberDigital]: https://theshiftproject.org/en/lean-ict-2/
-
-
-## Usage
-
-### Calculating emissions per byte
-
-#### Server-side
-
-This approach relies on the `fs` module and so can only be used on platforms like Node.js, that support this.
-
-```js
-
-const CO2 = require('@tgwf/co2')
-const bytesSent = (1024 * 1024 * 1024)
-const co2Emission = new CO2();
-estimatedCO2 = co2Emission.perByte(bytesSent)
-
-console.log(`Sending a gigabyte, had a carbon footprint of ${estimatedCO2.toFixed(3)} grams of CO2`)
+You can install CO2.js as a dependency for your projects using NPM.
 
+```bash
+npm install @tgwf/co2
 ```
 
-#### Browser-side
+### Using Skypack
 
-For browser-based solutions, you must import the `co2.js` submodule directly from `node_modules`. For example, like this:
+You can import the CO2.js library into projects using Skypack.
 
 ```js
-
-const CO2 = require('node_modules/@tgwf/co2/src/co2.js')
-const bytesSent = (1024 * 1024 * 1024)
-const co2Emission = new CO2();
-estimatedCO2 = co2Emission.perByte(bytesSent)
-
-console.log(`Sending a gigabyte, had a carbon footprint of ${estimatedCO2.toFixed(3)} grams of CO2`)
-****
+import tgwf from 'https://cdn.skypack.dev/@tgwf/co2';
 ```
 
-### Checking for green power
 
-Because different digital services and websites use different forms of power, there is also a module for checking if a domain uses green power or not, and whether the domains linked to on a page use green power as well.
-
-```js
+### Build it yourself
 
-const greencheck = require('@tgwf/hosting')
+You can also build the CO2.js library from the source code. To do this:
 
-// returns true if green, otherwise false
-greencheck.check("google.com")
-
-// returns an array of the green domains, in this case ["google.com"].
-greencheck.check(["google.com", "kochindustries.com"])]
-
-// returns an array of green domains, again in this case, ["google.com"]
-greencheck.checkPage(["google.com"])
-
-```
+1. Go to the [CO2.js repository](https://github.com/thegreenwebfoundation/co2.js) on GitHub.
+1. Clone or fork the repository.
+1. Navigate to the folder on your machine and run `npm run build` in your terminal.
+1. Once the build has finished running, you will find a `/dist` folder has been created. Inside you can find:
+  
+    - `dist/cjs` - A CommonJS compatible build.
+    - `dist/esm` - An ES Modules compatible build.
+    - `dist/iife` - An Immediately Invoked Function Expression (IIFE) version of the library.
 
-# Licenses
+## Licenses
 
 Apache 2.0

package/dist/cjs/1byte.js

@@ -0,0 +1,52 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var byte_exports = {};
+__export(byte_exports, {
+  OneByte: () => OneByte,
+  default: () => byte_default
+});
+module.exports = __toCommonJS(byte_exports);
+const CO2_PER_KWH_IN_DC_GREY = 519;
+const CO2_PER_KWH_NETWORK_GREY = 475;
+const CO2_PER_KWH_IN_DC_GREEN = 0;
+const KWH_PER_BYTE_IN_DC = 72e-12;
+const FIXED_NETWORK_WIRED = 429e-12;
+const FIXED_NETWORK_WIFI = 152e-12;
+const FOUR_G_MOBILE = 884e-12;
+const KWH_PER_BYTE_FOR_NETWORK = (FIXED_NETWORK_WIRED + FIXED_NETWORK_WIFI + FOUR_G_MOBILE) / 3;
+const KWH_PER_BYTE_FOR_DEVICES = 13e-11;
+class OneByte {
+  constructor(options) {
+    this.options = options;
+    this.KWH_PER_BYTE_FOR_NETWORK = KWH_PER_BYTE_FOR_NETWORK;
+  }
+  perByte(bytes, green) {
+    if (bytes < 1) {
+      return 0;
+    }
+    if (green) {
+      const Co2ForDC = bytes * KWH_PER_BYTE_IN_DC * CO2_PER_KWH_IN_DC_GREEN;
+      const Co2forNetwork = bytes * KWH_PER_BYTE_FOR_NETWORK * CO2_PER_KWH_NETWORK_GREY;
+      return Co2ForDC + Co2forNetwork;
+    }
+    const KwHPerByte = KWH_PER_BYTE_IN_DC + KWH_PER_BYTE_FOR_NETWORK;
+    return bytes * KwHPerByte * CO2_PER_KWH_IN_DC_GREY;
+  }
+}
+var byte_default = OneByte;
+//# sourceMappingURL=1byte.js.map

package/dist/cjs/1byte.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/1byte.js"],
+  "sourcesContent": ["// Use the 1byte model for now from the Shift Project, and assume a US grid mix figure they use of around 519 g co2 for the time being. It's lower for Europe, and in particular, France, but for v1, we don't include this\nconst CO2_PER_KWH_IN_DC_GREY = 519;\n\n// this figure is from the IEA's 2018 report for a global average:\nconst CO2_PER_KWH_NETWORK_GREY = 475;\n\n// TODO - these figures need to be updated, as the figures for green\n// shouldn't really be zero now we know that carbon intensity figures\n// for renewables still usually include the life cycle emissions\nconst CO2_PER_KWH_IN_DC_GREEN = 0;\n\n// the 1 byte model gives figures for energy usage for:\n\n// datacentres\n// networks\n// the device used to access a site/app\n\n// The device usage figure combines figures for:\n//  1. the usage for devices (which is small proportion of the energy use)\n//  2. the *making* the device, which is comparatively high.\n\nconst KWH_PER_BYTE_IN_DC = 7.2e-11;\n\n// this is probably best left as something users can define, or\n// a weighted average based on total usage.\n// Using a simple mean for now, as while web traffic to end users might trend\n// towards wifi and mobile,\n// Web traffic between servers is likely wired networks\n\nconst FIXED_NETWORK_WIRED = 4.29e-10;\nconst FIXED_NETWORK_WIFI = 1.52e-10;\nconst FOUR_G_MOBILE = 8.84e-10;\n\n// Pull requests gratefully accepted\nconst KWH_PER_BYTE_FOR_NETWORK =\n  (FIXED_NETWORK_WIRED + FIXED_NETWORK_WIFI + FOUR_G_MOBILE) / 3;\n\nconst KWH_PER_BYTE_FOR_DEVICES = 1.3e-10;\n\nclass OneByte {\n  constructor(options) {\n    this.options = options;\n\n    this.KWH_PER_BYTE_FOR_NETWORK = KWH_PER_BYTE_FOR_NETWORK;\n  }\n\n  perByte(bytes, green) {\n    if (bytes < 1) {\n      return 0;\n    }\n\n    if (green) {\n      // if we have a green datacentre, use the lower figure for renewable energy\n      const Co2ForDC = bytes * KWH_PER_BYTE_IN_DC * CO2_PER_KWH_IN_DC_GREEN;\n\n      // but for the worest of the internet, we can't easily check, so assume\n      // grey for now\n      const Co2forNetwork =\n        bytes * KWH_PER_BYTE_FOR_NETWORK * CO2_PER_KWH_NETWORK_GREY;\n\n      return Co2ForDC + Co2forNetwork;\n    }\n\n    const KwHPerByte = KWH_PER_BYTE_IN_DC + KWH_PER_BYTE_FOR_NETWORK;\n    return bytes * KwHPerByte * CO2_PER_KWH_IN_DC_GREY;\n  }\n}\n\nexport { OneByte };\nexport default OneByte;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,MAAM,yBAAyB;AAG/B,MAAM,2BAA2B;AAKjC,MAAM,0BAA0B;AAYhC,MAAM,qBAAqB;AAQ3B,MAAM,sBAAsB;AAC5B,MAAM,qBAAqB;AAC3B,MAAM,gBAAgB;AAGtB,MAAM,2BACH,uBAAsB,qBAAqB,iBAAiB;AAE/D,MAAM,2BAA2B;AAEjC,MAAM,QAAQ;AAAA,EACZ,YAAY,SAAS;AACnB,SAAK,UAAU;AAEf,SAAK,2BAA2B;AAAA,EAClC;AAAA,EAEA,QAAQ,OAAO,OAAO;AACpB,QAAI,QAAQ,GAAG;AACb,aAAO;AAAA,IACT;AAEA,QAAI,OAAO;AAET,YAAM,WAAW,QAAQ,qBAAqB;AAI9C,YAAM,gBACJ,QAAQ,2BAA2B;AAErC,aAAO,WAAW;AAAA,IACpB;AAEA,UAAM,aAAa,qBAAqB;AACxC,WAAO,QAAQ,aAAa;AAAA,EAC9B;AACF;AAGA,IAAO,eAAQ;",
+  "names": []
+}

package/dist/cjs/1byte.test.js

@@ -0,0 +1,27 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var import_byte = __toESM(require("./1byte.js"));
+describe("onebyte", () => {
+  describe("perByte", () => {
+    it("returns a simple average of the different networks", () => {
+      const expected_val = 488e-12 .toFixed(12);
+      const instance = new import_byte.default();
+      expect(instance.KWH_PER_BYTE_FOR_NETWORK.toFixed(12)).toBe(expected_val);
+    });
+  });
+});
+//# sourceMappingURL=1byte.test.js.map

package/dist/cjs/1byte.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/1byte.test.js"],
+  "sourcesContent": ["\"use strict\";\n\nimport OneByte from \"./1byte.js\";\n\ndescribe(\"onebyte\", () => {\n  describe(\"perByte\", () => {\n    it(\"returns a simple average of the different networks\", () => {\n      // we limit this to 12 figures with toFixed(12), because\n      // we have a recurring 333333 afterwards\n      // 4.88e-10 is the same as 0.000000000488\n      const expected_val = (0.000000000488).toFixed(12);\n      const instance = new OneByte();\n\n      expect(instance.KWH_PER_BYTE_FOR_NETWORK.toFixed(12)).toBe(expected_val);\n    });\n  });\n});\n"],
+  "mappings": ";;;;;;;;;;;;;;;;AAEA,kBAAoB;AAEpB,SAAS,WAAW,MAAM;AACxB,WAAS,WAAW,MAAM;AACxB,OAAG,sDAAsD,MAAM;AAI7D,YAAM,eAAgB,SAAgB,QAAQ,EAAE;AAChD,YAAM,WAAW,IAAI,oBAAQ;AAE7B,aAAO,SAAS,yBAAyB,QAAQ,EAAE,CAAC,EAAE,KAAK,YAAY;AAAA,IACzE,CAAC;AAAA,EACH,CAAC;AACH,CAAC;",
+  "names": []
+}

package/dist/cjs/co2.js

@@ -0,0 +1,121 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var co2_exports = {};
+__export(co2_exports, {
+  CO2: () => CO2,
+  default: () => co2_default
+});
+module.exports = __toCommonJS(co2_exports);
+var import_byte = __toESM(require("./1byte.js"));
+var import_sustainable_web_design = __toESM(require("./sustainable-web-design.js"));
+class CO2 {
+  constructor(options) {
+    this.options = options;
+    this.model = new import_byte.default();
+    if (options) {
+      if (options.model === "swd") {
+        this.model = new import_sustainable_web_design.default();
+      } else {
+        this.model = new options.model();
+      }
+    }
+  }
+  perByte(bytes, green) {
+    return this.model.perByte(bytes, green);
+  }
+  perDomain(pageXray, greenDomains) {
+    const co2PerDomain = [];
+    for (let domain of Object.keys(pageXray.domains)) {
+      let co2;
+      if (greenDomains && greenDomains.indexOf(domain) > -1) {
+        co2 = this.perByte(pageXray.domains[domain].transferSize, true);
+      } else {
+        co2 = this.perByte(pageXray.domains[domain].transferSize);
+      }
+      co2PerDomain.push({
+        domain,
+        co2,
+        transferSize: pageXray.domains[domain].transferSize
+      });
+    }
+    co2PerDomain.sort((a, b) => b.co2 - a.co2);
+    return co2PerDomain;
+  }
+  perPage(pageXray, green) {
+    const domainCO2 = this.perDomain(pageXray, green);
+    let totalCO2 = 0;
+    for (let domain of domainCO2) {
+      totalCO2 += domain.co2;
+    }
+    return totalCO2;
+  }
+  perContentType(pageXray, greenDomains) {
+    const co2PerContentType = {};
+    for (let asset of pageXray.assets) {
+      const domain = new URL(asset.url).domain;
+      const transferSize = asset.transferSize;
+      const co2ForTransfer = this.perByte(transferSize, greenDomains && greenDomains.indexOf(domain) > -1);
+      const contentType = asset.type;
+      if (!co2PerContentType[contentType]) {
+        co2PerContentType[contentType] = { co2: 0, transferSize: 0 };
+      }
+      co2PerContentType[contentType].co2 += co2ForTransfer;
+      co2PerContentType[contentType].transferSize += transferSize;
+    }
+    const all = [];
+    for (let type of Object.keys(co2PerContentType)) {
+      all.push({
+        type,
+        co2: co2PerContentType[type].co2,
+        transferSize: co2PerContentType[type].transferSize
+      });
+    }
+    all.sort((a, b) => b.co2 - a.co2);
+    return all;
+  }
+  dirtiestResources(pageXray, greenDomains) {
+    const allAssets = [];
+    for (let asset of pageXray.assets) {
+      const domain = new URL(asset.url).domain;
+      const transferSize = asset.transferSize;
+      const co2ForTransfer = this.perByte(transferSize, greenDomains && greenDomains.indexOf(domain) > -1);
+      allAssets.push({ url: asset.url, co2: co2ForTransfer, transferSize });
+    }
+    allAssets.sort((a, b) => b.co2 - a.co2);
+    return allAssets.slice(0, allAssets.length > 10 ? 10 : allAssets.length);
+  }
+  perParty(pageXray, greenDomains) {
+    let firstParty = 0;
+    let thirdParty = 0;
+    const firstPartyRegEx = pageXray.firstPartyRegEx;
+    for (let d of Object.keys(pageXray.domains)) {
+      if (!d.match(firstPartyRegEx)) {
+        thirdParty += this.perByte(pageXray.domains[d].transferSize, greenDomains && greenDomains.indexOf(d) > -1);
+      } else {
+        firstParty += this.perByte(pageXray.domains[d].transferSize, greenDomains && greenDomains.indexOf(d) > -1);
+      }
+    }
+    return { firstParty, thirdParty };
+  }
+}
+var co2_default = CO2;
+//# sourceMappingURL=co2.js.map

package/dist/cjs/co2.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/co2.js"],
+  "sourcesContent": ["\"use strict\";\n\nimport OneByte from \"./1byte.js\";\nimport SustainableWebDesign from \"./sustainable-web-design.js\";\n\nclass CO2 {\n  constructor(options) {\n    this.options = options;\n\n    // default model\n    this.model = new OneByte();\n\n    if (options) {\n      if (options.model === \"swd\") {\n        this.model = new SustainableWebDesign();\n      } else {\n        // retain the fallback for people developing\n        // new models that follow the same API\n        this.model = new options.model();\n      }\n    }\n  }\n\n  /**\n   * Accept a figure in bytes for data transfer, and a boolean for whether\n   * the domain shows as 'green', and return a CO2 figure for energy used to shift the corresponding\n   * the data transfer.\n   *\n   * @param {number} bytes\n   * @param {boolean} green\n   * @return {number} the amount of CO2 in grammes\n   */\n  perByte(bytes, green) {\n    return this.model.perByte(bytes, green);\n  }\n\n  perDomain(pageXray, greenDomains) {\n    const co2PerDomain = [];\n    for (let domain of Object.keys(pageXray.domains)) {\n      let co2;\n      if (greenDomains && greenDomains.indexOf(domain) > -1) {\n        co2 = this.perByte(pageXray.domains[domain].transferSize, true);\n      } else {\n        co2 = this.perByte(pageXray.domains[domain].transferSize);\n      }\n      co2PerDomain.push({\n        domain,\n        co2,\n        transferSize: pageXray.domains[domain].transferSize,\n      });\n    }\n    co2PerDomain.sort((a, b) => b.co2 - a.co2);\n\n    return co2PerDomain;\n  }\n\n  perPage(pageXray, green) {\n    // Accept an xray object, and if we receive a boolean as the second\n    // argument, we assume every request we make is sent to a server\n    // running on renwewable power.\n\n    // if we receive an array of domains, return a number accounting the\n    // reduced CO2 from green hosted domains\n\n    const domainCO2 = this.perDomain(pageXray, green);\n    let totalCO2 = 0;\n    for (let domain of domainCO2) {\n      totalCO2 += domain.co2;\n    }\n    return totalCO2;\n  }\n\n  perContentType(pageXray, greenDomains) {\n    const co2PerContentType = {};\n    for (let asset of pageXray.assets) {\n      const domain = new URL(asset.url).domain;\n      const transferSize = asset.transferSize;\n      const co2ForTransfer = this.perByte(\n        transferSize,\n        greenDomains && greenDomains.indexOf(domain) > -1\n      );\n      const contentType = asset.type;\n      if (!co2PerContentType[contentType]) {\n        co2PerContentType[contentType] = { co2: 0, transferSize: 0 };\n      }\n      co2PerContentType[contentType].co2 += co2ForTransfer;\n      co2PerContentType[contentType].transferSize += transferSize;\n    }\n    // restructure and sort\n    const all = [];\n    for (let type of Object.keys(co2PerContentType)) {\n      all.push({\n        type,\n        co2: co2PerContentType[type].co2,\n        transferSize: co2PerContentType[type].transferSize,\n      });\n    }\n    all.sort((a, b) => b.co2 - a.co2);\n    return all;\n  }\n\n  dirtiestResources(pageXray, greenDomains) {\n    const allAssets = [];\n    for (let asset of pageXray.assets) {\n      const domain = new URL(asset.url).domain;\n      const transferSize = asset.transferSize;\n      const co2ForTransfer = this.perByte(\n        transferSize,\n        greenDomains && greenDomains.indexOf(domain) > -1\n      );\n      allAssets.push({ url: asset.url, co2: co2ForTransfer, transferSize });\n    }\n    allAssets.sort((a, b) => b.co2 - a.co2);\n\n    return allAssets.slice(0, allAssets.length > 10 ? 10 : allAssets.length);\n  }\n\n  perParty(pageXray, greenDomains) {\n    let firstParty = 0;\n    let thirdParty = 0;\n    // calculate co2 per first/third party\n    const firstPartyRegEx = pageXray.firstPartyRegEx;\n    for (let d of Object.keys(pageXray.domains)) {\n      if (!d.match(firstPartyRegEx)) {\n        thirdParty += this.perByte(\n          pageXray.domains[d].transferSize,\n          greenDomains && greenDomains.indexOf(d) > -1\n        );\n      } else {\n        firstParty += this.perByte(\n          pageXray.domains[d].transferSize,\n          greenDomains && greenDomains.indexOf(d) > -1\n        );\n      }\n    }\n    return { firstParty, thirdParty };\n  }\n}\n\nexport { CO2 };\nexport default CO2;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,kBAAoB;AACpB,oCAAiC;AAEjC,MAAM,IAAI;AAAA,EACR,YAAY,SAAS;AACnB,SAAK,UAAU;AAGf,SAAK,QAAQ,IAAI,oBAAQ;AAEzB,QAAI,SAAS;AACX,UAAI,QAAQ,UAAU,OAAO;AAC3B,aAAK,QAAQ,IAAI,sCAAqB;AAAA,MACxC,OAAO;AAGL,aAAK,QAAQ,IAAI,QAAQ,MAAM;AAAA,MACjC;AAAA,IACF;AAAA,EACF;AAAA,EAWA,QAAQ,OAAO,OAAO;AACpB,WAAO,KAAK,MAAM,QAAQ,OAAO,KAAK;AAAA,EACxC;AAAA,EAEA,UAAU,UAAU,cAAc;AAChC,UAAM,eAAe,CAAC;AACtB,aAAS,UAAU,OAAO,KAAK,SAAS,OAAO,GAAG;AAChD,UAAI;AACJ,UAAI,gBAAgB,aAAa,QAAQ,MAAM,IAAI,IAAI;AACrD,cAAM,KAAK,QAAQ,SAAS,QAAQ,QAAQ,cAAc,IAAI;AAAA,MAChE,OAAO;AACL,cAAM,KAAK,QAAQ,SAAS,QAAQ,QAAQ,YAAY;AAAA,MAC1D;AACA,mBAAa,KAAK;AAAA,QAChB;AAAA,QACA;AAAA,QACA,cAAc,SAAS,QAAQ,QAAQ;AAAA,MACzC,CAAC;AAAA,IACH;AACA,iBAAa,KAAK,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG;AAEzC,WAAO;AAAA,EACT;AAAA,EAEA,QAAQ,UAAU,OAAO;AAQvB,UAAM,YAAY,KAAK,UAAU,UAAU,KAAK;AAChD,QAAI,WAAW;AACf,aAAS,UAAU,WAAW;AAC5B,kBAAY,OAAO;AAAA,IACrB;AACA,WAAO;AAAA,EACT;AAAA,EAEA,eAAe,UAAU,cAAc;AACrC,UAAM,oBAAoB,CAAC;AAC3B,aAAS,SAAS,SAAS,QAAQ;AACjC,YAAM,SAAS,IAAI,IAAI,MAAM,GAAG,EAAE;AAClC,YAAM,eAAe,MAAM;AAC3B,YAAM,iBAAiB,KAAK,QAC1B,cACA,gBAAgB,aAAa,QAAQ,MAAM,IAAI,EACjD;AACA,YAAM,cAAc,MAAM;AAC1B,UAAI,CAAC,kBAAkB,cAAc;AACnC,0BAAkB,eAAe,EAAE,KAAK,GAAG,cAAc,EAAE;AAAA,MAC7D;AACA,wBAAkB,aAAa,OAAO;AACtC,wBAAkB,aAAa,gBAAgB;AAAA,IACjD;AAEA,UAAM,MAAM,CAAC;AACb,aAAS,QAAQ,OAAO,KAAK,iBAAiB,GAAG;AAC/C,UAAI,KAAK;AAAA,QACP;AAAA,QACA,KAAK,kBAAkB,MAAM;AAAA,QAC7B,cAAc,kBAAkB,MAAM;AAAA,MACxC,CAAC;AAAA,IACH;AACA,QAAI,KAAK,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG;AAChC,WAAO;AAAA,EACT;AAAA,EAEA,kBAAkB,UAAU,cAAc;AACxC,UAAM,YAAY,CAAC;AACnB,aAAS,SAAS,SAAS,QAAQ;AACjC,YAAM,SAAS,IAAI,IAAI,MAAM,GAAG,EAAE;AAClC,YAAM,eAAe,MAAM;AAC3B,YAAM,iBAAiB,KAAK,QAC1B,cACA,gBAAgB,aAAa,QAAQ,MAAM,IAAI,EACjD;AACA,gBAAU,KAAK,EAAE,KAAK,MAAM,KAAK,KAAK,gBAAgB,aAAa,CAAC;AAAA,IACtE;AACA,cAAU,KAAK,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG;AAEtC,WAAO,UAAU,MAAM,GAAG,UAAU,SAAS,KAAK,KAAK,UAAU,MAAM;AAAA,EACzE;AAAA,EAEA,SAAS,UAAU,cAAc;AAC/B,QAAI,aAAa;AACjB,QAAI,aAAa;AAEjB,UAAM,kBAAkB,SAAS;AACjC,aAAS,KAAK,OAAO,KAAK,SAAS,OAAO,GAAG;AAC3C,UAAI,CAAC,EAAE,MAAM,eAAe,GAAG;AAC7B,sBAAc,KAAK,QACjB,SAAS,QAAQ,GAAG,cACpB,gBAAgB,aAAa,QAAQ,CAAC,IAAI,EAC5C;AAAA,MACF,OAAO;AACL,sBAAc,KAAK,QACjB,SAAS,QAAQ,GAAG,cACpB,gBAAgB,aAAa,QAAQ,CAAC,IAAI,EAC5C;AAAA,MACF;AAAA,IACF;AACA,WAAO,EAAE,YAAY,WAAW;AAAA,EAClC;AACF;AAGA,IAAO,cAAQ;",
+  "names": []
+}