builtwith-api 1.0.6 → 3.1.0

package/package.json

@@ -1,26 +1,70 @@
 {
   "name": "builtwith-api",
-  "version": "1.0.6",
+  "version": "3.1.0",
   "description": "Wrapper for the BuiltWith API",
-  "main": "src/index.js",
-  "scripts": {},
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "builtwith": "./dist/cli.js",
+    "builtwith-mcp": "./dist/mcp.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./mcp": {
+      "types": "./dist/mcp.d.ts",
+      "import": "./dist/mcp.js"
+    }
+  },
+  "scripts": {
+    "build": "bun run build:js && bun run build:types && chmod +x dist/cli.js dist/mcp.js",
+    "build:js": "bun build ./src/index.ts ./src/cli.ts ./src/mcp.ts ./src/errors.ts --outdir dist --target node --format esm --sourcemap=external --external zod --external @modelcontextprotocol/sdk",
+    "build:types": "tsc --emitDeclarationOnly",
+    "cli": "bun run src/cli.ts",
+    "mcp": "bun run src/mcp.ts",
+    "mcp:inspect": "npx @modelcontextprotocol/inspector node dist/mcp.js",
+    "compile": "bun run compile:linux-x64 && bun run compile:linux-arm64 && bun run compile:darwin-x64 && bun run compile:darwin-arm64 && bun run compile:windows-x64",
+    "compile:linux-x64": "bun build src/cli.ts --compile --target bun-linux-x64 --outfile dist/builtwith-linux-x64",
+    "compile:linux-arm64": "bun build src/cli.ts --compile --target bun-linux-arm64 --outfile dist/builtwith-linux-arm64",
+    "compile:darwin-x64": "bun build src/cli.ts --compile --target bun-darwin-x64 --outfile dist/builtwith-darwin-x64",
+    "compile:darwin-arm64": "bun build src/cli.ts --compile --target bun-darwin-arm64 --outfile dist/builtwith-darwin-arm64",
+    "compile:windows-x64": "bun build src/cli.ts --compile --target bun-windows-x64 --outfile dist/builtwith-windows-x64.exe",
+    "prepublishOnly": "bun run build",
+    "test": "bun test",
+    "smoke": "bun test.ts",
+    "clean": "rm -rf dist"
+  },
   "homepage": "https://github.com/zcaceres/builtwith-api",
   "repository": {
     "type": "git",
     "url": "https://github.com/zcaceres/builtwith-api.git"
   },
   "keywords": [
-    "utilities",
-    "BuiltWith",
-    "apis"
+    "builtwith",
+    "api",
+    "cli",
+    "mcp",
+    "model-context-protocol",
+    "technology-detection",
+    "web-intelligence"
+  ],
+  "files": [
+    "dist"
   ],
   "author": "Zach Caceres (@zachcaceres)",
   "license": "MIT",
-  "dependencies": {
-    "lodash": "^4.17.15",
-    "node-fetch": "^2.6.0"
+  "engines": {
+    "node": ">=18.0.0"
   },
   "devDependencies": {
-    "dotenv": "^8.2.0"
+    "@types/bun": "^1.3.9",
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.27.1",
+    "zod": "^4.3.6"
   }
 }

package/src/config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  VALID_RESPONSE_TYPES: {
-    XML: "xml",
-    JSON: "json",
-    TXT: "txt"
-  },
-}

package/src/index.js

