@tgwf/co2 0.13.6 → 0.13.8

package/.all-contributorsrc

@@ -1,39 +1,139 @@
 {
+  "projectName": "co2.js",
+  "projectOwner": "thegreenwebfoundation",
+  "repoType": "github",
+  "repoHost": "https://github.com",
   "files": [
     "README.md"
   ],
   "imageSize": 100,
-  "commit": false,
+  "commit": true,
+  "commitConvention": "none",
   "contributors": [
     {
-      "login": "JamieBeevor",
-      "name": "JamieB",
-      "avatar_url": "https://avatars1.githubusercontent.com/u/26165947?v=4",
-      "profile": "https://greengumption.co.uk",
+      "login": "mrchrisadams",
+      "name": "Chris Adams",
+      "avatar_url": "https://avatars.githubusercontent.com/u/17906?v=4",
+      "profile": "https://github.com/mrchrisadams",
       "contributions": [
-        "ideas",
-        "question",
-        "review"
+        "code"
       ]
     },
     {
-    "login": "soulgalore",
+      "login": "fershad",
+      "name": "fershad",
+      "avatar_url": "https://avatars.githubusercontent.com/u/27988517?v=4",
+      "profile": "https://www.fershad.com/",
+      "contributions": [
+        "code",
+        "doc",
+        "maintenance"
+      ]
+    },
+    {
+      "login": "soulgalore",
       "name": "Peter Hedenskog",
-      "avatar_url": "https://avatars2.githubusercontent.com/u/540757?v=4",
-      "profile": "https://www.peterhedenskog.com",
+      "avatar_url": "https://avatars.githubusercontent.com/u/540757?v=4",
+      "profile": "https://www.peterhedenskog.com/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "drydenwilliams",
+      "name": "Dryden",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4403089?v=4",
+      "profile": "https://www.drydenwilliams.co.uk/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "EvanHahn",
+      "name": "Evan Hahn",
+      "avatar_url": "https://avatars.githubusercontent.com/u/777712?v=4",
+      "profile": "https://evanhahn.com/",
+      "contributions": [
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "PrathumP",
+      "name": "Prathum Pandey",
+      "avatar_url": "https://avatars.githubusercontent.com/u/115390367?v=4",
+      "profile": "https://github.com/PrathumP",
+      "contributions": [
+        "bug",
+        "code"
+      ]
+    },
+    {
+      "login": "Fdawgs",
+      "name": "Frazer Smith",
+      "avatar_url": "https://avatars.githubusercontent.com/u/43814140?v=4",
+      "profile": "https://github.com/Fdawgs",
       "contributions": [
         "code",
-        "ideas",
-        "review",
-        "infra",
-        "docs"
+        "test"
+      ]
+    },
+    {
+      "login": "hamishfagg",
+      "name": "Hamish Fagg",
+      "avatar_url": "https://avatars.githubusercontent.com/u/895845?v=4",
+      "profile": "https://github.com/hamishfagg",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "toolness",
+      "name": "Atul Varma",
+      "avatar_url": "https://avatars.githubusercontent.com/u/124687?v=4",
+      "profile": "http://portfolio.toolness.org/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "piperchester",
+      "name": "Piper",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1530684?v=4",
+      "profile": "https://www.intersectionalenvironmentalist.com/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "raymundovr",
+      "name": "Raymundo Vásquez Ruiz",
+      "avatar_url": "https://avatars.githubusercontent.com/u/108420?v=4",
+      "profile": "https://vasquezruiz.com/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "JamieBeevor",
+      "name": "JamieB",
+      "avatar_url": "https://avatars.githubusercontent.com/u/26165947?v=4",
+      "profile": "https://greengumption.co.uk/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "p-gerard",
+      "name": "p-gerard",
+      "avatar_url": "https://avatars.githubusercontent.com/u/97036756?v=4",
+      "profile": "https://github.com/p-gerard",
+      "contributions": [
+        "bug",
+        "code"
       ]
     }
   ],
   "contributorsPerLine": 7,
-  "projectName": "co2.js",
-  "projectOwner": "thegreenwebfoundation",
-  "repoType": "github",
-  "repoHost": "https://github.com",
-  "skipCi": true
+  "linkToUsage": false
 }

package/CHANGELOG.md

@@ -18,6 +18,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 # Released
 
+## [0.13.7] - 2023-09-13
+
+- Automated monthly update of annual average grid intensity data.
+
+## [0.13.6] - 2023-08-08
+
+- 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
@@ -54,8 +64,8 @@ In PR #135 there were significant changes made to how average annual grid intens
 
 - 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.
+  - 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
@@ -120,7 +130,7 @@ In PR #135 there were significant changes made to how average annual grid intens
 
 ### 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
@@ -212,7 +222,7 @@ This release used a version bump as previously we had released v0.10.0 under a p
 
 ### 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
 

package/README.md

@@ -1,5 +1,9 @@
 # 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 +18,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 +39,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 +70,10 @@ 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.
 
 ## Marginal and average emissions intensity data
 
@@ -80,13 +84,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,17 +105,17 @@ 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))
 
@@ -123,6 +128,34 @@ See LICENCE for more.
 <!-- 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 -->

package/data/output/average-intensities.js

