@tgwf/co2
Version:
Work out the co2 of your digital services
217 lines (216 loc) • 8.89 kB
JavaScript
;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __export = (target, all) => {
for (var name in all)
__defProp(target, name, { get: all[name], enumerable: true });
};
var __copyProps = (to, from, except, desc) => {
if (from && typeof from === "object" || typeof from === "function") {
for (let key of __getOwnPropNames(from))
if (!__hasOwnProp.call(to, key) && key !== except)
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
}
return to;
};
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
var sustainable_web_design_v3_exports = {};
__export(sustainable_web_design_v3_exports, {
SustainableWebDesign: () => SustainableWebDesign,
default: () => sustainable_web_design_v3_default
});
module.exports = __toCommonJS(sustainable_web_design_v3_exports);
var import_constants = require("./constants/index.js");
var import_helpers = require("./helpers/index.js");
class SustainableWebDesign {
constructor(options) {
this.allowRatings = true;
this.options = options;
this.version = 3;
}
energyPerByteByComponent(bytes) {
const transferedBytesToGb = bytes / import_constants.fileSize.GIGABYTE;
const energyUsage = transferedBytesToGb * import_constants.KWH_PER_GB;
return {
consumerDeviceEnergy: energyUsage * import_constants.END_USER_DEVICE_ENERGY,
networkEnergy: energyUsage * import_constants.NETWORK_ENERGY,
productionEnergy: energyUsage * import_constants.PRODUCTION_ENERGY,
dataCenterEnergy: energyUsage * import_constants.DATACENTER_ENERGY
};
}
co2byComponent(energyByComponent, carbonIntensity = import_constants.GLOBAL_GRID_INTENSITY, options = {}) {
let deviceCarbonIntensity = import_constants.GLOBAL_GRID_INTENSITY;
let networkCarbonIntensity = import_constants.GLOBAL_GRID_INTENSITY;
let dataCenterCarbonIntensity = import_constants.GLOBAL_GRID_INTENSITY;
let globalEmissions = import_constants.GLOBAL_GRID_INTENSITY;
if (options == null ? void 0 : options.gridIntensity) {
const { device, network, dataCenter } = options.gridIntensity;
if ((device == null ? void 0 : device.value) || (device == null ? void 0 : device.value) === 0) {
deviceCarbonIntensity = device.value;
}
if ((network == null ? void 0 : network.value) || (network == null ? void 0 : network.value) === 0) {
networkCarbonIntensity = network.value;
}
if ((dataCenter == null ? void 0 : dataCenter.value) || (dataCenter == null ? void 0 : dataCenter.value) === 0) {
dataCenterCarbonIntensity = dataCenter.value;
}
}
if (carbonIntensity === true) {
dataCenterCarbonIntensity = import_constants.RENEWABLES_GRID_INTENSITY;
}
const returnCO2ByComponent = {};
for (const [key, value] of Object.entries(energyByComponent)) {
if (key.startsWith("dataCenterEnergy")) {
returnCO2ByComponent[key.replace("Energy", "CO2")] = value * dataCenterCarbonIntensity;
} else if (key.startsWith("consumerDeviceEnergy")) {
returnCO2ByComponent[key.replace("Energy", "CO2")] = value * deviceCarbonIntensity;
} else if (key.startsWith("networkEnergy")) {
returnCO2ByComponent[key.replace("Energy", "CO2")] = value * networkCarbonIntensity;
} else {
returnCO2ByComponent[key.replace("Energy", "CO2")] = value * globalEmissions;
}
}
return returnCO2ByComponent;
}
perByte(bytes, carbonIntensity = false, segmentResults = false, ratingResults = false, options = {}) {
if (bytes < 1) {
bytes = 0;
}
const energyBycomponent = this.energyPerByteByComponent(bytes, options);
if (typeof carbonIntensity !== "boolean") {
throw new Error(
`perByte expects a boolean for the carbon intensity value. Received: ${carbonIntensity}`
);
}
const co2ValuesbyComponent = this.co2byComponent(
energyBycomponent,
carbonIntensity,
options
);
const co2Values = Object.values(co2ValuesbyComponent);
const co2ValuesSum = co2Values.reduce(
(prevValue, currentValue) => prevValue + currentValue
);
let rating = null;
if (ratingResults) {
rating = this.ratingScale(co2ValuesSum);
}
if (segmentResults) {
if (ratingResults) {
return {
...co2ValuesbyComponent,
total: co2ValuesSum,
rating
};
}
return { ...co2ValuesbyComponent, total: co2ValuesSum };
}
if (ratingResults) {
return { total: co2ValuesSum, rating };
}
return co2ValuesSum;
}
perVisit(bytes, carbonIntensity = false, segmentResults = false, ratingResults = false, options = {}) {
const energyBycomponent = this.energyPerVisitByComponent(bytes, options);
if (typeof carbonIntensity !== "boolean") {
throw new Error(
`perVisit expects a boolean for the carbon intensity value. Received: ${carbonIntensity}`
);
}
const co2ValuesbyComponent = this.co2byComponent(
energyBycomponent,
carbonIntensity,
options
);
const co2Values = Object.values(co2ValuesbyComponent);
const co2ValuesSum = co2Values.reduce(
(prevValue, currentValue) => prevValue + currentValue
);
let rating = null;
if (ratingResults) {
rating = this.ratingScale(co2ValuesSum);
}
if (segmentResults) {
if (ratingResults) {
return {
...co2ValuesbyComponent,
total: co2ValuesSum,
rating
};
}
return { ...co2ValuesbyComponent, total: co2ValuesSum };
}
if (ratingResults) {
return { total: co2ValuesSum, rating };
}
return co2ValuesSum;
}
energyPerByte(bytes) {
const energyByComponent = this.energyPerByteByComponent(bytes);
const energyValues = Object.values(energyByComponent);
return energyValues.reduce(
(prevValue, currentValue) => prevValue + currentValue
);
}
energyPerVisitByComponent(bytes, options = {}, firstView = import_constants.FIRST_TIME_VIEWING_PERCENTAGE, returnView = import_constants.RETURNING_VISITOR_PERCENTAGE, dataReloadRatio = import_constants.PERCENTAGE_OF_DATA_LOADED_ON_SUBSEQUENT_LOAD) {
if (options.dataReloadRatio || options.dataReloadRatio === 0) {
dataReloadRatio = options.dataReloadRatio;
}
if (options.firstVisitPercentage || options.firstVisitPercentage === 0) {
firstView = options.firstVisitPercentage;
}
if (options.returnVisitPercentage || options.returnVisitPercentage === 0) {
returnView = options.returnVisitPercentage;
}
const energyBycomponent = this.energyPerByteByComponent(bytes);
const cacheAdjustedSegmentEnergy = {};
const energyValues = Object.values(energyBycomponent);
for (const [key, value] of Object.entries(energyBycomponent)) {
cacheAdjustedSegmentEnergy[`${key} - first`] = value * firstView;
cacheAdjustedSegmentEnergy[`${key} - subsequent`] = value * returnView * dataReloadRatio;
}
return cacheAdjustedSegmentEnergy;
}
energyPerVisit(bytes) {
let firstVisits = 0;
let subsequentVisits = 0;
const energyBycomponent = Object.entries(
this.energyPerVisitByComponent(bytes)
);
for (const [key, val] of energyBycomponent) {
if (key.indexOf("first") > 0) {
firstVisits += val;
}
}
for (const [key, val] of energyBycomponent) {
if (key.indexOf("subsequent") > 0) {
subsequentVisits += val;
}
}
return firstVisits + subsequentVisits;
}
emissionsPerVisitInGrams(energyPerVisit, carbonintensity = import_constants.GLOBAL_GRID_INTENSITY) {
return (0, import_helpers.formatNumber)(energyPerVisit * carbonintensity);
}
annualEnergyInKwh(energyPerVisit, monthlyVisitors = 1e3) {
return energyPerVisit * monthlyVisitors * 12;
}
annualEmissionsInGrams(co2grams, monthlyVisitors = 1e3) {
return co2grams * monthlyVisitors * 12;
}
annualSegmentEnergy(annualEnergy) {
return {
consumerDeviceEnergy: (0, import_helpers.formatNumber)(annualEnergy * import_constants.END_USER_DEVICE_ENERGY),
networkEnergy: (0, import_helpers.formatNumber)(annualEnergy * import_constants.NETWORK_ENERGY),
dataCenterEnergy: (0, import_helpers.formatNumber)(annualEnergy * import_constants.DATACENTER_ENERGY),
productionEnergy: (0, import_helpers.formatNumber)(annualEnergy * import_constants.PRODUCTION_ENERGY)
};
}
ratingScale(co2e) {
return (0, import_helpers.outputRating)(co2e, this.version);
}
}
var sustainable_web_design_v3_default = SustainableWebDesign;
//# sourceMappingURL=sustainable-web-design-v3.js.map