@cleanslate/sdk 0.1.0

package/dist/node/cleanSlateNodeBrowserAutomation.d.ts

@@ -0,0 +1,279 @@
+import { CleanSlateBrowserSurface, IBrowserViewConsoleEntry, IBrowserViewNetworkEntry, ICleanSlateBrowserActionResult, ICleanSlateBrowserAnnotation, ICleanSlateBrowserAutomationService, ICleanSlateBrowserLocator, ICleanSlateBrowserSnapshot, ICleanSlateBrowserState, ICleanSlateBrowserTab, ICleanSlateBrowserTarget, ICleanSlateBrowserWaitOptions } from '../host/browserAutomation.js';
+export interface ICleanSlateNodeBrowserAutomationOptions {
+    headless?: boolean;
+}
+export declare function resolveNodeBrowserHeadless(configuredDefault?: boolean, environment?: NodeJS.ProcessEnv): boolean;
+export declare class CleanSlateNodeBrowserAutomation implements ICleanSlateBrowserAutomationService {
+    private readonly options;
+    private browser;
+    private context;
+    private activePage;
+    private nextTabId;
+    private readonly tabIds;
+    private readonly consoleEntries;
+    private readonly networkEntries;
+    private readonly annotations;
+    private pendingDialog;
+    private annotationActive;
+    private readonly annotationEmitter;
+    private readonly openEmitter;
+    readonly onDidChangeAnnotations: import("../core/event.js").Event<any>;
+    readonly onDidOpenBrowser: import("../core/event.js").Event<ICleanSlateBrowserState>;
+    constructor(options?: ICleanSlateNodeBrowserAutomationOptions);
+    open(url: string): Promise<ICleanSlateBrowserState>;
+    openInAgentManager(url: string, surface?: CleanSlateBrowserSurface): Promise<ICleanSlateBrowserState>;
+    revealOpenBrowser(surface?: CleanSlateBrowserSurface): Promise<ICleanSlateBrowserState | undefined>;
+    layoutOpenBrowser(_bounds: any, surface?: CleanSlateBrowserSurface): Promise<ICleanSlateBrowserState | undefined>;
+    setOpenBrowserVisible(_visible: boolean, surface?: CleanSlateBrowserSurface): Promise<ICleanSlateBrowserState | undefined>;
+    navigateBack(surface: CleanSlateBrowserSurface): Promise<ICleanSlateBrowserState>;
+    navigateForward(surface: CleanSlateBrowserSurface): Promise<ICleanSlateBrowserState>;
+    reload(surface: CleanSlateBrowserSurface): Promise<ICleanSlateBrowserState>;
+    snapshot(surface: CleanSlateBrowserSurface, options?: {
+        limit?: number;
+    }): Promise<ICleanSlateBrowserSnapshot>;
+    click(surface: CleanSlateBrowserSurface, input: ICleanSlateBrowserTarget): Promise<ICleanSlateBrowserActionResult>;
+    hover(surface: CleanSlateBrowserSurface, input: ICleanSlateBrowserTarget): Promise<ICleanSlateBrowserActionResult>;
+    fill(surface: CleanSlateBrowserSurface, input: ICleanSlateBrowserLocator & {
+        value: string;
+    }): Promise<ICleanSlateBrowserActionResult>;
+    check(surface: CleanSlateBrowserSurface, input: ICleanSlateBrowserLocator & {
+        checked?: boolean;
+    }): Promise<ICleanSlateBrowserActionResult>;
+    select(surface: CleanSlateBrowserSurface, input: ICleanSlateBrowserLocator & {
+        values: string[];
+    }): Promise<{
+        values: string[];
+        action: string;
+        target?: string;
+        point?: import("../host/browserAutomation.js").ICleanSlateBrowserPoint;
+        success: true;
+        surface: CleanSlateBrowserSurface;
+        viewId: string;
+        url: string;
+        title: string;
+        visible: boolean;
+        loading: boolean;
+        canGoBack: boolean;
+        canGoForward: boolean;
+        annotationActive: boolean;
+        loadError?: string;
+    }>;
+    uploadFiles(surface: CleanSlateBrowserSurface, input: ICleanSlateBrowserLocator & {
+        files: string[];
+    }): Promise<{
+        files: string[];
+        action: string;
+        target?: string;
+        point?: import("../host/browserAutomation.js").ICleanSlateBrowserPoint;
+        success: true;
+        surface: CleanSlateBrowserSurface;
+        viewId: string;
+        url: string;
+        title: string;
+        visible: boolean;
+        loading: boolean;
+        canGoBack: boolean;
+        canGoForward: boolean;
+        annotationActive: boolean;
+        loadError?: string;
+    }>;
+    handleDialog(surface: CleanSlateBrowserSurface, input: {
+        accept: boolean;
+        promptText?: string;
+    }): Promise<ICleanSlateBrowserActionResult>;
+    clipboard(surface: CleanSlateBrowserSurface, input: {
+        action: 'read' | 'write';
+        text?: string;
+    }): Promise<{
+        text: string | undefined;
+        action: string;
+        target?: string;
+        point?: import("../host/browserAutomation.js").ICleanSlateBrowserPoint;
+        success: true;
+        surface: CleanSlateBrowserSurface;
+        viewId: string;
+        url: string;
+        title: string;
+        visible: boolean;
+        loading: boolean;
+        canGoBack: boolean;
+        canGoForward: boolean;
+        annotationActive: boolean;
+        loadError?: string;
+    }>;
+    typeText(surface: CleanSlateBrowserSurface, text: string): Promise<ICleanSlateBrowserActionResult>;
+    pressKey(surface: CleanSlateBrowserSurface, input: ICleanSlateBrowserLocator & {
+        key: string;
+        ctrlKey?: boolean;
+        shiftKey?: boolean;
+        altKey?: boolean;
+        metaKey?: boolean;
+    }): Promise<ICleanSlateBrowserActionResult>;
+    scroll(surface: CleanSlateBrowserSurface, input: ICleanSlateBrowserTarget & {
+        deltaX?: number;
+        deltaY?: number;
+    }): Promise<ICleanSlateBrowserActionResult>;
+    wait(surface: CleanSlateBrowserSurface, input?: ICleanSlateBrowserWaitOptions): Promise<ICleanSlateBrowserState>;
+    getUrl(surface: CleanSlateBrowserSurface): Promise<ICleanSlateBrowserState>;
+    getDiagnostics(surface: CleanSlateBrowserSurface, options?: {
+        clear?: boolean;
+    }): Promise<{
+        console: IBrowserViewConsoleEntry[];
+        network: IBrowserViewNetworkEntry[];
+        downloads: never[];
+        success: true;
+        surface: CleanSlateBrowserSurface;
+        viewId: string;
+        url: string;
+        title: string;
+        visible: boolean;
+        loading: boolean;
+        canGoBack: boolean;
+        canGoForward: boolean;
+        annotationActive: boolean;
+        loadError?: string;
+    }>;
+    listTabs(_surface: CleanSlateBrowserSurface): Promise<{
+        success: true;
+        tabs: ICleanSlateBrowserTab[];
+    }>;
+    newTab(surface: CleanSlateBrowserSurface, options?: {
+        url?: string;
+        background?: boolean;
+    }): Promise<{
+        tabId: string;
+        success: true;
+        surface: CleanSlateBrowserSurface;
+        viewId: string;
+        url: string;
+        title: string;
+        visible: boolean;
+        loading: boolean;
+        canGoBack: boolean;
+        canGoForward: boolean;
+        annotationActive: boolean;
+        loadError?: string;
+    }>;
+    selectTab(surface: CleanSlateBrowserSurface, tabId: string): Promise<{
+        tabId: string;
+        success: true;
+        surface: CleanSlateBrowserSurface;
+        viewId: string;
+        url: string;
+        title: string;
+        visible: boolean;
+        loading: boolean;
+        canGoBack: boolean;
+        canGoForward: boolean;
+        annotationActive: boolean;
+        loadError?: string;
+    }>;
+    closeTab(_surface: CleanSlateBrowserSurface, tabId: string): Promise<{
+        success: true;
+        tabs: ICleanSlateBrowserTab[];
+    }>;
+    screenshot(surface: CleanSlateBrowserSurface, options?: {
+        quality?: number;
+        fullPage?: boolean;
+    }): Promise<{
+        mimeType: "image/jpeg";
+        base64: string;
+        success: true;
+        surface: CleanSlateBrowserSurface;
+        viewId: string;
+        url: string;
+        title: string;
+        visible: boolean;
+        loading: boolean;
+        canGoBack: boolean;
+        canGoForward: boolean;
+        annotationActive: boolean;
+        loadError?: string;
+    }>;
+    startAnnotation(surface: CleanSlateBrowserSurface): Promise<{
+        annotationMode: "active";
+        success: true;
+        surface: CleanSlateBrowserSurface;
+        viewId: string;
+        url: string;
+        title: string;
+        visible: boolean;
+        loading: boolean;
+        canGoBack: boolean;
+        canGoForward: boolean;
+        annotationActive: boolean;
+        loadError?: string;
+    }>;
+    stopAnnotation(surface: CleanSlateBrowserSurface): Promise<{
+        annotationMode: "inactive";
+        annotations: import("../host/browserAutomation.js").IBrowserViewAnnotation[];
+        success: true;
+        surface: CleanSlateBrowserSurface;
+        viewId: string;
+        url: string;
+        title: string;
+        visible: boolean;
+        loading: boolean;
+        canGoBack: boolean;
+        canGoForward: boolean;
+        annotationActive: boolean;
+        loadError?: string;
+    }>;
+    listAnnotations(surface: CleanSlateBrowserSurface): Promise<{
+        annotations: import("../host/browserAutomation.js").IBrowserViewAnnotation[];
+        success: true;
+        surface: CleanSlateBrowserSurface;
+        viewId: string;
+        url: string;
+        title: string;
+        visible: boolean;
+        loading: boolean;
+        canGoBack: boolean;
+        canGoForward: boolean;
+        annotationActive: boolean;
+        loadError?: string;
+    }>;
+    listCachedAnnotations(): ICleanSlateBrowserAnnotation[];
+    refreshVisibleAnnotations(): Promise<ICleanSlateBrowserAnnotation[]>;
+    deleteAnnotation(surface: CleanSlateBrowserSurface, annotationId: string): Promise<{
+        annotations: import("../host/browserAutomation.js").IBrowserViewAnnotation[];
+        success: true;
+        surface: CleanSlateBrowserSurface;
+        viewId: string;
+        url: string;
+        title: string;
+        visible: boolean;
+        loading: boolean;
+        canGoBack: boolean;
+        canGoForward: boolean;
+        annotationActive: boolean;
+        loadError?: string;
+    }>;
+    clearAnnotations(surface: CleanSlateBrowserSurface): Promise<{
+        annotations: import("../host/browserAutomation.js").IBrowserViewAnnotation[];
+        success: true;
+        surface: CleanSlateBrowserSurface;
+        viewId: string;
+        url: string;
+        title: string;
+        visible: boolean;
+        loading: boolean;
+        canGoBack: boolean;
+        canGoForward: boolean;
+        annotationActive: boolean;
+        loadError?: string;
+    }>;
+    dispose(): Promise<void>;
+    private ensureContext;
+    private ensurePage;
+    private page;
+    private registerPage;
+    private idFor;
+    private pageForId;
+    private tabs;
+    private state;
+    private action;
+    private hasLocator;
+    private locator;
+}
+//# sourceMappingURL=cleanSlateNodeBrowserAutomation.d.ts.map

