@tgwf/co2 0.18.1-0 → 0.18.2-0

package/dist/cjs/carbon-txt.js

@@ -40,8 +40,8 @@ const processResponse = (res, verbose = false) => {
   return {
     success: true,
     url: res.url,
-    disclosures: (_b = (_a = res == null ? void 0 : res.data) == null ? void 0 : _a.org) == null ? void 0 : _b.disclosures,
-    upstream: (_d = (_c = res == null ? void 0 : res.data) == null ? void 0 : _c.upstream) == null ? void 0 : _d.services
+    org: { disclosures: (_b = (_a = res == null ? void 0 : res.data) == null ? void 0 : _a.org) == null ? void 0 : _b.disclosures },
+    upstream: { services: (_d = (_c = res == null ? void 0 : res.data) == null ? void 0 : _c.upstream) == null ? void 0 : _d.services }
   };
 };
 async function check(domain, options) {
@@ -50,16 +50,25 @@ async function check(domain, options) {
   }
   const agentId = options == null ? void 0 : options.userAgentIdentifier;
   const verbose = (options == null ? void 0 : options.verbose) || false;
-  const req = await fetch(
-    `https://carbon-txt-api.greenweb.org/api/validate/domain/`,
-    {
-      headers: (0, import_helpers.getApiRequestHeaders)(agentId),
+  const apiKey = (options == null ? void 0 : options.apiKey) || null;
+  if (!apiKey) {
+    throw new Error("A valid API key is required.");
+  }
+  const validatorUrl = (options == null ? void 0 : options.customValidator) || "https://carbon-txt-api.greenweb.org/api/validate/domain/";
+  try {
+    const req = await fetch(validatorUrl, {
+      headers: {
+        ...(0, import_helpers.getApiRequestHeaders)(agentId),
+        "x-api-key": apiKey
+      },
       method: "POST",
       body: JSON.stringify({ domain })
-    }
-  );
-  const res = await req.json();
-  return processResponse(res, verbose);
+    });
+    const res = await req.json();
+    return processResponse(res, verbose);
+  } catch (error) {
+    return { success: false, errors: [error.message] };
+  }
 }
 var carbon_txt_default = check;
 //# sourceMappingURL=carbon-txt.js.map

