builtwith-api 3.1.0 → 3.2.1

package/dist/cli.js

@@ -15,6 +15,7 @@ var ResponseFormatSchema = z.enum(["xml", "json", "txt", "csv", "tsv"]);
 var ClientOptionsSchema = z.strictObject({
   responseFormat: ResponseFormatSchema.optional()
 });
+var dateRangePattern = /^\d{4}-\d{2}-\d{2}(-\d{4}-\d{2}-\d{2})?$/;
 var DomainParamsSchema = z.strictObject({
   hideAll: z.boolean().optional(),
   hideDescriptionAndLinks: z.boolean().optional(),
@@ -22,8 +23,8 @@ var DomainParamsSchema = z.strictObject({
   noMetaData: z.boolean().optional(),
   noAttributeData: z.boolean().optional(),
   noPII: z.boolean().optional(),
-  firstDetectedRange: z.string().optional(),
-  lastDetectedRange: z.string().optional()
+  firstDetectedRange: z.string().regex(dateRangePattern, "Expected YYYY-MM-DD or YYYY-MM-DD-YYYY-MM-DD").optional(),
+  lastDetectedRange: z.string().regex(dateRangePattern, "Expected YYYY-MM-DD or YYYY-MM-DD-YYYY-MM-DD").optional()
 });
 var ListsParamsSchema = z.strictObject({
   includeMetaData: z.boolean().optional(),
@@ -42,21 +43,18 @@ var TrustParamsSchema = z.strictObject({
   live: z.boolean().optional()
 });
 var SingleLookupSchema = z.string().min(1);
-var MultiLookupSchema = z.union([
-  z.string().min(1),
-  z.array(z.string().min(1)).min(1).max(16)
-]);
-var FreeResponseSchema = z.object({
+var MultiLookupSchema = z.union([z.string().min(1), z.array(z.string().min(1)).min(1).max(16)]);
+var FreeResponseSchema = z.strictObject({
   domain: z.string(),
   first: z.number(),
   last: z.number(),
-  groups: z.array(z.object({
+  groups: z.array(z.strictObject({
     name: z.string(),
     live: z.number(),
     dead: z.number(),
     latest: z.number(),
     oldest: z.number(),
-    categories: z.array(z.object({
+    categories: z.array(z.strictObject({
       live: z.number(),
       dead: z.number(),
       latest: z.number(),
@@ -65,7 +63,7 @@ var FreeResponseSchema = z.object({
     }))
   }))
 });
-var TechnologySchema = z.object({
+var TechnologySchema = z.strictObject({
   Name: z.string(),
   Description: z.string(),
   Link: z.string(),
@@ -76,7 +74,7 @@ var TechnologySchema = z.object({
   IsPremium: z.string(),
   Categories: z.array(z.string()).optional()
 });
-var PathSchema = z.object({
+var PathSchema = z.strictObject({
   Technologies: z.array(TechnologySchema),
   FirstIndexed: z.number(),
   LastIndexed: z.number(),
@@ -84,7 +82,7 @@ var PathSchema = z.object({
   Url: z.string(),
   SubDomain: z.string()
 });
-var MetaSchema = z.object({
+var MetaSchema = z.strictObject({
   Majestic: z.number(),
   Vertical: z.string(),
   Social: z.array(z.string()),
@@ -95,7 +93,7 @@ var MetaSchema = z.object({
   State: z.string(),
   Postcode: z.string(),
   Country: z.string(),
-  Names: z.array(z.object({
+  Names: z.array(z.strictObject({
     Name: z.string(),
     Type: z.number(),
     Level: z.string(),
@@ -104,7 +102,7 @@ var MetaSchema = z.object({
   ARank: z.number(),
   QRank: z.number()
 });
-var AttributesSchema = z.object({
+var AttributesSchema = z.strictObject({
   MJRank: z.number(),
   MJTLDRank: z.number(),
   RefSN: z.number(),
@@ -116,12 +114,15 @@ var AttributesSchema = z.object({
   AdobeTags: z.number(),
   CDimensions: z.number(),
   CGoals: z.number(),
-  CMetrics: z.number()
+  CMetrics: z.number(),
+  Followers: z.number(),
+  Employees: z.number(),
+  ProductCount: z.number().optional()
 });
-var DomainResponseSchema = z.object({
-  Results: z.array(z.object({
-    Result: z.object({
-      SpendHistory: z.array(z.object({
+var DomainResponseSchema = z.strictObject({
+  Results: z.array(z.strictObject({
+    Result: z.strictObject({
+      SpendHistory: z.array(z.strictObject({
         D: z.number(),
         S: z.number()
       })),
@@ -138,9 +139,9 @@ var DomainResponseSchema = z.object({
   })),
   Errors: z.array(z.string())
 });
-var ListsResponseSchema = z.object({
+var ListsResponseSchema = z.strictObject({
   NextOffset: z.string(),
-  Results: z.array(z.object({
+  Results: z.array(z.strictObject({
     D: z.string(),
     FI: z.number().optional(),
     LI: z.number().optional(),
@@ -159,15 +160,15 @@ var ListsResponseSchema = z.object({
     Country: z.string().optional()
   }))
 });
-var RelationshipsResponseSchema = z.object({
-  Relationships: z.array(z.object({
+var RelationshipsResponseSchema = z.strictObject({
+  Relationships: z.array(z.strictObject({
     Domain: z.string(),
-    Identifiers: z.array(z.object({
+    Identifiers: z.array(z.strictObject({
       Value: z.string(),
       Type: z.string(),
       First: z.number(),
       Last: z.number(),
-      Matches: z.array(z.object({
+      Matches: z.array(z.strictObject({
         Domain: z.string(),
         First: z.number(),
         Last: z.number(),
@@ -181,14 +182,14 @@ var RelationshipsResponseSchema = z.object({
   next_skip: z.number(),
   more_results: z.boolean()
 });
-var KeywordsResponseSchema = z.object({
-  Keywords: z.array(z.object({
+var KeywordsResponseSchema = z.strictObject({
+  Keywords: z.array(z.strictObject({
     Domain: z.string(),
     Keywords: z.array(z.string())
   }))
 });
-var TrendsResponseSchema = z.object({
-  Tech: z.object({
+var TrendsResponseSchema = z.strictObject({
+  Tech: z.strictObject({
     icon: z.string(),
     categories: z.array(z.string()),
     tag: z.string(),
@@ -197,7 +198,7 @@ var TrendsResponseSchema = z.object({
     description: z.string(),
     link: z.string(),
     trends_link: z.string(),
-    coverage: z.object({
+    coverage: z.strictObject({
       ten_k: z.number(),
       hundred_k: z.number(),
       milly: z.number(),
@@ -206,7 +207,7 @@ var TrendsResponseSchema = z.object({
     })
   })
 });
-var CompanyToUrlResponseSchema = z.array(z.object({
+var CompanyToUrlResponseSchema = z.array(z.strictObject({
   Domain: z.string(),
   CompanyName: z.string(),
   Spend: z.number(),
@@ -219,9 +220,9 @@ var CompanyToUrlResponseSchema = z.array(z.object({
   City: z.string(),
   Socials: z.array(z.string())
 }));
-var TrustResponseSchema = z.object({
+var TrustResponseSchema = z.strictObject({
   Domain: z.string(),
-  DBRecord: z.object({
+  DBRecord: z.strictObject({
     EarliestRecord: z.number(),
     LatestUpdate: z.number(),
     PremiumTechs: z.number(),
@@ -237,18 +238,18 @@ var TrustResponseSchema = z.object({
   LiveRecord: z.object({}).passthrough().nullable(),
   Status: z.number()
 });
-var TagsResponseSchema = z.array(z.object({
+var TagsResponseSchema = z.array(z.strictObject({
   Value: z.string(),
-  Matches: z.array(z.object({
+  Matches: z.array(z.strictObject({
     Domain: z.string(),
     First: z.string(),
     Last: z.string()
   }))
 }));
-var RecommendationsResponseSchema = z.array(z.object({
+var RecommendationsResponseSchema = z.array(z.strictObject({
   Domain: z.string(),
   Compiled: z.string(),
-  Recommendations: z.array(z.object({
+  Recommendations: z.array(z.strictObject({
     link: z.string(),
     name: z.string(),
     tag: z.string(),
@@ -257,20 +258,20 @@ var RecommendationsResponseSchema = z.array(z.object({
     match: z.number()
   }))
 }));
-var RedirectsResponseSchema = z.object({
+var RedirectsResponseSchema = z.strictObject({
   Lookup: z.string(),
-  Inbound: z.array(z.object({
+  Inbound: z.array(z.strictObject({
     Domain: z.string(),
     FirstDetected: z.string(),
     LastDetected: z.string()
   })),
-  Outbound: z.array(z.object({
+  Outbound: z.array(z.strictObject({
     Domain: z.string(),
     FirstDetected: z.string(),
     LastDetected: z.string()
   }))
 });
-var ProductResponseSchema = z.object({
+var ProductResponseSchema = z.strictObject({
   query: z.string(),
   is_more: z.boolean(),
   page: z.number(),
@@ -282,9 +283,9 @@ var ProductResponseSchema = z.object({
   remaining: z.number(),
   used_this_query: z.number(),
   next_page: z.string(),
-  shops: z.array(z.object({
+  shops: z.array(z.strictObject({
     Domain: z.string(),
-    Products: z.array(z.object({
+    Products: z.array(z.strictObject({
       Title: z.string(),
       Url: z.string(),
       Indexed: z.string(),
@@ -299,10 +300,7 @@ var ProductResponseSchema = z.object({
 // src/params.ts
 var toQueryString = (params) => Object.entries(params).filter((entry) => entry[1] !== undefined).map(([k, v]) => `${k}=${encodeURIComponent(v).replace(/%2C/gi, ",")}`).join("&");
 var booleanFlag = (value) => value ? "yes" : undefined;
-var booleanParams = (params, mapping) => Object.fromEntries(Object.entries(mapping).map(([jsKey, apiKey]) => [
-  apiKey,
-  booleanFlag(params?.[jsKey])
-]));
+var booleanParams = (params, mapping) => Object.fromEntries(Object.entries(mapping).map(([jsKey, apiKey]) => [apiKey, booleanFlag(params?.[jsKey])]));
 var cleanWords = (words) => words ? words.split(",").map((w) => w.trim()).join(",") : undefined;
 var buildURL = (apiKey, format, path, params, subdomain = "api") => {
   const base = `https://${subdomain}.builtwith.com/${path}/api.${format}?KEY=${apiKey}`;
@@ -324,12 +322,23 @@ var validateLookup = (url, { multi = false } = {}) => {
 };
 
 // src/request.ts
+import { z as z2 } from "zod/v4";
 var TEXT_FORMATS = [
   VALID_RESPONSE_TYPES.TXT,
   VALID_RESPONSE_TYPES.XML,
   VALID_RESPONSE_TYPES.CSV,
   VALID_RESPONSE_TYPES.TSV
 ];
+var ApiErrorSchema = z2.object({
+  Errors: z2.array(z2.object({ Message: z2.string() }))
+});
+function checkForApiError(data) {
+  const parsed = ApiErrorSchema.safeParse(data);
+  if (parsed.success && parsed.data.Errors.length > 0) {
+    const messages = parsed.data.Errors.map((e) => e.Message).join("; ");
+    throw new Error(`BuiltWith API error: ${messages}`);
+  }
+}
 var request = async (url, format, schema) => {
   const res = await fetch(url);
   if (!res.ok) {
@@ -339,7 +348,14 @@ var request = async (url, format, schema) => {
   if (TEXT_FORMATS.includes(format)) {
     return res.text();
   }
-  const data = await res.json();
+  const raw = await res.text();
+  let data;
+  try {
+    data = JSON.parse(raw);
+  } catch {
+    throw new Error(`BuiltWith returned invalid JSON: ${raw.slice(0, 200)}`);
+  }
+  checkForApiError(data);
   return schema.parse(data);
 };
 var requestSafe = async (url, format, schema) => {
@@ -359,6 +375,7 @@ var requestSafe = async (url, format, schema) => {
     console.warn("BuiltWith sent an invalid JSON payload. Falling back to text parsing.");
     return raw;
   }
+  checkForApiError(data);
   return schema.parse(data);
 };
 
@@ -470,28 +487,6 @@ function createClient(apiKey, moduleParams = {}) {
   };
 }
 
-// src/errors.ts
-import { z as z2 } from "zod/v4";
-function formatError(err) {
-  if (err instanceof z2.ZodError) {
-    const fields = err.issues.map((i) => {
-      const path = i.path.length > 0 ? i.path.join(".") : "response";
-      return `  ${path}: ${i.message}`;
-    });
-    return `BuiltWith API returned an unexpected response:
-${fields.join(`
-`)}`;
-  }
-  if (err instanceof Error) {
-    return err.message;
-  }
-  return String(err);
-}
-
-// src/cli.ts
-import { createRequire } from "node:module";
-import { parseArgs } from "node:util";
-
 // src/commands.ts
 function splitLookup(value) {
   const str = String(value);
@@ -501,23 +496,36 @@ var commands = [
   {
     name: "free",
     description: "Free lookup — basic technology profile for a domain",
-    args: [
-      { name: "lookup", description: "Domain to look up", type: "string", required: true }
-    ],
+    args: [{ name: "lookup", description: "Domain to look up", type: "string", required: true }],
     execute: (client, args) => client.free(String(args.lookup))
   },
   {
     name: "domain",
     description: "Detailed technology profile for one or more domains (comma-separated)",
     args: [
-      { name: "lookup", description: "Domain(s) to look up (comma-separated for multiple)", type: "string", required: true },
+      {
+        name: "lookup",
+        description: "Domain(s) to look up (comma-separated for multiple)",
+        type: "string",
+        required: true
+      },
       { name: "hideAll", description: "Hide description text and links", type: "boolean", required: false },
-      { name: "hideDescriptionAndLinks", description: "Hide description and links only", type: "boolean", required: false },
+      {
+        name: "hideDescriptionAndLinks",
+        description: "Hide description and links only",
+        type: "boolean",
+        required: false
+      },
       { name: "onlyLiveTechnologies", description: "Only return live technologies", type: "boolean", required: false },
       { name: "noMetaData", description: "Exclude metadata", type: "boolean", required: false },
       { name: "noAttributeData", description: "Exclude attribute data", type: "boolean", required: false },
       { name: "noPII", description: "Exclude personally identifiable information", type: "boolean", required: false },
-      { name: "firstDetectedRange", description: "Filter by first detected date range", type: "string", required: false },
+      {
+        name: "firstDetectedRange",
+        description: "Filter by first detected date range",
+        type: "string",
+        required: false
+      },
       { name: "lastDetectedRange", description: "Filter by last detected date range", type: "string", required: false }
     ],
     execute: (client, args) => {
@@ -544,7 +552,12 @@ var commands = [
     name: "relationships",
     description: "Find related domains via shared identifiers",
     args: [
-      { name: "lookup", description: "Domain(s) to look up (comma-separated for multiple)", type: "string", required: true }
+      {
+        name: "lookup",
+        description: "Domain(s) to look up (comma-separated for multiple)",
+        type: "string",
+        required: true
+      }
     ],
     execute: (client, args) => client.relationships(splitLookup(args.lookup))
   },
@@ -552,7 +565,12 @@ var commands = [
     name: "keywords",
     description: "Get keywords for one or more domains",
     args: [
-      { name: "lookup", description: "Domain(s) to look up (comma-separated for multiple)", type: "string", required: true }
+      {
+        name: "lookup",
+        description: "Domain(s) to look up (comma-separated for multiple)",
+        type: "string",
+        required: true
+      }
     ],
     execute: (client, args) => client.keywords(splitLookup(args.lookup))
   },
@@ -584,9 +602,7 @@ var commands = [
   {
     name: "domainLive",
     description: "Live technology lookup for a domain",
-    args: [
-      { name: "lookup", description: "Domain to look up", type: "string", required: true }
-    ],
+    args: [{ name: "lookup", description: "Domain to look up", type: "string", required: true }],
     execute: (client, args) => client.domainLive(String(args.lookup))
   },
   {
@@ -605,37 +621,91 @@ var commands = [
   {
     name: "tags",
     description: "Get tracking/analytics tags for a domain",
-    args: [
-      { name: "lookup", description: "Domain to look up", type: "string", required: true }
-    ],
+    args: [{ name: "lookup", description: "Domain to look up", type: "string", required: true }],
     execute: (client, args) => client.tags(String(args.lookup))
   },
   {
     name: "recommendations",
     description: "Get technology recommendations for a domain",
-    args: [
-      { name: "lookup", description: "Domain to look up", type: "string", required: true }
-    ],
+    args: [{ name: "lookup", description: "Domain to look up", type: "string", required: true }],
     execute: (client, args) => client.recommendations(String(args.lookup))
   },
   {
     name: "redirects",
     description: "Get redirect chains for a domain",
-    args: [
-      { name: "lookup", description: "Domain to look up", type: "string", required: true }
-    ],
+    args: [{ name: "lookup", description: "Domain to look up", type: "string", required: true }],
     execute: (client, args) => client.redirects(String(args.lookup))
   },
   {
     name: "product",
     description: "Search for products across e-commerce sites",
-    args: [
-      { name: "query", description: "Product search query", type: "string", required: true }
-    ],
+    args: [{ name: "query", description: "Product search query", type: "string", required: true }],
     execute: (client, args) => client.product(String(args.query))
   }
 ];
 
+// src/errors.ts
+import { z as z3 } from "zod/v4";
+function formatError(err) {
+  if (err instanceof z3.ZodError) {
+    const fields = err.issues.map((i) => {
+      const path = i.path.length > 0 ? i.path.join(".") : "response";
+      return `  ${path}: ${i.message}`;
+    });
+    return `BuiltWith API returned an unexpected response:
+${fields.join(`
+`)}`;
+  }
+  if (err instanceof Error) {
+    return err.message;
+  }
+  return String(err);
+}
+
+// src/cli.ts
+import { createRequire } from "node:module";
+import { parseArgs } from "node:util";
+
+// src/format.ts
+function formatTable(data, indent = 0) {
+  const pad = "  ".repeat(indent);
+  if (data === null || data === undefined)
+    return `${pad}(none)`;
+  if (typeof data !== "object")
+    return `${pad}${data}`;
+  if (Array.isArray(data)) {
+    if (data.length === 0)
+      return `${pad}(empty)`;
+    const allFlatObjects = data.every((item) => typeof item === "object" && item !== null && !Array.isArray(item) && Object.values(item).every((v) => v === null || typeof v !== "object"));
+    if (allFlatObjects) {
+      const keys = [...new Set(data.flatMap((item) => Object.keys(item)))];
+      if (keys.length === 0)
+        return `${pad}(${data.length} empty items)`;
+      const widths = keys.map((k) => Math.max(k.length, ...data.map((item) => String(item[k] ?? "").length)));
+      const header = keys.map((k, i) => k.padEnd(widths[i])).join("  ");
+      const separator = keys.map((_, i) => "─".repeat(widths[i])).join("  ");
+      const rows = data.map((item) => keys.map((k, i) => String(item[k] ?? "").padEnd(widths[i])).join("  "));
+      return [pad + header, pad + separator, ...rows.map((r) => pad + r)].join(`
+`);
+    }
+    return data.map((item, i) => `${pad}[${i}]
+${formatTable(item, indent + 1)}`).join(`
+`);
+  }
+  const entries = Object.entries(data);
+  if (entries.length === 0)
+    return `${pad}(empty)`;
+  const maxKey = Math.max(...entries.map(([k]) => k.length));
+  return entries.map(([key, value]) => {
+    if (typeof value === "object" && value !== null) {
+      return `${pad}${key}:
+${formatTable(value, indent + 1)}`;
+    }
+    return `${pad}${key.padEnd(maxKey)}  ${value}`;
+  }).join(`
+`);
+}
+
 // src/cli.ts
 var require2 = createRequire(import.meta.url);
 var { version } = require2("../package.json");
@@ -647,11 +717,13 @@ ${commands.map((c) => `  ${c.name.padEnd(16)} ${c.description}`).join(`
 
 Options:
   --api-key <key>  BuiltWith API key (or set BUILTWITH_API_KEY env var)
+  --table          Pretty-print output as a readable table instead of JSON
   --version        Show version number
   --help           Show help
 
 Examples:
   builtwith free example.com
+  builtwith free example.com --table
   builtwith domain example.com --hideAll --onlyLiveTechnologies
   builtwith domain "example.com,other.com"
   builtwith lists Shopify --since 2024-01-01
@@ -669,11 +741,15 @@ function printCommandHelp(cmd) {
     for (const f of flags) {
       console.log(`  --${f.name.padEnd(28)} ${f.description} (${f.type})`);
     }
+    console.log();
   }
+  console.log("Global options:");
+  console.log(`  --api-key <key>              BuiltWith API key (or set BUILTWITH_API_KEY env var)`);
+  console.log(`  --table                      Pretty-print output as a readable table instead of JSON`);
 }
 function run() {
   const argv = process.argv.slice(2);
-  if (argv.includes("--version") || argv.includes("-V")) {
+  if (argv[0] === "--version" || argv[0] === "-V") {
     console.log(version);
     process.exit(0);
   }
@@ -695,22 +771,30 @@ function run() {
   }
   const primaryArg = cmd.args.find((a) => a.required);
   const primaryValue = argv[1];
-  if (primaryArg && (!primaryValue || primaryValue.startsWith("--"))) {
+  if (primaryArg && (!primaryValue || primaryValue.startsWith("-"))) {
     console.error(`Error: missing required argument <${primaryArg.name}>`);
     process.exit(1);
   }
   const flagArgs = cmd.args.filter((a) => !a.required);
   const options = {
-    "api-key": { type: "string" }
+    "api-key": { type: "string" },
+    table: { type: "boolean" }
   };
   for (const f of flagArgs) {
     options[f.name] = { type: f.type === "boolean" ? "boolean" : "string" };
   }
-  const { values } = parseArgs({
-    args: argv.slice(2),
-    options,
-    strict: false
-  });
+  let values;
+  try {
+    ({ values } = parseArgs({
+      args: argv.slice(2),
+      options,
+      strict: true
+    }));
+  } catch (err) {
+    console.error(`Error: ${err instanceof Error ? err.message : err}`);
+    process.exit(1);
+  }
+  const useTable = Boolean(values.table);
   const apiKey = values["api-key"] || process.env.BUILTWITH_API_KEY;
   if (!apiKey) {
     console.error("Error: pass --api-key or set BUILTWITH_API_KEY environment variable.");
@@ -731,7 +815,11 @@ function run() {
   }
   const client = createClient(apiKey);
   cmd.execute(client, args).then((result) => {
-    console.log(JSON.stringify(result, null, 2));
+    if (useTable) {
+      console.log(formatTable(result));
+    } else {
+      console.log(JSON.stringify(result, null, 2));
+    }
   }).catch((err) => {
     console.error(formatError(err));
     process.exit(1);
@@ -739,4 +827,4 @@ function run() {
 }
 run();
 
-//# debugId=D76DF713FC3000FE64756E2164756E21
+//# debugId=D6F1EBFA208B3E4B64756E2164756E21