builtwith-api 1.0.8 → 3.2.0

package/src/index.js

@@ -1,244 +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;
-  }
-
-  function checkUrlData(url, isMultiDomain = true) {
-    let isArray = Array.isArray(url);
-    if (isArray) {
-      if (!isMultiDomain) throw "API does not allow for multi-domain LOOKUP";
-      if (url.length > 16) throw "Domain LOOKUP size to big (16 max)";
-    }
-  }
-
-  return {
-    /**
-     * Make a request to the BuiltWith Free API
-     *
-     * @see https://api.builtwith.com/free-api
-     * @param {String} url
-     */
-    free: async function (url) {
-      checkUrlData(url, false);
-
-      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|string[])} url
-     * @param {Object} params
-     */
-    domain: async function (url, params) {
-      checkUrlData(url);
-      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("v15", {
-        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|string[])} url
-     */
-    relationships: async function (url) {
-      checkUrlData(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|string[])} url
-     */
-    keywords: async function (url) {
-      checkUrlData(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("ddlv2", {
-        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/index.test.js

@@ -1,90 +0,0 @@
-const nock = require('nock');
-const BuiltWith = require('../src/index');
-
-const apiKey = 'testApiKey';
-const moduleParams = { isBulletProof: false };
-
-describe('BuiltWith', () => {
-  beforeEach(() => {
-    nock('https://api.builtwith.com')
-      .get(/.*/)
-      .reply(200, { test: 'data' });
-  });
-
-  afterEach(() => {
-    nock.cleanAll();
-  });
-
-  it('should make a standard request for the domain API', async () => {
-    const bw = BuiltWith(apiKey, moduleParams);
-
-    const response = await bw.domain('testUrl');
-
-    expect(response).toEqual({ test: 'data' });
-  });
-
-  it('should make a standard request for the lists API', async () => {
-    const bw = BuiltWith(apiKey, moduleParams);
-
-    const response = await bw.lists('testUrl');
-
-    expect(response).toEqual({ test: 'data' });
-  });
-
-  it('should make a standard request for the relationships API', async () => {
-    const bw = BuiltWith(apiKey, moduleParams);
-
-    const response = await bw.relationships('testUrl');
-
-    expect(response).toEqual({ test: 'data' });
-  });
-
-
-  it('should make a standard request for the free API', async () => {
-    const bw = BuiltWith(apiKey, moduleParams);
-
-    const response = await bw.free('testUrl');
-
-    expect(response).toEqual({ test: 'data' });
-  });
-
-  it('should make a standard request for the keywords API', async () => {
-    const bw = BuiltWith(apiKey, moduleParams);
-
-    const response = await bw.keywords('testUrl');
-
-    expect(response).toEqual({ test: 'data' });
-  });
-
-  it('should make a standard request for the trends API', async () => {
-    const bw = BuiltWith(apiKey, moduleParams);
-
-    const response = await bw.trends('testUrl');
-
-    expect(response).toEqual({ test: 'data' });
-  });
-
-  it('should make a standard request for the companyToUrl API', async () => {
-    const bw = BuiltWith(apiKey, moduleParams);
-
-    const response = await bw.companyToUrl('My Company');
-
-    expect(response).toEqual({ test: 'data' });
-  });
-
-  it('should make a standard request for the domainLive API', async () => {
-    const bw = BuiltWith(apiKey, moduleParams);
-
-    const response = await bw.domainLive('testUrl');
-
-    expect(response).toEqual({ test: 'data' });
-  });
-
-  it('should make a standard request for the trust API', async () => {
-    const bw = BuiltWith(apiKey, moduleParams);
-
-    const response = await bw.trust('testUrl');
-
-    expect(response).toEqual({ test: 'data' });
-  });
-});

package/src/utils.js

@@ -1,54 +0,0 @@
-const { VALID_RESPONSE_TYPES } = require("./config");
-
-module.exports = {
-  makeStandardRequest: async function (url, responseFormat) {
-    const res = await fetch(url);
-    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'
-  },
-};