scavio 0.7.0 → 0.9.0

package/dist/index.js

@@ -430,6 +430,114 @@ var TikTokNamespace = class {
   }
 };
 
+// src/namespaces/tiktok-shop.ts
+var TikTokShopNamespace = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Search TikTok Shop products by keyword (US catalog), up to 30 per page with
+   * exact prices, ratings, and shop details. Paginate with next_cursor and dedupe
+   * by product_id across pages.
+   *
+   * This is one of the three endpoints that return exact prices; tiktokShop.product()
+   * does not return a price. A product_id returned here is not guaranteed to resolve
+   * on tiktokShop.product() - only about 44% do.
+   */
+  async search(options) {
+    return this.client._post("/api/v1/tiktok-shop/search", options);
+  }
+  /**
+   * Keyword autocomplete and expansion for a partial query, across 8 marketplace
+   * regions. Suggestions are not guaranteed prefix matches: a misspelling returns
+   * typo corrections, and results can include brand and shop names.
+   */
+  async searchSuggestions(options) {
+    return this.client._post("/api/v1/tiktok-shop/search/suggestions", options);
+  }
+  /**
+   * Full product detail: description, images, variants with stock, shipping, shop
+   * profile, category path, and top reviews.
+   *
+   * Two limits worth knowing before you build on this:
+   *
+   * 1. It resolves only about 44% of the product ids returned by tiktokShop.search().
+   *    Upstream has no detail data for the rest, so an HTTP 404 is a normal outcome,
+   *    not an error. Skip the item rather than retrying - retries do not help and no
+   *    other region carries it. Search to product is not a reliable pipeline.
+   *
+   *    This method throws `NotFoundError` on that 404 (there is no `data` field in
+   *    the response body to test), so a loop over search ids must catch it or it
+   *    dies on the first miss:
+   *
+   *    ```ts
+   *    import { NotFoundError } from "scavio";
+   *
+   *    for (const productId of productIds) {
+   *      try {
+   *        const detail = await client.tiktokShop.product({ product_id: productId });
+   *      } catch (e) {
+   *        if (e instanceof NotFoundError) continue; // no detail upstream; skip
+   *        throw e;
+   *      }
+   *    }
+   *    ```
+   *
+   *    tiktokShop.productReviews() often works for ids product() cannot resolve: of
+   *    8 such ids tested, 8 returned HTTP 200 and 7 carried at least one review, so
+   *    it is a useful fallback source of product detail.
+   * 2. It does NOT return a price. Upstream masks the price on the product page.
+   *    Exact prices come from tiktokShop.search(), tiktokShop.shopProducts(), and
+   *    tiktokShop.categoryProducts().
+   */
+  async product(options) {
+    return this.client._post("/api/v1/tiktok-shop/product", options);
+  }
+  /**
+   * Paginated product reviews with text, images, star histogram, and
+   * verified-purchase flags, up to 200 per call. total_reviews drifts between calls
+   * and must not be used to compute a page count; page with has_more instead.
+   */
+  async productReviews(options) {
+    return this.client._post("/api/v1/tiktok-shop/product/reviews", options);
+  }
+  /**
+   * The global TikTok Shop category tree: 28 top-level categories, 240 nodes, two
+   * levels deep. Category ids are identical in every region and names are always
+   * English.
+   */
+  async categories() {
+    return this.client._post("/api/v1/tiktok-shop/categories", {});
+  }
+  /**
+   * Products listed under a category id from tiktokShop.categories(), with exact
+   * prices. Page size is inconsistent upstream (15 to 20 per page), so always
+   * paginate with next_cursor rather than assuming a fixed page size. Category
+   * listings are shallow: after a few pages the source stops returning new products
+   * and has_more turns false, which is the end of the listing rather than an error.
+   */
+  async categoryProducts(options) {
+    return this.client._post("/api/v1/tiktok-shop/category/products", options);
+  }
+  /**
+   * A shop's product catalog, 30 per page, with exact prices. Shop follower count,
+   * location, and shop-level rating are not available here; call
+   * tiktokShop.product() for the full shop profile.
+   */
+  async shopProducts(options) {
+    return this.client._post("/api/v1/tiktok-shop/shop/products", options);
+  }
+  /**
+   * Resolve any TikTok Shop URL or share link to a product_id or shop_id, ready to
+   * pass to the other methods. Accepts canonical product and store pages,
+   * tiktok.com/view links, affiliate share links, and vt.tiktok.com short links.
+   */
+  async resolve(options) {
+    return this.client._post("/api/v1/tiktok-shop/resolve", options);
+  }
+};
+
 // src/namespaces/instagram.ts
 var InstagramNamespace = class {
   constructor(client) {
@@ -565,44 +673,44 @@ var YouTubeNamespace = class {
   }
 };
 
-// src/namespaces/twitter.ts
-var TwitterNamespace = class {
+// src/namespaces/x.ts
+var XNamespace = class {
   constructor(client) {
     this.client = client;
   }
   client;
   async search(options) {
-    return this.client._post("/api/v1/twitter/search", options);
+    return this.client._post("/api/v1/x/search", options);
   }
   async tweet(options) {
-    return this.client._post("/api/v1/twitter/tweet", options);
+    return this.client._post("/api/v1/x/tweet", options);
   }
   async tweetComments(options) {
-    return this.client._post("/api/v1/twitter/tweet/comments", options);
+    return this.client._post("/api/v1/x/tweet/comments", options);
   }
   async tweetRetweeters(options) {
-    return this.client._post("/api/v1/twitter/tweet/retweeters", options);
+    return this.client._post("/api/v1/x/tweet/retweeters", options);
   }
   async user(options) {
-    return this.client._post("/api/v1/twitter/user", options);
+    return this.client._post("/api/v1/x/user", options);
   }
   async userTweets(options) {
-    return this.client._post("/api/v1/twitter/user/tweets", options);
+    return this.client._post("/api/v1/x/user/tweets", options);
   }
   async userReplies(options) {
-    return this.client._post("/api/v1/twitter/user/replies", options);
+    return this.client._post("/api/v1/x/user/replies", options);
   }
   async userMedia(options) {
-    return this.client._post("/api/v1/twitter/user/media", options);
+    return this.client._post("/api/v1/x/user/media", options);
   }
   async userFollowers(options) {
-    return this.client._post("/api/v1/twitter/user/followers", options);
+    return this.client._post("/api/v1/x/user/followers", options);
   }
   async userFollowings(options) {
-    return this.client._post("/api/v1/twitter/user/followings", options);
+    return this.client._post("/api/v1/x/user/followings", options);
   }
   async trending(options = {}) {
-    return this.client._post("/api/v1/twitter/trending", options);
+    return this.client._post("/api/v1/x/trending", options);
   }
 };
 
@@ -664,8 +772,9 @@ var Scavio = class {
   youtube;
   reddit;
   tiktok;
+  tiktokShop;
   instagram;
-  twitter;
+  x;
   linkedin;
   apiKey;
   baseUrl;
@@ -691,8 +800,9 @@ var Scavio = class {
     this.youtube = new YouTubeNamespace(this);
     this.reddit = new RedditNamespace(this);
     this.tiktok = new TikTokNamespace(this);
+    this.tiktokShop = new TikTokShopNamespace(this);
     this.instagram = new InstagramNamespace(this);
-    this.twitter = new TwitterNamespace(this);
+    this.x = new XNamespace(this);
     this.linkedin = new LinkedInNamespace(this);
   }
   /** @internal */