scavio 0.30.1 → 0.32.0

package/dist/index.js

@@ -145,7 +145,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.30.1" : "0.0.0";
+var SDK_VERSION = true ? "0.32.0" : "0.0.0";
 var USER_AGENT = `scavio-js/${SDK_VERSION}`;
 function isServerRuntime() {
   const g = globalThis;
@@ -2799,6 +2799,540 @@ var SpecsNamespace = class {
   }
 };
 
+// src/namespaces/lowes.ts
+var LowesNamespace = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Search Lowe's by keyword or category at one store: the store's price,
+   * was-price and savings with the sale end date, brand, model number, rating,
+   * review count, and stock for pickup, truck delivery, parcel shipping and
+   * same-day delivery. Pass query or category_id; on_sale returns that
+   * store's deals.
+   *
+   * Costs 2 credits.
+   */
+  async search(options) {
+    return this.client._post("/api/v1/lowes/search", options);
+  }
+  /**
+   * One Lowe's item at one store: price, was-price and savings, on-hand stock
+   * with lead time per fulfillment method, stock at nearby stores, aisle and
+   * bay, grouped specifications, UPC, dimensions, weight, rating, images, and
+   * the store's hours.
+   *
+   * Costs 2 credits.
+   */
+  async product(options) {
+    return this.client._post("/api/v1/lowes/product", options);
+  }
+  /**
+   * Lowe's stores near a ZIP code, nearest first: store_id, name, address,
+   * phone, coordinates, distance, time zone, opening hours and features.
+   *
+   * Costs 2 credits.
+   */
+  async stores(options) {
+    return this.client._post("/api/v1/lowes/stores", options);
+  }
+  /**
+   * One page of an item's customer reviews (10 per page): rating, title, text,
+   * date, reviewer, recommended, helpful votes, verified and incentivized
+   * flags, photos and brand replies, plus the average rating and count per star.
+   *
+   * Costs 1 credit.
+   */
+  async reviews(options) {
+    return this.client._post("/api/v1/lowes/reviews", options);
+  }
+};
+
+// src/namespaces/sams-club.ts
+var SamsClubNamespace = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Search Sam's Club: item_id, price, was_price, savings_amount, unit price,
+   * Instant Savings (amount, end date, purchase limit), rating, review count,
+   * stock, pickup/delivery/shipping availability and aisle. The club is picked
+   * by location and returned in data.club.
+   *
+   * Costs 1 credit.
+   */
+  async search(options) {
+    return this.client._post("/api/v1/samsclub/search", options);
+  }
+  /**
+   * One Sam's Club item: online price and the club shelf price (club_price)
+   * with was price, savings and unit price, Instant Savings, rating histogram,
+   * UPC, model, specifications, and per-method fulfillment with stock and
+   * aisle. Pass club_id to price and stock a specific club.
+   *
+   * Costs 1 credit.
+   */
+  async product(options) {
+    return this.client._post("/api/v1/samsclub/product", options);
+  }
+  /**
+   * Sam's Club clubs near a US ZIP, nearest first: club_id, name, address,
+   * coordinates, distance in miles, phone, opening hours, services and whether
+   * the club is temporarily closed.
+   *
+   * Costs 1 credit.
+   */
+  async clubs(options) {
+    return this.client._post("/api/v1/samsclub/clubs", options);
+  }
+  /**
+   * Every item on Sam's Club Instant Savings, paged: price, was price and
+   * savings amount, plus each offer's amount, end date, purchase limit and
+   * channels.
+   *
+   * Costs 1 credit.
+   */
+  async savings(options = {}) {
+    return this.client._post("/api/v1/samsclub/savings", options);
+  }
+  /**
+   * Products in a Sam's Club category, paged, with the same fields as
+   * search(). Clearance is category "1150109".
+   *
+   * Costs 1 credit.
+   */
+  async category(options) {
+    return this.client._post("/api/v1/samsclub/category", options);
+  }
+  /**
+   * Customer reviews for a Sam's Club item, 10 per page: rating, title, text,
+   * author, date, verified purchase and helpful votes, plus the average rating,
+   * total count and 1-5 star breakdown.
+   *
+   * Costs 1 credit.
+   */
+  async reviews(options) {
+    return this.client._post("/api/v1/samsclub/reviews", options);
+  }
+};
+
+// src/namespaces/canadian-tire.ts
+var CanadianTireNamespace = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Search Canadian Tire by keyword or category at one store: the store's
+   * price and regular price (CAD), price range for multi-variant items,
+   * savings, badges (clearance, sale, rebate), rating, review count, brand,
+   * part number, SKU, and stock at the store and online.
+   *
+   * Costs 1 credit.
+   */
+  async search(options) {
+    return this.client._post("/api/v1/canadiantire/search", options);
+  }
+  /**
+   * One product by code at one store: breadcrumb, images, rating, review
+   * count, descriptions, features, specifications, price and regular price,
+   * warranty, manuals, variants with their SKUs, and the store's price, stock,
+   * and pickup and ship-to-home dates.
+   *
+   * Costs 1 credit.
+   */
+  async product(options) {
+    return this.client._post("/api/v1/canadiantire/product", options);
+  }
+  /**
+   * Canadian Tire stores near a postal code or coordinates, nearest first:
+   * store_id, name, address, phone, coordinates, distance, weekly hours and
+   * services. Pass sku to get each store's stock quantity and aisle for it.
+   *
+   * Costs 1 credit.
+   */
+  async stores(options) {
+    return this.client._post("/api/v1/canadiantire/stores", options);
+  }
+  /**
+   * Up to 50 SKUs at one store in one call: the store's price and regular
+   * price, clearance and sale flags, price valid-until date, stock quantity,
+   * aisle, online stock, and pickup and delivery dates. Unknown SKUs are
+   * listed in not_found.
+   *
+   * Costs 1 credit.
+   */
+  async availability(options) {
+    return this.client._post("/api/v1/canadiantire/availability", options);
+  }
+  /**
+   * Every clearance item at one store, 100 per page, with clearance price,
+   * regular price, stock at the store and the same fields as search().
+   * In-stock items only by default.
+   *
+   * Costs 1 credit.
+   */
+  async clearance(options) {
+    return this.client._post("/api/v1/canadiantire/clearance", options);
+  }
+  /**
+   * Items on a deal at one store, 100 per page: sale prices, instant rebates,
+   * special buys or Triangle Rewards loyalty offers, with the same fields as
+   * search().
+   *
+   * Costs 1 credit.
+   */
+  async deals(options) {
+    return this.client._post("/api/v1/canadiantire/deals", options);
+  }
+};
+
+// src/namespaces/dollar-general.ts
+var DollarGeneralNamespace = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Search Dollar General at one store: that store's price and original price,
+   * available_quantity (units on hand at that store), inventory_status,
+   * rating, review count, categories, digital coupons and promotions, UPC and
+   * product URL.
+   *
+   * Costs 1 credit.
+   */
+  async search(options) {
+    return this.client._post("/api/v1/dollargeneral/search", options);
+  }
+  /**
+   * One product by UPC at one store: price, original price,
+   * available_quantity, stock_status, nearby_stores_with_stock, rating, review
+   * count, SKU, brand, description, highlights, images, categories, digital
+   * coupons and promotions. An unknown UPC or store number is a 404.
+   *
+   * Costs 1 credit.
+   */
+  async product(options) {
+    return this.client._post("/api/v1/dollargeneral/product", options);
+  }
+  /**
+   * Dollar General stores near a US ZIP code or coordinates, nearest first (up
+   * to 25): store_id, address, phone, coordinates, distance in miles, opening
+   * hours and services. Pass upc and each store also carries its unit count of
+   * that product.
+   *
+   * Costs 1 credit.
+   */
+  async stores(options) {
+    return this.client._post("/api/v1/dollargeneral/stores", options);
+  }
+  /**
+   * Products on sale or on clearance, priced and stocked at one store, 24 per
+   * page. available_quantity > 0 means in stock at that store; the listing
+   * covers the whole chain. Clearance items carry the current price only (no
+   * was-price).
+   *
+   * Costs 1 credit.
+   */
+  async deals(options) {
+    return this.client._post("/api/v1/dollargeneral/deals", options);
+  }
+  /**
+   * Dollar General's current digital coupons, 30 per page: offer id and code,
+   * summary, description, brand, company, value, offer type, category, minimum
+   * quantity, start and expiration dates, and whether it is a manufacturer
+   * coupon.
+   *
+   * Costs 1 credit.
+   */
+  async coupons(options = {}) {
+    return this.client._post("/api/v1/dollargeneral/coupons", options);
+  }
+};
+
+// src/namespaces/sephora.ts
+var SephoraNamespace = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Search sephora.com products, 60 per page: product id, sku id, brand, name,
+   * URL, image, price, list and sale price (with a price range when sizes are
+   * priced differently), value price for sets, rating, review count, extra
+   * colors, and bestseller, new, exclusive, online-only, limited-edition and
+   * sponsored flags. Pass zip for same-day delivery eligibility. Also returns
+   * category facets and related searches.
+   *
+   * Costs 1 credit.
+   */
+  async search(options) {
+    return this.client._post("/api/v1/sephora/search", options);
+  }
+  /**
+   * Products in a sephora.com category, 60 per page, in the same shape as
+   * search(), plus the category's id, name and URL, total product count,
+   * parent category, subcategories with product counts and breadcrumbs. An
+   * unknown category is a 404.
+   *
+   * Costs 1 credit.
+   */
+  async category(options) {
+    return this.client._post("/api/v1/sephora/category", options);
+  }
+  /**
+   * One sephora.com product: rating, review count, loves count, price range,
+   * description, suggested usage, breadcrumbs, a summary of what reviews say
+   * with pro and con sentiment counts (no review text), and every shade or
+   * size as a sku with price, list and sale price, in_stock, only_few_left,
+   * ingredients, images, and pickup and same-day eligibility. An unknown
+   * product is a 404.
+   *
+   * Costs 1 credit.
+   */
+  async product(options) {
+    return this.client._post("/api/v1/sephora/product", options);
+  }
+};
+
+// src/namespaces/ulta.ts
+var UltaNamespace = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Search Ulta Beauty by keyword, 64 products per page plus sponsored
+   * placements: product_id, sku_id, brand, name, URL, image, list and sale
+   * price (low end and range when shades are priced differently), discount,
+   * promo text, rating, review count, badge, variant label, limited-stock and
+   * sponsored flags.
+   *
+   * Costs 1 credit.
+   */
+  async search(options) {
+    return this.client._post("/api/v1/ulta/search", options);
+  }
+  /**
+   * Products in an Ulta Beauty category, 64 per page plus sponsored
+   * placements, with the category title and total_results and the same
+   * product fields as search().
+   *
+   * Costs 1 credit.
+   */
+  async category(options) {
+    return this.client._post("/api/v1/ulta/category", options);
+  }
+  /**
+   * One Ulta Beauty product for the selected shade or size: list and sale
+   * price, discount, availability, GTIN, rating, review count, badges,
+   * description, usage, ingredients, breadcrumbs, images, every shade or size
+   * variant, ship / pickup / same-day eligibility and the five most recent
+   * customer reviews. An unknown product is a 404.
+   *
+   * Costs 1 credit.
+   */
+  async product(options) {
+    return this.client._post("/api/v1/ulta/product", options);
+  }
+  /**
+   * In-store pickup availability of one shade or size at the 10 Ulta Beauty
+   * stores nearest a US ZIP: store id, name, address, distance in miles, open
+   * now and hours label, curbside label, in_stock and the availability label.
+   * In stock / out of stock per store, not unit counts.
+   *
+   * Costs 1 credit.
+   */
+  async stores(options) {
+    return this.client._post("/api/v1/ulta/stores", options);
+  }
+};
+
+// src/namespaces/aldi.ts
+var AldiNamespace = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Search ALDI US at one store (store_id, or the nearest store to a zip):
+   * product_id, name, brand, size, price and was_price for that store and
+   * service_type, discount label, unit price, in_stock and stock_level,
+   * category, in-store aisle location, ALDI exclusive-brand flag, dietary
+   * labels, image and URL. Exact matches only unless include_related is set.
+   *
+   * Costs 1 credit.
+   */
+  async search(options) {
+    return this.client._post("/api/v1/aldi/search", options);
+  }
+  /**
+   * One ALDI US product by id or aldi.us URL at one store: price and
+   * was_price for that store and service_type, unit price, stock, category,
+   * brand, size, description, ingredients, allergen warnings, dietary labels
+   * and images. An unknown product id is a 404.
+   *
+   * Costs 1 credit.
+   */
+  async product(options) {
+    return this.client._post("/api/v1/aldi/product", options);
+  }
+  /**
+   * ALDI US stores near a ZIP code, nearest first: store_id (for search and
+   * product), name, street address, city, state, ZIP, coordinates and
+   * distance in miles.
+   *
+   * Costs 1 credit.
+   */
+  async stores(options) {
+    return this.client._post("/api/v1/aldi/stores", options);
+  }
+};
+
+// src/namespaces/micro-center.ts
+var MicroCenterNamespace = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Search Micro Center by keyword or category at one store, up to 96 per
+   * page: product_id, SKU, name, brand, category, price and original price,
+   * image, URL, highlights, and that store's stock (label as printed,
+   * quantity, quantity_capped at 25+, in_stock, not_carried). Open-box count
+   * and lowest price, rebate text and an in_store_only flag where shown.
+   *
+   * Costs 2 credits.
+   */
+  async search(options) {
+    return this.client._post("/api/v1/microcenter/search", options);
+  }
+  /**
+   * One product by id or URL: SKU, MPN, UPC, description, price, original
+   * price, ship and pickup flags, images, rating, up to 10 recent reviews,
+   * breadcrumbs and the full spec table. selected_store carries the store's
+   * stock and each open-box unit (condition, warranty, price); stores_in_stock
+   * is a yes/no per Micro Center store, not a unit count. An unknown product
+   * id is a 404.
+   *
+   * Costs 2 credits.
+   */
+  async product(options) {
+    return this.client._post("/api/v1/microcenter/product", options);
+  }
+  /**
+   * Every Micro Center store with its 3-digit store_id, name, city, state and
+   * store page URL; street address and ZIP where known. Optionally filtered by
+   * state. The web store 029 is not listed but is accepted as a store_id.
+   *
+   * Costs 1 credit.
+   */
+  async stores(options = {}) {
+    return this.client._post("/api/v1/microcenter/stores", options);
+  }
+};
+
+// src/namespaces/walgreens.ts
+var WalgreensNamespace = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Search Walgreens retail products, up to 70 per page: product id, SKU, UPC,
+   * name, brand, size, regular and sale price, unit price, promotion, coupon,
+   * loyalty and rebate messages, rating, review count, image, URL,
+   * ship/pickup/delivery availability, online stock status and clearance flag.
+   * Prices are national. Pass store_id for that store's availability text.
+   *
+   * Costs 2 credits.
+   */
+  async search(options) {
+    return this.client._post("/api/v1/walgreens/search", options);
+  }
+  /**
+   * One Walgreens retail product by id or URL: SKU, UPC, GTIN, brand, size,
+   * regular and sale price, savings, unit price, rewards and rebate offers,
+   * description, ingredients, warnings, rating, review count, category path,
+   * images, ship and pickup availability and clearance flag. Prices are
+   * national. An unknown id is a 404.
+   *
+   * Costs 2 credits.
+   */
+  async product(options) {
+    return this.client._post("/api/v1/walgreens/product", options);
+  }
+  /**
+   * Walgreens and Duane Reade stores near a US ZIP or coordinates, nearest
+   * first: store_number, name, brand, address, phone, coordinates, distance in
+   * miles, opening and closing time, time zone and store page URL. Paged with
+   * total_results, total_pages and has_more.
+   *
+   * Costs 2 credits.
+   */
+  async stores(options) {
+    return this.client._post("/api/v1/walgreens/stores", options);
+  }
+  /**
+   * Live in-store stock of one product at up to 20 stores: per store the
+   * status (In Stock, Out of Stock, or Not Available when the store does not
+   * carry it), the unit count and in_stock. Store numbers Walgreens does not
+   * recognise are listed in unknown_store_ids. An unknown product is a 404.
+   *
+   * Costs 4 credits.
+   */
+  async stock(options) {
+    return this.client._post("/api/v1/walgreens/stock", options);
+  }
+};
+
+// src/namespaces/cvs.ts
+var CVS_PRODUCT_TIMEOUT = 12e4;
+var CvsNamespace = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /**
+   * Search CVS front-store products: product_id and sku_id, name, brand, URL,
+   * regular and sale price, unit price, promotion text, rating, review count,
+   * size, image, coupons (ExtraBucks rewards and manufacturer coupons) and
+   * stock at one store (in store, pickup, same-day delivery) plus online ship
+   * availability. Sponsored placements are excluded. Includes brand,
+   * price-range and rating facets.
+   *
+   * Costs 1 credit.
+   */
+  async search(options) {
+    return this.client._post("/api/v1/cvs/search", options);
+  }
+  /**
+   * One CVS product by URL or id: regular and sale price, unit price,
+   * promotion and its end date, rating, review count, UPC, size, description,
+   * highlights, ingredients, directions, warnings, attributes, breadcrumbs,
+   * images and every variant (SKU id, UPC, size, price, rating). An unknown
+   * product is a 404. Can take 10-30+ seconds.
+   *
+   * Costs 1 credit.
+   */
+  async product(options) {
+    return this.client._post("/api/v1/cvs/product", options, void 0, CVS_PRODUCT_TIMEOUT);
+  }
+  /**
+   * Units available at one CVS store for up to 20 SKUs: in_store (on the
+   * shelf), pickup and ship (online stock, chain-wide). same_day_delivery is
+   * always null here; search returns same-day units. An unknown SKU or store
+   * number reads as 0.
+   *
+   * Costs 1 credit.
+   */
+  async stock(options) {
+    return this.client._post("/api/v1/cvs/stock", options);
+  }
+};
+
 // src/namespaces/trustpilot.ts
 var TrustpilotNamespace = class {
   constructor(client) {
@@ -3314,6 +3848,16 @@ var Scavio = class extends ScavioCore {
   kroger;
   decathlon;
   specs;
+  lowes;
+  samsClub;
+  canadianTire;
+  dollarGeneral;
+  sephora;
+  ulta;
+  aldi;
+  microCenter;
+  walgreens;
+  cvs;
   trustpilot;
   chatgpt;
   gemini;
@@ -3377,6 +3921,16 @@ var Scavio = class extends ScavioCore {
     this.kroger = new KrogerNamespace(this);
     this.decathlon = new DecathlonNamespace(this);
     this.specs = new SpecsNamespace(this);
+    this.lowes = new LowesNamespace(this);
+    this.samsClub = new SamsClubNamespace(this);
+    this.canadianTire = new CanadianTireNamespace(this);
+    this.dollarGeneral = new DollarGeneralNamespace(this);
+    this.sephora = new SephoraNamespace(this);
+    this.ulta = new UltaNamespace(this);
+    this.aldi = new AldiNamespace(this);
+    this.microCenter = new MicroCenterNamespace(this);
+    this.walgreens = new WalgreensNamespace(this);
+    this.cvs = new CvsNamespace(this);
     this.trustpilot = new TrustpilotNamespace(this);
     this.chatgpt = new ChatgptNamespace(this);
     this.gemini = new GeminiNamespace(this);
@@ -3487,15 +4041,20 @@ async function getSubtle() {
 export {
   AI_PROMPT_TIMEOUT,
   AirbnbNamespace,
+  AldiNamespace,
   AmazonNamespace,
   AppStoreNamespace,
   BadRequestError,
   BookingNamespace,
+  CVS_PRODUCT_TIMEOUT,
+  CanadianTireNamespace,
   CapterraNamespace,
   ChatgptNamespace,
   CompaniesHouseNamespace,
   CostcoNamespace,
+  CvsNamespace,
   DEFAULT_MAX_REQUESTS_PER_SECOND,
+  DollarGeneralNamespace,
   EbayNamespace,
   ExtractNamespace,
   G2Namespace,
@@ -3513,9 +4072,11 @@ export {
   KrogerNamespace,
   KuaishouNamespace,
   LinkedInNamespace,
+  LowesNamespace,
   MAX_REQUESTS_PER_SECOND,
   MercadoLibreNamespace,
   MetaAdsNamespace,
+  MicroCenterNamespace,
   MissingAPIKeyError,
   NotFoundError,
   RateLimitError,
@@ -3524,18 +4085,22 @@ export {
   RedfinNamespace,
   RightmoveNamespace,
   SECNamespace,
+  SamsClubNamespace,
   Scavio,
   ScavioAPIError,
   ScavioConnectionError,
   ScavioError,
   ScavioJobTimeoutError,
   ScavioTimeoutError,
+  SephoraNamespace,
   TargetNamespace,
   ThreadsNamespace,
   TikTokNamespace,
   TikTokShopNamespace,
   TripadvisorNamespace,
   TrustpilotNamespace,
+  UltaNamespace,
+  WalgreensNamespace,
   WalmartNamespace,
   XNamespace,
   YelpNamespace,