@@ -1,227 +0,0 @@
-const _ = require('lodash')
-
-const utils = require("./utils")
-const { VALID_RESPONSE_TYPES } = require("./config")
-
-
-function BuiltWith(apiKey, moduleParams = {}) {
-  const responseFormat = _.get(moduleParams, 'responseFormat', 'json')
-
-  if (!Object.values(VALID_RESPONSE_TYPES).includes(responseFormat)) {
-    throw new Error(`Invalid 'responseFormat'. Valid format are 'xml', 'txt', and 'json'. You input ${responseFormat}`)
-  }
-
-  if (responseFormat === VALID_RESPONSE_TYPES.TXT) {
-    console.warn("TXT response format is only supported for the BuiltWith Lists API. See: https://api.builtwith.com/lists-api");
-  }
-
-  function constructBuiltWithURL(
-    apiName,
-    requestParams = {},
-    subdomain = 'api'
-  ) {
-    let bwURL = `https://${subdomain}.builtwith.com/${apiName}/api.${responseFormat}?KEY=${apiKey}`
-
-    if (!_.isEmpty(requestParams)) {
-      bwURL += `&${utils.paramsObjToQueryString(requestParams)}`
-    }
-
-    return bwURL
-  }
-
-
-  return {
-    /**
-     * Make a request to the BuiltWith Free API
-     *
-     * @see https://api.builtwith.com/free-api
-     * @param {String} url
-     */
-    free: async function(url) {
-      const bwURL = constructBuiltWithURL("free1", {
-        LOOKUP: url
-      });
-
-      const res = await utils.makeStandardRequest(bwURL, responseFormat)
-      return res;
-    },
-
-    /**
-     * Make a request to the BuiltWith Domain API
-     *
-     * @see https://api.builtwith.com/domain-api
-     * @param {String} url
-     * @param {Object} params
-     */
-    domain: async function(url, params) {
-      const hideAll = _.get(params, "hideAll", false);
-      const noMetaData = _.get(params, "noMetaData", false);
-      const noAttributeData = _.get(params, "noAttributeData", false);
-      const hideDescriptionAndLinks = _.get(
-        params,
-        "hideDescriptionAndLinks",
-        false
-      );
-      const onlyLiveTechnologies = _.get(params, "onlyLiveTechnologies", false);
-
-      const bwURL = constructBuiltWithURL("v14", {
-        LOOKUP: url,
-        HIDETEXT: hideAll,
-        HIDEDL: hideDescriptionAndLinks,
-        LIVEONLY: onlyLiveTechnologies,
-        NOMETA: noMetaData,
-        NOATTR: noAttributeData
-      });
-
-      const res = await utils.makeStandardRequest(bwURL, responseFormat);
-
-      return res;
-    },
-
-    /**
-     * Make a request to the BuiltWith Lists API
-     *
-     * @see: https://api.builtwith.com/lists-api
-     * @param {String} technology
-     * @param {Object} params
-     */
-    lists: async function(technology, params) {
-      const includeMetaData = _.get(params, "includeMetaData", false);
-      const offset = _.get(params, "offset");
-      const since = _.get(params, "since");
-
-      const bwURL = constructBuiltWithURL("lists5", {
-        TECH: technology,
-        META: includeMetaData,
-        OFFSET: offset,
-        SINCE: since
-      });
-
-      const res = await utils.makeBulletProofRequest(bwURL)
-      return res
-    },
-
-    /**
-     * Make a request to the BuiltWith Relationships API
-     *
-     * @note Relationships API may throw an error related to the maxJSONLength property for certain URLs. This is thrown in BuiltWith and cannot be handled here.
-     *
-     * @see https://api.builtwith.com/relationships-api
-     * @param {String} url
-     */
-    relationships: async function(url) {
-      const bwURL = constructBuiltWithURL("rv1", {
-        LOOKUP: url
-      });
-
-      const res = await utils.makeStandardRequest(bwURL, responseFormat);
-
-      return res;
-    },
-
-    /**
-     * Make a request to the BuiltWith Keywords API
-     *
-     * @see https://api.builtwith.com/keywords-api
-     * @param {String} url
-     */
-    keywords: async function(url) {
-      const bwURL = constructBuiltWithURL("kw2", {
-        LOOKUP: url
-      });
-
-      const res = await utils.makeStandardRequest(bwURL, responseFormat)
-      return res;
-    },
-
-    /**
-     * Make a request to the BuiltWith Trends API
-     *
-     * @see: https://api.builtwith.com/trends-api
-     * @param {String} technology
-     * @param {Object} params
-     */
-    trends: async function(technology, params) {
-      const date = _.get(params, "date");
-
-      const bwURL = constructBuiltWithURL("trends/v6", {
-        TECH: technology,
-        DATE: date
-      });
-
-      const res = await utils.makeBulletProofRequest(bwURL);
-      return res
-    },
-
-    /**
-     * Make a request to the BuiltWith Company to URL API
-     *
-     * @see: https://api.builtwith.com/trends-api
-     * @param {String} companyName
-     * @param {Object} params
-     */
-    companyToUrl: async function(companyName, params) {
-      const tld = _.get(params, "tld");
-      const amount = _.get(params, "noMetaData");
-
-      const bwURL = constructBuiltWithURL(
-        "ctu1",
-        {
-          COMPANY: encodeURIComponent(companyName),
-          TLD: tld,
-          AMOUNT: amount
-        },
-        "ctu"
-      );
-
-      const res = await utils.makeStandardRequest(bwURL, responseFormat)
-      return res;
-    },
-
-    /**
-     * Make a request to the BuiltWith Domain Live API
-     *
-     * @see https://api.builtwith.com/domain-live-api
-     * @param {String} url
-     */
-    domainLive: async function(url) {
-      const bwURL = constructBuiltWithURL("dlv1", {
-        LOOKUP: url
-      });
-
-      const res = await utils.makeStandardRequest(bwURL, responseFormat)
-      return res;
-    },
-
-    /**
-     * Make a request to the BuiltWith Domain Live API
-     *
-     * @see https://api.builtwith.com/trust-api
-     * @param {String} url
-     * @param {Object} params
-     */
-    trust: async function(url, params) {
-      const words = _.get(params, "words", "")
-      const live = _.get(params, "live", false)
-
-      const bwURL = constructBuiltWithURL("trustv1", {
-        LOOKUP: url,
-        // 'wordOne, wordTwo' ==> 'wordOne,wordTwo'
-        WORDS: words.split(',').map(wrd => wrd.trim()).join(','),
-        LIVE: live
-      });
-
-      const res = await utils.makeStandardRequest(bwURL, responseFormat)
-      return res;
-    },
-
-  };
-}
-
-// Constructor to authenticate and get module
-module.exports = function(apiKey, moduleParams) {
-  if (!apiKey) {
-    throw new Error('You must initialize the BuiltWith module with an api key')
-  }
-  return BuiltWith(apiKey, moduleParams)
-}

