@webability/core 1.2.1 → 1.3.1

package/dist/dom.d.cts

@@ -0,0 +1,50 @@
+import { P as PageLike, S as ScanResult } from './types-10iqML3X.cjs';
+
+/**
+ * In-DOM scan entry — runs the full detector engine directly against a live
+ * `document`, with no Playwright/Puppeteer and no injected source strings.
+ *
+ * Built for contexts that already ARE the page: Chrome-extension content
+ * scripts (MV3 CSP bans eval, so the server path's addScriptTag string
+ * injection is impossible), the widget, or any bundled in-browser consumer.
+ *
+ * Parity notes vs the server `scan()`:
+ * - Same detectors, same dedupe, same confidence tiering (issues/incomplete).
+ * - axe-core runs as a bundled module (no injection) when `includeAxe`.
+ * - HTML_CodeSniffer is NOT run — the server loads it from a CDN, which is
+ *   remote code a browser extension may not execute.
+ * - No navigation/bot-challenge/auth-wall guards — the user is already on the
+ *   page they want scanned.
+ */
+
+interface DomScanOptions {
+    /** Also run axe-core (bundled, ~104 rules). Default true. */
+    includeAxe?: boolean;
+    /** axe tag filter. Default WCAG 2.x A/AA. */
+    wcagTags?: string[];
+    /**
+     * Window to scan. Default the ambient `window`. SAME-REALM only: detector
+     * code executes in the realm this module was loaded into, so a cross-realm
+     * window (an iframe's contentWindow) is not supported — load the bundle
+     * inside that frame instead.
+     */
+    window?: Window & typeof globalThis;
+    /**
+     * Run the focus-mutating checks (focus visibility/obscured). Default FALSE
+     * in DOM mode: they steal focus and scroll the page the user is looking
+     * at. Opt in for detached/offscreen documents only.
+     */
+    interactiveChecks?: boolean;
+}
+/**
+ * Adapts a live Window into the PageLike the engine orchestration expects.
+ * `evaluate` calls the function directly — detector browser functions are
+ * pure and reference helpers as globals, which `installDomKernel` provides.
+ * `addScriptTag` is a successful no-op: the only content the engine injects
+ * is the helper kernel, and it is already installed as real code.
+ */
+declare function createDomPage(win: Window & typeof globalThis): PageLike;
+/** Runs the full WebAbility scan against the current document. */
+declare function scanDocument(options?: DomScanOptions): Promise<ScanResult>;
+
+export { type DomScanOptions, createDomPage, scanDocument };

package/dist/dom.d.ts

@@ -0,0 +1,50 @@
+import { P as PageLike, S as ScanResult } from './types-10iqML3X.js';
+
+/**
+ * In-DOM scan entry — runs the full detector engine directly against a live
+ * `document`, with no Playwright/Puppeteer and no injected source strings.
+ *
+ * Built for contexts that already ARE the page: Chrome-extension content
+ * scripts (MV3 CSP bans eval, so the server path's addScriptTag string
+ * injection is impossible), the widget, or any bundled in-browser consumer.
+ *
+ * Parity notes vs the server `scan()`:
+ * - Same detectors, same dedupe, same confidence tiering (issues/incomplete).
+ * - axe-core runs as a bundled module (no injection) when `includeAxe`.
+ * - HTML_CodeSniffer is NOT run — the server loads it from a CDN, which is
+ *   remote code a browser extension may not execute.
+ * - No navigation/bot-challenge/auth-wall guards — the user is already on the
+ *   page they want scanned.
+ */
+
+interface DomScanOptions {
+    /** Also run axe-core (bundled, ~104 rules). Default true. */
+    includeAxe?: boolean;
+    /** axe tag filter. Default WCAG 2.x A/AA. */
+    wcagTags?: string[];
+    /**
+     * Window to scan. Default the ambient `window`. SAME-REALM only: detector
+     * code executes in the realm this module was loaded into, so a cross-realm
+     * window (an iframe's contentWindow) is not supported — load the bundle
+     * inside that frame instead.
+     */
+    window?: Window & typeof globalThis;
+    /**
+     * Run the focus-mutating checks (focus visibility/obscured). Default FALSE
+     * in DOM mode: they steal focus and scroll the page the user is looking
+     * at. Opt in for detached/offscreen documents only.
+     */
+    interactiveChecks?: boolean;
+}
+/**
+ * Adapts a live Window into the PageLike the engine orchestration expects.
+ * `evaluate` calls the function directly — detector browser functions are
+ * pure and reference helpers as globals, which `installDomKernel` provides.
+ * `addScriptTag` is a successful no-op: the only content the engine injects
+ * is the helper kernel, and it is already installed as real code.
+ */
+declare function createDomPage(win: Window & typeof globalThis): PageLike;
+/** Runs the full WebAbility scan against the current document. */
+declare function scanDocument(options?: DomScanOptions): Promise<ScanResult>;
+
+export { type DomScanOptions, createDomPage, scanDocument };