clarity-js/src/layout/discover.ts

An analytics library that uses web page interactions to generate aggregated insights

import { Priority, type Timer } from "@clarity-types/core";
import { Event, Metric } from "@clarity-types/data";
import { Source } from "@clarity-types/layout";
import measure from "@src/core/measure";
import * as task from "@src/core/task";
import { time } from "@src/core/time";
import { id } from "@src/data/metadata";
import * as scroll from "@src/interaction/scroll";
import * as doc from "@src/layout/document";
import encode from "@src/layout/encode";
import * as region from "@src/layout/region";
import { checkDocumentStyles } from "@src/layout/style";
import traverse from "@src/layout/traverse";

export function start(): void {
    task.schedule(discover, Priority.High).then((): void => {
        measure(doc.compute)();
        measure(region.compute)();
        measure(scroll.compute)();
    });
}

async function discover(): Promise<void> {
    const ts = time();
    const timer: Timer = { id: id(), cost: Metric.LayoutCost };
    task.start(timer);
    await traverse(document, timer, Source.Discover, ts);
    checkDocumentStyles(document, ts);
    await encode(Event.Discover, timer, ts);
    task.stop(timer);
}