tablefacts 0.1.0

package/types/research/lib/util.d.mts

@@ -0,0 +1,45 @@
+import { fold } from "../../lib/text.mjs";
+export { fold };
+export declare const BROWSER_UA = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/130.0 Safari/537.36 cannario-research";
+export declare const sleep: (ms: any) => Promise<any>;
+/** Runs `fn(item, index)` over `items` with at most `size` in flight; results keep the order of `items`. */
+export declare function mapPool(items: any, size: any, fn: any): Promise<any[]>;
+export declare const MAX_BODY_BYTES: number;
+/**
+ * GETs a URL as text. The body is capped at 2 MB (`truncated: true` when it was cut, never an error) and a
+ * clearly binary content-type (image, pdf, zip...) is not read at all (`skipped: true`, empty text).
+ */
+export declare function fetchText(url: any, { headers, timeout, maxBytes }?: {
+    headers?: {} | undefined;
+    maxBytes?: number | undefined;
+    timeout?: number | undefined;
+}): Promise<{
+    ok: boolean;
+    status: number;
+    url: string;
+    type: string;
+    text: string;
+    skipped: boolean;
+} | {
+    ok: boolean;
+    status: number;
+    url: string;
+    type: string;
+    text: any;
+    truncated: boolean;
+} | {
+    ok: boolean;
+    status: number;
+    url: string;
+    type: string;
+    text: any;
+}>;
+export declare const tokens: (s: any) => string[];
+/** Loose text match: at least 60% of the shorter side's words appear in the other. */
+export declare function sameText(a: any, b: any): boolean;
+export declare const slugify: (s: any) => string;
+export declare const digits: (s: any) => string;
+/** Same phone number written differently (spaces, +country, leading 0). */
+export declare const samePhone: (a: any, b: any) => boolean;
+/** Distance in km between two { lat, lng } points. */
+export declare function km(a: any, b: any): number;

package/types/research/lib/website.d.mts

