@anweat/dsh-browser 0.1.7 → 0.1.9

package/lib/browser-service.d.ts

@@ -23,6 +23,8 @@ import type { ResolvedConfig } from './config.ts';
 import { type BrowserRecipeStep, type RecipeStepResult } from './automation.ts';
 import { type UserscriptValidation } from './scripts.ts';
 import { type AutomationMode } from './freedom.ts';
+import { type OpencliCatalogFilter, type OpencliCatalogItem } from './opencli-catalog.ts';
+import { UsageGovernor } from './usage-policy.ts';
 export interface RenderRule {
     hostname: string;
     contentSelectors: string[];
@@ -37,7 +39,7 @@ export interface RenderResult {
 export interface SnapshotResult {
     title: string;
     text: string;
-    screenshotPath: string;
+    screenshotPath?: string;
     htmlPath: string;
     usedRule?: string;
 }
@@ -70,6 +72,61 @@ export interface ScriptRunResult {
     resultJson: string;
     truncated: boolean;
 }
+export interface CrawlPage {
+    url: string;
+    title: string;
+    text: string;
+    depth: number;
+    status: number;
+}
+export interface CrawlResult {
+    pages: CrawlPage[];
+    errors: {
+        url: string;
+        depth: number;
+        error: string;
+        status?: number;
+    }[];
+    stats: {
+        pagesVisited: number;
+        queued: number;
+        elapsedMs: number;
+        waitMs: number;
+        backoffEvents: number;
+    };
+    warnings: string[];
+}
+export interface BrowserStatus {
+    enabled: boolean;
+    channel: string;
+    browserRuntime: 'playwright' | 'patchright';
+    runtimeWarnings: string[];
+    headless: boolean;
+    opencliEnabled: boolean;
+    opencliInstalled: boolean;
+    opencliEntryPath?: string;
+    automationMode: AutomationMode;
+    exposedTools: string[];
+    directInteractionPolicy: 'deny' | 'ask' | 'allow';
+    mutatingRecipePolicy: 'deny' | 'ask' | 'allow';
+    externalUserscriptPolicy: 'deny' | 'ask' | 'allow';
+    opencliRunPolicy: 'deny' | 'ask' | 'allow';
+    chromiumInstalled: boolean;
+    chromiumExecutablePath?: string;
+    usagePolicy: ResolvedConfig['usagePolicy'];
+    usageGovernor: ReturnType<UsageGovernor['snapshot']>;
+    authProfiles: {
+        id: string;
+        allowedDomains: string[];
+        persistState: boolean;
+    }[];
+    rulePacks: string[];
+    builtinScripts: string[];
+    externalUserscriptsRequireApproval: boolean;
+    mutatingRecipesRequireApproval: boolean;
+    activeUrl?: string;
+    activeAuthProfile?: string;
+}
 export declare class BrowserService {
     private readonly config;
     private browser;
@@ -79,11 +136,15 @@ export declare class BrowserService {
     private activeProfile?;
     private activeRulePack?;
     private readonly authProfiles;
+    private readonly usageGovernor;
+    private opencliCatalogCache?;
     constructor(config: ResolvedConfig);
     available(): boolean;
+    private assertEnabled;
     private ensure;
     /** Run `playwright install chromium` from the bundled playwright CLI. */
     installChromium(): Promise<CliResult>;
+    private navigate;
     private transientContext;
     private persistAndClose;
     render(url: string, rules: readonly RenderRule[], opts?: {
@@ -99,6 +160,7 @@ export declare class BrowserService {
         maxChars?: number;
         authProfile?: string;
         rulePack?: string;
+        screenshot?: boolean;
     }): Promise<SnapshotResult>;
     searchResults(url: string, spec: PlatformSpec, opts?: {
         signal?: AbortSignal;
@@ -119,6 +181,14 @@ export declare class BrowserService {
         signal?: AbortSignal;
     }): Promise<CliResult>;
     opencliDoctor(signal?: AbortSignal): Promise<CliResult>;
+    opencliCatalog(filter?: OpencliCatalogFilter, signal?: AbortSignal): Promise<OpencliCatalogItem[]>;
+    crawl(startUrls: readonly string[], opts?: {
+        maxPages?: number;
+        maxDepth?: number;
+        sameOrigin?: boolean;
+        maxCharsPerPage?: number;
+        signal?: AbortSignal;
+    }): Promise<CrawlResult>;
     scriptCatalog(): {
         id: string;
         name: string;
@@ -138,6 +208,7 @@ export declare class BrowserService {
         timeoutMs?: number;
         authProfile?: string;
         rulePack?: string;
+        inputs?: Record<string, string>;
     }): Promise<ScriptRunResult>;
     private ensureActivePage;
     private captureScreenshot;
@@ -169,29 +240,6 @@ export declare class BrowserService {
         signal?: AbortSignal;
     }): Promise<RecipeRunResult>;
     closePage(): Promise<void>;
-    status(): Promise<{
-        enabled: boolean;
-        channel: string;
-        headless: boolean;
-        opencliEnabled: boolean;
-        automationMode: AutomationMode;
-        exposedTools: string[];
-        directInteractionPolicy: 'deny' | 'ask' | 'allow';
-        mutatingRecipePolicy: 'deny' | 'ask' | 'allow';
-        externalUserscriptPolicy: 'deny' | 'ask' | 'allow';
-        opencliRunPolicy: 'deny' | 'ask' | 'allow';
-        chromiumInstalled: boolean;
-        authProfiles: {
-            id: string;
-            allowedDomains: string[];
-            persistState: boolean;
-        }[];
-        rulePacks: string[];
-        builtinScripts: string[];
-        externalUserscriptsRequireApproval: boolean;
-        mutatingRecipesRequireApproval: boolean;
-        activeUrl?: string;
-        activeAuthProfile?: string;
-    }>;
+    status(): Promise<BrowserStatus>;
     close(): Promise<void>;
 }