@tgwf/co2 0.14.0 → 0.14.2

package/CHANGELOG.md

@@ -12,15 +12,154 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 > - **Fixed** for any bug fixes.
 > - **Security** in case of vulnerabilities.
 
-# Unreleased
+## Unreleased
 
-- _(Add a summary of your feature, and if relevant the issue, in your PR for merging into `main`)_
+- Adds user agent header for requests to Green Web Foundation APIs
+<!-- - _(Add a summary of your feature, and if relevant the issue, in your PR for merging into `main`)_ -->
 
-# Released
+## Released
 
-## [0.11.0] - 2022-10-03
+### [0.14.1] - 2024-01-09
 
-### Added
+#### Changed
+
+- Removed `index.d.ts` in favour of importing type definitions from `@types/tgwf__co2`.
+- Reduce package size by excluding files from publish NPM package.
+- Automated monthly update of annual average grid intensity data.
+
+### [0.13.10] - 2023-12-16
+
+#### Changed
+
+- Automated monthly update of annual average grid intensity data.
+
+### [0.13.9] - 2023-11-07
+
+#### Fixed
+
+- Fix to return expected results when variables with 0 value are passed into function
+
+#### Changed
+
+- Automated monthly update of annual average grid intensity data.
+
+### [0.13.8] - 2023-10-09
+
+#### Fixed
+
+- Properly use value of 0 for system segments and variables in the perByteTrace and perVisitTrace functions.
+
+#### Changed
+
+- Automated monthly update of annual average grid intensity data.
+
+### [0.13.7] - 2023-09-13
+
+#### Changed
+
+- Automated monthly update of annual average grid intensity data.
+
+### [0.13.6] - 2023-08-08
+
+#### Changed
+
+- Automated monthly update of annual average grid intensity data.
+- Create FUNDING.yml to allow sponsor contribution to this project.
+- Store segment flag on CO2 instance, not models.
+
+### [0.13.5] - 2023-07-5
+
+#### Changed
+
+- Automated monthly update of annual average grid intensity data.
+
+### [0.13.4] - 2023-05-24
+
+#### Fixed
+
+- Fixed an error when try to use global grid intensities in IIFE. (PR #147)
+
+### [0.13.3] - 2023-05-18
+
+#### Changed
+
+- Updated the global grid intensity constant to use the latest WORLD grid intensity value from Ember. (PR #142)
+
+### [0.13.2] - 2023-04-21
+
+- Fix to ensure that region names that are keys in the average annual grid intensity export are capitalised.
+
+### [0.13.1] - 2023-04-20
+
+#### Fixed
+
+- Fixed the import of average grid intensities in node. (PR #137)
+
+### [0.13.0] - 2023-04-13
+
+#### Changed
+
+In PR #135 there were significant changes made to how average annual grid intensities are fetched and generated.
+
+- Updated average annual grid intensities to include 2022 values from Ember.
+- Changed the functions to generate average grid intensities to:
+  - Fetch data directly from Ember's API.
+  - Get the _latest_ annual average values for each country/region.
+- Renamed the average grid intensities export file.
+
+### [0.12.2] - 2023-03-01
+
+#### Added
+
+- Add a module declaration for use from typescript (PR #131)
+
+#### Changed
+
+- Updated 2021 average annual grid intensity values (PR #133)
+
+### [0.12.1] - 2023-02-02
+
+#### Fixed
+
+- Removed incorrectly imported constants in tests.
+
+### [0.12.0] - 2023-02-02
+
+#### Added
+
+- Introduced two new functions `perByteTrace` and `perVisitTrace` which allow developers to pass an options object containing customised values for the constants used in the Sustainable Web Design model. (PR #126)
+
+#### Changed
+
+- Allowed developers now have the option to return a breakdown of carbon emissions estimates by system segment when using the Sustainable Web Design model. (PR #113)
+
+### [0.11.4] - 2022-12-02
+
+#### Fixed
+
+- Updated the `greenCheckMulti` function to work properly in ESM. (PR #123)
+
+### [0.11.3] - 2022-10-13
+
+#### Fixed
+
+- Corrected the Node export for the hosting raised in issue #110. (PR #118)
+
+### [0.11.2] - 2022-10-11
+
+#### Fixed
+
+- v0.11.x updates increased library size to 17MB + when published to NPM. This has been raised in [#108](https://github.com/thegreenwebfoundation/co2.js/issues/108) and it was found data files were being included in the published package. (PR #117)
+
+### [0.11.1] - 2022-10-07
+
+#### Changed
+
+- We have used generic filenames for data files, to avoid any confusion around the data being provided in this library. (PR #112)
+
+### [0.11.0] - 2022-10-03
+
+#### Added
 
 - Introduced average and marginal carbon intensity data into the library. This comes from [Ember Climate](https://ember-climate.org/data/data-explorer/) (for average carbon intensity data), and [The Green Web Foundation](https://developers.thegreenwebfoundation.org/co2js/data) (marginal intensity data, originally sourced from the UNFCCC - the United Nations Framework Convention on Climate Change). For more, [see our release guide for v0.11](https://www.thegreenwebfoundation.org/news/release-guide-co2-js-v0-11/) about the differences between the kinds of data. See [#64](https://github.com/thegreenwebfoundation/co2.js/issues/64), and [#97](https://github.com/thegreenwebfoundation/co2.js/issues/97) for more.
 - Added new paths to `import` and `require` the annual, country-level average and marginal carbon intensity data mentioned above like, as javascript objects, or as JSON. See [#104 for more](https://github.com/thegreenwebfoundation/co2.js/issues/104).
@@ -28,32 +167,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Introduced scripts to automate the generation of grid intensity data based of Ember & UNFCCC source files.
 - Introduced a `release:minor` command, to automate the publishing process, to complement `release:patch`.
 
-### Changed
+#### Changed
 
-- Changed the default model for transfer based CO2 calculations from the _1byte_ model to the _Sustainable Web Design_ model instead. See https://developers.thegreenwebfoundation.org/co2js/models/ for guidance on the differences and how to migrate between them. See [#94 for more](https://github.com/thegreenwebfoundation/co2.js/issues/94).
+- Changed the default model for transfer based CO2 calculations from the _1byte_ model to the _Sustainable Web Design_ model instead. See <https://developers.thegreenwebfoundation.org/co2js/models/> for guidance on the differences and how to migrate between them. See [#94 for more](https://github.com/thegreenwebfoundation/co2.js/issues/94).
 - Updated our release commands to generate and format the carbon intensity data as part of the release process.
 
-## 0.10.4 2022-08-12
+### [0.10.4] - 2022-08-12
 
-### Added
+#### Added
 
 - Introduced a `release:patch` command, to automate the publishing process. This is designed to make sure we always publish the most recent compiled code, by adding a rebuild step that can be easy to forget.
 
-## 0.10.3 2022-08-12
+### [0.10.3] - 2022-08-12
 
-### Added
+#### Added
 
 - Introduced a new `perVisit()` function for the Sustainable Web Design model, which applies [caching and return visits assumptions](https://sustainablewebdesign.org/calculating-digital-emissions/).
 
-## [0.10.2] - 2022-08-12
+### [0.10.2] - 2022-08-12
 
 - 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
+### [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
+### [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)
@@ -61,104 +200,104 @@ This release used a version bump as previously we had released v0.10.0 under a p
 - 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
+### [0.9.0] - 2022-03-28
 
-### Added
+#### Added
 
 - Added newly implemented Sustainable Web Design model [thanks @dryden!]
 - Added new readme page for using both emissions models
 - Added new source of data to the Sustainable Web Design model from Ember Climate.
 
-### Changed
+#### Changed
 
 - Changed the CO2 class to accept either the One Byte model or the Sustainable Web Design model
 
-### Fixed
+#### Fixed
 
 - Fixed various typos.
 
-## [0.8.0] - 2021-11-28
+### [0.8.0] - 2021-11-28
 
-###  Fixed
+####  Fixed
 
 - Update further dependencies
 - Fix embarassing order of magnitude typo in 1byte model (thanks @mstaschik!)
 
-## Added
+#### Added
 
 - Read JSON blob also as gzipped #44 (thanks @soulgalore)
 
-### Changed
+#### Changed
 
 - The 1byte model will give different numbers now. It's mentioned in `#fixed` but it's worth repeating.
 
-## [0.7.0] - 2021-11-28
+### [0.7.0] - 2021-11-28
 
-### Fixed
+#### Fixed
 
 - Update tests to avoid network requests #50
 - Update dependencies across the board
 
-###  Changed
+####  Changed
 
 - Switch to github actions instead of travis for CI.
 
-## [0.6.1] - 2020-03-15
+### [0.6.1] - 2020-03-15
 
-### Fixed
+#### Fixed
 
 - Added the function to load JSON, on the tgwg.hosting object, for use in the sustaiable web sitespeed plugin.
 
-## [0.6.0] - 2020-03-15
+### [0.6.0] - 2020-03-15
 
-### Added
+#### Added
 
 - Added the hosting-JSON for running local checks against an array instead of SQLite.
 
-### Changed
+#### Changed
 
 - Swapped out checking against a sqlite database `hosting-json`in favour of simple array in,
 - Updated conventions for style - using kebab-cases over CamelCase for naming files
 
-### Removed
+#### Removed
 
-- Extracted sqlite usage and dependencies into a separate module, `url2green`. This means  you no longer need to compile SQLite on install.
+- Extracted sqlite usage and dependencies into a separate module, `url2green`. This means you no longer need to compile SQLite on install.
 
-## [0.5.0] - 2020-03-03
+### [0.5.0] - 2020-03-03
 
-### Changed
+#### Changed
 
 - Updated README
 - Updated the emissions figured for green energy after further research on methodology with @@JamieBeevor
 - Incorporated class based CO2 models from @soulgalore
 - Credit contributors
 
-## [0.4.7] - 2020-03-02
+### [0.4.7] - 2020-03-02
 
-### Added
+#### Added
 
 - Added a changelog at last!
 
-## [0.4.6] - 2020-03-01
+### [0.4.6] - 2020-03-01
 
-### Added
+#### Added
 
 - Changelog inconsistency section in Bad Practices
 
-## [0.4.4] - 2020-03-01
+### [0.4.4] - 2020-03-01
 
-### Added
+#### Added
 
 Added the (currently unused) green byte model.
 
-### Changed
+#### Changed
 
 Update the 1byte model to use an average of devices, rather than just wifi
 
-## [0.4.3] - 2020-03-01
+### [0.4.3] - 2020-03-01
 
-### Added
+#### Added
 
-### Changed
+#### Changed
 
 Split hosting API into two separate files (one for sqlite, and one relying on the greencheck API)

package/README.md

@@ -1,5 +1,11 @@
 # CO2.js
 
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
+[![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors-)
+
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
 <img src="https://github.com/thegreenwebfoundation/co2.js/actions/workflows/unittests.yml/badge.svg" />
 
 One day, the 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.
@@ -14,7 +20,7 @@ CO2.js is a JavaScript library that enables developers a way to estimate the emi
 
 Being able to estimate the CO2 emissions associated with digital activities can be of benefit to both developers and users.
 
-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.
+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 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).
 
@@ -35,7 +41,7 @@ npm install @tgwf/co2
 You can import the CO2.js library into projects using Skypack.
 
 ```js
-import tgwf from 'https://cdn.skypack.dev/@tgwf/co2';
+import tgwf from "https://cdn.skypack.dev/@tgwf/co2";
 ```
 
 ## Using a JS CDN
@@ -66,10 +72,18 @@ You can also build the CO2.js library from the source code. To do this:
 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.
+
+   - `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.
+
+## TypeScript support
+
+Type definitions for CO2.js are [published in the DefinitelyTyped project](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tgwf__co2), and are [available on NPM](https://www.npmjs.com/package/@types/tgwf__co2) at `@types/tgwf__co2`.
+
+If you want to use type definitions in your project, they should be installed as a devDependency.
+
+`npm install --dev @types/tgwf__co2`
 
 ## Marginal and average emissions intensity data
 
@@ -80,13 +94,14 @@ CO2.js includes yearly average grid intensity data from [Ember](https://ember-cl
 You can import annual, country-level marginal or average grid intensity data into your projects directly from CO2.js. For example, if we wanted to use the average grid intensity for Australia in our project, we could use the code below:
 
 ```js
-import { averageIntensity } from '@tgwf/co2';
+import { averageIntensity } from "@tgwf/co2";
 const { data } = averageIntensity;
 const { AUS } = data;
-console.log({ AUS })
+console.log({ AUS });
 ```
 
 All countries are represented by their respective [Alpha-3 ISO country code](https://www.iso.org/obp/ui/#search).
+
 ## Publishing to NPM
 
 We use [`np`](https://www.npmjs.com/package/np) to publish new versions of this library to NPM. To do this:
@@ -100,20 +115,59 @@ We use [`np`](https://www.npmjs.com/package/np) to publish new versions of this
 
 CO2.js releases will be communicated through the following channels:
 
-| Channel | Minor Release (0.xx) | Patch Release (0.xx.x) |
-|----------|----------------------|----------------------|
-| [Github](https://github.com/thegreenwebfoundation/co2.js/releases)  | ✅ | ✅ |
-| [Green Web Foundation website](https://www.thegreenwebfoundation.org/co2-js/#releases) | ✅ | ❌ |
-| W3C Slack Sustainability Channel | ✅ | ❌ |
-| ClimateAction.Tech Slack | ✅ | ❌ |
-| [Green Web Foundation LinkedIn Account](https://www.linkedin.com/company/green-web-foundation/) | ✅ | ❌ |
+| Channel                                                                                         | Minor Release (0.xx) | Patch Release (0.xx.x) |
+| ----------------------------------------------------------------------------------------------- | -------------------- | ---------------------- |
+| [Github](https://github.com/thegreenwebfoundation/co2.js/releases)                              | ✅                   | ✅                     |
+| [Green Web Foundation website](https://www.thegreenwebfoundation.org/co2-js/#releases)          | ✅                   | ❌                     |
+| W3C Slack Sustainability Channel                                                                | ✅                   | ❌                     |
+| ClimateAction.Tech Slack                                                                        | ✅                   | ❌                     |
+| [Green Web Foundation LinkedIn Account](https://www.linkedin.com/company/green-web-foundation/) | ✅                   | ❌                     |
 
 ## Licenses
 
-The code for CO2.js is licensed Apache 2.0. ([What does this mean?](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)))
+The code for CO2.js is licensed Apache 2.0. ([What does this mean?](<https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)>))
 
 The average carbon intensity data from Ember is published under the Creative Commons ShareAlike Attribution Licence ([CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)). ([What does this mean?](https://www.tldrlegal.com/license/creative-commons-attribution-share-alike-cc-sa))
 
 The marginal intensity data is published by the Green Web Foundation, under the Creative Commons ShareAlike Attribution Licence ([CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)). ([What does this mean?](https://www.tldrlegal.com/license/creative-commons-attribution-share-alike-cc-sa))
 
 See LICENCE for more.
+
+## Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/mrchrisadams"><img src="https://avatars.githubusercontent.com/u/17906?v=4?s=100" width="100px;" alt="Chris Adams"/><br /><sub><b>Chris Adams</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=mrchrisadams" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.fershad.com/"><img src="https://avatars.githubusercontent.com/u/27988517?v=4?s=100" width="100px;" alt="fershad"/><br /><sub><b>fershad</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=fershad" title="Code">💻</a> <a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=fershad" title="Documentation">📖</a> <a href="#maintenance-fershad" title="Maintenance">🚧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.peterhedenskog.com/"><img src="https://avatars.githubusercontent.com/u/540757?v=4?s=100" width="100px;" alt="Peter Hedenskog"/><br /><sub><b>Peter Hedenskog</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=soulgalore" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.drydenwilliams.co.uk/"><img src="https://avatars.githubusercontent.com/u/4403089?v=4?s=100" width="100px;" alt="Dryden"/><br /><sub><b>Dryden</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=drydenwilliams" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://evanhahn.com/"><img src="https://avatars.githubusercontent.com/u/777712?v=4?s=100" width="100px;" alt="Evan Hahn"/><br /><sub><b>Evan Hahn</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=EvanHahn" title="Code">💻</a> <a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=EvanHahn" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/PrathumP"><img src="https://avatars.githubusercontent.com/u/115390367?v=4?s=100" width="100px;" alt="Prathum Pandey"/><br /><sub><b>Prathum Pandey</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/issues?q=author%3APrathumP" title="Bug reports">🐛</a> <a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=PrathumP" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Fdawgs"><img src="https://avatars.githubusercontent.com/u/43814140?v=4?s=100" width="100px;" alt="Frazer Smith"/><br /><sub><b>Frazer Smith</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=Fdawgs" title="Code">💻</a> <a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=Fdawgs" title="Tests">⚠️</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/hamishfagg"><img src="https://avatars.githubusercontent.com/u/895845?v=4?s=100" width="100px;" alt="Hamish Fagg"/><br /><sub><b>Hamish Fagg</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=hamishfagg" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://portfolio.toolness.org/"><img src="https://avatars.githubusercontent.com/u/124687?v=4?s=100" width="100px;" alt="Atul Varma"/><br /><sub><b>Atul Varma</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=toolness" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.intersectionalenvironmentalist.com/"><img src="https://avatars.githubusercontent.com/u/1530684?v=4?s=100" width="100px;" alt="Piper"/><br /><sub><b>Piper</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=piperchester" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://vasquezruiz.com/"><img src="https://avatars.githubusercontent.com/u/108420?v=4?s=100" width="100px;" alt="Raymundo Vásquez Ruiz"/><br /><sub><b>Raymundo Vásquez Ruiz</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=raymundovr" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://greengumption.co.uk/"><img src="https://avatars.githubusercontent.com/u/26165947?v=4?s=100" width="100px;" alt="JamieB"/><br /><sub><b>JamieB</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=JamieBeevor" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/p-gerard"><img src="https://avatars.githubusercontent.com/u/97036756?v=4?s=100" width="100px;" alt="p-gerard"/><br /><sub><b>p-gerard</b></sub></a><br /><a href="https://github.com/thegreenwebfoundation/co2.js/issues?q=author%3Ap-gerard" title="Bug reports">🐛</a> <a href="https://github.com/thegreenwebfoundation/co2.js/commits?author=p-gerard" title="Code">💻</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->

package/dist/cjs/co2.js

@@ -40,23 +40,15 @@ class CO2 {
       throw new Error(`"${options.model}" is not a valid model. Please use "1byte" for the OneByte model, and "swd" for the Sustainable Web Design model.
 See https://developers.thegreenwebfoundation.org/co2js/models/ to learn more about the models available in CO2.js.`);
     }
-    if ((options == null ? void 0 : options.results) === "segment") {
-      this.model.results = {
-        segment: true
-      };
-    } else {
-      this.model.results = {
-        segment: false
-      };
-    }
+    this._segment = (options == null ? void 0 : options.results) === "segment";
   }
   perByte(bytes, green = false) {
-    return this.model.perByte(bytes, green, this.model.results.segment);
+    return this.model.perByte(bytes, green, this._segment);
   }
   perVisit(bytes, green = false) {
     var _a;
     if ((_a = this.model) == null ? void 0 : _a.perVisit) {
-      return this.model.perVisit(bytes, green, this.model.results.segment);
+      return this.model.perVisit(bytes, green, this._segment);
     } else {
       throw new Error(`The perVisit() method is not supported in the model you are using. Try using perByte() instead.
 See https://developers.thegreenwebfoundation.org/co2js/methods/ to learn more about the methods available in CO2.js.`);
@@ -69,17 +61,17 @@ See https://developers.thegreenwebfoundation.org/co2js/methods/ to learn more ab
       adjustments = (0, import_helpers.parseOptions)(options);
     }
     return {
-      co2: this.model.perByte(bytes, green, this.model.results.segment, adjustments),
+      co2: this.model.perByte(bytes, green, this._segment, adjustments),
       green,
       variables: {
         description: "Below are the variables used to calculate this CO2 estimate.",
         bytes,
         gridIntensity: {
           description: "The grid intensity (grams per kilowatt-hour) used to calculate this CO2 estimate.",
-          network: ((_b = (_a = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _a.network) == null ? void 0 : _b.value) || import_constants.GLOBAL_GRID_INTENSITY,
-          dataCenter: green ? import_constants.RENEWABLES_GRID_INTENSITY : ((_d = (_c = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _c.dataCenter) == null ? void 0 : _d.value) || import_constants.GLOBAL_GRID_INTENSITY,
+          network: ((_b = (_a = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _a.network) == null ? void 0 : _b.value) ?? import_constants.GLOBAL_GRID_INTENSITY,
+          dataCenter: green ? import_constants.RENEWABLES_GRID_INTENSITY : ((_d = (_c = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _c.dataCenter) == null ? void 0 : _d.value) ?? import_constants.GLOBAL_GRID_INTENSITY,
           production: import_constants.GLOBAL_GRID_INTENSITY,
-          device: ((_f = (_e = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _e.device) == null ? void 0 : _f.value) || import_constants.GLOBAL_GRID_INTENSITY
+          device: ((_f = (_e = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _e.device) == null ? void 0 : _f.value) ?? import_constants.GLOBAL_GRID_INTENSITY
         }
       }
     };
@@ -92,21 +84,21 @@ See https://developers.thegreenwebfoundation.org/co2js/methods/ to learn more ab
         adjustments = (0, import_helpers.parseOptions)(options);
       }
       return {
-        co2: this.model.perVisit(bytes, green, this.model.results.segment, adjustments),
+        co2: this.model.perVisit(bytes, green, this._segment, adjustments),
         green,
         variables: {
           description: "Below are the variables used to calculate this CO2 estimate.",
           bytes,
           gridIntensity: {
             description: "The grid intensity (grams per kilowatt-hour) used to calculate this CO2 estimate.",
-            network: ((_c = (_b = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _b.network) == null ? void 0 : _c.value) || import_constants.GLOBAL_GRID_INTENSITY,
-            dataCenter: green ? import_constants.RENEWABLES_GRID_INTENSITY : ((_e = (_d = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _d.dataCenter) == null ? void 0 : _e.value) || import_constants.GLOBAL_GRID_INTENSITY,
+            network: ((_c = (_b = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _b.network) == null ? void 0 : _c.value) ?? import_constants.GLOBAL_GRID_INTENSITY,
+            dataCenter: green ? import_constants.RENEWABLES_GRID_INTENSITY : ((_e = (_d = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _d.dataCenter) == null ? void 0 : _e.value) ?? import_constants.GLOBAL_GRID_INTENSITY,
             production: import_constants.GLOBAL_GRID_INTENSITY,
-            device: ((_g = (_f = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _f.device) == null ? void 0 : _g.value) || import_constants.GLOBAL_GRID_INTENSITY
+            device: ((_g = (_f = adjustments == null ? void 0 : adjustments.gridIntensity) == null ? void 0 : _f.device) == null ? void 0 : _g.value) ?? import_constants.GLOBAL_GRID_INTENSITY
           },
-          dataReloadRatio: (adjustments == null ? void 0 : adjustments.dataReloadRatio) || 0.02,
-          firstVisitPercentage: (adjustments == null ? void 0 : adjustments.firstVisitPercentage) || 0.75,
-          returnVisitPercentage: (adjustments == null ? void 0 : adjustments.returnVisitPercentage) || 0.25
+          dataReloadRatio: (adjustments == null ? void 0 : adjustments.dataReloadRatio) ?? 0.02,
+          firstVisitPercentage: (adjustments == null ? void 0 : adjustments.firstVisitPercentage) ?? 0.75,
+          returnVisitPercentage: (adjustments == null ? void 0 : adjustments.returnVisitPercentage) ?? 0.25
         }
       };
     } else {

package/dist/cjs/co2.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/co2.js"],
-  "sourcesContent": ["\"use strict\";\n\n/**\n * @typedef {Object} CO2EstimateTraceResultPerByte\n * @property {number} co2 - The CO2 estimate in grams/kilowatt-hour\n * @property {boolean} green - Whether the domain is green or not\n * @property {TraceResultVariables} variables - The variables used to calculate the CO2 estimate\n */\n\n/**\n * @typedef {Object} CO2EstimateTraceResultPerVisit\n * @property {number} co2 - The CO2 estimate in grams/kilowatt-hour\n * @property {boolean} green - Whether the domain is green or not\n * @property {TraceResultVariables} variables - The variables used to calculate the CO2 estimate\n */\n\n/**\n * @typedef {Object} TraceResultVariablesPerByte\n * @property {GridIntensityVariables} gridIntensity - The grid intensity related variables\n */\n/**\n * @typedef {Object} TraceResultVariablesPerVisit\n * @property {GridIntensityVariables} gridIntensity - The grid intensity related variables\n * @property {number} dataReloadRatio - What percentage of a page is reloaded on each subsequent page view\n * @property {number} firstVisitPercentage - What percentage of visits are loading this page for subsequent times\n * @property {number} returnVisitPercentage - What percentage of visits are loading this page for the second or more time\n */\n\n/**\n * @typedef {Object} GridIntensityVariables\n * @property {string} description - The description of the variables\n * @property {number} network - The network grid intensity set by the user or the default\n * @property {number} dataCenter - The data center grid intensity set by the user or the default\n * @property {number} device - The device grid intensity set by the user or the default\n * @property {number} production - The production grid intensity set by the user or the default\n */\n\nimport OneByte from \"./1byte.js\";\nimport SustainableWebDesign from \"./sustainable-web-design.js\";\n\nimport {\n  GLOBAL_GRID_INTENSITY,\n  RENEWABLES_GRID_INTENSITY,\n} from \"./constants/index.js\";\nimport { parseOptions } from \"./helpers/index.js\";\n\nclass CO2 {\n  constructor(options) {\n    this.model = new SustainableWebDesign();\n    // Using optional chaining allows an empty object to be passed\n    // in without breaking the code.\n    if (options?.model === \"1byte\") {\n      this.model = new OneByte();\n    } else if (options?.model === \"swd\") {\n      this.model = new SustainableWebDesign();\n    } else if (options?.model) {\n      throw new Error(\n        `\"${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.`\n      );\n    }\n\n    if (options?.results === \"segment\") {\n      this.model.results = {\n        segment: true,\n      };\n    } else {\n      this.model.results = {\n        segment: false,\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 = false) {\n    return this.model.perByte(bytes, green, this.model.results.segment);\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  perVisit(bytes, green = false) {\n    if (this.model?.perVisit) {\n      return this.model.perVisit(bytes, green, this.model.results.segment);\n    } else {\n      throw new Error(\n        `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.`\n      );\n    }\n  }\n\n  /**\n   * Accept a figure in bytes for data transfer, a boolean for whether\n   * the domain shows as 'green', and an options object.\n   * Returns an object containing CO2 figure, green boolean, and object of the variables used in calculating the CO2 figure.\n   *\n   * @param {number} bytes\n   * @param {boolean} green\n   * @param {Object} options\n   * @return {CO2EstimateTraceResultPerByte} the amount of CO2 in grammes\n   */\n  perByteTrace(bytes, green = false, options = {}) {\n    let adjustments = {};\n    if (options) {\n      // If there are options, parse them and add them to the model.\n      adjustments = parseOptions(options);\n    }\n    return {\n      co2: this.model.perByte(\n        bytes,\n        green,\n        this.model.results.segment,\n        adjustments\n      ),\n      green,\n      variables: {\n        description:\n          \"Below are the variables used to calculate this CO2 estimate.\",\n        bytes,\n        gridIntensity: {\n          description:\n            \"The grid intensity (grams per kilowatt-hour) used to calculate this CO2 estimate.\",\n          network:\n            adjustments?.gridIntensity?.network?.value || GLOBAL_GRID_INTENSITY,\n          dataCenter: green\n            ? RENEWABLES_GRID_INTENSITY\n            : adjustments?.gridIntensity?.dataCenter?.value ||\n              GLOBAL_GRID_INTENSITY,\n          production: GLOBAL_GRID_INTENSITY,\n          device:\n            adjustments?.gridIntensity?.device?.value || GLOBAL_GRID_INTENSITY,\n        },\n      },\n    };\n  }\n\n  /**\n   * Accept a figure in bytes for data transfer, a boolean for whether\n   * the domain shows as 'green', and an options object.\n   * Returns an object containing CO2 figure, green boolean, and object of the variables used in calculating the CO2 figure.\n   *\n   * @param {number} bytes\n   * @param {boolean} green\n   * @param {Object} options\n   * @return {CO2EstimateTraceResultPerVisit} the amount of CO2 in grammes\n   */\n  perVisitTrace(bytes, green = false, options = {}) {\n    if (this.model?.perVisit) {\n      let adjustments = {};\n      if (options) {\n        // If there are options, parse them and add them to the model.\n        adjustments = parseOptions(options);\n      }\n\n      return {\n        co2: this.model.perVisit(\n          bytes,\n          green,\n          this.model.results.segment,\n          adjustments\n        ),\n        green,\n        variables: {\n          description:\n            \"Below are the variables used to calculate this CO2 estimate.\",\n          bytes,\n          gridIntensity: {\n            description:\n              \"The grid intensity (grams per kilowatt-hour) used to calculate this CO2 estimate.\",\n            network:\n              adjustments?.gridIntensity?.network?.value ||\n              GLOBAL_GRID_INTENSITY,\n            dataCenter: green\n              ? RENEWABLES_GRID_INTENSITY\n              : adjustments?.gridIntensity?.dataCenter?.value ||\n                GLOBAL_GRID_INTENSITY,\n            production: GLOBAL_GRID_INTENSITY,\n            device:\n              adjustments?.gridIntensity?.device?.value ||\n              GLOBAL_GRID_INTENSITY,\n          },\n          dataReloadRatio: adjustments?.dataReloadRatio || 0.02,\n          firstVisitPercentage: adjustments?.firstVisitPercentage || 0.75,\n          returnVisitPercentage: adjustments?.returnVisitPercentage || 0.25,\n        },\n      };\n    } else {\n      throw new Error(\n        `The perVisitDetailed() 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.`\n      );\n    }\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;AAqCA,kBAAoB;AACpB,oCAAiC;AAEjC,uBAGO;AACP,qBAA6B;AAE7B,MAAM,IAAI;AAAA,EACR,YAAY,SAAS;AACnB,SAAK,QAAQ,IAAI,sCAAqB;AAGtC,QAAI,oCAAS,WAAU,SAAS;AAC9B,WAAK,QAAQ,IAAI,oBAAQ;AAAA,IAC3B,WAAW,oCAAS,WAAU,OAAO;AACnC,WAAK,QAAQ,IAAI,sCAAqB;AAAA,IACxC,WAAW,mCAAS,OAAO;AACzB,YAAM,IAAI,MACR,IAAI,QAAQ;AAAA,mHACd;AAAA,IACF;AAEA,QAAI,oCAAS,aAAY,WAAW;AAClC,WAAK,MAAM,UAAU;AAAA,QACnB,SAAS;AAAA,MACX;AAAA,IACF,OAAO;AACL,WAAK,MAAM,UAAU;AAAA,QACnB,SAAS;AAAA,MACX;AAAA,IACF;AAAA,EACF;AAAA,EAWA,QAAQ,OAAO,QAAQ,OAAO;AAC5B,WAAO,KAAK,MAAM,QAAQ,OAAO,OAAO,KAAK,MAAM,QAAQ,OAAO;AAAA,EACpE;AAAA,EAWA,SAAS,OAAO,QAAQ,OAAO;AA9FjC;AA+FI,QAAI,WAAK,UAAL,mBAAY,UAAU;AACxB,aAAO,KAAK,MAAM,SAAS,OAAO,OAAO,KAAK,MAAM,QAAQ,OAAO;AAAA,IACrE,OAAO;AACL,YAAM,IAAI,MACR;AAAA,qHACF;AAAA,IACF;AAAA,EACF;AAAA,EAYA,aAAa,OAAO,QAAQ,OAAO,UAAU,CAAC,GAAG;AAlHnD;AAmHI,QAAI,cAAc,CAAC;AACnB,QAAI,SAAS;AAEX,oBAAc,iCAAa,OAAO;AAAA,IACpC;AACA,WAAO;AAAA,MACL,KAAK,KAAK,MAAM,QACd,OACA,OACA,KAAK,MAAM,QAAQ,SACnB,WACF;AAAA,MACA;AAAA,MACA,WAAW;AAAA,QACT,aACE;AAAA,QACF;AAAA,QACA,eAAe;AAAA,UACb,aACE;AAAA,UACF,SACE,wDAAa,kBAAb,mBAA4B,YAA5B,mBAAqC,UAAS;AAAA,UAChD,YAAY,QACR,6CACA,wDAAa,kBAAb,mBAA4B,eAA5B,mBAAwC,UACxC;AAAA,UACJ,YAAY;AAAA,UACZ,QACE,wDAAa,kBAAb,mBAA4B,WAA5B,mBAAoC,UAAS;AAAA,QACjD;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAYA,cAAc,OAAO,QAAQ,OAAO,UAAU,CAAC,GAAG;AA/JpD;AAgKI,QAAI,WAAK,UAAL,mBAAY,UAAU;AACxB,UAAI,cAAc,CAAC;AACnB,UAAI,SAAS;AAEX,sBAAc,iCAAa,OAAO;AAAA,MACpC;AAEA,aAAO;AAAA,QACL,KAAK,KAAK,MAAM,SACd,OACA,OACA,KAAK,MAAM,QAAQ,SACnB,WACF;AAAA,QACA;AAAA,QACA,WAAW;AAAA,UACT,aACE;AAAA,UACF;AAAA,UACA,eAAe;AAAA,YACb,aACE;AAAA,YACF,SACE,wDAAa,kBAAb,mBAA4B,YAA5B,mBAAqC,UACrC;AAAA,YACF,YAAY,QACR,6CACA,wDAAa,kBAAb,mBAA4B,eAA5B,mBAAwC,UACxC;AAAA,YACJ,YAAY;AAAA,YACZ,QACE,wDAAa,kBAAb,mBAA4B,WAA5B,mBAAoC,UACpC;AAAA,UACJ;AAAA,UACA,iBAAiB,4CAAa,oBAAmB;AAAA,UACjD,sBAAsB,4CAAa,yBAAwB;AAAA,UAC3D,uBAAuB,4CAAa,0BAAyB;AAAA,QAC/D;AAAA,MACF;AAAA,IACF,OAAO;AACL,YAAM,IAAI,MACR;AAAA,qHACF;AAAA,IACF;AAAA,EACF;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;",
+  "sourcesContent": ["\"use strict\";\n\n/**\n * @typedef {Object} CO2EstimateTraceResultPerByte\n * @property {number} co2 - The CO2 estimate in grams/kilowatt-hour\n * @property {boolean} green - Whether the domain is green or not\n * @property {TraceResultVariables} variables - The variables used to calculate the CO2 estimate\n */\n\n/**\n * @typedef {Object} CO2EstimateTraceResultPerVisit\n * @property {number} co2 - The CO2 estimate in grams/kilowatt-hour\n * @property {boolean} green - Whether the domain is green or not\n * @property {TraceResultVariables} variables - The variables used to calculate the CO2 estimate\n */\n\n/**\n * @typedef {Object} TraceResultVariablesPerByte\n * @property {GridIntensityVariables} gridIntensity - The grid intensity related variables\n */\n/**\n * @typedef {Object} TraceResultVariablesPerVisit\n * @property {GridIntensityVariables} gridIntensity - The grid intensity related variables\n * @property {number} dataReloadRatio - What percentage of a page is reloaded on each subsequent page view\n * @property {number} firstVisitPercentage - What percentage of visits are loading this page for subsequent times\n * @property {number} returnVisitPercentage - What percentage of visits are loading this page for the second or more time\n */\n\n/**\n * @typedef {Object} GridIntensityVariables\n * @property {string} description - The description of the variables\n * @property {number} network - The network grid intensity set by the user or the default\n * @property {number} dataCenter - The data center grid intensity set by the user or the default\n * @property {number} device - The device grid intensity set by the user or the default\n * @property {number} production - The production grid intensity set by the user or the default\n */\n\nimport OneByte from \"./1byte.js\";\nimport SustainableWebDesign from \"./sustainable-web-design.js\";\n\nimport {\n  GLOBAL_GRID_INTENSITY,\n  RENEWABLES_GRID_INTENSITY,\n} from \"./constants/index.js\";\nimport { parseOptions } from \"./helpers/index.js\";\n\nclass CO2 {\n  constructor(options) {\n    this.model = new SustainableWebDesign();\n    // Using optional chaining allows an empty object to be passed\n    // in without breaking the code.\n    if (options?.model === \"1byte\") {\n      this.model = new OneByte();\n    } else if (options?.model === \"swd\") {\n      this.model = new SustainableWebDesign();\n    } else if (options?.model) {\n      throw new Error(\n        `\"${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.`\n      );\n    }\n\n    /** @private */\n    this._segment = options?.results === \"segment\";\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 = false) {\n    return this.model.perByte(bytes, green, this._segment);\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  perVisit(bytes, green = false) {\n    if (this.model?.perVisit) {\n      return this.model.perVisit(bytes, green, this._segment);\n    } else {\n      throw new Error(\n        `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.`\n      );\n    }\n  }\n\n  /**\n   * Accept a figure in bytes for data transfer, a boolean for whether\n   * the domain shows as 'green', and an options object.\n   * Returns an object containing CO2 figure, green boolean, and object of the variables used in calculating the CO2 figure.\n   *\n   * @param {number} bytes\n   * @param {boolean} green\n   * @param {Object} options\n   * @return {CO2EstimateTraceResultPerByte} the amount of CO2 in grammes\n   */\n  perByteTrace(bytes, green = false, options = {}) {\n    let adjustments = {};\n    if (options) {\n      // If there are options, parse them and add them to the model.\n      adjustments = parseOptions(options);\n    }\n    return {\n      co2: this.model.perByte(bytes, green, this._segment, adjustments),\n      green,\n      variables: {\n        description:\n          \"Below are the variables used to calculate this CO2 estimate.\",\n        bytes,\n        gridIntensity: {\n          description:\n            \"The grid intensity (grams per kilowatt-hour) used to calculate this CO2 estimate.\",\n          network:\n            adjustments?.gridIntensity?.network?.value ?? GLOBAL_GRID_INTENSITY,\n          dataCenter: green\n            ? RENEWABLES_GRID_INTENSITY\n            : adjustments?.gridIntensity?.dataCenter?.value ??\n              GLOBAL_GRID_INTENSITY,\n          production: GLOBAL_GRID_INTENSITY,\n          device:\n            adjustments?.gridIntensity?.device?.value ?? GLOBAL_GRID_INTENSITY,\n        },\n      },\n    };\n  }\n\n  /**\n   * Accept a figure in bytes for data transfer, a boolean for whether\n   * the domain shows as 'green', and an options object.\n   * Returns an object containing CO2 figure, green boolean, and object of the variables used in calculating the CO2 figure.\n   *\n   * @param {number} bytes\n   * @param {boolean} green\n   * @param {Object} options\n   * @return {CO2EstimateTraceResultPerVisit} the amount of CO2 in grammes\n   */\n  perVisitTrace(bytes, green = false, options = {}) {\n    if (this.model?.perVisit) {\n      let adjustments = {};\n      if (options) {\n        // If there are options, parse them and add them to the model.\n        adjustments = parseOptions(options);\n      }\n\n      return {\n        co2: this.model.perVisit(bytes, green, this._segment, adjustments),\n        green,\n        variables: {\n          description:\n            \"Below are the variables used to calculate this CO2 estimate.\",\n          bytes,\n          gridIntensity: {\n            description:\n              \"The grid intensity (grams per kilowatt-hour) used to calculate this CO2 estimate.\",\n            network:\n              adjustments?.gridIntensity?.network?.value ??\n              GLOBAL_GRID_INTENSITY,\n            dataCenter: green\n              ? RENEWABLES_GRID_INTENSITY\n              : adjustments?.gridIntensity?.dataCenter?.value ??\n                GLOBAL_GRID_INTENSITY,\n            production: GLOBAL_GRID_INTENSITY,\n            device:\n              adjustments?.gridIntensity?.device?.value ??\n              GLOBAL_GRID_INTENSITY,\n          },\n          dataReloadRatio: adjustments?.dataReloadRatio ?? 0.02,\n          firstVisitPercentage: adjustments?.firstVisitPercentage ?? 0.75,\n          returnVisitPercentage: adjustments?.returnVisitPercentage ?? 0.25,\n        },\n      };\n    } else {\n      throw new Error(\n        `The perVisitDetailed() 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.`\n      );\n    }\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;AAqCA,kBAAoB;AACpB,oCAAiC;AAEjC,uBAGO;AACP,qBAA6B;AAE7B,MAAM,IAAI;AAAA,EACR,YAAY,SAAS;AACnB,SAAK,QAAQ,IAAI,sCAAqB;AAGtC,QAAI,oCAAS,WAAU,SAAS;AAC9B,WAAK,QAAQ,IAAI,oBAAQ;AAAA,IAC3B,WAAW,oCAAS,WAAU,OAAO;AACnC,WAAK,QAAQ,IAAI,sCAAqB;AAAA,IACxC,WAAW,mCAAS,OAAO;AACzB,YAAM,IAAI,MACR,IAAI,QAAQ;AAAA,mHACd;AAAA,IACF;AAGA,SAAK,WAAW,oCAAS,aAAY;AAAA,EACvC;AAAA,EAWA,QAAQ,OAAO,QAAQ,OAAO;AAC5B,WAAO,KAAK,MAAM,QAAQ,OAAO,OAAO,KAAK,QAAQ;AAAA,EACvD;AAAA,EAWA,SAAS,OAAO,QAAQ,OAAO;AAvFjC;AAwFI,QAAI,WAAK,UAAL,mBAAY,UAAU;AACxB,aAAO,KAAK,MAAM,SAAS,OAAO,OAAO,KAAK,QAAQ;AAAA,IACxD,OAAO;AACL,YAAM,IAAI,MACR;AAAA,qHACF;AAAA,IACF;AAAA,EACF;AAAA,EAYA,aAAa,OAAO,QAAQ,OAAO,UAAU,CAAC,GAAG;AA3GnD;AA4GI,QAAI,cAAc,CAAC;AACnB,QAAI,SAAS;AAEX,oBAAc,iCAAa,OAAO;AAAA,IACpC;AACA,WAAO;AAAA,MACL,KAAK,KAAK,MAAM,QAAQ,OAAO,OAAO,KAAK,UAAU,WAAW;AAAA,MAChE;AAAA,MACA,WAAW;AAAA,QACT,aACE;AAAA,QACF;AAAA,QACA,eAAe;AAAA,UACb,aACE;AAAA,UACF,SACE,wDAAa,kBAAb,mBAA4B,YAA5B,mBAAqC,UAAS;AAAA,UAChD,YAAY,QACR,6CACA,wDAAa,kBAAb,mBAA4B,eAA5B,mBAAwC,UACxC;AAAA,UACJ,YAAY;AAAA,UACZ,QACE,wDAAa,kBAAb,mBAA4B,WAA5B,mBAAoC,UAAS;AAAA,QACjD;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAYA,cAAc,OAAO,QAAQ,OAAO,UAAU,CAAC,GAAG;AAnJpD;AAoJI,QAAI,WAAK,UAAL,mBAAY,UAAU;AACxB,UAAI,cAAc,CAAC;AACnB,UAAI,SAAS;AAEX,sBAAc,iCAAa,OAAO;AAAA,MACpC;AAEA,aAAO;AAAA,QACL,KAAK,KAAK,MAAM,SAAS,OAAO,OAAO,KAAK,UAAU,WAAW;AAAA,QACjE;AAAA,QACA,WAAW;AAAA,UACT,aACE;AAAA,UACF;AAAA,UACA,eAAe;AAAA,YACb,aACE;AAAA,YACF,SACE,wDAAa,kBAAb,mBAA4B,YAA5B,mBAAqC,UACrC;AAAA,YACF,YAAY,QACR,6CACA,wDAAa,kBAAb,mBAA4B,eAA5B,mBAAwC,UACxC;AAAA,YACJ,YAAY;AAAA,YACZ,QACE,wDAAa,kBAAb,mBAA4B,WAA5B,mBAAoC,UACpC;AAAA,UACJ;AAAA,UACA,iBAAiB,4CAAa,oBAAmB;AAAA,UACjD,sBAAsB,4CAAa,yBAAwB;AAAA,UAC3D,uBAAuB,4CAAa,0BAAyB;AAAA,QAC/D;AAAA,MACF;AAAA,IACF,OAAO;AACL,YAAM,IAAI,MACR;AAAA,qHACF;AAAA,IACF;AAAA,EACF;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": []
 }