scavio 0.35.0 → 0.37.0

package/README.md

@@ -685,13 +685,44 @@ to `MENARDS_PRODUCT_TIMEOUT` (120s). None ever lowers a longer client timeout.
 
 ### [Nordstrom](https://scavio.dev/docs/nordstrom-search?utm_source=npm-scavio-js&utm_medium=package&utm_campaign=readme)
 
-Two endpoints, new in 0.35.0, 5 credits each. nordstrom.com (US site only).
-`search` returns 24 products a page with current and original price ranges,
-percent off, on-sale flag, rating, review count, badges and colors; `sort` is
-`relevance` (default), `rating`, `price_high`, `price_low`, `newest` or
-`percent_off`. `product` takes a result's `url` or `style_id` and lists every
-color and size as a sku with UPC, price, price type, `in_stock` and the
-`quantity` available to ship online.
+Eight endpoints, nordstrom.com (US site only). `search` and `product` are new in
+0.35.0; `category`, `brand`, `stores`, `availability` and `suggestions` are new
+in 0.36.0; `reviews` is new in 0.37.0. `availability` costs 10 credits (the
+product page plus the store lookup) and `reviews` 10; every other call costs 5.
+
+- `search`, `category` and `brand` return 24 products a page with current and
+  original price ranges, percent off, on-sale flag, rating, review count,
+  badges and colors; `sort` is `relevance` (default), `rating`, `price_high`,
+  `price_low`, `newest` or `percent_off`. `category` takes a `/browse` path or
+  URL (departments, `sale/women`, `/browse/new`); `brand` takes a
+  `/brands/<slug>--<id>` path or URL (a product's `brand_url` works). Both also
+  return the category or brand (name, title, path, URL, breadcrumbs,
+  subcategories) and the filter sidebar with option counts (top 100 options per
+  group); filters inside a category URL are ignored.
+- `product` takes a result's `url` or `style_id` and lists every color and size
+  as a sku with UPC, price, price type, `in_stock` and the `quantity` available
+  to ship. `in_stock` is true when the sku can be shipped or picked up in a
+  store, so a sku can be in stock with `quantity` 0 (store-only).
+- `reviews` takes `url` or `style_id` and returns the product's full review
+  history, up to `max_reviews` per call (1-200, default 60). `sort` is
+  `most_helpful` (default), `most_recent`, `highest_rated` or `lowest_rated`;
+  filter with `stars` (e.g. `[1, 2]`), `verified_only`, `with_photos` or a text
+  `search` (`search` cannot be combined with `sort`). The response carries the
+  `summary` (average rating, total reviews, histogram, size and width rating,
+  praised and criticized features with a quote, rating-only count), the
+  `ai_summary`, `total_results`, `returned` and `has_more`. Rating-only reviews
+  are included with `title` and `text` null.
+- `availability` takes `url` or `style_id` (optionally `sku_id`) and returns per
+  sku `ship_quantity`, `pickup_available`, `pick_quantity` and the stores that
+  can do in-store pickup. Quantities are chain-wide; per store Nordstrom only
+  says whether pickup is available, not how many.
+- `stores` takes exactly one of `zip`, `latitude` + `longitude`, or
+  `store_numbers` (array or comma-separated string), with `distance_miles`
+  1-100 (default 100). Each store has address, phone, hours, daily hours,
+  coordinates, pickup and curbside flags and amenities. A ZIP with no store in
+  range is an empty list (still billed).
+- `suggestions` returns the site's autocomplete strings for a partial `query`
+  (`limit` 1-20, default 8).
 
 ```ts
 const found = await client.nordstrom.search({ query: "dress", sort: "percent_off" });
@@ -702,12 +733,37 @@ const item = await client.nordstrom.product({ style_id: top.style_id });
 for (const color of (item as any).data.colors) {
   for (const sku of color.skus) console.log(color.name, sku.size, sku.upc, sku.price, sku.price_type, sku.quantity);
 }
+
+const dresses = await client.nordstrom.category({ category: "/browse/women/clothing/dresses", sort: "price_low" });
+const label = await client.nordstrom.brand({ brand: "/brands/astr-the-label--53360" });
+const near = await client.nordstrom.stores({ zip: "10001" });
+
+const stock = await client.nordstrom.availability({ style_id: "7737947" });
+for (const sku of (stock as any).data.skus) {
+  console.log(sku.sku_id, sku.size, sku.color, sku.ship_quantity, sku.pick_quantity, sku.pickup_store_count);
+}
+
+const ideas = await client.nordstrom.suggestions({ query: "nike air" });
+console.log((ideas as any).data.suggestions);
+
+const rev = (await client.nordstrom.reviews({ style_id: "7737947", sort: "most_recent", max_reviews: 100 })) as any;
+const { summary } = rev.data;
+console.log(summary.average_rating, summary.total_reviews, summary.ratings_histogram, summary.size_rating);
+console.log(rev.data.total_results, rev.data.returned, rev.data.has_more, rev.data.ai_summary);
+for (const r of rev.data.reviews.slice(0, 5)) {
+  console.log(r.date, r.rating, r.title, r.text, r.size_purchased, r.helpful_votes, r.badges, r.photos.length);
+}
+const critical = await client.nordstrom.reviews({ style_id: "7737947", stars: [1, 2], verified_only: true });
 ```
 
-Reviews are the 12-13 shown on the product page, with no deeper paging. There
-is no store locator, store-level stock or category endpoint. An unknown style
-id is a 404. Both calls raise the request timeout to `NORDSTROM_TIMEOUT`
-(120s), never lowering a longer client timeout.
+`product` returns the reviews shown on the product page (up to about 13) plus
+the total review count and star histogram; `reviews` returns the rest. An
+unknown style id, sku id, category or brand is a 404. Every call raises the
+request timeout to `NORDSTROM_TIMEOUT` (120s), except `reviews`, which takes
+20-60s (up to about 100s at 200 reviews) and raises it to
+`NORDSTROM_REVIEWS_TIMEOUT` (150s). Neither ever lowers a longer client timeout.
+If the upstream page still fails after the API's own retries, the call is an
+unbilled 502.
 
 ### [Mercado Libre](https://scavio.dev/docs/mercadolibre-search?utm_source=npm-scavio-js&utm_medium=package&utm_campaign=readme)
 

package/dist/index.cjs

@@ -76,6 +76,7 @@ __export(index_exports, {
   MetaAdsNamespace: () => MetaAdsNamespace,
   MicroCenterNamespace: () => MicroCenterNamespace,
   MissingAPIKeyError: () => MissingAPIKeyError,
+  NORDSTROM_REVIEWS_TIMEOUT: () => NORDSTROM_REVIEWS_TIMEOUT,
   NORDSTROM_TIMEOUT: () => NORDSTROM_TIMEOUT,
   NordstromNamespace: () => NordstromNamespace,
   NotFoundError: () => NotFoundError,
@@ -261,7 +262,7 @@ function parseRetryAfter(header) {
 var BASE_URL = "https://api.scavio.dev";
 var DEFAULT_TIMEOUT = 3e4;
 var DEFAULT_MAX_RETRIES = 2;
-var SDK_VERSION = true ? "0.35.0" : "0.0.0";
+var SDK_VERSION = true ? "0.37.0" : "0.0.0";
 var USER_AGENT = `scavio-js/${SDK_VERSION}`;
 function isServerRuntime() {
   const g = globalThis;
@@ -3906,6 +3907,7 @@ var MenardsNamespace = class {
 
 // src/namespaces/nordstrom.ts
 var NORDSTROM_TIMEOUT = 12e4;
+var NORDSTROM_REVIEWS_TIMEOUT = 15e4;
 var NordstromNamespace = class {
   constructor(client) {
     this.client = client;
@@ -3935,16 +3937,116 @@ var NordstromNamespace = class {
    * criticized features with a quote each, breadcrumbs and images. Every color
    * lists its images and every size as a sku with sku id, size, size type,
    * UPC, price, original price, percent off, price type (regular, clearance,
-   * promotion), in_stock and the quantity available to ship. Includes the
-   * 12-13 reviews shown on the product page, with title, text, rating, size
-   * rating, author, date, helpful votes and verified-purchase flag. Pass url
-   * or style_id. An unknown style id is a 404.
+   * promotion), in_stock and the quantity available to ship. in_stock is true
+   * when the sku can be shipped or picked up in a store, so a sku held only in
+   * a store reads in stock with quantity 0 (availability() lists its pickup
+   * stores). Includes the reviews shown on the product page (up to about 13),
+   * with the total review count; each review has title, text, rating, size
+   * rating, author, date, helpful votes and verified-purchase flag
+   * (reviews() pages the full review history). Pass url or style_id. An
+   * unknown style id is a 404.
    *
    * Costs 5 credits.
    */
   async product(options) {
     return this.client._post("/api/v1/nordstrom/product", options, void 0, NORDSTROM_TIMEOUT);
   }
+  /**
+   * Browse a nordstrom.com (US) category page, 24 products per page, sorted
+   * by relevance, rating, price, newest or percent off. Works on any /browse
+   * category, including sale (sale/women), new arrivals (/browse/new) and
+   * top-level departments (/browse/women). Returns the category's name, page
+   * title, path, URL, breadcrumbs and subcategories (name and path, for
+   * drilling down). Each product has the same fields as a search result. Also
+   * returns the total result count, page count, and the filter sidebar: each
+   * filter group with its options and product counts (groups with more than
+   * 100 options list the 100 with the most products and give the full
+   * option_count). An unknown category is a 404.
+   *
+   * Costs 5 credits.
+   */
+  async category(options) {
+    return this.client._post("/api/v1/nordstrom/category", options, void 0, NORDSTROM_TIMEOUT);
+  }
+  /**
+   * List a brand's products on nordstrom.com (US) from its brand page, 24 per
+   * page, sorted by relevance, rating, price, newest or percent off. Returns
+   * the brand's name, path, URL, breadcrumbs and sub-pages (Women, Men,
+   * Kids...), products with the same fields as a search result, the total
+   * result count, page count and the filter sidebar with option counts. An
+   * unknown brand is a 404.
+   *
+   * Costs 5 credits.
+   */
+  async brand(options) {
+    return this.client._post("/api/v1/nordstrom/brand", options, void 0, NORDSTROM_TIMEOUT);
+  }
+  /**
+   * Find Nordstrom stores (full-line stores and Nordstrom Local) near a US ZIP
+   * code or latitude/longitude within up to 100 miles, nearest first, or look
+   * stores up by store number. Each store has store number, name, type
+   * (full_line or local), address, phone, weekly hours, holiday hours when
+   * posted, open and close times for the next 8 days, time zone, distance in
+   * miles, coordinates, whether it offers buy-online pickup and curbside
+   * pickup, its amenities and its store page URL. A ZIP with no store in range
+   * returns an empty list.
+   *
+   * Costs 5 credits.
+   */
+  async stores(options) {
+    return this.client._post("/api/v1/nordstrom/stores", options, void 0, NORDSTROM_TIMEOUT);
+  }
+  /**
+   * Online and store-pickup availability for every size and color of one
+   * nordstrom.com (US) product, by URL or style id, optionally one sku. Each
+   * sku has sku id, size, color, UPC, in_stock, whether it ships and the
+   * quantity available to ship, the quantity available for pickup, and the
+   * stores where it can be picked up (store number, name, address, city,
+   * state, ZIP, phone). Quantities are chain-wide: per store Nordstrom only
+   * says whether pickup is available, not how many. An unknown style id or sku
+   * id is a 404.
+   *
+   * Costs 10 credits (the product page plus the store lookup).
+   */
+  async availability(options) {
+    return this.client._post("/api/v1/nordstrom/availability", options, void 0, NORDSTROM_TIMEOUT);
+  }
+  /**
+   * The search-box autocomplete of nordstrom.com: the queries Nordstrom
+   * suggests for a partial search term, most likely first. Useful for keyword
+   * research and for building queries for search().
+   *
+   * Costs 5 credits.
+   */
+  async suggestions(options) {
+    return this.client._post("/api/v1/nordstrom/suggestions", options, void 0, NORDSTROM_TIMEOUT);
+  }
+  /**
+   * Customer reviews of one nordstrom.com (US) product by URL or style id, up
+   * to 200 per call (default 60), sorted most helpful (default), most recent,
+   * highest rated or lowest rated, optionally filtered to star ratings,
+   * verified purchases, reviews with photos, or a text search. Returns the
+   * product's review summary (average rating, total reviews, star histogram,
+   * size rating 1 runs small to 5 runs big, width rating where the site has
+   * one, the most mentioned praised and criticized features with a quote each,
+   * and the count of rating-only reviews), the AI review summary when the site
+   * shows one, the number of reviews matching the filters (total_results),
+   * returned and has_more. Each review has id, title, text, star rating, size
+   * rating, author, date, helpful votes, verified-purchase flag, reviewer
+   * badges (verified_purchaser, top_250, top_1000), size and color purchased,
+   * the reviewer's height, weight, body type and usual sizes when given,
+   * secondary ratings (Size, with its scale), the site it was syndicated from
+   * (e.g. nordstromrack.com) and photos with thumbnails. Rating-only reviews
+   * are included with title and text null. Takes 20-60s, up to about 100s at
+   * max_reviews 200, so the request timeout is raised to
+   * NORDSTROM_REVIEWS_TIMEOUT. A product with no reviews returns an empty
+   * list; an unknown style id is a 404.
+   *
+   * Costs 10 credits.
+   */
+  async reviews(options) {
+    return this.client._post("/api/v1/nordstrom/reviews", options, void 0, NORDSTROM_REVIEWS_TIMEOUT);
+  }
 };
 
 // src/namespaces/trustpilot.ts
@@ -4716,6 +4818,7 @@ async function getSubtle() {
   MetaAdsNamespace,
   MicroCenterNamespace,
   MissingAPIKeyError,
+  NORDSTROM_REVIEWS_TIMEOUT,
   NORDSTROM_TIMEOUT,
   NordstromNamespace,
   NotFoundError,