package/dist/node/cleanSlateNodeBrowserAutomation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cleanSlateNodeBrowserAutomation.d.ts","sourceRoot":"","sources":["../../src/node/cleanSlateNodeBrowserAutomation.ts"],"names":[],"mappings":"AAOA,OAAO,EACN,wBAAwB,EACxB,wBAAwB,EACxB,wBAAwB,EACxB,8BAA8B,EAC9B,4BAA4B,EAC5B,mCAAmC,EACnC,yBAAyB,EACzB,0BAA0B,EAC1B,uBAAuB,EACvB,qBAAqB,EACrB,wBAAwB,EACxB,6BAA6B,EAC7B,MAAM,8BAA8B,CAAC;AAEtC,MAAM,WAAW,uCAAuC;IACvD,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,wBAAgB,0BAA0B,CACzC,iBAAiB,UAAO,EACxB,WAAW,GAAE,MAAM,CAAC,UAAwB,GAC1C,OAAO,CAGT;AAED,qBAAa,+BAAgC,YAAW,mCAAmC;IAgB9E,OAAO,CAAC,QAAQ,CAAC,OAAO;IAfpC,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,OAAO,CAA6B;IAC5C,OAAO,CAAC,UAAU,CAAmB;IACrC,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA2B;IAClD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAkC;IACjE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAkC;IACjE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsC;IAClE,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAsB;IACxD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0C;IACtE,QAAQ,CAAC,sBAAsB,wCAAgC;IAC/D,QAAQ,CAAC,gBAAgB,4DAA0B;gBAEtB,OAAO,GAAE,uCAA4C;IAE5E,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAQzD,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,wBAAyC,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAI/G,iBAAiB,CAAC,OAAO,GAAE,wBAAgC,GAAG,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC;IAGhH,iBAAiB,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,GAAE,wBAAgC,GAAG,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC;IAGxH,qBAAqB,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,GAAE,wBAAgC,GAAG,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC;IAI3H,YAAY,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAKjF,eAAe,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAKpF,MAAM,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAM3E,QAAQ,CAAC,OAAO,EAAE,wBAAwB,EAAE,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAyDlH,KAAK,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,wBAAwB,GAAG,OAAO,CAAC,8BAA8B,CAAC;IASlH,KAAK,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,wBAAwB,GAAG,OAAO,CAAC,8BAA8B,CAAC;IASlH,IAAI,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,yBAAyB,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAItI,KAAK,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,yBAAyB,GAAG;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAK3I,MAAM,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,yBAAyB,GAAG;QAAE,MAAM,EAAE,MAAM,EAAE,CAAA;KAAE;;;;;;;;;;;;;;;;;IAIjG,WAAW,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,yBAAyB,GAAG;QAAE,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE;;;;;;;;;;;;;;;;;IAKrG,YAAY,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAUzI,SAAS,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE;;;;;;;;;;;;;;;;;IAS/F,QAAQ,CAAC,OAAO,EAAE,wBAAwB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAIlG,QAAQ,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,yBAAyB,GAAG;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAgBpN,MAAM,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,wBAAwB,GAAG;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAY1J,IAAI,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,GAAE,6BAAkC,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAgB1H,MAAM,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAGrE,cAAc,CAAC,OAAO,EAAE,wBAAwB,EAAE,OAAO,GAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO;;;;;;;;;;;;;;;;IAcnF,QAAQ,CAAC,QAAQ,EAAE,wBAAwB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,IAAI,CAAC;QAAC,IAAI,EAAE,qBAAqB,EAAE,CAAA;KAAE,CAAC;IAIvG,MAAM,CAAC,OAAO,EAAE,wBAAwB,EAAE,OAAO,GAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAO;;;;;;;;;;;;;;IAY9F,SAAS,CAAC,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,MAAM;;;;;;;;;;;;;;IAM1D,QAAQ,CAAC,QAAQ,EAAE,wBAAwB,EAAE,KAAK,EAAE,MAAM;;;;IAS1D,UAAU,CAAC,OAAO,EAAE,wBAAwB,EAAE,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAO;;;;;;;;;;;;;;;IAUpG,eAAe,CAAC,OAAO,EAAE,wBAAwB;;;;;;;;;;;;;;IAIjD,cAAc,CAAC,OAAO,EAAE,wBAAwB;;;;;;;;;;;;;;;IAIhD,eAAe,CAAC,OAAO,EAAE,wBAAwB;;;;;;;;;;;;;;IAGvD,qBAAqB,IAAI,4BAA4B,EAAE;IAGvD,yBAAyB,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;IAG9D,gBAAgB,CAAC,OAAO,EAAE,wBAAwB,EAAE,YAAY,EAAE,MAAM;;;;;;;;;;;;;;IAQxE,gBAAgB,CAAC,OAAO,EAAE,wBAAwB;;;;;;;;;;;;;;IAMlD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;YAShB,aAAa;YA2Bb,UAAU;IAUxB,OAAO,CAAC,IAAI;IAGZ,OAAO,CAAC,YAAY;IAmCpB,OAAO,CAAC,KAAK;IAQb,OAAO,CAAC,SAAS;YAQH,IAAI;YAQJ,KAAK;YAcL,MAAM;IAOpB,OAAO,CAAC,UAAU;YAGJ,OAAO;CAyBrB"}