@hydrafetch/node-sdk 0.2.0 → 0.4.0

package/README.md

@@ -82,6 +82,16 @@ out.results.forEach((item) => console.log(item.url, item.data?.name));
 
 Pass `prompt` instead of, or alongside, `schema` to describe the fields in plain language.
 
+Sites that price or stock by delivery area serve a different page for each area. Pass `location` to fetch as if from a country and language, and `headers` to send the cookie that picks the store or area, the same options `scrape` takes.
+
+```ts
+const out = await hf.extract(['https://shop.example/search?q=ghee'], {
+  prompt: 'every product with its size and price',
+  location: { country: 'in' },
+  headers: { Cookie: 'store_id=42' },
+});
+```
+
 ### Zod schemas
 
 If you already use Zod, pass the schema directly. Zod stays optional and is imported only when you
@@ -162,6 +172,7 @@ results.forEach((r) => console.log(r.title, r.url, r.data?.markdown));
 await hf.brand('stripe.com');                                 // logos, colours, fonts, socials
 await hf.logo('stripe.com', { theme: 'dark', type: 'icon' }); // one asset
 await hf.styleguide('stripe.com');                            // computed design system
+await hf.styleguide('https://stripe.com/pricing', { maxAge: 0 }); // one page, read fresh
 ```
 
 For logos in a browser use [`@hydrafetch/client-sdk`](https://github.com/Hydrafetch/client-sdk) or [`@hydrafetch/react`](https://github.com/Hydrafetch/react-sdk) with a publishable key. Those bill against logo pulls rather than credits.
@@ -225,7 +236,7 @@ const hf = new Hydrafetch({
 | `extract(urls, options?)` | `ExtractResult<T>` | 5 per URL |
 | `brand(domain)` | `BrandResult` | 5 |
 | `logo(domain, options?)` | `LogoResult` | 1 |
-| `styleguide(domain)` | `StyleguideResult` | 10 |
+| `styleguide(domainOrUrl, options?)` | `StyleguideResult` | 10 |
 | `screenshot(url, options?)` | `ScreenshotResult` | 5 |
 | `images(url)` | `ImagesResult` | 1 |
 | `links(url, options?)` | `ScrapeResult<'links'>` | 1 |

package/dist/index.cjs

@@ -241,8 +241,12 @@ var Hydrafetch = class {
   logo(domain, options = {}) {
     return this.request("GET", "/v1/web/brand/logo", void 0, { domain, ...options });
   }
-  styleguide(domain) {
-    return this.request("GET", "/v1/web/styleguide", void 0, { domain });
+  styleguide(domainOrUrl, options = {}) {
+    const target = /^https?:\/\//i.test(domainOrUrl) ? { url: domainOrUrl } : { domain: domainOrUrl };
+    return this.request("GET", "/v1/web/styleguide", void 0, {
+      ...target,
+      ...options
+    });
   }
   screenshot(url, options = {}) {
     return this.request("POST", "/v1/web/screenshot", { url, ...options });

package/dist/index.d.cts

@@ -34,6 +34,10 @@ interface ScrapeBase {
 type ScrapeResult<F extends Format = 'markdown'> = ScrapeBase & {
     [K in F]: ScrapeContent[K];
 } & Partial<Omit<ScrapeContent, F>>;
+interface Location {
+    country?: string;
+    languages?: string[];
+}
 interface ScrapeOptions<F extends readonly Format[] = readonly Format[]> {
     formats?: F;
     maxAge?: number;
@@ -48,6 +52,7 @@ interface ScrapeOptions<F extends readonly Format[] = readonly Format[]> {
     includeLinks?: boolean;
     waitFor?: number;
     timeout?: number;
+    location?: Location;
     headers?: Record<string, string>;
     jsonOptions?: Record<string, unknown>;
 }
@@ -114,6 +119,8 @@ interface ExtractOptions {
     showConfidence?: boolean;
     mergeEntities?: boolean;
     maxAge?: number;
+    location?: Location;
+    headers?: Record<string, string>;
 }
 interface ExtractItem<T = unknown> {
     url: string;
@@ -185,8 +192,12 @@ interface LogoResult {
     type?: string;
     [key: string]: unknown;
 }
+interface StyleguideOptions {
+    maxAge?: number;
+}
 interface StyleguideResult {
     domain?: string;
+    page?: string;
     colors?: Record<string, unknown>;
     typography?: Record<string, unknown>;
     [key: string]: unknown;
@@ -250,7 +261,7 @@ declare class Hydrafetch {
     extract<T = unknown>(urls: string | string[], options?: ExtractOptions): Promise<ExtractResult<T>>;
     brand(domain: string): Promise<BrandResult>;
     logo(domain: string, options?: BrandOptions): Promise<LogoResult>;
-    styleguide(domain: string): Promise<StyleguideResult>;
+    styleguide(domainOrUrl: string, options?: StyleguideOptions): Promise<StyleguideResult>;
     screenshot(url: string, options?: ScreenshotOptions): Promise<ScreenshotResult>;
     images(url: string, options?: {
         maxAge?: number;
@@ -286,4 +297,4 @@ declare class HydrafetchTimeoutError extends HydrafetchError {
     constructor(message: string);
 }
 
-export { type BatchOptions, type BrandOptions, type BrandResult, type CrawlOptions, type ExtractItem, type ExtractOptions, type ExtractResult, type ExtractSchema, type Format, Hydrafetch, HydrafetchError, type HydrafetchOptions, HydrafetchTimeoutError, type ImagesResult, type JobPage, type JobResult, type JobStatus, type LogoResult, type MapOptions, type MapResult, type PageImage, type PageMetadata, type ScrapeBase, type ScrapeContent, type ScrapeOptions, type ScrapeResult, type ScreenshotOptions, type ScreenshotResult, type SearchOptions, type SearchResult, type SearchResultItem, type StyleguideResult, type Usage, type WaitOptions, type ZodLike };
+export { type BatchOptions, type BrandOptions, type BrandResult, type CrawlOptions, type ExtractItem, type ExtractOptions, type ExtractResult, type ExtractSchema, type Format, Hydrafetch, HydrafetchError, type HydrafetchOptions, HydrafetchTimeoutError, type ImagesResult, type JobPage, type JobResult, type JobStatus, type Location, type LogoResult, type MapOptions, type MapResult, type PageImage, type PageMetadata, type ScrapeBase, type ScrapeContent, type ScrapeOptions, type ScrapeResult, type ScreenshotOptions, type ScreenshotResult, type SearchOptions, type SearchResult, type SearchResultItem, type StyleguideOptions, type StyleguideResult, type Usage, type WaitOptions, type ZodLike };

package/dist/index.d.ts

@@ -34,6 +34,10 @@ interface ScrapeBase {
 type ScrapeResult<F extends Format = 'markdown'> = ScrapeBase & {
     [K in F]: ScrapeContent[K];
 } & Partial<Omit<ScrapeContent, F>>;
+interface Location {
+    country?: string;
+    languages?: string[];
+}
 interface ScrapeOptions<F extends readonly Format[] = readonly Format[]> {
     formats?: F;
     maxAge?: number;
@@ -48,6 +52,7 @@ interface ScrapeOptions<F extends readonly Format[] = readonly Format[]> {
     includeLinks?: boolean;
     waitFor?: number;
     timeout?: number;
+    location?: Location;
     headers?: Record<string, string>;
     jsonOptions?: Record<string, unknown>;
 }
@@ -114,6 +119,8 @@ interface ExtractOptions {
     showConfidence?: boolean;
     mergeEntities?: boolean;
     maxAge?: number;
+    location?: Location;
+    headers?: Record<string, string>;
 }
 interface ExtractItem<T = unknown> {
     url: string;
@@ -185,8 +192,12 @@ interface LogoResult {
     type?: string;
     [key: string]: unknown;
 }
+interface StyleguideOptions {
+    maxAge?: number;
+}
 interface StyleguideResult {
     domain?: string;
+    page?: string;
     colors?: Record<string, unknown>;
     typography?: Record<string, unknown>;
     [key: string]: unknown;
@@ -250,7 +261,7 @@ declare class Hydrafetch {
     extract<T = unknown>(urls: string | string[], options?: ExtractOptions): Promise<ExtractResult<T>>;
     brand(domain: string): Promise<BrandResult>;
     logo(domain: string, options?: BrandOptions): Promise<LogoResult>;
-    styleguide(domain: string): Promise<StyleguideResult>;
+    styleguide(domainOrUrl: string, options?: StyleguideOptions): Promise<StyleguideResult>;
     screenshot(url: string, options?: ScreenshotOptions): Promise<ScreenshotResult>;
     images(url: string, options?: {
         maxAge?: number;
@@ -286,4 +297,4 @@ declare class HydrafetchTimeoutError extends HydrafetchError {
     constructor(message: string);
 }
 
-export { type BatchOptions, type BrandOptions, type BrandResult, type CrawlOptions, type ExtractItem, type ExtractOptions, type ExtractResult, type ExtractSchema, type Format, Hydrafetch, HydrafetchError, type HydrafetchOptions, HydrafetchTimeoutError, type ImagesResult, type JobPage, type JobResult, type JobStatus, type LogoResult, type MapOptions, type MapResult, type PageImage, type PageMetadata, type ScrapeBase, type ScrapeContent, type ScrapeOptions, type ScrapeResult, type ScreenshotOptions, type ScreenshotResult, type SearchOptions, type SearchResult, type SearchResultItem, type StyleguideResult, type Usage, type WaitOptions, type ZodLike };
+export { type BatchOptions, type BrandOptions, type BrandResult, type CrawlOptions, type ExtractItem, type ExtractOptions, type ExtractResult, type ExtractSchema, type Format, Hydrafetch, HydrafetchError, type HydrafetchOptions, HydrafetchTimeoutError, type ImagesResult, type JobPage, type JobResult, type JobStatus, type Location, type LogoResult, type MapOptions, type MapResult, type PageImage, type PageMetadata, type ScrapeBase, type ScrapeContent, type ScrapeOptions, type ScrapeResult, type ScreenshotOptions, type ScreenshotResult, type SearchOptions, type SearchResult, type SearchResultItem, type StyleguideOptions, type StyleguideResult, type Usage, type WaitOptions, type ZodLike };

package/dist/index.js

@@ -213,8 +213,12 @@ var Hydrafetch = class {
   logo(domain, options = {}) {
     return this.request("GET", "/v1/web/brand/logo", void 0, { domain, ...options });
   }
-  styleguide(domain) {
-    return this.request("GET", "/v1/web/styleguide", void 0, { domain });
+  styleguide(domainOrUrl, options = {}) {
+    const target = /^https?:\/\//i.test(domainOrUrl) ? { url: domainOrUrl } : { domain: domainOrUrl };
+    return this.request("GET", "/v1/web/styleguide", void 0, {
+      ...target,
+      ...options
+    });
   }
   screenshot(url, options = {}) {
     return this.request("POST", "/v1/web/screenshot", { url, ...options });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hydrafetch/node-sdk",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Official Node/TypeScript client for the Hydrafetch web data API. Turn any URL into clean Markdown and structured data.",
   "keywords": [
     "hydrafetch",