package/dist/cjs/carbon-txt.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/carbon-txt.js"],
-  "sourcesContent": ["\"use strict\";\n\nimport { getApiRequestHeaders } from \"./helpers/index.js\";\n\n/**\n * @module carbontxt-validator\n */\n\n/**\n * Process the response from the carbon.txt validator API\n * @param {object} res - The response object from the API\n * @param {boolean} verbose - Optional. Whether to return verbose results\n * @returns {object} - The processed response object\n */\nconst processResponse = (res, verbose = false) => {\n  // This captures errors when an invalid domain is sent to the API\n  if (!res.success && !res.errors) {\n    return {\n      success: false,\n      errors: [res.detail[0].msg],\n    };\n  }\n\n  if (verbose) {\n    return res;\n  }\n\n  if (!res.success) {\n    return { success: false, errors: res.errors };\n  }\n\n  return {\n    success: true,\n    url: res.url,\n    disclosures: res?.data?.org?.disclosures,\n    upstream: res?.data?.upstream?.services,\n  };\n};\n\n/**\n * Perform a domain lookup using the Green Web Foundation carbon.txt validator endpoint\n * @param {string} domain - The domain to check, or an array of domains to be checked.\n * @param {string} options - Optional. An object of domain check options, or a string\n * @param {string} options.userAgentIdentifier - Optional. A string representing the app, site, or organisation that is making the request.\n * @param {string} options.verbose - Optional. A boolean indicating whether to return verbose results.\n */\n\nexport async function check(domain, options) {\n  if (typeof domain !== \"string\") {\n    throw new Error(\"Invalid domain. Domain must be a string.\");\n  }\n\n  const agentId = options?.userAgentIdentifier;\n  const verbose = options?.verbose || false;\n\n  const req = await fetch(\n    `https://carbon-txt-api.greenweb.org/api/validate/domain/`,\n    {\n      headers: getApiRequestHeaders(agentId),\n      method: \"POST\",\n      body: JSON.stringify({ domain }),\n    }\n  );\n\n  const res = await req.json();\n  return processResponse(res, verbose);\n}\n\nexport default check;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,qBAAqC;AAYrC,MAAM,kBAAkB,CAAC,KAAK,UAAU,UAAU;AAdlD;AAgBE,MAAI,CAAC,IAAI,WAAW,CAAC,IAAI,QAAQ;AAC/B,WAAO;AAAA,MACL,SAAS;AAAA,MACT,QAAQ,CAAC,IAAI,OAAO,CAAC,EAAE,GAAG;AAAA,IAC5B;AAAA,EACF;AAEA,MAAI,SAAS;AACX,WAAO;AAAA,EACT;AAEA,MAAI,CAAC,IAAI,SAAS;AAChB,WAAO,EAAE,SAAS,OAAO,QAAQ,IAAI,OAAO;AAAA,EAC9C;AAEA,SAAO;AAAA,IACL,SAAS;AAAA,IACT,KAAK,IAAI;AAAA,IACT,cAAa,sCAAK,SAAL,mBAAW,QAAX,mBAAgB;AAAA,IAC7B,WAAU,sCAAK,SAAL,mBAAW,aAAX,mBAAqB;AAAA,EACjC;AACF;AAUA,eAAsB,MAAM,QAAQ,SAAS;AAC3C,MAAI,OAAO,WAAW,UAAU;AAC9B,UAAM,IAAI,MAAM,0CAA0C;AAAA,EAC5D;AAEA,QAAM,UAAU,mCAAS;AACzB,QAAM,WAAU,mCAAS,YAAW;AAEpC,QAAM,MAAM,MAAM;AAAA,IAChB;AAAA,IACA;AAAA,MACE,aAAS,qCAAqB,OAAO;AAAA,MACrC,QAAQ;AAAA,MACR,MAAM,KAAK,UAAU,EAAE,OAAO,CAAC;AAAA,IACjC;AAAA,EACF;AAEA,QAAM,MAAM,MAAM,IAAI,KAAK;AAC3B,SAAO,gBAAgB,KAAK,OAAO;AACrC;AAEA,IAAO,qBAAQ;",
+  "sourcesContent": ["\"use strict\";\n\nimport { getApiRequestHeaders } from \"./helpers/index.js\";\n\n/**\n * @module carbontxt-validator\n */\n\n/**\n * Process the response from the carbon.txt validator API\n * @param {object} res - The response object from the API\n * @param {boolean} verbose - Optional. Whether to return verbose results\n * @returns {object} - The processed response object\n */\nconst processResponse = (res, verbose = false) => {\n  // This captures errors when an invalid domain is sent to the API\n  if (!res.success && !res.errors) {\n    return {\n      success: false,\n      errors: [res.detail[0].msg],\n    };\n  }\n\n  if (verbose) {\n    return res;\n  }\n\n  if (!res.success) {\n    return { success: false, errors: res.errors };\n  }\n\n  return {\n    success: true,\n    url: res.url,\n    org: { disclosures: res?.data?.org?.disclosures },\n    upstream: { services: res?.data?.upstream?.services },\n  };\n};\n\n/**\n * Perform a domain lookup using the Green Web Foundation carbon.txt validator endpoint\n * @param {string} domain - The domain to check.\n * @param {string} options - Optional. An object of domain check options, or a string\n * @param {string} options.userAgentIdentifier - Optional. A string representing the app, site, or organisation that is making the request.\n * @param {string} options.verbose - Optional. A boolean indicating whether to return verbose results.\n * @param {string} options.customValidator - Optional. A string representing the URL of the carbon.txt validator endpoint.\n * @param {string} options.apiKey - Optional. A string representing the API key to use for the request.\n */\n\nexport async function check(domain, options) {\n  if (typeof domain !== \"string\") {\n    throw new Error(\"Invalid domain. Domain must be a string.\");\n  }\n\n  const agentId = options?.userAgentIdentifier;\n  const verbose = options?.verbose || false;\n  const apiKey = options?.apiKey || null;\n\n  if (!apiKey) {\n    throw new Error(\"A valid API key is required.\");\n  }\n\n  const validatorUrl =\n    options?.customValidator ||\n    \"https://carbon-txt-api.greenweb.org/api/validate/domain/\";\n\n  try {\n    const req = await fetch(validatorUrl, {\n      headers: {\n        ...getApiRequestHeaders(agentId),\n        \"x-api-key\": apiKey,\n      },\n      method: \"POST\",\n      body: JSON.stringify({ domain }),\n    });\n\n    const res = await req.json();\n    return processResponse(res, verbose);\n  } catch (error) {\n    return { success: false, errors: [error.message] };\n  }\n}\n\nexport default check;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,qBAAqC;AAYrC,MAAM,kBAAkB,CAAC,KAAK,UAAU,UAAU;AAdlD;AAgBE,MAAI,CAAC,IAAI,WAAW,CAAC,IAAI,QAAQ;AAC/B,WAAO;AAAA,MACL,SAAS;AAAA,MACT,QAAQ,CAAC,IAAI,OAAO,CAAC,EAAE,GAAG;AAAA,IAC5B;AAAA,EACF;AAEA,MAAI,SAAS;AACX,WAAO;AAAA,EACT;AAEA,MAAI,CAAC,IAAI,SAAS;AAChB,WAAO,EAAE,SAAS,OAAO,QAAQ,IAAI,OAAO;AAAA,EAC9C;AAEA,SAAO;AAAA,IACL,SAAS;AAAA,IACT,KAAK,IAAI;AAAA,IACT,KAAK,EAAE,cAAa,sCAAK,SAAL,mBAAW,QAAX,mBAAgB,YAAY;AAAA,IAChD,UAAU,EAAE,WAAU,sCAAK,SAAL,mBAAW,aAAX,mBAAqB,SAAS;AAAA,EACtD;AACF;AAYA,eAAsB,MAAM,QAAQ,SAAS;AAC3C,MAAI,OAAO,WAAW,UAAU;AAC9B,UAAM,IAAI,MAAM,0CAA0C;AAAA,EAC5D;AAEA,QAAM,UAAU,mCAAS;AACzB,QAAM,WAAU,mCAAS,YAAW;AACpC,QAAM,UAAS,mCAAS,WAAU;AAElC,MAAI,CAAC,QAAQ;AACX,UAAM,IAAI,MAAM,8BAA8B;AAAA,EAChD;AAEA,QAAM,gBACJ,mCAAS,oBACT;AAEF,MAAI;AACF,UAAM,MAAM,MAAM,MAAM,cAAc;AAAA,MACpC,SAAS;AAAA,QACP,OAAG,qCAAqB,OAAO;AAAA,QAC/B,aAAa;AAAA,MACf;AAAA,MACA,QAAQ;AAAA,MACR,MAAM,KAAK,UAAU,EAAE,OAAO,CAAC;AAAA,IACjC,CAAC;AAED,UAAM,MAAM,MAAM,IAAI,KAAK;AAC3B,WAAO,gBAAgB,KAAK,OAAO;AAAA,EACrC,SAAS,OAAO;AACd,WAAO,EAAE,SAAS,OAAO,QAAQ,CAAC,MAAM,OAAO,EAAE;AAAA,EACnD;AACF;AAEA,IAAO,qBAAQ;",
   "names": []
 }

package/dist/cjs/helpers/index.js

@@ -197,7 +197,7 @@ Falling back to default value.`
   return adjustments;
 }
 function getApiRequestHeaders(comment = "") {
-  return { "User-Agent": `co2js/${"0.18.1-0"} ${comment}` };
+  return { "User-Agent": `co2js/${"0.18.2-0"} ${comment}` };
 }
 function outputRating(co2e, swdmVersion) {
   let {

package/dist/esm/carbon-txt.js

@@ -1,3 +1,22 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
 import { getApiRequestHeaders } from "./helpers/index.js";
 const processResponse = (res, verbose = false) => {
   var _a, _b, _c, _d;
@@ -16,8 +35,8 @@ const processResponse = (res, verbose = false) => {
   return {
     success: true,
     url: res.url,
-    disclosures: (_b = (_a = res == null ? void 0 : res.data) == null ? void 0 : _a.org) == null ? void 0 : _b.disclosures,
-    upstream: (_d = (_c = res == null ? void 0 : res.data) == null ? void 0 : _c.upstream) == null ? void 0 : _d.services
+    org: { disclosures: (_b = (_a = res == null ? void 0 : res.data) == null ? void 0 : _a.org) == null ? void 0 : _b.disclosures },
+    upstream: { services: (_d = (_c = res == null ? void 0 : res.data) == null ? void 0 : _c.upstream) == null ? void 0 : _d.services }
   };
 };
 async function check(domain, options) {
@@ -26,16 +45,24 @@ async function check(domain, options) {
   }
   const agentId = options == null ? void 0 : options.userAgentIdentifier;
   const verbose = (options == null ? void 0 : options.verbose) || false;
-  const req = await fetch(
-    "https://carbon-txt-api.greenweb.org/api/validate/domain/",
-    {
-      headers: getApiRequestHeaders(agentId),
+  const apiKey = (options == null ? void 0 : options.apiKey) || null;
+  if (!apiKey) {
+    throw new Error("A valid API key is required.");
+  }
+  const validatorUrl = (options == null ? void 0 : options.customValidator) || "https://carbon-txt-api.greenweb.org/api/validate/domain/";
+  try {
+    const req = await fetch(validatorUrl, {
+      headers: __spreadProps(__spreadValues({}, getApiRequestHeaders(agentId)), {
+        "x-api-key": apiKey
+      }),
       method: "POST",
       body: JSON.stringify({ domain })
-    }
-  );
-  const res = await req.json();
-  return processResponse(res, verbose);
+    });
+    const res = await req.json();
+    return processResponse(res, verbose);
+  } catch (error) {
+    return { success: false, errors: [error.message] };
+  }
 }
 var carbon_txt_default = check;
 export {

package/dist/esm/helpers/index.js

@@ -164,7 +164,7 @@ function parseVisitTraceOptions(options = {}, version = 3, green = false) {
   return adjustments;
 }
 function getApiRequestHeaders(comment = "") {
-  return { "User-Agent": "co2js/".concat("0.18.1-0", " ").concat(comment) };
+  return { "User-Agent": "co2js/".concat("0.18.2-0", " ").concat(comment) };
 }
 function outputRating(co2e, swdmVersion) {
   let {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tgwf/co2",
-  "version": "0.18.1-0",
+  "version": "0.18.2-0",
   "description": "Work out the co2 of your digital services",
   "main": "dist/cjs/index-node.js",
   "module": "dist/esm/index.js",