@tgwf/co2 0.10.0 → 0.10.1

package/.esbuild.browser.js

@@ -1,6 +1,6 @@
 require('esbuild').buildSync({
   entryPoints: ['src/index.js'],
-  outdir: 'public',
+  outdir: 'dist/iife',
   globalName: 'co2',
   format: 'iife',
   platform: 'browser',

package/.gitpod.yml

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

package/README.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tgwf/co2",
-  "version": "0.10.0",
+  "version": "0.10.1",
   "description": "Work out the co2 of your digital services",
   "main": "dist/cjs/index-node.js",
   "module": "dist/esm/index.js",
@@ -19,7 +19,8 @@
     "build": "npm run build:esm && npm run build:browser && npm run build:node",
     "build:esm": "node .esbuild.esm.js && ./fixup",
     "build:browser": "node .esbuild.browser.js",
-    "build:node": "node .esbuild.node.js && ./fixup"
+    "build:node": "node .esbuild.node.js && ./fixup",
+    "gitpod": "npm run build && cp ./dist/iife/index.js ./public && npm run serve"
   },
   "keywords": [
     "sustainability",

package/public/index.html

@@ -7,7 +7,7 @@
 
 <body class="">
 
-  <h1>This is a minimal demo</h1>
+  <h1>This is a minimal demo using the IIFE version of CO2.js.</h1>
 
   <p>Add a number in bytes, and we convert it to carbon, using the SWD model</p>
 
@@ -26,7 +26,6 @@
 
   <script src="./index.js"></script>
   <script>
-
     let emissions = new co2.co2();
 
     async function main() {
@@ -36,7 +35,9 @@
       // is the result green?
       const result = await hosting.check("google.com")
       // should return true or false
-      console.log({result})
+      console.log({
+        result
+      })
 
       document.querySelector('form').addEventListener('submit', function (event) {
         event.preventDefault();
@@ -54,4 +55,4 @@
   </script>
 </body>
 
-</html>
+</html>

package/src/constants/file-size.js

@@ -1,4 +1,4 @@
-const GIGABYTE = 1024 * 1024 * 1024;
+const GIGABYTE = 1000 * 1000 * 1000;
 
 export default {
   GIGABYTE,

package/src/sustainable-web-design.js

@@ -175,15 +175,6 @@ class SustainableWebDesign {
     log({ energyBycomponent });
     const energyValues = Object.values(energyBycomponent);
 
-    // sanity check that these numbers add back up
-    const v9recombinedNoCaching = energyValues.reduce(
-      (prevValue, currentValue) => prevValue + currentValue
-    );
-
-    // energyBycomponent doesn't apply any caching logic, to should be the
-    // same number as the total in the v8
-    log({ v9recombinedNoCaching });
-
     // for this, we want
     for (const [key, value] of Object.entries(energyBycomponent)) {
       // represent the first load
@@ -209,8 +200,8 @@ class SustainableWebDesign {
     // fetch the values using the default caching assumptions
     // const energyValues = Object.values(this.energyPerVisitByComponent(bytes));
 
-    let v9firstVisits = 0;
-    let v9subsequentVisits = 0;
+    let firstVisits = 0;
+    let subsequentVisits = 0;
 
     const energyBycomponent = Object.entries(
       this.energyPerVisitByComponent(bytes)
@@ -218,50 +209,17 @@ class SustainableWebDesign {
 
     for (const [key, val] of energyBycomponent) {
       if (key.indexOf("first") > 0) {
-        v9firstVisits += val;
+        firstVisits += val;
       }
     }
 
     for (const [key, val] of energyBycomponent) {
       if (key.indexOf("subsequent") > 0) {
-        v9subsequentVisits += val;
+        subsequentVisits += val;
       }
     }
 
-    log({ v9firstVisits });
-    log({ v9subsequentVisits });
-    return v9firstVisits + v9subsequentVisits;
-  }
-
-  /*
-   * JUST FOR TEST PURPOSES
-   * Testing v0.8.0 => v0.9.0 versions
-   *
-   *
-   */
-  energyPerVisitV8(bytes) {
-    log({ bytes });
-    const transferedBytesToGb = bytes / fileSize.GIGABYTE;
-
-    const v8visitWithNoCaching = transferedBytesToGb * KWH_PER_GB;
-
-    const v8firstVisit =
-      transferedBytesToGb * KWH_PER_GB * RETURNING_VISITOR_PERCENTAGE;
-
-    const v8subsequentVisits =
-      transferedBytesToGb *
-      KWH_PER_GB *
-      FIRST_TIME_VIEWING_PERCENTAGE *
-      PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD;
-
-    const v8firstAndSubsequentVisits = v8firstVisit + v8subsequentVisits;
-
-    log({ v8visitWithNoCaching });
-    log({ v8firstVisit });
-    log({ v8subsequentVisits });
-    log({ v8firstAndSubsequentVisits });
-
-    return v8firstVisit + v8subsequentVisits;
+    return firstVisits + subsequentVisits;
   }
 
   // TODO: this method looks like it applies the carbon intensity

package/.tool-versions

@@ -1 +0,0 @@
-nodejs 18.4.0