builtwith-api 1.0.8 → 3.2.0

package/dist/schemas.d.ts

@@ -0,0 +1,470 @@
+import { z } from "zod/v4";
+/** Supported API response formats. */
+export declare const ResponseFormatSchema: z.ZodEnum<{
+    xml: "xml";
+    json: "json";
+    txt: "txt";
+    csv: "csv";
+    tsv: "tsv";
+}>;
+/**
+ * Response format returned by the BuiltWith API.
+ *
+ * - `"json"` — parsed and validated (default)
+ * - `"xml"` / `"txt"` / `"csv"` / `"tsv"` — returned as raw strings
+ */
+export type ResponseFormat = z.infer<typeof ResponseFormatSchema>;
+/** Validation schema for {@link ClientOptions}. */
+export declare const ClientOptionsSchema: z.ZodObject<{
+    responseFormat: z.ZodOptional<z.ZodEnum<{
+        xml: "xml";
+        json: "json";
+        txt: "txt";
+        csv: "csv";
+        tsv: "tsv";
+    }>>;
+}, z.core.$strict>;
+/**
+ * Options passed to `createClient`.
+ *
+ * @example
+ * ```ts
+ * const client = createClient(API_KEY, { responseFormat: "xml" });
+ * ```
+ */
+export type ClientOptions = z.infer<typeof ClientOptionsSchema>;
+/** Validation schema for {@link DomainParams}. */
+export declare const DomainParamsSchema: z.ZodObject<{
+    hideAll: z.ZodOptional<z.ZodBoolean>;
+    hideDescriptionAndLinks: z.ZodOptional<z.ZodBoolean>;
+    onlyLiveTechnologies: z.ZodOptional<z.ZodBoolean>;
+    noMetaData: z.ZodOptional<z.ZodBoolean>;
+    noAttributeData: z.ZodOptional<z.ZodBoolean>;
+    noPII: z.ZodOptional<z.ZodBoolean>;
+    firstDetectedRange: z.ZodOptional<z.ZodString>;
+    lastDetectedRange: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * Optional parameters for the Domain API endpoint.
+ *
+ * @example
+ * ```ts
+ * await client.domain("example.com", {
+ *   onlyLiveTechnologies: true,
+ *   hideAll: true,
+ * });
+ * ```
+ */
+export type DomainParams = z.infer<typeof DomainParamsSchema>;
+/** Validation schema for {@link ListsParams}. */
+export declare const ListsParamsSchema: z.ZodObject<{
+    includeMetaData: z.ZodOptional<z.ZodBoolean>;
+    offset: z.ZodOptional<z.ZodString>;
+    since: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * Optional parameters for the Lists API endpoint.
+ *
+ * @example
+ * ```ts
+ * await client.lists("Shopify", { since: "2024-01-01" });
+ * ```
+ */
+export type ListsParams = z.infer<typeof ListsParamsSchema>;
+/** Validation schema for {@link TrendsParams}. */
+export declare const TrendsParamsSchema: z.ZodObject<{
+    date: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * Optional parameters for the Trends API endpoint.
+ *
+ * @example
+ * ```ts
+ * await client.trends("jQuery", { date: "2024-06" });
+ * ```
+ */
+export type TrendsParams = z.infer<typeof TrendsParamsSchema>;
+/** Validation schema for {@link CompanyToUrlParams}. */
+export declare const CompanyToUrlParamsSchema: z.ZodObject<{
+    tld: z.ZodOptional<z.ZodString>;
+    amount: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+/**
+ * Optional parameters for the Company-to-URL API endpoint.
+ *
+ * @example
+ * ```ts
+ * await client.companyToUrl("Google", { tld: "com", amount: 5 });
+ * ```
+ */
+export type CompanyToUrlParams = z.infer<typeof CompanyToUrlParamsSchema>;
+/** Validation schema for {@link TrustParams}. */
+export declare const TrustParamsSchema: z.ZodObject<{
+    words: z.ZodOptional<z.ZodString>;
+    live: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/**
+ * Optional parameters for the Trust API endpoint.
+ *
+ * @example
+ * ```ts
+ * await client.trust("example.com", { words: "shop,buy", live: true });
+ * ```
+ */
+export type TrustParams = z.infer<typeof TrustParamsSchema>;
+export declare const SingleLookupSchema: z.ZodString;
+export declare const MultiLookupSchema: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
+/** Validation schema for {@link FreeResponse}. */
+export declare const FreeResponseSchema: z.ZodObject<{
+    domain: z.ZodString;
+    first: z.ZodNumber;
+    last: z.ZodNumber;
+    groups: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        live: z.ZodNumber;
+        dead: z.ZodNumber;
+        latest: z.ZodNumber;
+        oldest: z.ZodNumber;
+        categories: z.ZodArray<z.ZodObject<{
+            live: z.ZodNumber;
+            dead: z.ZodNumber;
+            latest: z.ZodNumber;
+            oldest: z.ZodNumber;
+            name: z.ZodString;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/** Response from the Free API — basic technology profile for a single domain. */
+export type FreeResponse = z.infer<typeof FreeResponseSchema>;
+/** Validation schema for {@link DomainResponse}. */
+export declare const DomainResponseSchema: z.ZodObject<{
+    Results: z.ZodArray<z.ZodObject<{
+        Result: z.ZodObject<{
+            SpendHistory: z.ZodArray<z.ZodObject<{
+                D: z.ZodNumber;
+                S: z.ZodNumber;
+            }, z.core.$strict>>;
+            IsDB: z.ZodString;
+            Spend: z.ZodNumber;
+            Paths: z.ZodArray<z.ZodObject<{
+                Technologies: z.ZodArray<z.ZodObject<{
+                    Name: z.ZodString;
+                    Description: z.ZodString;
+                    Link: z.ZodString;
+                    Parent: z.ZodOptional<z.ZodString>;
+                    Tag: z.ZodString;
+                    FirstDetected: z.ZodNumber;
+                    LastDetected: z.ZodNumber;
+                    IsPremium: z.ZodString;
+                    Categories: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                }, z.core.$strict>>;
+                FirstIndexed: z.ZodNumber;
+                LastIndexed: z.ZodNumber;
+                Domain: z.ZodString;
+                Url: z.ZodString;
+                SubDomain: z.ZodString;
+            }, z.core.$strict>>;
+        }, z.core.$strict>;
+        Meta: z.ZodObject<{
+            Majestic: z.ZodNumber;
+            Vertical: z.ZodString;
+            Social: z.ZodArray<z.ZodString>;
+            CompanyName: z.ZodString;
+            Telephones: z.ZodArray<z.ZodString>;
+            Emails: z.ZodArray<z.ZodString>;
+            City: z.ZodString;
+            State: z.ZodString;
+            Postcode: z.ZodString;
+            Country: z.ZodString;
+            Names: z.ZodArray<z.ZodObject<{
+                Name: z.ZodString;
+                Type: z.ZodNumber;
+                Level: z.ZodString;
+                Email: z.ZodString;
+            }, z.core.$strict>>;
+            ARank: z.ZodNumber;
+            QRank: z.ZodNumber;
+        }, z.core.$strict>;
+        Attributes: z.ZodObject<{
+            MJRank: z.ZodNumber;
+            MJTLDRank: z.ZodNumber;
+            RefSN: z.ZodNumber;
+            RefIP: z.ZodNumber;
+            Sitemap: z.ZodNumber;
+            GTMTags: z.ZodNumber;
+            QubitTags: z.ZodNumber;
+            TealiumTags: z.ZodNumber;
+            AdobeTags: z.ZodNumber;
+            CDimensions: z.ZodNumber;
+            CGoals: z.ZodNumber;
+            CMetrics: z.ZodNumber;
+        }, z.core.$strict>;
+        FirstIndexed: z.ZodNumber;
+        LastIndexed: z.ZodNumber;
+        Lookup: z.ZodString;
+        SalesRevenue: z.ZodNumber;
+    }, z.core.$strict>>;
+    Errors: z.ZodArray<z.ZodString>;
+}, z.core.$strict>;
+/** Response from the Domain API — detailed technology profile with metadata and attributes. */
+export type DomainResponse = z.infer<typeof DomainResponseSchema>;
+/** Validation schema for {@link ListsResponse}. */
+export declare const ListsResponseSchema: z.ZodObject<{
+    NextOffset: z.ZodString;
+    Results: z.ZodArray<z.ZodObject<{
+        D: z.ZodString;
+        FI: z.ZodOptional<z.ZodNumber>;
+        LI: z.ZodOptional<z.ZodNumber>;
+        LOS: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        Q: z.ZodOptional<z.ZodNumber>;
+        A: z.ZodOptional<z.ZodNumber>;
+        U: z.ZodOptional<z.ZodNumber>;
+        M: z.ZodOptional<z.ZodNumber>;
+        SKU: z.ZodOptional<z.ZodNumber>;
+        F: z.ZodOptional<z.ZodNumber>;
+        E: z.ZodOptional<z.ZodNumber>;
+        FD: z.ZodOptional<z.ZodNumber>;
+        LD: z.ZodOptional<z.ZodNumber>;
+        S: z.ZodOptional<z.ZodNumber>;
+        R: z.ZodOptional<z.ZodNumber>;
+        Country: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/** Response from the Lists API — domains using a specific technology. */
+export type ListsResponse = z.infer<typeof ListsResponseSchema>;
+/** Validation schema for {@link RelationshipsResponse}. */
+export declare const RelationshipsResponseSchema: z.ZodObject<{
+    Relationships: z.ZodArray<z.ZodObject<{
+        Domain: z.ZodString;
+        Identifiers: z.ZodArray<z.ZodObject<{
+            Value: z.ZodString;
+            Type: z.ZodString;
+            First: z.ZodNumber;
+            Last: z.ZodNumber;
+            Matches: z.ZodArray<z.ZodObject<{
+                Domain: z.ZodString;
+                First: z.ZodNumber;
+                Last: z.ZodNumber;
+                Overlap: z.ZodBoolean;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    Errors: z.ZodArray<z.ZodString>;
+    results: z.ZodNumber;
+    max_per_page: z.ZodNumber;
+    next_skip: z.ZodNumber;
+    more_results: z.ZodBoolean;
+}, z.core.$strict>;
+/** Response from the Relationships API — domains sharing identifiers (analytics IDs, ad accounts, etc.). */
+export type RelationshipsResponse = z.infer<typeof RelationshipsResponseSchema>;
+/** Validation schema for {@link KeywordsResponse}. */
+export declare const KeywordsResponseSchema: z.ZodObject<{
+    Keywords: z.ZodArray<z.ZodObject<{
+        Domain: z.ZodString;
+        Keywords: z.ZodArray<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/** Response from the Keywords API — SEO keywords associated with domains. */
+export type KeywordsResponse = z.infer<typeof KeywordsResponseSchema>;
+/** Validation schema for {@link TrendsResponse}. */
+export declare const TrendsResponseSchema: z.ZodObject<{
+    Tech: z.ZodObject<{
+        icon: z.ZodString;
+        categories: z.ZodArray<z.ZodString>;
+        tag: z.ZodString;
+        is_premium: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodString;
+        link: z.ZodString;
+        trends_link: z.ZodString;
+        coverage: z.ZodObject<{
+            ten_k: z.ZodNumber;
+            hundred_k: z.ZodNumber;
+            milly: z.ZodNumber;
+            live: z.ZodNumber;
+            expired: z.ZodNumber;
+        }, z.core.$strict>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+/** Response from the Trends API — technology adoption coverage data. */
+export type TrendsResponse = z.infer<typeof TrendsResponseSchema>;
+/** Validation schema for {@link CompanyToUrlResponse}. */
+export declare const CompanyToUrlResponseSchema: z.ZodArray<z.ZodObject<{
+    Domain: z.ZodString;
+    CompanyName: z.ZodString;
+    Spend: z.ZodNumber;
+    PageRank: z.ZodNumber;
+    BuiltWithRank: z.ZodNumber;
+    Parked: z.ZodBoolean;
+    Country: z.ZodString;
+    State: z.ZodString;
+    Postcode: z.ZodString;
+    City: z.ZodString;
+    Socials: z.ZodArray<z.ZodString>;
+}, z.core.$strict>>;
+/** Response from the Company-to-URL API — domains associated with a company name. */
+export type CompanyToUrlResponse = z.infer<typeof CompanyToUrlResponseSchema>;
+/** Validation schema for {@link TrustResponse}. */
+export declare const TrustResponseSchema: z.ZodObject<{
+    Domain: z.ZodString;
+    DBRecord: z.ZodObject<{
+        EarliestRecord: z.ZodNumber;
+        LatestUpdate: z.ZodNumber;
+        PremiumTechs: z.ZodNumber;
+        LiveTechs: z.ZodBoolean;
+        AffiliateLinks: z.ZodBoolean;
+        PaymentOptions: z.ZodBoolean;
+        Ecommerce: z.ZodBoolean;
+        Parked: z.ZodBoolean;
+        Spend: z.ZodNumber;
+        Established: z.ZodBoolean;
+        DBIndexed: z.ZodBoolean;
+    }, z.core.$strict>;
+    LiveRecord: z.ZodNullable<z.ZodObject<{}, z.core.$loose>>;
+    Status: z.ZodNumber;
+}, z.core.$strict>;
+/** Response from the Trust API — domain verification and trust score. */
+export type TrustResponse = z.infer<typeof TrustResponseSchema>;
+/** Validation schema for {@link TagsResponse}. */
+export declare const TagsResponseSchema: z.ZodArray<z.ZodObject<{
+    Value: z.ZodString;
+    Matches: z.ZodArray<z.ZodObject<{
+        Domain: z.ZodString;
+        First: z.ZodString;
+        Last: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>>;
+/** Response from the Tags API — tracking and analytics tags found on a domain. */
+export type TagsResponse = z.infer<typeof TagsResponseSchema>;
+/** Validation schema for {@link RecommendationsResponse}. */
+export declare const RecommendationsResponseSchema: z.ZodArray<z.ZodObject<{
+    Domain: z.ZodString;
+    Compiled: z.ZodString;
+    Recommendations: z.ZodArray<z.ZodObject<{
+        link: z.ZodString;
+        name: z.ZodString;
+        tag: z.ZodString;
+        categories: z.ZodArray<z.ZodString>;
+        stars: z.ZodNumber;
+        match: z.ZodNumber;
+    }, z.core.$strict>>;
+}, z.core.$strict>>;
+/** Response from the Recommendations API — suggested technologies for a domain. */
+export type RecommendationsResponse = z.infer<typeof RecommendationsResponseSchema>;
+/** Validation schema for {@link RedirectsResponse}. */
+export declare const RedirectsResponseSchema: z.ZodObject<{
+    Lookup: z.ZodString;
+    Inbound: z.ZodArray<z.ZodObject<{
+        Domain: z.ZodString;
+        FirstDetected: z.ZodString;
+        LastDetected: z.ZodString;
+    }, z.core.$strict>>;
+    Outbound: z.ZodArray<z.ZodObject<{
+        Domain: z.ZodString;
+        FirstDetected: z.ZodString;
+        LastDetected: z.ZodString;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/** Response from the Redirects API — inbound and outbound redirect chains. */
+export type RedirectsResponse = z.infer<typeof RedirectsResponseSchema>;
+/** Validation schema for {@link ProductResponse}. */
+export declare const ProductResponseSchema: z.ZodObject<{
+    query: z.ZodString;
+    is_more: z.ZodBoolean;
+    page: z.ZodNumber;
+    limit: z.ZodNumber;
+    results: z.ZodNumber;
+    shop_count: z.ZodNumber;
+    credits: z.ZodNumber;
+    used: z.ZodNumber;
+    remaining: z.ZodNumber;
+    used_this_query: z.ZodNumber;
+    next_page: z.ZodString;
+    shops: z.ZodArray<z.ZodObject<{
+        Domain: z.ZodString;
+        Products: z.ZodArray<z.ZodObject<{
+            Title: z.ZodString;
+            Url: z.ZodString;
+            Indexed: z.ZodString;
+            FirstIndexed: z.ZodString;
+            Price: z.ZodNumber;
+        }, z.core.$strict>>;
+        Type: z.ZodNumber;
+        Spend: z.ZodNumber;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+/** Response from the Product API — e-commerce product search results. */
+export type ProductResponse = z.infer<typeof ProductResponseSchema>;
+/**
+ * The BuiltWith API client. Created via `createClient()`.
+ *
+ * All methods return validated, typed responses when using JSON format,
+ * or raw strings for XML/TXT/CSV/TSV formats.
+ *
+ * @example
+ * ```ts
+ * import { createClient } from "builtwith-api";
+ *
+ * const client = createClient(process.env.BUILTWITH_API_KEY!);
+ * const profile = await client.free("example.com");
+ * ```
+ */
+export interface BuiltWithClient {
+    /** Free lookup — basic technology profile for a single domain. */
+    free(lookup: string): Promise<FreeResponse | string>;
+    /**
+     * Detailed technology profile for one or more domains.
+     * @param lookup - Single domain or array of up to 16 domains.
+     * @param params - Optional filters (hide fields, date ranges, etc.).
+     */
+    domain(lookup: string | string[], params?: DomainParams): Promise<DomainResponse | string>;
+    /**
+     * List domains using a specific technology.
+     * @param technology - Technology name (e.g. "Shopify", "React").
+     * @param params - Optional pagination and filtering.
+     */
+    lists(technology: string, params?: ListsParams): Promise<ListsResponse | string>;
+    /**
+     * Find related domains via shared identifiers (analytics IDs, ad accounts, etc.).
+     * @param lookup - Single domain or array of up to 16 domains.
+     */
+    relationships(lookup: string | string[]): Promise<RelationshipsResponse | string>;
+    /**
+     * Get SEO keywords associated with one or more domains.
+     * @param lookup - Single domain or array of up to 16 domains.
+     */
+    keywords(lookup: string | string[]): Promise<KeywordsResponse | string>;
+    /**
+     * Technology adoption trends and coverage data.
+     * @param technology - Technology name to look up.
+     * @param params - Optional date filter.
+     */
+    trends(technology: string, params?: TrendsParams): Promise<TrendsResponse | string>;
+    /**
+     * Find domains associated with a company name.
+     * @param companyName - Company name to search.
+     * @param params - Optional TLD filter and result count.
+     */
+    companyToUrl(companyName: string, params?: CompanyToUrlParams): Promise<CompanyToUrlResponse | string>;
+    /** Live technology lookup — scans the domain in real time. */
+    domainLive(lookup: string): Promise<DomainResponse | string>;
+    /**
+     * Trust and verification score for a domain.
+     * @param lookup - Domain to look up.
+     * @param params - Optional keywords and live analysis toggle.
+     */
+    trust(lookup: string, params?: TrustParams): Promise<TrustResponse | string>;
+    /** Get tracking and analytics tags found on a domain. */
+    tags(lookup: string): Promise<TagsResponse | string>;
+    /** Get technology recommendations for a domain. */
+    recommendations(lookup: string): Promise<RecommendationsResponse | string>;
+    /** Get inbound and outbound redirect chains for a domain. */
+    redirects(lookup: string): Promise<RedirectsResponse | string>;
+    /** Search for products across e-commerce sites. */
+    product(query: string): Promise<ProductResponse | string>;
+}
+/** @internal Maps JS param names to BuiltWith API query string keys. */
+export type BooleanMapping = Record<string, string>;
+/** @internal URL query parameters — `undefined` values are omitted. */
+export type QueryParams = Record<string, string | number | undefined>;
+//# sourceMappingURL=schemas.d.ts.map

package/dist/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAI3B,sCAAsC;AACtC,eAAO,MAAM,oBAAoB;;;;;;EAA+C,CAAC;AACjF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,mDAAmD;AACnD,eAAO,MAAM,mBAAmB;;;;;;;;kBAE9B,CAAC;AACH;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAKhE,kDAAkD;AAClD,eAAO,MAAM,kBAAkB;;;;;;;;;kBAS7B,CAAC;AACH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,iDAAiD;AACjD,eAAO,MAAM,iBAAiB;;;;kBAI5B,CAAC;AACH;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,kDAAkD;AAClD,eAAO,MAAM,kBAAkB;;kBAE7B,CAAC;AACH;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,wDAAwD;AACxD,eAAO,MAAM,wBAAwB;;;kBAGnC,CAAC;AACH;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E,iDAAiD;AACjD,eAAO,MAAM,iBAAiB;;;kBAG5B,CAAC;AACH;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,eAAO,MAAM,kBAAkB,aAAoB,CAAC;AACpD,eAAO,MAAM,iBAAiB,6DAA0E,CAAC;AAMzG,kDAAkD;AAClD,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;kBAsB7B,CAAC;AACH,iFAAiF;AACjF,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AA6D9D,oDAAoD;AACpD,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAuB/B,CAAC;AACH,+FAA+F;AAC/F,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,mDAAmD;AACnD,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;kBAsB9B,CAAC;AACH,yEAAyE;AACzE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,2DAA2D;AAC3D,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;kBA2BtC,CAAC;AACH,4GAA4G;AAC5G,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF,sDAAsD;AACtD,eAAO,MAAM,sBAAsB;;;;;kBAOjC,CAAC;AACH,6EAA6E;AAC7E,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,oDAAoD;AACpD,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;kBAkB/B,CAAC;AACH,wEAAwE;AACxE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,0DAA0D;AAC1D,eAAO,MAAM,0BAA0B;;;;;;;;;;;;mBActC,CAAC;AACF,qFAAqF;AACrF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,mDAAmD;AACnD,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;kBAmB9B,CAAC;AACH,yEAAyE;AACzE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,kDAAkD;AAClD,eAAO,MAAM,kBAAkB;;;;;;;mBAW9B,CAAC;AACF,kFAAkF;AAClF,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,6DAA6D;AAC7D,eAAO,MAAM,6BAA6B;;;;;;;;;;;mBAezC,CAAC;AACF,mFAAmF;AACnF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAEpF,uDAAuD;AACvD,eAAO,MAAM,uBAAuB;;;;;;;;;;;;kBAgBlC,CAAC;AACH,8EAA8E;AAC9E,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE,qDAAqD;AACrD,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;kBA4BhC,CAAC;AACH,yEAAyE;AACzE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAIpE;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,MAAM,CAAC,CAAC;IACrD;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,GAAG,MAAM,CAAC,CAAC;IAC3F;;;;OAIG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,GAAG,MAAM,CAAC,CAAC;IACjF;;;OAGG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,qBAAqB,GAAG,MAAM,CAAC,CAAC;IAClF;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,gBAAgB,GAAG,MAAM,CAAC,CAAC;IACxE;;;;OAIG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,GAAG,MAAM,CAAC,CAAC;IACpF;;;;OAIG;IACH,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,GAAG,MAAM,CAAC,CAAC;IACvG,8DAA8D;IAC9D,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,MAAM,CAAC,CAAC;IAC7D;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,GAAG,MAAM,CAAC,CAAC;IAC7E,yDAAyD;IACzD,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,MAAM,CAAC,CAAC;IACrD,mDAAmD;IACnD,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,GAAG,MAAM,CAAC,CAAC;IAC3E,6DAA6D;IAC7D,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,GAAG,MAAM,CAAC,CAAC;IAC/D,mDAAmD;IACnD,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,MAAM,CAAC,CAAC;CAC3D;AAID,wEAAwE;AACxE,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACpD,uEAAuE;AACvE,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,CAAC"}

package/package.json

@@ -1,29 +1,63 @@
 {
   "name": "builtwith-api",
-  "version": "1.0.8",
-  "description": "Wrapper for the BuiltWith API",
-  "main": "src/index.js",
-  "scripts": {},
+  "version": "3.2.0",
+  "description": "Typed TypeScript wrapper for the BuiltWith API — library and CLI",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "builtwith": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./commands": {
+      "types": "./dist/commands.d.ts",
+      "import": "./dist/commands.js"
+    },
+    "./errors": {
+      "types": "./dist/errors.d.ts",
+      "import": "./dist/errors.js"
+    }
+  },
+  "scripts": {
+    "build": "bun run build:js && bun run build:types && chmod +x dist/cli.js",
+    "build:js": "bun build ./src/index.ts ./src/cli.ts ./src/errors.ts ./src/commands.ts --outdir dist --target node --format esm --sourcemap=external --external zod",
+    "build:types": "tsc --emitDeclarationOnly",
+    "cli": "bun run src/cli.ts",
+    "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"
+  },
   "homepage": "https://github.com/zcaceres/builtwith-api",
   "repository": {
     "type": "git",
-    "url": "https://github.com/zcaceres/builtwith-api.git"
+    "url": "https://github.com/zcaceres/builtwith-api.git",
+    "directory": "packages/builtwith-api"
   },
   "keywords": [
-    "utilities",
-    "BuiltWith",
-    "apis"
+    "builtwith",
+    "api",
+    "cli",
+    "technology-detection",
+    "web-intelligence"
   ],
   "files": [
-    "src",
-    "src/utils"
+    "dist"
   ],
   "author": "Zach Caceres (@zachcaceres)",
   "license": "MIT",
-  "dependencies": {
-    "lodash": "^4.17.15"
+  "engines": {
+    "node": ">=18.0.0"
   },
-  "devDependencies": {
-    "dotenv": "^8.2.0"
+  "dependencies": {
+    "zod": "^4.3.6"
   }
 }

package/README.md

@@ -1,100 +0,0 @@
-# Builtwith API
-
-`builtwith-api` is a utility wrapper for the BuiltWith API suite.
-
-Install using
-```
-yarn install builtwith-api
-
-or
-
-npm install builtwith-api
-```
-
-## Features
-
-Response Formats
-- JSON support
-- XML support
-- TXT support (only for lists API)
-
-APIS
-- free
-- domain
-- lists
-- relationships
-- keywords
-- trends
-- companyToUrl
-- domainLive
-- trust
-
-________________
-
-## How To Use
-
-```js
-const BuiltWith = require('builtwith-api')
-
-const builtwith = BuiltWith(process.env.YOUR_BUILTWITH_API_KEY, {
-  responseFormat: 'json' // 'json' 'xml' 'txt' (only for lists API)
-})
-
-const url = 'facebook.com'
-
-await builtwith.free(url)
-
-await builtwith.domain(url, {
-  // This will hide technology description, link, tag and category fields
-  hideAll: false,
-  // This will hide technology description and link fields (but keep tag and categories)
-  hideDescriptionAndLinks: false,
-  // This will only return technologies we consider to be live
-  onlyLiveTechnologies: true,
-  // No meta data (like address, names etc..) will be returned. Improves performance.
-  noMetaData: true,
-  // No attributes data will be returned
-  noAttributeData: true
-})
-
-const technologies = 'Shopify'
-// The name of a technology. Spaces automatically replaced with dashes (-).
-await builtwith.lists(technology, {
-  // Brings back meta data with the results, which includes names, titles, social links, addresses, emails, telephone numbers, traffic ranks etc.
-  includeMetaData: true,
-  // Gets the next page of results - use the exact value from NextOffset in response. If the value of NextOffset is END there are no more results.
-  offset: 'oQEwEnH2FJuIzeXOEk2T',
-  // Gets live sites using the technology since a certain time, accepts dates and queries i.e. 30 Days Ago or Last January for example.
-  since: '2016-01-20'
-})
-
-await builtwith.relationships(url)
-
-const urls = ['hotelscombined.com', 'builtwith.com']
-// Multi-domain lookup. Will automatically be converted into URI encoded array (hotelscombined.com,builtwith.com).
-await builtwith.keywords(urls)
-
-await builtwith.trends(technology, {
-  // Totals will be the closest to this date - providing the ability to get historical totals
-  date: '2016-01-20'
-})
-
-const companyName = 'Shell'
-await builtwith.companyToUrl(companyName, {
-  // Bring back domains in order of priority - the first result is generally the one we think the website is
-  amount: 1,
-  // Set the priority extension - if you know the country of the company supply the most likely TLD. i.e. for United Kingdom use 'uk'
-  tld: 'com'
-})
-
-await builtwith.domainLive(url)
-
-await builtwith.trust(url, {
-  // If the words specified here are in the HTML of the website the result will have Stopwords set to true for LIVE lookups.
-  words: 'medicine,masks',
-  // Performs a live lookup of the website in question. This slows down the response. A result with a status of 'needLive' requires the LIVE option to determine if the website is suspect or not. Live lookups slow down the response of the API, you should consider calling this if the non-LIVE lookup response status is 'needLive'.
-  live: false
-})
-```
-
-Made live on Facebook by Zach Caceres during Covid-19 Quarantine

package/src/config.js

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