stophy 1.0.1 → 1.0.3

package/README.md

@@ -17,7 +17,7 @@ const result = await new Stophy().web.search({ query: "bun runtime" });
 console.log(result.data.results);
 ```
 
-Web search, YouTube search, and YouTube transcripts work without a key, with a small free allowance. Every other method throws a `StophyError` with the code `unauthorized`.
+Web search, YouTube search, and transcripts work without a key, with a small free allowance. Every other method throws a `StophyError` with the code `unauthorized`.
 
 ## Use an API key
 
@@ -32,42 +32,38 @@ console.log(videos.data.results);
 
 `new Stophy("st_...")` works too.
 
-Methods follow the source and the command: `stophy.maps.search(...)`, `stophy.reddit.subreddit(...)`, `stophy.youtube.comments.replies(...)`. Each result has `data`, `creditsUsed`, and `requestId`.
+Methods follow the source and the command: `stophy.maps.search(...)`, `stophy.reddit.subreddit(...)`, `stophy.ads.search({ network: "meta", ... })`. Endpoints with a single name are methods on the client: `stophy.transcript(...)`, `stophy.suggest(...)`.
+
+Every response is `{ success, data, creditsUsed, requestId }`. `data` is one flat object. Lists are in `data.results`.
 
 ## More sources
 
-A YouTube transcript, Reddit posts, Google Maps reviews and an Amazon product:
+A transcript, Reddit posts, Google Maps reviews, an Amazon product and Meta ads:
 
 ```ts
 const stophy = new Stophy({ apiKey: "st_..." });
 
-const transcript = await stophy.youtube.transcript({ video: "dQw4w9WgXcQ", includeTimestamps: true });
+const transcript = await stophy.transcript({ video: "https://youtu.be/dQw4w9WgXcQ", includeTimestamps: true });
 console.log(transcript.data.text, transcript.data.segments);
 
 const posts = await stophy.reddit.search({ query: "bun runtime", sort: "top", within: "month" });
 console.log(posts.data.results);
 
-const places = await stophy.maps.search({ query: "coffee", near: "Austin, TX", limit: 5 });
-const placeId = places.data.places[0]?.id;
+const places = await stophy.maps.search({ query: "coffee", location: "Austin, TX", limit: 5 });
+const placeId = places.data.results[0]?.placeId;
 if (placeId) {
   const reviews = await stophy.maps.reviews({ place: placeId, limit: 20 });
-  console.log(reviews.data.reviews);
+  console.log(reviews.data.results);
 }
 
 const product = await stophy.amazon.product({ product: "B08N5WRWNW", country: "us" });
