@tgwf/co2 0.14.1 → 0.14.2

package/CHANGELOG.md

@@ -12,58 +12,92 @@ 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.13.8] - 2023-10-09
+### [0.14.1] - 2024-01-09
+
+#### 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
 
-- Fix: Properly use value of 0 for system segments and variables in the perByteTrace and perVisitTrace functions.
 - Automated monthly update of annual average grid intensity data.
 
-## [0.13.7] - 2023-09-13
+### [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.6] - 2023-08-08
+### [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
+### [0.13.5] - 2023-07-5
 
-### Changed
+#### Changed
 
 - Automated monthly update of annual average grid intensity data.
 
-## [0.13.4] - 2023-05-24
+### [0.13.4] - 2023-05-24
 
-### Fixed
+#### Fixed
 
 - Fixed an error when try to use global grid intensities in IIFE. (PR #147)
 
-## [0.13.3] - 2023-05-18
+### [0.13.3] - 2023-05-18
 
-### Changed
+#### 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
+### [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
+### [0.13.1] - 2023-04-20
 
-### Fixed
+#### Fixed
 
 - Fixed the import of average grid intensities in node. (PR #137)
 
-## [0.13.0] - 2023-04-13
+### [0.13.0] - 2023-04-13
 
-### Changed
+#### Changed
 
 In PR #135 there were significant changes made to how average annual grid intensities are fetched and generated.
 
@@ -73,59 +107,59 @@ In PR #135 there were significant changes made to how average annual grid intens
   - Get the _latest_ annual average values for each country/region.
 - Renamed the average grid intensities export file.
 
-## [0.12.2] - 2023-03-01
+### [0.12.2] - 2023-03-01
 
-### Added
+#### Added
 
 - Add a module declaration for use from typescript (PR #131)
 
-### Changed
+#### Changed
 
 - Updated 2021 average annual grid intensity values (PR #133)
 
-## [0.12.1] - 2023-02-02
+### [0.12.1] - 2023-02-02
 
-### Fixed
+#### Fixed
 
 - Removed incorrectly imported constants in tests.
 
-## [0.12.0] - 2023-02-02
+### [0.12.0] - 2023-02-02
 
-### Added
+#### 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
+#### 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
+### [0.11.4] - 2022-12-02
 
-### Fixed
+#### Fixed
 
 - Updated the `greenCheckMulti` function to work properly in ESM. (PR #123)
 
-## [0.11.3] - 2022-10-13
+### [0.11.3] - 2022-10-13
 
-### Fixed
+#### Fixed
 
 - Corrected the Node export for the hosting raised in issue #110. (PR #118)
 
-## [0.11.2] - 2022-10-11
+### [0.11.2] - 2022-10-11
 
-### Fixed
+#### 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
+### [0.11.1] - 2022-10-07
 
-### Changed
+#### 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
+### [0.11.0] - 2022-10-03
 
-### Added
+#### 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).
@@ -133,32 +167,32 @@ In PR #135 there were significant changes made to how average annual grid intens
 - 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).
 - 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)
@@ -166,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.
 
-## [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/dist/cjs/helpers/index.js

@@ -18,6 +18,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var helpers_exports = {};
 __export(helpers_exports, {
   formatNumber: () => formatNumber,
+  getApiRequestHeaders: () => getApiRequestHeaders,
   parseOptions: () => parseOptions
 });
 module.exports = __toCommonJS(helpers_exports);
@@ -159,4 +160,7 @@ Falling back to default value.`);
   }
   return adjustments;
 }
+function getApiRequestHeaders(comment = "") {
+  return { "User-Agent": `co2js/${"0.14.2"} ${comment}` };
+}
 //# sourceMappingURL=index.js.map

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/helpers/index.js"],
-  "sourcesContent": ["import { averageIntensity } from \"../index.js\";\nimport {\n  GLOBAL_GRID_INTENSITY,\n  PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD,\n  FIRST_TIME_VIEWING_PERCENTAGE,\n  RETURNING_VISITOR_PERCENTAGE,\n} from \"../constants/index.js\";\nconst formatNumber = (num) => parseFloat(num.toFixed(2));\n\nfunction parseOptions(options) {\n  // CHeck that it is an object\n  if (typeof options !== \"object\") {\n    throw new Error(\"Options must be an object\");\n  }\n\n  const adjustments = {};\n\n  if (options?.gridIntensity) {\n    adjustments.gridIntensity = {};\n    const { device, dataCenter, network } = options.gridIntensity;\n    if (device || device === 0) {\n      if (typeof device === \"object\") {\n        if (!averageIntensity.data[device.country?.toUpperCase()]) {\n          console.warn(\n            `\"${device.country}\" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \\nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information. \\nFalling back to global average grid intensity.`\n          );\n          adjustments.gridIntensity[\"device\"] = {\n            value: GLOBAL_GRID_INTENSITY,\n          };\n        }\n        adjustments.gridIntensity[\"device\"] = {\n          country: device.country,\n          value: parseFloat(\n            averageIntensity.data[device.country?.toUpperCase()]\n          ),\n        };\n      } else if (typeof device === \"number\") {\n        adjustments.gridIntensity[\"device\"] = {\n          value: device,\n        };\n      } else {\n        adjustments.gridIntensity[\"device\"] = {\n          value: GLOBAL_GRID_INTENSITY,\n        };\n        console.warn(\n          `The device grid intensity must be a number or an object. You passed in a ${typeof device}. \\nFalling back to global average grid intensity.`\n        );\n      }\n    }\n    if (dataCenter || dataCenter === 0) {\n      if (typeof dataCenter === \"object\") {\n        if (!averageIntensity.data[dataCenter.country?.toUpperCase()]) {\n          console.warn(\n            `\"${dataCenter.country}\" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \\nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information.  \\nFalling back to global average grid intensity.`\n          );\n          adjustments.gridIntensity[\"dataCenter\"] = {\n            value: GLOBAL_GRID_INTENSITY,\n          };\n        }\n        adjustments.gridIntensity[\"dataCenter\"] = {\n          country: dataCenter.country,\n          value: parseFloat(\n            averageIntensity.data[dataCenter.country?.toUpperCase()]\n          ),\n        };\n      } else if (typeof dataCenter === \"number\") {\n        adjustments.gridIntensity[\"dataCenter\"] = {\n          value: dataCenter,\n        };\n      } else {\n        adjustments.gridIntensity[\"dataCenter\"] = {\n          value: GLOBAL_GRID_INTENSITY,\n        };\n        console.warn(\n          `The data center grid intensity must be a number or an object. You passed in a ${typeof dataCenter}. \\nFalling back to global average grid intensity.`\n        );\n      }\n    }\n    if (network || network === 0) {\n      if (typeof network === \"object\") {\n        if (!averageIntensity.data[network.country?.toUpperCase()]) {\n          console.warn(\n            `\"${network.country}\" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \\nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information.  Falling back to global average grid intensity. \\nFalling back to global average grid intensity.`\n          );\n          adjustments.gridIntensity[\"network\"] = {\n            value: GLOBAL_GRID_INTENSITY,\n          };\n        }\n        adjustments.gridIntensity[\"network\"] = {\n          country: network.country,\n          value: parseFloat(\n            averageIntensity.data[network.country?.toUpperCase()]\n          ),\n        };\n      } else if (typeof network === \"number\") {\n        adjustments.gridIntensity[\"network\"] = {\n          value: network,\n        };\n      } else {\n        adjustments.gridIntensity[\"network\"] = {\n          value: GLOBAL_GRID_INTENSITY,\n        };\n        console.warn(\n          `The network grid intensity must be a number or an object. You passed in a ${typeof network}. \\nFalling back to global average grid intensity.`\n        );\n      }\n    }\n  }\n\n  if (options?.dataReloadRatio || options.dataReloadRatio === 0) {\n    if (typeof options.dataReloadRatio === \"number\") {\n      if (options.dataReloadRatio >= 0 && options.dataReloadRatio <= 1) {\n        adjustments.dataReloadRatio = options.dataReloadRatio;\n      } else {\n        adjustments.dataReloadRatio =\n          PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD;\n        console.warn(\n          `The dataReloadRatio option must be a number between 0 and 1. You passed in ${options.dataReloadRatio}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.dataReloadRatio =\n        PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD;\n      console.warn(\n        `The dataReloadRatio option must be a number. You passed in a ${typeof options.dataReloadRatio}. \\nFalling back to default value.`\n      );\n    }\n  }\n\n  if (options?.firstVisitPercentage || options.firstVisitPercentage === 0) {\n    if (typeof options.firstVisitPercentage === \"number\") {\n      if (\n        options.firstVisitPercentage >= 0 &&\n        options.firstVisitPercentage <= 1\n      ) {\n        adjustments.firstVisitPercentage = options.firstVisitPercentage;\n      } else {\n        adjustments.firstVisitPercentage = FIRST_TIME_VIEWING_PERCENTAGE;\n        console.warn(\n          `The firstVisitPercentage option must be a number between 0 and 1. You passed in ${options.firstVisitPercentage}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.firstVisitPercentage = FIRST_TIME_VIEWING_PERCENTAGE;\n      console.warn(\n        `The firstVisitPercentage option must be a number. You passed in a ${typeof options.firstVisitPercentage}. \\nFalling back to default value.`\n      );\n    }\n  }\n\n  if (options?.returnVisitPercentage || options.returnVisitPercentage === 0) {\n    if (typeof options.returnVisitPercentage === \"number\") {\n      if (\n        options.returnVisitPercentage >= 0 &&\n        options.returnVisitPercentage <= 1\n      ) {\n        adjustments.returnVisitPercentage = options.returnVisitPercentage;\n      } else {\n        adjustments.returnVisitPercentage = RETURNING_VISITOR_PERCENTAGE;\n        console.warn(\n          `The returnVisitPercentage option must be a number between 0 and 1. You passed in ${options.returnVisitPercentage}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.returnVisitPercentage = RETURNING_VISITOR_PERCENTAGE;\n      console.warn(\n        `The returnVisitPercentage option must be a number. You passed in a ${typeof options.returnVisitPercentage}. \\nFalling back to default value.`\n      );\n    }\n  }\n\n  return adjustments;\n}\n\nexport { formatNumber, parseOptions };\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,eAAiC;AACjC,uBAKO;AACP,MAAM,eAAe,CAAC,QAAQ,WAAW,IAAI,QAAQ,CAAC,CAAC;AAEvD,sBAAsB,SAAS;AAT/B;AAWE,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAM,IAAI,MAAM,2BAA2B;AAAA,EAC7C;AAEA,QAAM,cAAc,CAAC;AAErB,MAAI,mCAAS,eAAe;AAC1B,gBAAY,gBAAgB,CAAC;AAC7B,UAAM,EAAE,QAAQ,YAAY,YAAY,QAAQ;AAChD,QAAI,UAAU,WAAW,GAAG;AAC1B,UAAI,OAAO,WAAW,UAAU;AAC9B,YAAI,CAAC,0BAAiB,KAAK,aAAO,YAAP,mBAAgB,gBAAgB;AACzD,kBAAQ,KACN,IAAI,OAAO;AAAA;AAAA,+CACb;AACA,sBAAY,cAAc,YAAY;AAAA,YACpC,OAAO;AAAA,UACT;AAAA,QACF;AACA,oBAAY,cAAc,YAAY;AAAA,UACpC,SAAS,OAAO;AAAA,UAChB,OAAO,WACL,0BAAiB,KAAK,aAAO,YAAP,mBAAgB,cACxC;AAAA,QACF;AAAA,MACF,WAAW,OAAO,WAAW,UAAU;AACrC,oBAAY,cAAc,YAAY;AAAA,UACpC,OAAO;AAAA,QACT;AAAA,MACF,OAAO;AACL,oBAAY,cAAc,YAAY;AAAA,UACpC,OAAO;AAAA,QACT;AACA,gBAAQ,KACN,4EAA4E,OAAO;AAAA,+CACrF;AAAA,MACF;AAAA,IACF;AACA,QAAI,cAAc,eAAe,GAAG;AAClC,UAAI,OAAO,eAAe,UAAU;AAClC,YAAI,CAAC,0BAAiB,KAAK,iBAAW,YAAX,mBAAoB,gBAAgB;AAC7D,kBAAQ,KACN,IAAI,WAAW;AAAA;AAAA,+CACjB;AACA,sBAAY,cAAc,gBAAgB;AAAA,YACxC,OAAO;AAAA,UACT;AAAA,QACF;AACA,oBAAY,cAAc,gBAAgB;AAAA,UACxC,SAAS,WAAW;AAAA,UACpB,OAAO,WACL,0BAAiB,KAAK,iBAAW,YAAX,mBAAoB,cAC5C;AAAA,QACF;AAAA,MACF,WAAW,OAAO,eAAe,UAAU;AACzC,oBAAY,cAAc,gBAAgB;AAAA,UACxC,OAAO;AAAA,QACT;AAAA,MACF,OAAO;AACL,oBAAY,cAAc,gBAAgB;AAAA,UACxC,OAAO;AAAA,QACT;AACA,gBAAQ,KACN,iFAAiF,OAAO;AAAA,+CAC1F;AAAA,MACF;AAAA,IACF;AACA,QAAI,WAAW,YAAY,GAAG;AAC5B,UAAI,OAAO,YAAY,UAAU;AAC/B,YAAI,CAAC,0BAAiB,KAAK,cAAQ,YAAR,mBAAiB,gBAAgB;AAC1D,kBAAQ,KACN,IAAI,QAAQ;AAAA;AAAA,+CACd;AACA,sBAAY,cAAc,aAAa;AAAA,YACrC,OAAO;AAAA,UACT;AAAA,QACF;AACA,oBAAY,cAAc,aAAa;AAAA,UACrC,SAAS,QAAQ;AAAA,UACjB,OAAO,WACL,0BAAiB,KAAK,cAAQ,YAAR,mBAAiB,cACzC;AAAA,QACF;AAAA,MACF,WAAW,OAAO,YAAY,UAAU;AACtC,oBAAY,cAAc,aAAa;AAAA,UACrC,OAAO;AAAA,QACT;AAAA,MACF,OAAO;AACL,oBAAY,cAAc,aAAa;AAAA,UACrC,OAAO;AAAA,QACT;AACA,gBAAQ,KACN,6EAA6E,OAAO;AAAA,+CACtF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,MAAI,oCAAS,oBAAmB,QAAQ,oBAAoB,GAAG;AAC7D,QAAI,OAAO,QAAQ,oBAAoB,UAAU;AAC/C,UAAI,QAAQ,mBAAmB,KAAK,QAAQ,mBAAmB,GAAG;AAChE,oBAAY,kBAAkB,QAAQ;AAAA,MACxC,OAAO;AACL,oBAAY,kBACV;AACF,gBAAQ,KACN,8EAA8E,QAAQ;AAAA,+BACxF;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,kBACV;AACF,cAAQ,KACN,gEAAgE,OAAO,QAAQ;AAAA,+BACjF;AAAA,IACF;AAAA,EACF;AAEA,MAAI,oCAAS,yBAAwB,QAAQ,yBAAyB,GAAG;AACvE,QAAI,OAAO,QAAQ,yBAAyB,UAAU;AACpD,UACE,QAAQ,wBAAwB,KAChC,QAAQ,wBAAwB,GAChC;AACA,oBAAY,uBAAuB,QAAQ;AAAA,MAC7C,OAAO;AACL,oBAAY,uBAAuB;AACnC,gBAAQ,KACN,mFAAmF,QAAQ;AAAA,+BAC7F;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,uBAAuB;AACnC,cAAQ,KACN,qEAAqE,OAAO,QAAQ;AAAA,+BACtF;AAAA,IACF;AAAA,EACF;AAEA,MAAI,oCAAS,0BAAyB,QAAQ,0BAA0B,GAAG;AACzE,QAAI,OAAO,QAAQ,0BAA0B,UAAU;AACrD,UACE,QAAQ,yBAAyB,KACjC,QAAQ,yBAAyB,GACjC;AACA,oBAAY,wBAAwB,QAAQ;AAAA,MAC9C,OAAO;AACL,oBAAY,wBAAwB;AACpC,gBAAQ,KACN,oFAAoF,QAAQ;AAAA,+BAC9F;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,wBAAwB;AACpC,cAAQ,KACN,sEAAsE,OAAO,QAAQ;AAAA,+BACvF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;",
+  "sourcesContent": ["import { averageIntensity } from \"../index.js\";\nimport {\n  GLOBAL_GRID_INTENSITY,\n  PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD,\n  FIRST_TIME_VIEWING_PERCENTAGE,\n  RETURNING_VISITOR_PERCENTAGE,\n} from \"../constants/index.js\";\nconst formatNumber = (num) => parseFloat(num.toFixed(2));\n\nfunction parseOptions(options) {\n  // CHeck that it is an object\n  if (typeof options !== \"object\") {\n    throw new Error(\"Options must be an object\");\n  }\n\n  const adjustments = {};\n\n  if (options?.gridIntensity) {\n    adjustments.gridIntensity = {};\n    const { device, dataCenter, network } = options.gridIntensity;\n    if (device || device === 0) {\n      if (typeof device === \"object\") {\n        if (!averageIntensity.data[device.country?.toUpperCase()]) {\n          console.warn(\n            `\"${device.country}\" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \\nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information. \\nFalling back to global average grid intensity.`\n          );\n          adjustments.gridIntensity[\"device\"] = {\n            value: GLOBAL_GRID_INTENSITY,\n          };\n        }\n        adjustments.gridIntensity[\"device\"] = {\n          country: device.country,\n          value: parseFloat(\n            averageIntensity.data[device.country?.toUpperCase()]\n          ),\n        };\n      } else if (typeof device === \"number\") {\n        adjustments.gridIntensity[\"device\"] = {\n          value: device,\n        };\n      } else {\n        adjustments.gridIntensity[\"device\"] = {\n          value: GLOBAL_GRID_INTENSITY,\n        };\n        console.warn(\n          `The device grid intensity must be a number or an object. You passed in a ${typeof device}. \\nFalling back to global average grid intensity.`\n        );\n      }\n    }\n    if (dataCenter || dataCenter === 0) {\n      if (typeof dataCenter === \"object\") {\n        if (!averageIntensity.data[dataCenter.country?.toUpperCase()]) {\n          console.warn(\n            `\"${dataCenter.country}\" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \\nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information.  \\nFalling back to global average grid intensity.`\n          );\n          adjustments.gridIntensity[\"dataCenter\"] = {\n            value: GLOBAL_GRID_INTENSITY,\n          };\n        }\n        adjustments.gridIntensity[\"dataCenter\"] = {\n          country: dataCenter.country,\n          value: parseFloat(\n            averageIntensity.data[dataCenter.country?.toUpperCase()]\n          ),\n        };\n      } else if (typeof dataCenter === \"number\") {\n        adjustments.gridIntensity[\"dataCenter\"] = {\n          value: dataCenter,\n        };\n      } else {\n        adjustments.gridIntensity[\"dataCenter\"] = {\n          value: GLOBAL_GRID_INTENSITY,\n        };\n        console.warn(\n          `The data center grid intensity must be a number or an object. You passed in a ${typeof dataCenter}. \\nFalling back to global average grid intensity.`\n        );\n      }\n    }\n    if (network || network === 0) {\n      if (typeof network === \"object\") {\n        if (!averageIntensity.data[network.country?.toUpperCase()]) {\n          console.warn(\n            `\"${network.country}\" is not a valid country. Please use a valid 3 digit ISO 3166 country code. \\nSee https://developers.thegreenwebfoundation.org/co2js/data/ for more information.  Falling back to global average grid intensity. \\nFalling back to global average grid intensity.`\n          );\n          adjustments.gridIntensity[\"network\"] = {\n            value: GLOBAL_GRID_INTENSITY,\n          };\n        }\n        adjustments.gridIntensity[\"network\"] = {\n          country: network.country,\n          value: parseFloat(\n            averageIntensity.data[network.country?.toUpperCase()]\n          ),\n        };\n      } else if (typeof network === \"number\") {\n        adjustments.gridIntensity[\"network\"] = {\n          value: network,\n        };\n      } else {\n        adjustments.gridIntensity[\"network\"] = {\n          value: GLOBAL_GRID_INTENSITY,\n        };\n        console.warn(\n          `The network grid intensity must be a number or an object. You passed in a ${typeof network}. \\nFalling back to global average grid intensity.`\n        );\n      }\n    }\n  }\n\n  if (options?.dataReloadRatio || options.dataReloadRatio === 0) {\n    if (typeof options.dataReloadRatio === \"number\") {\n      if (options.dataReloadRatio >= 0 && options.dataReloadRatio <= 1) {\n        adjustments.dataReloadRatio = options.dataReloadRatio;\n      } else {\n        adjustments.dataReloadRatio =\n          PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD;\n        console.warn(\n          `The dataReloadRatio option must be a number between 0 and 1. You passed in ${options.dataReloadRatio}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.dataReloadRatio =\n        PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD;\n      console.warn(\n        `The dataReloadRatio option must be a number. You passed in a ${typeof options.dataReloadRatio}. \\nFalling back to default value.`\n      );\n    }\n  }\n\n  if (options?.firstVisitPercentage || options.firstVisitPercentage === 0) {\n    if (typeof options.firstVisitPercentage === \"number\") {\n      if (\n        options.firstVisitPercentage >= 0 &&\n        options.firstVisitPercentage <= 1\n      ) {\n        adjustments.firstVisitPercentage = options.firstVisitPercentage;\n      } else {\n        adjustments.firstVisitPercentage = FIRST_TIME_VIEWING_PERCENTAGE;\n        console.warn(\n          `The firstVisitPercentage option must be a number between 0 and 1. You passed in ${options.firstVisitPercentage}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.firstVisitPercentage = FIRST_TIME_VIEWING_PERCENTAGE;\n      console.warn(\n        `The firstVisitPercentage option must be a number. You passed in a ${typeof options.firstVisitPercentage}. \\nFalling back to default value.`\n      );\n    }\n  }\n\n  if (options?.returnVisitPercentage || options.returnVisitPercentage === 0) {\n    if (typeof options.returnVisitPercentage === \"number\") {\n      if (\n        options.returnVisitPercentage >= 0 &&\n        options.returnVisitPercentage <= 1\n      ) {\n        adjustments.returnVisitPercentage = options.returnVisitPercentage;\n      } else {\n        adjustments.returnVisitPercentage = RETURNING_VISITOR_PERCENTAGE;\n        console.warn(\n          `The returnVisitPercentage option must be a number between 0 and 1. You passed in ${options.returnVisitPercentage}. \\nFalling back to default value.`\n        );\n      }\n    } else {\n      adjustments.returnVisitPercentage = RETURNING_VISITOR_PERCENTAGE;\n      console.warn(\n        `The returnVisitPercentage option must be a number. You passed in a ${typeof options.returnVisitPercentage}. \\nFalling back to default value.`\n      );\n    }\n  }\n\n  return adjustments;\n}\n\n/**\n * Returns an object containing all the HTTP headers to use when making a request to the Green Web Foundation API.\n * @param {string} comment - Optional. The app, site, or organisation that is making the request.\n *\n * @returns {import('http').OutgoingHttpHeaders}\n */\nfunction getApiRequestHeaders(comment = \"\") {\n  return { \"User-Agent\": `co2js/${process.env.CO2JS_VERSION} ${comment}` };\n}\n\nexport { formatNumber, parseOptions, getApiRequestHeaders };\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,eAAiC;AACjC,uBAKO;AACP,MAAM,eAAe,CAAC,QAAQ,WAAW,IAAI,QAAQ,CAAC,CAAC;AAEvD,sBAAsB,SAAS;AAT/B;AAWE,MAAI,OAAO,YAAY,UAAU;AAC/B,UAAM,IAAI,MAAM,2BAA2B;AAAA,EAC7C;AAEA,QAAM,cAAc,CAAC;AAErB,MAAI,mCAAS,eAAe;AAC1B,gBAAY,gBAAgB,CAAC;AAC7B,UAAM,EAAE,QAAQ,YAAY,YAAY,QAAQ;AAChD,QAAI,UAAU,WAAW,GAAG;AAC1B,UAAI,OAAO,WAAW,UAAU;AAC9B,YAAI,CAAC,0BAAiB,KAAK,aAAO,YAAP,mBAAgB,gBAAgB;AACzD,kBAAQ,KACN,IAAI,OAAO;AAAA;AAAA,+CACb;AACA,sBAAY,cAAc,YAAY;AAAA,YACpC,OAAO;AAAA,UACT;AAAA,QACF;AACA,oBAAY,cAAc,YAAY;AAAA,UACpC,SAAS,OAAO;AAAA,UAChB,OAAO,WACL,0BAAiB,KAAK,aAAO,YAAP,mBAAgB,cACxC;AAAA,QACF;AAAA,MACF,WAAW,OAAO,WAAW,UAAU;AACrC,oBAAY,cAAc,YAAY;AAAA,UACpC,OAAO;AAAA,QACT;AAAA,MACF,OAAO;AACL,oBAAY,cAAc,YAAY;AAAA,UACpC,OAAO;AAAA,QACT;AACA,gBAAQ,KACN,4EAA4E,OAAO;AAAA,+CACrF;AAAA,MACF;AAAA,IACF;AACA,QAAI,cAAc,eAAe,GAAG;AAClC,UAAI,OAAO,eAAe,UAAU;AAClC,YAAI,CAAC,0BAAiB,KAAK,iBAAW,YAAX,mBAAoB,gBAAgB;AAC7D,kBAAQ,KACN,IAAI,WAAW;AAAA;AAAA,+CACjB;AACA,sBAAY,cAAc,gBAAgB;AAAA,YACxC,OAAO;AAAA,UACT;AAAA,QACF;AACA,oBAAY,cAAc,gBAAgB;AAAA,UACxC,SAAS,WAAW;AAAA,UACpB,OAAO,WACL,0BAAiB,KAAK,iBAAW,YAAX,mBAAoB,cAC5C;AAAA,QACF;AAAA,MACF,WAAW,OAAO,eAAe,UAAU;AACzC,oBAAY,cAAc,gBAAgB;AAAA,UACxC,OAAO;AAAA,QACT;AAAA,MACF,OAAO;AACL,oBAAY,cAAc,gBAAgB;AAAA,UACxC,OAAO;AAAA,QACT;AACA,gBAAQ,KACN,iFAAiF,OAAO;AAAA,+CAC1F;AAAA,MACF;AAAA,IACF;AACA,QAAI,WAAW,YAAY,GAAG;AAC5B,UAAI,OAAO,YAAY,UAAU;AAC/B,YAAI,CAAC,0BAAiB,KAAK,cAAQ,YAAR,mBAAiB,gBAAgB;AAC1D,kBAAQ,KACN,IAAI,QAAQ;AAAA;AAAA,+CACd;AACA,sBAAY,cAAc,aAAa;AAAA,YACrC,OAAO;AAAA,UACT;AAAA,QACF;AACA,oBAAY,cAAc,aAAa;AAAA,UACrC,SAAS,QAAQ;AAAA,UACjB,OAAO,WACL,0BAAiB,KAAK,cAAQ,YAAR,mBAAiB,cACzC;AAAA,QACF;AAAA,MACF,WAAW,OAAO,YAAY,UAAU;AACtC,oBAAY,cAAc,aAAa;AAAA,UACrC,OAAO;AAAA,QACT;AAAA,MACF,OAAO;AACL,oBAAY,cAAc,aAAa;AAAA,UACrC,OAAO;AAAA,QACT;AACA,gBAAQ,KACN,6EAA6E,OAAO;AAAA,+CACtF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,MAAI,oCAAS,oBAAmB,QAAQ,oBAAoB,GAAG;AAC7D,QAAI,OAAO,QAAQ,oBAAoB,UAAU;AAC/C,UAAI,QAAQ,mBAAmB,KAAK,QAAQ,mBAAmB,GAAG;AAChE,oBAAY,kBAAkB,QAAQ;AAAA,MACxC,OAAO;AACL,oBAAY,kBACV;AACF,gBAAQ,KACN,8EAA8E,QAAQ;AAAA,+BACxF;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,kBACV;AACF,cAAQ,KACN,gEAAgE,OAAO,QAAQ;AAAA,+BACjF;AAAA,IACF;AAAA,EACF;AAEA,MAAI,oCAAS,yBAAwB,QAAQ,yBAAyB,GAAG;AACvE,QAAI,OAAO,QAAQ,yBAAyB,UAAU;AACpD,UACE,QAAQ,wBAAwB,KAChC,QAAQ,wBAAwB,GAChC;AACA,oBAAY,uBAAuB,QAAQ;AAAA,MAC7C,OAAO;AACL,oBAAY,uBAAuB;AACnC,gBAAQ,KACN,mFAAmF,QAAQ;AAAA,+BAC7F;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,uBAAuB;AACnC,cAAQ,KACN,qEAAqE,OAAO,QAAQ;AAAA,+BACtF;AAAA,IACF;AAAA,EACF;AAEA,MAAI,oCAAS,0BAAyB,QAAQ,0BAA0B,GAAG;AACzE,QAAI,OAAO,QAAQ,0BAA0B,UAAU;AACrD,UACE,QAAQ,yBAAyB,KACjC,QAAQ,yBAAyB,GACjC;AACA,oBAAY,wBAAwB,QAAQ;AAAA,MAC9C,OAAO;AACL,oBAAY,wBAAwB;AACpC,gBAAQ,KACN,oFAAoF,QAAQ;AAAA,+BAC9F;AAAA,MACF;AAAA,IACF,OAAO;AACL,kBAAY,wBAAwB;AACpC,cAAQ,KACN,sEAAsE,OAAO,QAAQ;AAAA,+BACvF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;AAQA,8BAA8B,UAAU,IAAI;AAC1C,SAAO,EAAE,cAAc,SAAS,YAA6B,UAAU;AACzE;",
   "names": []
 }

package/dist/cjs/hosting-api.js

@@ -21,23 +21,28 @@ __export(hosting_api_exports, {
   default: () => hosting_api_default
 });
 module.exports = __toCommonJS(hosting_api_exports);
-function check(domain) {
+var import_helpers = require("./helpers/index.js");
+function check(domain, userAgentIdentifier) {
   if (typeof domain === "string") {
-    return checkAgainstAPI(domain);
+    return checkAgainstAPI(domain, userAgentIdentifier);
   } else {
-    return checkDomainsAgainstAPI(domain);
+    return checkDomainsAgainstAPI(domain, userAgentIdentifier);
   }
 }
-async function checkAgainstAPI(domain) {
-  const req = await fetch(`https://api.thegreenwebfoundation.org/greencheck/${domain}`);
+async function checkAgainstAPI(domain, userAgentIdentifier) {
+  const req = await fetch(`https://api.thegreenwebfoundation.org/greencheck/${domain}`, {
+    headers: (0, import_helpers.getApiRequestHeaders)(userAgentIdentifier)
+  });
   const res = await req.json();
   return res.green;
 }
-async function checkDomainsAgainstAPI(domains) {
+async function checkDomainsAgainstAPI(domains, userAgentIdentifier) {
   try {
     const apiPath = "https://api.thegreenwebfoundation.org/v2/greencheckmulti";
     const domainsString = JSON.stringify(domains);
-    const req = await fetch(`${apiPath}/${domainsString}`);
+    const req = await fetch(`${apiPath}/${domainsString}`, {
+      headers: (0, import_helpers.getApiRequestHeaders)(userAgentIdentifier)
+    });
     const allGreenCheckResults = await req.json();
     return greenDomainsFromResults(allGreenCheckResults);
   } catch (e) {

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/hosting-api.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 */\n\nfunction check(domain) {\n  // is it a single domain or an array of them?\n  if (typeof domain === \"string\") {\n    return checkAgainstAPI(domain);\n  } else {\n    return checkDomainsAgainstAPI(domain);\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 * @returns {boolean} - A boolean indicating whether the domain is hosted by a green web host.\n */\nasync function checkAgainstAPI(domain) {\n  const req = await fetch(\n    `https://api.thegreenwebfoundation.org/greencheck/${domain}`\n  );\n  const res = await req.json();\n  return 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 * @returns {array} - An array of domains that are hosted by a green web host.\n */\n\nasync function checkDomainsAgainstAPI(domains) {\n  try {\n    const apiPath = \"https://api.thegreenwebfoundation.org/v2/greencheckmulti\";\n    const domainsString = JSON.stringify(domains);\n\n    const req = await fetch(`${apiPath}/${domainsString}`);\n\n    const allGreenCheckResults = await req.json();\n\n    return greenDomainsFromResults(allGreenCheckResults);\n  } catch (e) {\n    return [];\n  }\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  return greenEntries.map(([key, val]) => val.url);\n}\n\nexport default {\n  check,\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAOA,eAAe,QAAQ;AAErB,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,gBAAgB,MAAM;AAAA,EAC/B,OAAO;AACL,WAAO,uBAAuB,MAAM;AAAA,EACtC;AACF;AAOA,+BAA+B,QAAQ;AACrC,QAAM,MAAM,MAAM,MAChB,oDAAoD,QACtD;AACA,QAAM,MAAM,MAAM,IAAI,KAAK;AAC3B,SAAO,IAAI;AACb;AAQA,sCAAsC,SAAS;AAC7C,MAAI;AACF,UAAM,UAAU;AAChB,UAAM,gBAAgB,KAAK,UAAU,OAAO;AAE5C,UAAM,MAAM,MAAM,MAAM,GAAG,WAAW,eAAe;AAErD,UAAM,uBAAuB,MAAM,IAAI,KAAK;AAE5C,WAAO,wBAAwB,oBAAoB;AAAA,EACrD,SAAS,GAAP;AACA,WAAO,CAAC;AAAA,EACV;AACF;AAOA,iCAAiC,cAAc;AAC7C,QAAM,UAAU,OAAO,QAAQ,YAAY;AAC3C,QAAM,eAAe,QAAQ,OAAO,CAAC,CAAC,KAAK,SAAS,IAAI,KAAK;AAC7D,SAAO,aAAa,IAAI,CAAC,CAAC,KAAK,SAAS,IAAI,GAAG;AACjD;AAEA,IAAO,sBAAQ;AAAA,EACb;AACF;",
+  "sourcesContent": ["\"use strict\";\n\nimport { getApiRequestHeaders } from \"./helpers/index.js\";\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 * @param {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.\n */\n\nfunction check(domain, userAgentIdentifier) {\n  // is it a single domain or an array of them?\n  if (typeof domain === \"string\") {\n    return checkAgainstAPI(domain, userAgentIdentifier);\n  } else {\n    return checkDomainsAgainstAPI(domain, userAgentIdentifier);\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 {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.\n * @returns {boolean} - A boolean indicating whether the domain is hosted by a green web host.\n */\nasync function checkAgainstAPI(domain, userAgentIdentifier) {\n  const req = await fetch(\n    `https://api.thegreenwebfoundation.org/greencheck/${domain}`,\n    {\n      headers: getApiRequestHeaders(userAgentIdentifier),\n    }\n  );\n  const res = await req.json();\n  return 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 {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.\n * @returns {array} - An array of domains that are hosted by a green web host.\n */\n\nasync function checkDomainsAgainstAPI(domains, userAgentIdentifier) {\n  try {\n    const apiPath = \"https://api.thegreenwebfoundation.org/v2/greencheckmulti\";\n    const domainsString = JSON.stringify(domains);\n\n    const req = await fetch(`${apiPath}/${domainsString}`, {\n      headers: getApiRequestHeaders(userAgentIdentifier),\n    });\n\n    const allGreenCheckResults = await req.json();\n\n    return greenDomainsFromResults(allGreenCheckResults);\n  } catch (e) {\n    return [];\n  }\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  return greenEntries.map(([key, val]) => val.url);\n}\n\nexport default {\n  check,\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,qBAAqC;AAQrC,eAAe,QAAQ,qBAAqB;AAE1C,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,gBAAgB,QAAQ,mBAAmB;AAAA,EACpD,OAAO;AACL,WAAO,uBAAuB,QAAQ,mBAAmB;AAAA,EAC3D;AACF;AAQA,+BAA+B,QAAQ,qBAAqB;AAC1D,QAAM,MAAM,MAAM,MAChB,oDAAoD,UACpD;AAAA,IACE,SAAS,yCAAqB,mBAAmB;AAAA,EACnD,CACF;AACA,QAAM,MAAM,MAAM,IAAI,KAAK;AAC3B,SAAO,IAAI;AACb;AASA,sCAAsC,SAAS,qBAAqB;AAClE,MAAI;AACF,UAAM,UAAU;AAChB,UAAM,gBAAgB,KAAK,UAAU,OAAO;AAE5C,UAAM,MAAM,MAAM,MAAM,GAAG,WAAW,iBAAiB;AAAA,MACrD,SAAS,yCAAqB,mBAAmB;AAAA,IACnD,CAAC;AAED,UAAM,uBAAuB,MAAM,IAAI,KAAK;AAE5C,WAAO,wBAAwB,oBAAoB;AAAA,EACrD,SAAS,GAAP;AACA,WAAO,CAAC;AAAA,EACV;AACF;AAOA,iCAAiC,cAAc;AAC7C,QAAM,UAAU,OAAO,QAAQ,YAAY;AAC3C,QAAM,eAAe,QAAQ,OAAO,CAAC,CAAC,KAAK,SAAS,IAAI,KAAK;AAC7D,SAAO,aAAa,IAAI,CAAC,CAAC,KAAK,SAAS,IAAI,GAAG;AACjD;AAEA,IAAO,sBAAQ;AAAA,EACb;AACF;",
   "names": []
 }

package/dist/cjs/hosting-node.js

@@ -25,9 +25,10 @@ __export(hosting_node_exports, {
 module.exports = __toCommonJS(hosting_node_exports);
 var import_https = __toESM(require("https"));
 var import_hosting_json_node = __toESM(require("./hosting-json.node.js"));
-async function getBody(url) {
+var import_helpers = require("./helpers/index.js");
+async function getBody(url, userAgentIdentifier) {
   return new Promise(function(resolve, reject) {
-    const req = import_https.default.get(url, function(res) {
+    const req = import_https.default.get(url, { headers: (0, import_helpers.getApiRequestHeaders)(userAgentIdentifier) }, function(res) {
       if (res.statusCode < 200 || res.statusCode >= 300) {
         return reject(new Error(`Could not get info from: ${url}. Status Code: ${res.statusCode}`));
       }
@@ -40,23 +41,23 @@ async function getBody(url) {
     req.end();
   });
 }
-function check(domain, db) {
+function check(domain, db, userAgentIdentifier) {
   if (db) {
     return import_hosting_json_node.default.check(domain, db);
   }
   if (typeof domain === "string") {
-    return checkAgainstAPI(domain);
+    return checkAgainstAPI(domain, userAgentIdentifier);
   } else {
-    return checkDomainsAgainstAPI(domain);
+    return checkDomainsAgainstAPI(domain, userAgentIdentifier);
   }
 }
-async function checkAgainstAPI(domain) {
-  const res = JSON.parse(await getBody(`https://api.thegreenwebfoundation.org/greencheck/${domain}`));
+async function checkAgainstAPI(domain, userAgentIdentifier) {
+  const res = JSON.parse(await getBody(`https://api.thegreenwebfoundation.org/greencheck/${domain}`, userAgentIdentifier));
   return res.green;
 }
-async function checkDomainsAgainstAPI(domains) {
+async function checkDomainsAgainstAPI(domains, userAgentIdentifier) {
   try {
-    const allGreenCheckResults = JSON.parse(await getBody(`https://api.thegreenwebfoundation.org/v2/greencheckmulti/${JSON.stringify(domains)}`));
+    const allGreenCheckResults = JSON.parse(await getBody(`https://api.thegreenwebfoundation.org/v2/greencheckmulti/${JSON.stringify(domains)}`, userAgentIdentifier));
     return import_hosting_json_node.default.greenDomainsFromResults(allGreenCheckResults);
   } catch (e) {
     return [];

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

@@ -1,7 +1,7 @@
 {
   "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.node.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 * @return {string}\n */\nasync function getBody(url) {\n  return new Promise(function (resolve, reject) {\n    // Do async job\n    const req = https.get(url, 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    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 {object} db - Optional. A database object to use for lookups.\n * @returns {boolean|array} - A boolean if a string was provided, or an array of booleans if an array of domains was provided.\n */\n\nfunction check(domain, db) {\n  if (db) {\n    return hostingJSON.check(domain, db);\n  }\n\n  // is it a single domain or an array of them?\n  if (typeof domain === \"string\") {\n    return checkAgainstAPI(domain);\n  } else {\n    return checkDomainsAgainstAPI(domain);\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 * @returns {boolean} - A boolean indicating whether the domain is hosted by a green web host.\n */\nasync function checkAgainstAPI(domain) {\n  const res = JSON.parse(\n    await getBody(`https://api.thegreenwebfoundation.org/greencheck/${domain}`)\n  );\n  return 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 * @returns {array} - An array of domains that are hosted by a green web host.\n */\nasync function checkDomainsAgainstAPI(domains) {\n  try {\n    const allGreenCheckResults = JSON.parse(\n      await getBody(\n        `https://api.thegreenwebfoundation.org/v2/greencheckmulti/${JSON.stringify(\n          domains\n        )}`\n      )\n    );\n    return hostingJSON.greenDomainsFromResults(allGreenCheckResults);\n  } catch (e) {\n    return [];\n  }\n}\n\n/**\n * Take the result of a pageXray and check the domains in it against the database.\n * @param {object} pageXray - The result of a pageXray.\n * @param {object} db - A database object to use for lookups.\n * @returns {array} - An array indicating whether the domain is hosted by a green web host.\n */\nasync function checkPage(pageXray, db) {\n  const domains = Object.keys(pageXray.domains);\n  return check(domains, db);\n}\n\nexport default {\n  check,\n  checkPage,\n  greendomains: hostingJSON.greenDomainsFromResults,\n  loadJSON: hostingJSON.loadJSON,\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,mBAAkB;AAElB,+BAAwB;AASxB,uBAAuB,KAAK;AAC1B,SAAO,IAAI,QAAQ,SAAU,SAAS,QAAQ;AAE5C,UAAM,MAAM,qBAAM,IAAI,KAAK,SAAU,KAAK;AACxC,UAAI,IAAI,aAAa,OAAO,IAAI,cAAc,KAAK;AACjD,eAAO,OACL,IAAI,MACF,4BAA4B,qBAAqB,IAAI,YACvD,CACF;AAAA,MACF;AACA,YAAM,OAAO,CAAC;AAEd,UAAI,GAAG,QAAQ,CAAC,UAAU;AACxB,aAAK,KAAK,KAAK;AAAA,MACjB,CAAC;AAED,UAAI,GAAG,OAAO,MAAM,QAAQ,OAAO,OAAO,IAAI,EAAE,SAAS,CAAC,CAAC;AAAA,IAC7D,CAAC;AACD,QAAI,IAAI;AAAA,EACV,CAAC;AACH;AASA,eAAe,QAAQ,IAAI;AACzB,MAAI,IAAI;AACN,WAAO,iCAAY,MAAM,QAAQ,EAAE;AAAA,EACrC;AAGA,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,gBAAgB,MAAM;AAAA,EAC/B,OAAO;AACL,WAAO,uBAAuB,MAAM;AAAA,EACtC;AACF;AAOA,+BAA+B,QAAQ;AACrC,QAAM,MAAM,KAAK,MACf,MAAM,QAAQ,oDAAoD,QAAQ,CAC5E;AACA,SAAO,IAAI;AACb;AAOA,sCAAsC,SAAS;AAC7C,MAAI;AACF,UAAM,uBAAuB,KAAK,MAChC,MAAM,QACJ,4DAA4D,KAAK,UAC/D,OACF,GACF,CACF;AACA,WAAO,iCAAY,wBAAwB,oBAAoB;AAAA,EACjE,SAAS,GAAP;AACA,WAAO,CAAC;AAAA,EACV;AACF;AAQA,yBAAyB,UAAU,IAAI;AACrC,QAAM,UAAU,OAAO,KAAK,SAAS,OAAO;AAC5C,SAAO,MAAM,SAAS,EAAE;AAC1B;AAEA,IAAO,uBAAQ;AAAA,EACb;AAAA,EACA;AAAA,EACA,cAAc,iCAAY;AAAA,EAC1B,UAAU,iCAAY;AACxB;",
+  "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.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 {object} db - Optional. A database object to use for lookups.\n * @param {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.\n * @returns {boolean|array} - A boolean if a string was provided, or an array of booleans if an array of domains was provided.\n */\n\nfunction check(domain, db, userAgentIdentifier) {\n  if (db) {\n    return hostingJSON.check(domain, db);\n  }\n\n  // is it a single domain or an array of them?\n  if (typeof domain === \"string\") {\n    return checkAgainstAPI(domain, userAgentIdentifier);\n  } else {\n    return checkDomainsAgainstAPI(domain, userAgentIdentifier);\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 {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.\n * @returns {boolean} - A boolean indicating whether the domain is hosted by a green web host.\n */\nasync function checkAgainstAPI(domain, userAgentIdentifier) {\n  const res = JSON.parse(\n    await getBody(\n      `https://api.thegreenwebfoundation.org/greencheck/${domain}`,\n      userAgentIdentifier\n    )\n  );\n  return 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 {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.\n * @returns {array} - An array of domains that are hosted by a green web host.\n */\nasync function checkDomainsAgainstAPI(domains, userAgentIdentifier) {\n  try {\n    const allGreenCheckResults = JSON.parse(\n      await getBody(\n        `https://api.thegreenwebfoundation.org/v2/greencheckmulti/${JSON.stringify(\n          domains\n        )}`,\n        userAgentIdentifier\n      )\n    );\n    return hostingJSON.greenDomainsFromResults(allGreenCheckResults);\n  } catch (e) {\n    return [];\n  }\n}\n\n/**\n * Take the result of a pageXray and check the domains in it against the database.\n * @param {object} pageXray - The result of a pageXray.\n * @param {object} db - A database object to use for lookups.\n * @returns {array} - An array indicating whether the domain is hosted by a green web host.\n */\nasync function checkPage(pageXray, db) {\n  const domains = Object.keys(pageXray.domains);\n  return check(domains, db);\n}\n\nexport default {\n  check,\n  checkPage,\n  greendomains: hostingJSON.greenDomainsFromResults,\n  loadJSON: hostingJSON.loadJSON,\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAUA,mBAAkB;AAElB,+BAAwB;AACxB,qBAAqC;AAUrC,uBAAuB,KAAK,qBAAqB;AAC/C,SAAO,IAAI,QAAQ,SAAU,SAAS,QAAQ;AAE5C,UAAM,MAAM,qBAAM,IAChB,KACA,EAAE,SAAS,yCAAqB,mBAAmB,EAAE,GACrD,SAAU,KAAK;AACb,UAAI,IAAI,aAAa,OAAO,IAAI,cAAc,KAAK;AACjD,eAAO,OACL,IAAI,MACF,4BAA4B,qBAAqB,IAAI,YACvD,CACF;AAAA,MACF;AACA,YAAM,OAAO,CAAC;AAEd,UAAI,GAAG,QAAQ,CAAC,UAAU;AACxB,aAAK,KAAK,KAAK;AAAA,MACjB,CAAC;AAED,UAAI,GAAG,OAAO,MAAM,QAAQ,OAAO,OAAO,IAAI,EAAE,SAAS,CAAC,CAAC;AAAA,IAC7D,CACF;AACA,QAAI,IAAI;AAAA,EACV,CAAC;AACH;AAUA,eAAe,QAAQ,IAAI,qBAAqB;AAC9C,MAAI,IAAI;AACN,WAAO,iCAAY,MAAM,QAAQ,EAAE;AAAA,EACrC;AAGA,MAAI,OAAO,WAAW,UAAU;AAC9B,WAAO,gBAAgB,QAAQ,mBAAmB;AAAA,EACpD,OAAO;AACL,WAAO,uBAAuB,QAAQ,mBAAmB;AAAA,EAC3D;AACF;AAQA,+BAA+B,QAAQ,qBAAqB;AAC1D,QAAM,MAAM,KAAK,MACf,MAAM,QACJ,oDAAoD,UACpD,mBACF,CACF;AACA,SAAO,IAAI;AACb;AAQA,sCAAsC,SAAS,qBAAqB;AAClE,MAAI;AACF,UAAM,uBAAuB,KAAK,MAChC,MAAM,QACJ,4DAA4D,KAAK,UAC/D,OACF,KACA,mBACF,CACF;AACA,WAAO,iCAAY,wBAAwB,oBAAoB;AAAA,EACjE,SAAS,GAAP;AACA,WAAO,CAAC;AAAA,EACV;AACF;AAQA,yBAAyB,UAAU,IAAI;AACrC,QAAM,UAAU,OAAO,KAAK,SAAS,OAAO;AAC5C,SAAO,MAAM,SAAS,EAAE;AAC1B;AAEA,IAAO,uBAAQ;AAAA,EACb;AAAA,EACA;AAAA,EACA,cAAc,iCAAY;AAAA,EAC1B,UAAU,iCAAY;AACxB;",
   "names": []
 }

package/dist/cjs/hosting.js

@@ -25,8 +25,8 @@ __export(hosting_exports, {
 });
 module.exports = __toCommonJS(hosting_exports);
 var import_hosting_api = __toESM(require("./hosting-api.js"));
-function check(domain) {
-  return import_hosting_api.default.check(domain);
+function check(domain, userAgentIdentifier) {
+  return import_hosting_api.default.check(domain, userAgentIdentifier);
 }
 var hosting_default = {
   check

package/dist/cjs/hosting.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/hosting.js"],
-  "sourcesContent": ["\"use strict\";\n\nimport hostingAPI from \"./hosting-api.js\";\n\n/**\n * Check if a domain is hosted by a green web host.\n * @param {string|array} domain - The domain to check, or an array of domains to be checked.\n * @returns {boolean|array} - A boolean if a string was provided, or an array of booleans if an array of domains was provided.\n */\nfunction check(domain) {\n  return hostingAPI.check(domain);\n}\n\nexport default {\n  check,\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,yBAAuB;AAOvB,eAAe,QAAQ;AACrB,SAAO,2BAAW,MAAM,MAAM;AAChC;AAEA,IAAO,kBAAQ;AAAA,EACb;AACF;",
+  "sourcesContent": ["\"use strict\";\n\nimport hostingAPI from \"./hosting-api.js\";\n\n/**\n * Check if a domain is hosted by a green web host.\n * @param {string|array} domain - The domain to check, or an array of domains to be checked.\n * @param {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.\n * @returns {boolean|array} - A boolean if a string was provided, or an array of booleans if an array of domains was provided.\n */\nfunction check(domain, userAgentIdentifier) {\n  return hostingAPI.check(domain, userAgentIdentifier);\n}\n\nexport default {\n  check,\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,yBAAuB;AAQvB,eAAe,QAAQ,qBAAqB;AAC1C,SAAO,2BAAW,MAAM,QAAQ,mBAAmB;AACrD;AAEA,IAAO,kBAAQ;AAAA,EACb;AACF;",
   "names": []
 }

package/dist/esm/helpers/index.js

@@ -141,7 +141,11 @@ Falling back to default value.`);
   }
   return adjustments;
 }
+function getApiRequestHeaders(comment = "") {
+  return { "User-Agent": `co2js/${"0.14.2"} ${comment}` };
+}
 export {
   formatNumber,
+  getApiRequestHeaders,
   parseOptions
 };

package/dist/esm/hosting-api.js

@@ -1,21 +1,26 @@
 "use strict";
-function check(domain) {
+import { getApiRequestHeaders } from "./helpers/index.js";
+function check(domain, userAgentIdentifier) {
   if (typeof domain === "string") {
-    return checkAgainstAPI(domain);
+    return checkAgainstAPI(domain, userAgentIdentifier);
   } else {
-    return checkDomainsAgainstAPI(domain);
+    return checkDomainsAgainstAPI(domain, userAgentIdentifier);
   }
 }
-async function checkAgainstAPI(domain) {
-  const req = await fetch(`https://api.thegreenwebfoundation.org/greencheck/${domain}`);
+async function checkAgainstAPI(domain, userAgentIdentifier) {
+  const req = await fetch(`https://api.thegreenwebfoundation.org/greencheck/${domain}`, {
+    headers: getApiRequestHeaders(userAgentIdentifier)
+  });
   const res = await req.json();
   return res.green;
 }
-async function checkDomainsAgainstAPI(domains) {
+async function checkDomainsAgainstAPI(domains, userAgentIdentifier) {
   try {
     const apiPath = "https://api.thegreenwebfoundation.org/v2/greencheckmulti";
     const domainsString = JSON.stringify(domains);
-    const req = await fetch(`${apiPath}/${domainsString}`);
+    const req = await fetch(`${apiPath}/${domainsString}`, {
+      headers: getApiRequestHeaders(userAgentIdentifier)
+    });
     const allGreenCheckResults = await req.json();
     return greenDomainsFromResults(allGreenCheckResults);
   } catch (e) {

package/dist/esm/hosting.js

@@ -1,7 +1,7 @@
 "use strict";
 import hostingAPI from "./hosting-api.js";
-function check(domain) {
-  return hostingAPI.check(domain);
+function check(domain, userAgentIdentifier) {
+  return hostingAPI.check(domain, userAgentIdentifier);
 }
 var hosting_default = {
   check

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tgwf/co2",
-  "version": "0.14.1",
+  "version": "0.14.2",
   "description": "Work out the co2 of your digital services",
   "main": "dist/cjs/index-node.js",
   "module": "dist/esm/index.js",
@@ -29,7 +29,8 @@
     "intensity-data:average": "node data/functions/generate_average_co2.js",
     "intensity-data:marginal": "node data/functions/generate_marginal_co2.js",
     "intensity-data": "npm run intensity-data:average && npm run intensity-data:marginal && npm run format-data",
-    "format-data": "cd data && prettier --write '**/*.{js,json}'"
+    "format-data": "cd data && prettier --write '**/*.{js,json}'",
+    "version": "npm run build"
   },
   "keywords": [
     "sustainability",