@@ -1,6 +1,6 @@
 const data = {
   AFG: 120.48,
-  AFRICA: 510.26,
+  AFRICA: 484.16,
   ALB: 23.44,
   DZA: 498.9,
   ASM: 687.5,
@@ -9,13 +9,13 @@ const data = {
   ARG: 344.31,
   ARM: 222.68,
   ABW: 591.4,
-  ASEAN: 505.72,
-  ASIA: 535.1,
+  ASEAN: 508.06,
+  ASIA: 535.23,
   AUS: 501.7,
   AUT: 157.52,
   AZE: 532.9,
   BHS: 698.11,
-  BHR: 489.77,
+  BHR: 494.02,
   BGD: 577.03,
   BRB: 644.86,
   BLR: 415.64,
@@ -23,8 +23,8 @@ const data = {
   BLZ: 484.38,
   BEN: 666.67,
   BTN: 24.44,
-  BOL: 323.87,
-  BIH: 517.24,
+  BOL: 322.09,
+  BIH: 516.01,
   BWA: 794.52,
   BRA: 102.09,
   BRN: 658.85,
@@ -48,13 +48,13 @@ const data = {
   CRI: 37.21,
   CIV: 410.75,
   HRV: 246.46,
-  CUB: 602.03,
+  CUB: 602.23,
   CYP: 589.35,
   CZE: 415.35,
   DNK: 180.71,
   DJI: 666.67,
   DMA: 529.41,
-  DOM: 550.88,
+  DOM: 549.8,
   ECU: 188.71,
   EGY: 469.63,
   SLV: 194.23,
@@ -63,8 +63,8 @@ const data = {
   EST: 464.03,
   SWZ: 189.19,
   ETH: 25.19,
-  EU: 277.22,
-  EUROPE: 296.96,
+  EU: 277.19,
+  EUROPE: 296.45,
   FLK: 500,
   FRO: 428.57,
   FJI: 289.47,
@@ -82,14 +82,14 @@ const data = {
   GRC: 343.82,
   GRL: 133.33,
   GRD: 714.29,
-  GLP: 611.77,
+  GLP: 623.53,
   GUM: 670.33,
-  GTM: 320.64,
+  GTM: 291.55,
   GIN: 208.63,
   GNB: 750,
   GUY: 642.28,
   HTI: 606.06,
-  HND: 375.1,
+  HND: 373.96,
   HKG: 683.97,
   HUN: 222.97,
   ISL: 28.56,
@@ -100,19 +100,19 @@ const data = {
   IRL: 346.33,
   ISR: 548.03,
   ITA: 371.69,
-  JAM: 519.54,
+  JAM: 537.93,
   JPN: 494.86,
   JOR: 399.91,
   KAZ: 635.57,
   KEN: 100.57,
   KIR: 666.67,
   XKX: 768.73,
-  KWT: 489.65,
+  KWT: 551.74,
   KGZ: 104.43,
   LAO: 242.18,
-  "LATIN AMERICA AND CARIBBEAN": 241.91,
+  "LATIN AMERICA AND CARIBBEAN": 238.68,
   LVA: 181.82,
-  LBN: 594.75,
+  LBN: 605.74,
   LSO: 20,
   LBR: 304.35,
   LBY: 550.42,
@@ -123,14 +123,14 @@ const data = {
   MWI: 133.8,
   MYS: 543.87,
   MDV: 651.52,
-  MLI: 466.08,
+  MLI: 463.13,
   MLT: 495,
   MTQ: 698.63,
   MRT: 526.6,
   MUS: 611.11,
   MEX: 423.81,
-  "MIDDLE EAST": 512.24,
-  MDA: 678.44,
+  "MIDDLE EAST": 516.02,
+  MDA: 677.18,
   MNG: 749.66,
   MNE: 399.38,
   MSR: 1000,
@@ -145,24 +145,24 @@ const data = {
   NZL: 97.73,
   NIC: 354.21,
   NER: 622.22,
-  NGA: 368.22,
+  NGA: 368.11,
   "NORTH AMERICA": 336.01,
   PRK: 157.79,
   MKD: 529.33,
   NOR: 28.82,
-  OCEANIA: 449.43,
-  OECD: 341.08,
+  OCEANIA: 449.71,
+  OECD: 340.95,
   OMN: 488.27,
   PAK: 344.16,
   PSE: 465.12,
-  PAN: 192.14,
+  PAN: 186.61,
   PNG: 526.75,
   PRY: 25.49,
   PER: 256.51,
-  POL: 634.58,
+  POL: 633.1,
   PRT: 234.03,
   PRI: 681.47,
-  QAT: 489.68,
+  QAT: 489.88,
   REU: 519.03,
   ROU: 264.12,
   RUS: 363.68,
@@ -193,11 +193,11 @@ const data = {
   SWE: 45.08,
   CHE: 45.62,
   SYR: 541.17,
-  TWN: 561.02,
+  TWN: 560.98,
   TJK: 83.63,
   TZA: 366.75,
   THA: 501.57,
-  PHL: 582.05,
+  PHL: 582.84,
   TGO: 460.32,
   TON: 625,
   TTO: 491.41,
@@ -210,7 +210,7 @@ const data = {
   ARE: 407.98,
   GBR: 261.24,
   USA: 367.26,
-  URY: 114.81,
+  URY: 114.89,
   UZB: 505.41,
   VUT: 571.43,
   VEN: 212.48,