-console.log(product.data.product.title, product.data.product.price);
-```
+console.log(product.data.title, product.data.price);
 
-## Get markdown for a model
-
-```ts
-const markdown = await stophy.youtube.search(
-  { query: "bun runtime", limit: 5 },
-  { format: "markdown" },
-);
+const ads = await stophy.ads.search({ network: "meta", query: "running shoes" });
+console.log(ads.data.results);
 ```
 
-With `format: "markdown"`, the method returns a string.
+Some endpoints cover several sources. Pick one with a field: `network` for `ads.*`, `source` for `suggest`, `by` for `google.trends`. The types follow the choice.
 
 ## Get the next page
 

package/dist/index.cjs

@@ -106,29 +106,18 @@ function isRecord(value) {
 
 // src/bind.ts
 function post(path, call) {
-  function run(body, options) {
-    return call({ method: "POST", path, body, options });
-  }
-  return run;
+  return (body, options) => call({ method: "POST", path, body, options });
 }
 function postOptional(path, call) {
-  function run(body, options) {
-    if (isMarkdownOptions(body) && options === void 0) {
-      return call({ method: "POST", path, body: {}, options: body });
-    }
-    return call({ method: "POST", path, body: body ?? {}, options });
-  }
-  return run;
+  return (body, options) => call({
+    method: "POST",
+    path,
+    body: body ?? {},
+    options
+  });
 }
 function get(path, call) {
-  function run(options) {
-    return call({ method: "GET", path, options });
-  }
-  return run;
-}
-function isMarkdownOptions(value) {
-  if (typeof value !== "object" || value === null) return false;
-  return "format" in value && value.format === "markdown";
+  return (options) => call({ method: "GET", path, options });
 }
 
 // src/generated/surface.gen.ts
@@ -137,26 +126,19 @@ function bindSurface(call) {
     endpoints: get("/v1/endpoints", call),
     web: {
       search: post("/v1/web/search", call),
-      news: postOptional("/v1/web/news", call),
-      contacts: post("/v1/web/contacts", call)
+      news: postOptional("/v1/web/news", call)
     },
     youtube: {
       search: post("/v1/youtube/search", call),
       video: post("/v1/youtube/video", call),
-      transcript: post("/v1/youtube/transcript", call),
-      comments: Object.assign(post("/v1/youtube/comments", call), {
-        replies: post("/v1/youtube/comments/replies", call)
-      }),
+      comments: post("/v1/youtube/comments", call),
       channel: post("/v1/youtube/channel", call),
-      playlist: post("/v1/youtube/playlist", call),
-      suggest: post("/v1/youtube/suggest", call)
+      playlist: post("/v1/youtube/playlist", call)
     },
+    transcript: post("/v1/transcript", call),
     reddit: {
       search: post("/v1/reddit/search", call),
       post: post("/v1/reddit/post", call),
-      comments: {
-        more: post("/v1/reddit/comments/more", call)
-      },
       subreddit: post("/v1/reddit/subreddit", call),
       user: post("/v1/reddit/user", call),
       domain: post("/v1/reddit/domain", call)
@@ -168,59 +150,34 @@ function bindSurface(call) {
     },
     instagram: {
       profile: post("/v1/instagram/profile", call),
-      posts: post("/v1/instagram/posts", call),
       post: post("/v1/instagram/post", call),
-      url: post("/v1/instagram/url", call),
       search: post("/v1/instagram/search", call),
-      transcript: post("/v1/instagram/transcript", call),
-      comments: Object.assign(post("/v1/instagram/comments", call), {
-        replies: post("/v1/instagram/comments/replies", call)
-      })
+      comments: post("/v1/instagram/comments", call)
     },
     tiktok: {
       profile: post("/v1/tiktok/profile", call),
       video: post("/v1/tiktok/video", call),
-      url: post("/v1/tiktok/url", call),
-      transcript: post("/v1/tiktok/transcript", call),
-      posts: post("/v1/tiktok/posts", call),
       hashtag: post("/v1/tiktok/hashtag", call),
-      comments: Object.assign(post("/v1/tiktok/comments", call), {
-        replies: post("/v1/tiktok/comments/replies", call)
-      }),
-      search: post("/v1/tiktok/search", call),
-      ads: {
-        search: postOptional("/v1/tiktok/ads/search", call),
-        ad: post("/v1/tiktok/ads/ad", call)
-      }
+      comments: post("/v1/tiktok/comments", call),
+      search: post("/v1/tiktok/search", call)
     },
     bluesky: {
       profile: post("/v1/bluesky/profile", call),
-      posts: post("/v1/bluesky/posts", call),
       post: post("/v1/bluesky/post", call),
       followers: post("/v1/bluesky/followers", call)
     },
-    mastodon: {
-      profile: post("/v1/mastodon/profile", call),
-      posts: post("/v1/mastodon/posts", call),
-      post: post("/v1/mastodon/post", call),
-      hashtag: post("/v1/mastodon/hashtag", call)
-    },
     threads: {
       profile: post("/v1/threads/profile", call),
-      posts: post("/v1/threads/posts", call),
       post: post("/v1/threads/post", call),
       search: post("/v1/threads/search", call)
     },
     telegram: {
-      channel: post("/v1/telegram/channel", call),
       posts: post("/v1/telegram/posts", call),
       post: post("/v1/telegram/post", call)
     },
     meta: {
       ads: {
-        search: post("/v1/meta/ads/search", call),
-        page: post("/v1/meta/ads/page", call),
-        ad: post("/v1/meta/ads/ad", call)
+        page: post("/v1/meta/ads/page", call)
       }
     },
     linkedin: {
@@ -228,82 +185,40 @@ function bindSurface(call) {
         search: postOptional("/v1/linkedin/jobs/search", call),
         job: post("/v1/linkedin/jobs/job", call)
       },
-      ads: {
-        search: postOptional("/v1/linkedin/ads/search", call),
-        ad: post("/v1/linkedin/ads/ad", call)
-      },
-      company: Object.assign(post("/v1/linkedin/company", call), {
-        posts: post("/v1/linkedin/company/posts", call)
-      }),
+      company: post("/v1/linkedin/company", call),
       profile: post("/v1/linkedin/profile", call),
       posts: postOptional("/v1/linkedin/posts", call)
     },
     zillow: {
-      search: postOptional("/v1/zillow/search", call),
+      search: post("/v1/zillow/search", call),
       property: post("/v1/zillow/property", call)
     },
-    google: {
-      ads: {
-        advertisers: post("/v1/google/ads/advertisers", call),
-        search: postOptional("/v1/google/ads/search", call),
-        ad: post("/v1/google/ads/ad", call)
-      },
-      suggest: post("/v1/google/suggest", call),
-      trends: {
-        interest: post("/v1/google/trends/interest", call),
-        regions: post("/v1/google/trends/regions", call),
-        related: post("/v1/google/trends/related", call),
-        trending: postOptional("/v1/google/trends/trending", call)
-      }
-    },
     upwork: {
       search: postOptional("/v1/upwork/search", call),
       job: post("/v1/upwork/job", call)
     },
-    amazon: {
-      suggest: post("/v1/amazon/suggest", call),
-      search: postOptional("/v1/amazon/search", call),
-      product: post("/v1/amazon/product", call),
-      bestsellers: post("/v1/amazon/bestsellers", call)
+    google: {
+      trends: Object.assign(post("/v1/google/trends", call), {
+        related: post("/v1/google/trends/related", call),
+        trending: postOptional("/v1/google/trends/trending", call)
+      })
     },
     site: {
-      map: post("/v1/site/map", call),
       seo: post("/v1/site/seo", call)
     },
-    domain: {
-      whois: post("/v1/domain/whois", call),
-      dns: post("/v1/domain/dns", call),
-      tech: post("/v1/domain/tech", call)
-    },
     email: {
-      check: post("/v1/email/check", call)
+      verify: post("/v1/email/verify", call),
+      find: post("/v1/email/find", call)
     },
     crypto: {
       coins: postOptional("/v1/crypto/coins", call),
       coin: post("/v1/crypto/coin", call),
       history: post("/v1/crypto/history", call),
-      trending: postOptional("/v1/crypto/trending", call),
-      categories: postOptional("/v1/crypto/categories", call),
-      movers: postOptional("/v1/crypto/movers", call),
-      new: postOptional("/v1/crypto/new", call),
       dex: {
         search: post("/v1/crypto/dex/search", call),
-        pairs: post("/v1/crypto/dex/pairs", call),
-        token: post("/v1/crypto/dex/token", call),
-        new: postOptional("/v1/crypto/dex/new", call)
-      },
-      pump: {
-        coins: postOptional("/v1/crypto/pump/coins", call),
-        coin: post("/v1/crypto/pump/coin", call),
-        trades: post("/v1/crypto/pump/trades", call)
+        token: post("/v1/crypto/dex/token", call)
       },
-      wallet: post("/v1/crypto/wallet", call),
-      token: {
-        holders: post("/v1/crypto/token/holders", call)
-      },
-      binance: {
-        announcements: postOptional("/v1/crypto/binance/announcements", call)
-      }
+      wallet: post("/v1/crypto/wallet", call)
     },
     indeed: {
       search: postOptional("/v1/indeed/search", call),
@@ -317,6 +232,11 @@ function bindSurface(call) {
     googletravel: {
       flights: post("/v1/googletravel/flights", call)
     },
+    amazon: {
+      search: postOptional("/v1/amazon/search", call),
+      product: post("/v1/amazon/product", call),
+      bestsellers: post("/v1/amazon/bestsellers", call)
+    },
     shopify: {
       products: post("/v1/shopify/products", call),
       collections: post("/v1/shopify/collections", call),
@@ -347,14 +267,6 @@ function bindSurface(call) {
       calendar: post("/v1/airbnb/calendar", call),
       reviews: post("/v1/airbnb/reviews", call)
     },
-    redfin: {
-      search: post("/v1/redfin/search", call),
-      property: post("/v1/redfin/property", call)
-    },
-    realtor: {
-      search: post("/v1/realtor/search", call),
-      property: post("/v1/realtor/property", call)
-    },
     rightmove: {
       search: post("/v1/rightmove/search", call),
       property: post("/v1/rightmove/property", call)
@@ -367,54 +279,28 @@ function bindSurface(call) {
       search: post("/v1/pinterest/search", call),
       pin: post("/v1/pinterest/pin", call),
       board: post("/v1/pinterest/board", call),
-      user: post("/v1/pinterest/user", call),
-      ads: {
-        search: post("/v1/pinterest/ads/search", call),
-        ad: post("/v1/pinterest/ads/ad", call)
-      }
+      user: post("/v1/pinterest/user", call)
     },
     x: {
-      tweet: post("/v1/x/tweet", call)
-    },
-    kick: {
-      channel: post("/v1/kick/channel", call),
-      videos: post("/v1/kick/videos", call),
-      clips: post("/v1/kick/clips", call)
+      post: post("/v1/x/post", call)
     },
     finance: {
       quote: post("/v1/finance/quote", call),
       history: post("/v1/finance/history", call),
       search: post("/v1/finance/search", call),
-      profile: post("/v1/finance/profile", call)
+      stock: post("/v1/finance/stock", call)
     },
-    microsoft: {
-      ads: {
-        search: postOptional("/v1/microsoft/ads/search", call),
-        ad: post("/v1/microsoft/ads/ad", call),
-        advertisers: post("/v1/microsoft/ads/advertisers", call)
-      }
-    },
-    snapchat: {
-      profile: post("/v1/snapchat/profile", call),
-      ads: {
-        search: post("/v1/snapchat/ads/search", call),
-        ad: post("/v1/snapchat/ads/ad", call)
-      }
-    },
-    tumblr: {
-      blog: post("/v1/tumblr/blog", call),
-      posts: post("/v1/tumblr/posts", call),
-      post: post("/v1/tumblr/post", call),
-      search: post("/v1/tumblr/search", call)
+    ads: {
+      search: post("/v1/ads/search", call),
+      ad: post("/v1/ads/ad", call),
+      advertisers: post("/v1/ads/advertisers", call)
     },
-    quora: {
-      question: post("/v1/quora/question", call)
-    }
+    suggest: post("/v1/suggest", call)
   };
 }
 
 // package.json
-var version = "1.0.1";
+var version = "1.0.3";
 
 // src/transport.ts
 var DEFAULT_BASE_URL = "https://api.stophy.dev";
@@ -431,7 +317,6 @@ function createCaller(options) {
     timeoutMs: options.timeoutMs ?? DEFAULT_TIMEOUT_MS
   };
   return async (spec) => {
-    const markdown = spec.options?.format === "markdown";
     const headers = new Headers(options.headers);
     if (typeof document === "undefined" && !headers.has("user-agent")) {
       headers.set("user-agent", USER_AGENT);
@@ -439,7 +324,7 @@ function createCaller(options) {
     if (options.apiKey) {
       headers.set("authorization", `Bearer ${options.apiKey}`);
     }
-    headers.set("accept", markdown ? "text/markdown" : "application/json");
+    headers.set("accept", "application/json");
     if (spec.body !== void 0)
       headers.set("content-type", "application/json");
     const url = withQuery(`${baseUrl}${spec.path}`, spec.query);
@@ -452,13 +337,12 @@ function createCaller(options) {
         body: spec.body === void 0 ? void 0 : JSON.stringify(spec.body),
         signal
       }),
-      markdown,
       spec.options?.signal,
       retry
     );
   };
 }
-async function send(baseFetch, url, init, markdown, signal, retry) {
+async function send(baseFetch, url, init, signal, retry) {
   for (let n = 0; ; n += 1) {
     const deadline = withDeadline(signal, retry.timeoutMs);
     let waitMs;
@@ -479,7 +363,7 @@ async function send(baseFetch, url, init, markdown, signal, retry) {
         }
         waitMs = seconds === void 0 ? backoffMs(n, retry.initialDelayMs) : seconds * 1e3;
       } else {
-        return await readBody(response, markdown);
+        return await readBody(response);
       }
     } finally {
       deadline.clear();
@@ -509,10 +393,9 @@ function withDeadline(signal, timeoutMs) {
     }
   };
 }
-async function readBody(response, markdown) {
+async function readBody(response) {
   if (!response.ok) throw await errorFrom(response);
   const text = await response.text();
-  if (markdown) return text;
   if (!text) {
     throw failed(response, "Stophy returned an empty response", {});
   }