package/src/utils.js

@@ -1,56 +0,0 @@
-const fetch = require("node-fetch")
-const { VALID_RESPONSE_TYPES } = require("./config")
-
-module.exports = {
-  makeStandardRequest: async function(url, responseFormat) {
-    return fetch(url).then(res => {
-      if (responseFormat === VALID_RESPONSE_TYPES.XML) {
-        return res.text();
-      } else {
-        return res.json();
-      }
-    });
-  },
-
-  makeBulletProofRequest: async function(url, responseFormat) {
-    const res = await fetch(url);
-    if (
-      responseFormat === VALID_RESPONSE_TYPES.TXT ||
-      responseFormat === VALID_RESPONSE_TYPES.XML
-    ) {
-      return res.text();
-    } else {
-      /**
-       * BuiltWith sends invalid formats as errors, which break JSON parsing.
-       */
-      let parsed = await res.text();
-
-      try {
-        return JSON.parse(parsed);
-      } catch (e) {
-        console.warn(
-          "BuiltWith sent an invalid JSON payload. Falling back to text parsing."
-        );
-        return parsed;
-      }
-    }
-  },
-
-  /**
-   *  Convert a parameters object into a query string, joined by the `&` char
-   * { paramOne: 'hello', paramTwo: 'goodbye' }
-   * @param {Object} params
-   */
-  paramsObjToQueryString: function(params) {
-    // '&paramOne=hello&paramTwo=goodbye
-    return Object.entries(params) // [['paramOne', 'hello'], ['paramTwo', 'goodbye]]
-      .filter(([, value]) => {
-        if (value === undefined) return false;
-        else return true;
-      })
-      .map(([key, value]) => {
-        return `${key}=${value}`; // ['paramOne=hello', 'paramTwo=goodbye']
-      })
-      .join("&"); // 'paramOne=hello&paramTwo=goodBye'
-  }
-}