@@ -0,0 +1,283 @@
+/** Pulls every fact a page holds. `base` resolves relative links. */
+export declare function analyzeHtml(html: any, base: any, lines?: any): {
+    url: any;
+    title: any;
+    lang: any;
+    meta: {
+        siteName: any;
+        title: any;
+        description: any;
+        themeColor: any;
+    };
+    jsonld: {
+        name: any;
+        telephone: any;
+        email: any;
+        priceRange: any;
+        cuisines: string[];
+        address: {
+            street: any;
+            locality: any;
+            region: any;
+            postcode: any;
+            country: any;
+        };
+        geo: {
+            lat: number;
+            lng: number;
+        } | null;
+        sameAs: string[];
+        logo: any;
+        rating: {
+            value: number;
+            count: number | null;
+        } | null;
+        hours: {
+            week: string[][][];
+            partial?: undefined;
+        } | {
+            week: never[][];
+        } | null;
+    } | null;
+    links: {
+        tel: never[];
+        mail: never[];
+        whatsapp: never[];
+        reserve: never[];
+        menu: never[];
+        delivery: never[];
+        maps: never[];
+        waze: never[];
+        facebook: never[];
+        tiktok: never[];
+        tripadvisor: never[];
+        hubs: never[];
+        instagram: never[];
+    };
+    images: any[];
+    logos: {
+        url: string | null;
+        kind: any;
+    }[];
+    textLength: any;
+    headings: any[];
+    paragraphs: any;
+    hoursText: any;
+    anchors: {
+        href: string | null;
+        text: any;
+    }[];
+};
+/**
+ * One lazily launched Chromium shared by every render of a run. `get()` launches on first use;
+ * `close()` is safe to call when nothing was launched.
+ */
+export declare function createBrowser(): {
+    get(): any;
+    close(): Promise<void>;
+};
+/** One page, analysed. Returns { page, blocked } and never throws on HTTP errors. `browser` is a shared createBrowser(); without one a private browser is used and closed. */
+export declare function readPage(url: any, { renderJs, browser }?: {
+    renderJs?: boolean | undefined;
+}): Promise<{
+    page: null;
+    blocked: string;
+} | {
+    blocked?: undefined;
+    page: {
+        url: any;
+        title: any;
+        lang: any;
+        meta: {
+            siteName: any;
+            title: any;
+            description: any;
+            themeColor: any;
+        };
+        jsonld: {
+            name: any;
+            telephone: any;
+            email: any;
+            priceRange: any;
+            cuisines: string[];
+            address: {
+                street: any;
+                locality: any;
+                region: any;
+                postcode: any;
+                country: any;
+            };
+            geo: {
+                lat: number;
+                lng: number;
+            } | null;
+            sameAs: string[];
+            logo: any;
+            rating: {
+                value: number;
+                count: number | null;
+            } | null;
+            hours: {
+                week: string[][][];
+                partial?: undefined;
+            } | {
+                week: never[][];
+            } | null;
+        } | null;
+        links: {
+            tel: never[];
+            mail: never[];
+            whatsapp: never[];
+            reserve: never[];
+            menu: never[];
+            delivery: never[];
+            maps: never[];
+            waze: never[];
+            facebook: never[];
+            tiktok: never[];
+            tripadvisor: never[];
+            hubs: never[];
+            instagram: never[];
+        };
+        images: any[];
+        logos: {
+            url: string | null;
+            kind: any;
+        }[];
+        textLength: any;
+        headings: any[];
+        paragraphs: any;
+        hoursText: any;
+        anchors: {
+            href: string | null;
+            text: any;
+        }[];
+        rendered: boolean;
+    };
+} | {
+    blocked?: undefined;
+    page: {
+        url: any;
+        title: any;
+        lang: any;
+        meta: {
+            siteName: any;
+            title: any;
+            description: any;
+            themeColor: any;
+        };
+        jsonld: {
+            name: any;
+            telephone: any;
+            email: any;
+            priceRange: any;
+            cuisines: string[];
+            address: {
+                street: any;
+                locality: any;
+                region: any;
+                postcode: any;
+                country: any;
+            };
+            geo: {
+                lat: number;
+                lng: number;
+            } | null;
+            sameAs: string[];
+            logo: any;
+            rating: {
+                value: number;
+                count: number | null;
+            } | null;
+            hours: {
+                week: string[][][];
+                partial?: undefined;
+            } | {
+                week: never[][];
+            } | null;
+        } | null;
+        links: {
+            tel: never[];
+            mail: never[];
+            whatsapp: never[];
+            reserve: never[];
+            menu: never[];
+            delivery: never[];
+            maps: never[];
+            waze: never[];
+            facebook: never[];
+            tiktok: never[];
+            tripadvisor: never[];
+            hubs: never[];
+            instagram: never[];
+        };
+        images: any[];
+        logos: {
+            url: string | null;
+            kind: any;
+        }[];
+        textLength: any;
+        headings: any[];
+        paragraphs: any;
+        hoursText: any;
+        anchors: {
+            href: string | null;
+            text: any;
+        }[];
+    };
+}>;
+/** The restaurant's own site: the home page plus a few contact/about/menu pages, merged. */
+export declare function scrapeSite(startUrl: any, { renderJs, maxPages, browser }?: {
+    maxPages?: number | undefined;
+    renderJs?: boolean | undefined;
+}): Promise<{
+    url: any;
+    pages: {
+        url: any;
+        title: any;
+        rendered: boolean;
+    }[];
+    lang: any;
+    meta: {
+        siteName: any;
+        title: any;
+        description: any;
+        themeColor: any;
+    };
+    jsonld: {
+        name: any;
+        telephone: any;
+        email: any;
+        priceRange: any;
+        cuisines: string[];
+        address: {
+            street: any;
+            locality: any;
+            region: any;
+            postcode: any;
+            country: any;
+        };
+        geo: {
+            lat: number;
+            lng: number;
+        } | null;
+        sameAs: string[];
+        logo: any;
+        rating: {
+            value: number;
+            count: number | null;
+        } | null;
+        hours: {
+            week: string[][][];
+            partial?: undefined;
+        } | {
+            week: never[][];
+        } | null;
+    } | null;
+    links: {};
+    images: any;
+    logos: any;
+    headings: any;
+    paragraphs: any;
+    hoursText: any;
+}>;

package/types/research/research.d.mts

@@ -0,0 +1 @@
+export {};

package/types/tripadvisor/index.d.mts

@@ -0,0 +1,11 @@
+/**
+ * Downloads the photos of TripAdvisor restaurant pages through the user's own Edge.
+ * Resolves to a summary whose `failed` lists `{ item, reason }` and whose `found` is present only
+ * in a dry run. Throws a TablefactsError on invalid arguments (code 'EUSAGE', with `option`), a
+ * missing playwright ('EDEPENDENCY') or a browser that cannot be reached.
+ * `out` resolves against `projectDir` (default: TABLEFACTS_PROJECT or the current folder).
+ * `log(message, level)` gets level 'info', 'warn' or 'error'.
+ * @param {import('../lib/types.mjs').TripadvisorOptions} options
+ * @returns {Promise<import('../lib/types.mjs').PhotoSummary>}
+ */
+export declare function downloadTripadvisor({ links, out, cdp, edgeDir, max, projectDir, dryRun, debug, log: logOption, }?: import('../lib/types.mjs').TripadvisorOptions): Promise<import('../lib/types.mjs').PhotoSummary>;

package/types/tripadvisor/links.d.mts

@@ -0,0 +1,13 @@
+export declare function parseArgs(argv: any): {
+    links: never[];
+    dryRun: boolean;
+    debug: boolean;
+    max: number;
+};
+export declare function normalizeRestaurant(raw: any): {
+    id: string;
+    url: string;
+} | null;
+export declare function findPhotos(text: any): any[];
+export declare function sizeCandidates(photo: any): string[];
+export declare function fileName(photo: any): string;

package/types/tripadvisor/photos.d.mts

@@ -0,0 +1 @@
+export {};