if-electricitymaps
Version:
Electricity Maps plugin for Impact Framework.
101 lines • 12.8 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.ElectricityMapsCarbonIntensity = void 0;
const dayjs = require("dayjs");
const helpers_1 = require("../util/helpers");
const schemas_1 = require("../util/schemas");
const electricitymaps_api_1 = require("./electricitymaps-api");
const zod_1 = require("zod");
const utils_1 = require("@grnsft/if-core/utils");
const { InputValidationError } = utils_1.ERRORS;
const ElectricityMapsCarbonIntensity = () => {
const metadata = {};
const api = (0, electricitymaps_api_1.ElectricityMapsAPI)();
const errorBuilder = (0, helpers_1.buildErrorMessage)(exports.ElectricityMapsCarbonIntensity.name);
/**
* Test and init authentication by making a test request to EMaps API.
*/
const initializeAuthentication = async () => {
await api.authenticate();
};
/**
* Ensure inputs are valid.
*/
const validateInputs = (inputs) => {
const inputsSchema = zod_1.z.array(schemas_1.inputSchema);
try {
inputsSchema.parse(inputs);
}
catch (error) {
if (error instanceof zod_1.ZodError) {
error.errors.map(e => {
throw new InputValidationError(errorBuilder({
message: e.message,
scope: 'input',
}));
});
}
else {
throw error;
}
}
};
const execute = async (inputs) => {
await initializeAuthentication();
validateInputs(inputs);
const result = [];
for await (const input of inputs) {
let unit = 'gCO2eq/kWh';
let powerConsumption = input.power_consumption;
if (!input.power_consumption) {
powerConsumption = 1;
unit = 'gCO2eq';
}
const start = dayjs(input.timestamp);
const end = start.add(input.duration, 'second');
const carbonIntensityParams = input.zone
? {
zone: input.zone,
start: start.toISOString(),
end: end.toISOString(),
}
: {
lon: input.longitude,
lat: input.latitude,
start: start.toISOString(),
end: end.toISOString(),
};
const carbonIntensities = api.getCarbonIntensity(carbonIntensityParams);
const numHours = Math.floor(input.duration / 3600);
const blocks = [...Array(numHours).keys()];
// For each full hour, calculate the ratio of the hour that is in the block
const hourlyRatios = blocks.map(hour => {
// This is the first hourly block, the ratio is the time between the start and the next hour.
if (hour === 0) {
return (start.add(1, 'hour').startOf('hour').diff(start, 'second') / 3600);
}
// This is the last hourly block, the ratio is the time between the start of the hour and the end.
if (hour === numHours - 1) {
return (end.diff(start.add(hour, 'hour').startOf('hour'), 'second') / 3600);
}
return 1;
});
const totalCarbonIntensity = await carbonIntensities.then(intensities => intensities.reduce((memo, ci, index) => {
memo += ci.value * hourlyRatios[index];
return memo;
}, 0));
result.push({
...input,
carbonIntensity: totalCarbonIntensity * powerConsumption,
unit: unit,
});
}
return result;
};
return {
metadata,
execute,
};
};
exports.ElectricityMapsCarbonIntensity = ElectricityMapsCarbonIntensity;
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/electricitymaps/index.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,6CAAkD;AAClD,6CAA4C;AAC5C,+DAAyD;AAEzD,6BAAgC;AAChC,iDAA6C;AAC7C,MAAM,EAAC,oBAAoB,EAAC,GAAG,cAAM,CAAC;AAI/B,MAAM,8BAA8B,GAAG,GAAoB,EAAE;IAClE,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,MAAM,GAAG,GAAG,IAAA,wCAAkB,GAAE,CAAC;IACjC,MAAM,YAAY,GAAG,IAAA,2BAAiB,EAAC,sCAA8B,CAAC,IAAI,CAAC,CAAC;IAE5E;;OAEG;IACH,MAAM,wBAAwB,GAAG,KAAK,IAAI,EAAE;QAC1C,MAAM,GAAG,CAAC,YAAY,EAAE,CAAC;IAC3B,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,cAAc,GAAG,CAAC,MAAsB,EAAE,EAAE;QAChD,MAAM,YAAY,GAAG,OAAC,CAAC,KAAK,CAAC,qBAAW,CAAC,CAAC;QAC1C,IAAI,CAAC;YACH,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,cAAQ,EAAE,CAAC;gBAC9B,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;oBACnB,MAAM,IAAI,oBAAoB,CAC5B,YAAY,CAAC;wBACX,OAAO,EAAE,CAAC,CAAC,OAAO;wBAClB,KAAK,EAAE,OAAO;qBACf,CAAC,CACH,CAAC;gBACJ,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,KAAK,EAAE,MAAsB,EAA2B,EAAE;QACxE,MAAM,wBAAwB,EAAE,CAAC;QACjC,cAAc,CAAC,MAAM,CAAC,CAAC;QACvB,MAAM,MAAM,GAAG,EAAE,CAAC;QAElB,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACjC,IAAI,IAAI,GAAG,YAAY,CAAC;YACxB,IAAI,gBAAgB,GAAG,KAAK,CAAC,iBAAiB,CAAC;YAE/C,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC;gBAC7B,gBAAgB,GAAG,CAAC,CAAC;gBACrB,IAAI,GAAG,QAAQ,CAAC;YAClB,CAAC;YAED,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACrC,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAEhD,MAAM,qBAAqB,GAAG,KAAK,CAAC,IAAI;gBACtC,CAAC,CAAC;oBACE,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE;oBAC1B,GAAG,EAAE,GAAG,CAAC,WAAW,EAAE;iBACvB;gBACH,CAAC,CAAC;oBACE,GAAG,EAAE,KAAK,CAAC,SAAS;oBACpB,GAAG,EAAE,KAAK,CAAC,QAAQ;oBACnB,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE;oBAC1B,GAAG,EAAE,GAAG,CAAC,WAAW,EAAE;iBACvB,CAAC;YAEN,MAAM,iBAAiB,GAAG,GAAG,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,CAAC;YAExE,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YAE3C,2EAA2E;YAC3E,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;gBACrC,6FAA6F;gBAC7F,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;oBACf,OAAO,CACL,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,IAAI,CAClE,CAAC;gBACJ,CAAC;gBACD,kGAAkG;gBAClG,IAAI,IAAI,KAAK,QAAQ,GAAG,CAAC,EAAE,CAAC;oBAC1B,OAAO,CACL,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,GAAG,IAAI,CACnE,CAAC;gBACJ,CAAC;gBACD,OAAO,CAAC,CAAC;YACX,CAAC,CAAC,CAAC;YAEH,MAAM,oBAAoB,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CACtE,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE;gBACrC,IAAI,IAAI,EAAE,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;gBACvC,OAAO,IAAI,CAAC;YACd,CAAC,EAAE,CAAC,CAAC,CACN,CAAC;YAEF,MAAM,CAAC,IAAI,CAAC;gBACV,GAAG,KAAK;gBACR,eAAe,EAAE,oBAAoB,GAAG,gBAAgB;gBACxD,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,OAAO;QACL,QAAQ;QACR,OAAO;KACR,CAAC;AACJ,CAAC,CAAC;AA5GW,QAAA,8BAA8B,kCA4GzC","sourcesContent":["import * as dayjs from 'dayjs';\nimport {buildErrorMessage} from '../util/helpers';\nimport {inputSchema} from '../util/schemas';\nimport {ElectricityMapsAPI} from './electricitymaps-api';\n\nimport {z, ZodError} from 'zod';\nimport {ERRORS} from '@grnsft/if-core/utils';\nconst {InputValidationError} = ERRORS;\n\nimport {PluginParams, PluginInterface} from '@grnsft/if-core/types';\n\nexport const ElectricityMapsCarbonIntensity = (): PluginInterface => {\n  const metadata = {};\n  const api = ElectricityMapsAPI();\n  const errorBuilder = buildErrorMessage(ElectricityMapsCarbonIntensity.name);\n\n  /**\n   * Test and init authentication by making a test request to EMaps API.\n   */\n  const initializeAuthentication = async () => {\n    await api.authenticate();\n  };\n\n  /**\n   * Ensure inputs are valid.\n   */\n  const validateInputs = (inputs: PluginParams[]) => {\n    const inputsSchema = z.array(inputSchema);\n    try {\n      inputsSchema.parse(inputs);\n    } catch (error) {\n      if (error instanceof ZodError) {\n        error.errors.map(e => {\n          throw new InputValidationError(\n            errorBuilder({\n              message: e.message,\n              scope: 'input',\n            })\n          );\n        });\n      } else {\n        throw error;\n      }\n    }\n  };\n\n  const execute = async (inputs: PluginParams[]): Promise<PluginParams[]> => {\n    await initializeAuthentication();\n    validateInputs(inputs);\n    const result = [];\n\n    for await (const input of inputs) {\n      let unit = 'gCO2eq/kWh';\n      let powerConsumption = input.power_consumption;\n\n      if (!input.power_consumption) {\n        powerConsumption = 1;\n        unit = 'gCO2eq';\n      }\n\n      const start = dayjs(input.timestamp);\n      const end = start.add(input.duration, 'second');\n\n      const carbonIntensityParams = input.zone\n        ? {\n            zone: input.zone,\n            start: start.toISOString(),\n            end: end.toISOString(),\n          }\n        : {\n            lon: input.longitude,\n            lat: input.latitude,\n            start: start.toISOString(),\n            end: end.toISOString(),\n          };\n\n      const carbonIntensities = api.getCarbonIntensity(carbonIntensityParams);\n\n      const numHours = Math.floor(input.duration / 3600);\n      const blocks = [...Array(numHours).keys()];\n\n      // For each full hour, calculate the ratio of the hour that is in the block\n      const hourlyRatios = blocks.map(hour => {\n        // This is the first hourly block, the ratio is the time between the start and the next hour.\n        if (hour === 0) {\n          return (\n            start.add(1, 'hour').startOf('hour').diff(start, 'second') / 3600\n          );\n        }\n        // This is the last hourly block, the ratio is the time between the start of the hour and the end.\n        if (hour === numHours - 1) {\n          return (\n            end.diff(start.add(hour, 'hour').startOf('hour'), 'second') / 3600\n          );\n        }\n        return 1;\n      });\n\n      const totalCarbonIntensity = await carbonIntensities.then(intensities =>\n        intensities.reduce((memo, ci, index) => {\n          memo += ci.value * hourlyRatios[index];\n          return memo;\n        }, 0)\n      );\n\n      result.push({\n        ...input,\n        carbonIntensity: totalCarbonIntensity * powerConsumption,\n        unit: unit,\n      });\n    }\n\n    return result;\n  };\n\n  return {\n    metadata,\n    execute,\n  };\n};\n"]}