@hasna/browser 0.4.11 → 0.4.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +910 -736
- package/dist/sdk.d.ts +119 -0
- package/dist/sdk.d.ts.map +1 -0
- package/dist/sdk.test.d.ts +2 -0
- package/dist/sdk.test.d.ts.map +1 -0
- package/package.json +1 -1
package/dist/sdk.d.ts
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
import type { Page } from "playwright";
|
|
2
|
+
import type { PageInfo, ScreenshotOptions, ScreenshotResult, Session, SessionOptions } from "./types/index.js";
|
|
3
|
+
import { click as clickAction, fill as fillAction, pressKey as pressKeyAction, type as typeTextAction, waitForSelector as waitForSelectorAction } from "./lib/actions.js";
|
|
4
|
+
import { takeScreenshot as takeBrowserScreenshot } from "./lib/screenshot.js";
|
|
5
|
+
export interface BrowserSDKSession {
|
|
6
|
+
id: string;
|
|
7
|
+
session: Session;
|
|
8
|
+
page: Page;
|
|
9
|
+
}
|
|
10
|
+
export type BrowserSDKSessionRef = string | BrowserSDKSession;
|
|
11
|
+
export interface BrowserSDKDependencies {
|
|
12
|
+
createSession?: (opts?: SessionOptions) => Promise<{
|
|
13
|
+
session: Session;
|
|
14
|
+
page: Page;
|
|
15
|
+
}>;
|
|
16
|
+
closeSession?: (sessionId: string) => Promise<Session>;
|
|
17
|
+
getSessionPage?: (sessionId: string) => Page;
|
|
18
|
+
getPageInfo?: (page: Page) => Promise<PageInfo>;
|
|
19
|
+
navigate?: (page: Page, url: string, timeout?: number) => Promise<void>;
|
|
20
|
+
click?: typeof clickAction;
|
|
21
|
+
typeText?: typeof typeTextAction;
|
|
22
|
+
fill?: typeof fillAction;
|
|
23
|
+
pressKey?: typeof pressKeyAction;
|
|
24
|
+
waitForSelector?: typeof waitForSelectorAction;
|
|
25
|
+
takeScreenshot?: typeof takeBrowserScreenshot;
|
|
26
|
+
}
|
|
27
|
+
export interface BrowserSDKOptions {
|
|
28
|
+
dependencies?: BrowserSDKDependencies;
|
|
29
|
+
}
|
|
30
|
+
export type BrowserSDKStep = {
|
|
31
|
+
type: "navigate";
|
|
32
|
+
url: string;
|
|
33
|
+
timeout?: number;
|
|
34
|
+
} | {
|
|
35
|
+
type: "click";
|
|
36
|
+
selector: string;
|
|
37
|
+
timeout?: number;
|
|
38
|
+
selfHeal?: boolean;
|
|
39
|
+
} | {
|
|
40
|
+
type: "fill";
|
|
41
|
+
selector: string;
|
|
42
|
+
value: string;
|
|
43
|
+
timeout?: number;
|
|
44
|
+
selfHeal?: boolean;
|
|
45
|
+
} | {
|
|
46
|
+
type: "type";
|
|
47
|
+
selector: string;
|
|
48
|
+
text: string;
|
|
49
|
+
timeout?: number;
|
|
50
|
+
clear?: boolean;
|
|
51
|
+
selfHeal?: boolean;
|
|
52
|
+
} | {
|
|
53
|
+
type: "press";
|
|
54
|
+
key: string;
|
|
55
|
+
} | {
|
|
56
|
+
type: "wait";
|
|
57
|
+
selector: string;
|
|
58
|
+
timeout?: number;
|
|
59
|
+
state?: "attached" | "detached" | "visible" | "hidden";
|
|
60
|
+
} | {
|
|
61
|
+
type: "screenshot";
|
|
62
|
+
options?: ScreenshotOptions;
|
|
63
|
+
} | {
|
|
64
|
+
type: "pageInfo";
|
|
65
|
+
};
|
|
66
|
+
export interface BrowserSDKStepResult {
|
|
67
|
+
type: BrowserSDKStep["type"];
|
|
68
|
+
ok: true;
|
|
69
|
+
info?: PageInfo;
|
|
70
|
+
screenshot?: ScreenshotResult;
|
|
71
|
+
}
|
|
72
|
+
export interface BrowserSDKRunOptions {
|
|
73
|
+
session?: BrowserSDKSessionRef;
|
|
74
|
+
sessionOptions?: SessionOptions;
|
|
75
|
+
steps: BrowserSDKStep[];
|
|
76
|
+
autoClose?: boolean;
|
|
77
|
+
}
|
|
78
|
+
export interface BrowserSDKRunResult {
|
|
79
|
+
session: Session;
|
|
80
|
+
pageInfo: PageInfo;
|
|
81
|
+
steps: BrowserSDKStepResult[];
|
|
82
|
+
}
|
|
83
|
+
export declare class BrowserSDK {
|
|
84
|
+
private readonly deps;
|
|
85
|
+
private readonly sessions;
|
|
86
|
+
constructor(options?: BrowserSDKOptions);
|
|
87
|
+
open(options?: SessionOptions): Promise<BrowserSDKSession>;
|
|
88
|
+
createSession(options?: SessionOptions): Promise<BrowserSDKSession>;
|
|
89
|
+
getPage(ref: BrowserSDKSessionRef): Page;
|
|
90
|
+
pageInfo(ref: BrowserSDKSessionRef): Promise<PageInfo>;
|
|
91
|
+
navigate(ref: BrowserSDKSessionRef, url: string, opts?: {
|
|
92
|
+
timeout?: number;
|
|
93
|
+
}): Promise<PageInfo>;
|
|
94
|
+
click(ref: BrowserSDKSessionRef, selector: string, opts?: {
|
|
95
|
+
timeout?: number;
|
|
96
|
+
selfHeal?: boolean;
|
|
97
|
+
}): ReturnType<typeof clickAction>;
|
|
98
|
+
fill(ref: BrowserSDKSessionRef, selector: string, value: string, opts?: {
|
|
99
|
+
timeout?: number;
|
|
100
|
+
selfHeal?: boolean;
|
|
101
|
+
}): ReturnType<typeof fillAction>;
|
|
102
|
+
type(ref: BrowserSDKSessionRef, selector: string, text: string, opts?: {
|
|
103
|
+
timeout?: number;
|
|
104
|
+
clear?: boolean;
|
|
105
|
+
selfHeal?: boolean;
|
|
106
|
+
}): ReturnType<typeof typeTextAction>;
|
|
107
|
+
pressKey(ref: BrowserSDKSessionRef, key: string): ReturnType<typeof pressKeyAction>;
|
|
108
|
+
waitForSelector(ref: BrowserSDKSessionRef, selector: string, opts?: {
|
|
109
|
+
timeout?: number;
|
|
110
|
+
state?: "attached" | "detached" | "visible" | "hidden";
|
|
111
|
+
}): ReturnType<typeof waitForSelectorAction>;
|
|
112
|
+
screenshot(ref: BrowserSDKSessionRef, options?: ScreenshotOptions): Promise<ScreenshotResult>;
|
|
113
|
+
close(ref: BrowserSDKSessionRef): Promise<Session>;
|
|
114
|
+
run(options: BrowserSDKRunOptions): Promise<BrowserSDKRunResult>;
|
|
115
|
+
private resolveHandle;
|
|
116
|
+
private runStep;
|
|
117
|
+
}
|
|
118
|
+
export declare function createBrowserSDK(options?: BrowserSDKOptions): BrowserSDK;
|
|
119
|
+
//# sourceMappingURL=sdk.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../src/sdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,gBAAgB,EAChB,OAAO,EACP,cAAc,EACf,MAAM,kBAAkB,CAAC;AAM1B,OAAO,EACL,KAAK,IAAI,WAAW,EACpB,IAAI,IAAI,UAAU,EAElB,QAAQ,IAAI,cAAc,EAC1B,IAAI,IAAI,cAAc,EACtB,eAAe,IAAI,qBAAqB,EACzC,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAE9E,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,iBAAiB,CAAC;AAE9D,MAAM,WAAW,sBAAsB;IACrC,aAAa,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IACrF,YAAY,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACvD,cAAc,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7C,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IAChD,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,KAAK,CAAC,EAAE,OAAO,WAAW,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,cAAc,CAAC;IACjC,IAAI,CAAC,EAAE,OAAO,UAAU,CAAC;IACzB,QAAQ,CAAC,EAAE,OAAO,cAAc,CAAC;IACjC,eAAe,CAAC,EAAE,OAAO,qBAAqB,CAAC;IAC/C,cAAc,CAAC,EAAE,OAAO,qBAAqB,CAAC;CAC/C;AAED,MAAM,WAAW,iBAAiB;IAChC,YAAY,CAAC,EAAE,sBAAsB,CAAC;CACvC;AAED,MAAM,MAAM,cAAc,GACtB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,GACzE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,GACvF;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,GACvG;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAA;CAAE,GAC5G;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,OAAO,CAAC,EAAE,iBAAiB,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC;AAEzB,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAC7B,EAAE,EAAE,IAAI,CAAC;IACT,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,EAAE,oBAAoB,EAAE,CAAC;CAC/B;AAoBD,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAiC;IACtD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAwC;gBAErD,OAAO,GAAE,iBAAsB;IAIrC,IAAI,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAO9D,aAAa,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI7E,OAAO,CAAC,GAAG,EAAE,oBAAoB,GAAG,IAAI;IAKlC,QAAQ,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAItD,QAAQ,CAAC,GAAG,EAAE,oBAAoB,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;IAKhG,KAAK,CAAC,GAAG,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC;IAOnI,IAAI,CAAC,GAAG,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC;IAIhJ,IAAI,CAAC,GAAG,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC;IAQpK,QAAQ,CAAC,GAAG,EAAE,oBAAoB,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC;IAInF,eAAe,CAAC,GAAG,EAAE,oBAAoB,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAA;KAAE,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC;IAI3L,UAAU,CAAC,GAAG,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQ7F,KAAK,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC;IAMlD,GAAG,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAyBtE,OAAO,CAAC,aAAa;YAgBP,OAAO;CAyCtB;AAED,wBAAgB,gBAAgB,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,UAAU,CAExE"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sdk.test.d.ts","sourceRoot":"","sources":["../src/sdk.test.ts"],"names":[],"mappings":""}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hasna/browser",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.12",
|
|
4
4
|
"description": "General-purpose browser agent toolkit — Playwright, Chrome DevTools Protocol, Lightpanda with auto engine selection. CLI + MCP + REST + SDK.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|