@airtop/sdk 0.1.4 → 0.1.6
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/api/resources/profiles/client/Client.js +4 -4
- package/api/resources/sessions/client/Client.d.ts +2 -2
- package/api/resources/sessions/client/Client.js +12 -12
- package/api/resources/windows/client/Client.d.ts +52 -2
- package/api/resources/windows/client/Client.js +272 -16
- package/api/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts +25 -0
- package/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +23 -0
- package/api/resources/windows/client/requests/SessionSummaryHandlerRequestBody.d.ts +3 -0
- package/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +29 -0
- package/api/resources/windows/client/requests/index.d.ts +3 -1
- package/api/types/ClickConfig.d.ts +4 -0
- package/api/types/CustomProxy.d.ts +1 -1
- package/api/types/PageQueryConfig.d.ts +7 -0
- package/api/types/{PromptContentExperimentalConfig.d.ts → PageQueryExperimentalConfig.d.ts} +1 -1
- package/api/types/SessionConfigV1Proxy.d.ts +4 -1
- package/api/{resources/windows/client/requests/SessionContentPromptHandlerRequestBody.d.ts → types/SessionPageQueryHandlerRequestBody.d.ts} +6 -9
- package/api/types/SessionPageQueryHandlerRequestBody.js +5 -0
- package/api/types/SummaryConfig.d.ts +2 -2
- package/api/types/index.d.ts +4 -2
- package/api/types/index.js +4 -2
- package/dist/api/resources/profiles/client/Client.js +4 -4
- package/dist/api/resources/sessions/client/Client.d.ts +2 -2
- package/dist/api/resources/sessions/client/Client.js +12 -12
- package/dist/api/resources/windows/client/Client.d.ts +52 -2
- package/dist/api/resources/windows/client/Client.js +272 -16
- package/dist/api/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts +25 -0
- package/dist/api/resources/windows/client/requests/SessionClickHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +23 -0
- package/dist/api/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/SessionSummaryHandlerRequestBody.d.ts +3 -0
- package/dist/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +29 -0
- package/dist/api/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +5 -0
- package/dist/api/resources/windows/client/requests/index.d.ts +3 -1
- package/dist/api/types/ClickConfig.d.ts +4 -0
- package/dist/api/types/ClickConfig.js +5 -0
- package/dist/api/types/CustomProxy.d.ts +1 -1
- package/dist/api/types/PageQueryConfig.d.ts +7 -0
- package/dist/api/types/PageQueryConfig.js +5 -0
- package/dist/api/types/{PromptContentExperimentalConfig.d.ts → PageQueryExperimentalConfig.d.ts} +1 -1
- package/dist/api/types/PageQueryExperimentalConfig.js +5 -0
- package/dist/api/types/SessionConfigV1Proxy.d.ts +4 -1
- package/dist/api/{resources/windows/client/requests/SessionContentPromptHandlerRequestBody.d.ts → types/SessionPageQueryHandlerRequestBody.d.ts} +6 -9
- package/dist/api/types/SessionPageQueryHandlerRequestBody.js +5 -0
- package/dist/api/types/SummaryConfig.d.ts +2 -2
- package/dist/api/types/index.d.ts +4 -2
- package/dist/api/types/index.js +4 -2
- package/{serialization/resources/windows/client/requests/SessionContentPromptHandlerRequestBody.d.ts → dist/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts} +5 -4
- package/dist/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.js +38 -0
- package/dist/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +17 -0
- package/dist/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +38 -0
- package/dist/serialization/resources/windows/client/requests/SessionSummaryHandlerRequestBody.d.ts +2 -0
- package/dist/serialization/resources/windows/client/requests/SessionSummaryHandlerRequestBody.js +2 -0
- package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +19 -0
- package/dist/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +40 -0
- package/dist/serialization/resources/windows/client/requests/index.d.ts +3 -1
- package/dist/serialization/resources/windows/client/requests/index.js +7 -3
- package/dist/serialization/types/ClickConfig.d.ts +10 -0
- package/dist/serialization/types/ClickConfig.js +31 -0
- package/dist/serialization/types/PageQueryConfig.d.ts +12 -0
- package/dist/serialization/types/{PromptContentConfig.js → PageQueryConfig.js} +3 -4
- package/dist/serialization/types/{PromptContentExperimentalConfig.d.ts → PageQueryExperimentalConfig.d.ts} +2 -2
- package/dist/serialization/types/{PromptContentExperimentalConfig.js → PageQueryExperimentalConfig.js} +2 -2
- package/dist/serialization/types/SessionConfigV1Proxy.d.ts +1 -1
- package/dist/serialization/types/SessionConfigV1Proxy.js +5 -1
- package/dist/serialization/types/SessionPageQueryHandlerRequestBody.d.ts +18 -0
- package/{serialization/resources/windows/client/requests/SessionContentPromptHandlerRequestBody.js → dist/serialization/types/SessionPageQueryHandlerRequestBody.js} +5 -3
- package/dist/serialization/types/SummaryConfig.d.ts +1 -2
- package/dist/serialization/types/SummaryConfig.js +1 -2
- package/dist/serialization/types/index.d.ts +4 -2
- package/dist/serialization/types/index.js +4 -2
- package/dist/wrapper/AirtopClient.d.ts +6 -5
- package/dist/wrapper/AirtopClient.js +11 -10
- package/dist/wrapper/AirtopSessions.d.ts +11 -11
- package/dist/wrapper/AirtopSessions.js +16 -17
- package/dist/wrapper/AirtopWindows.d.ts +62 -14
- package/dist/wrapper/AirtopWindows.js +73 -31
- package/package.json +1 -1
- package/reference.md +295 -3
- package/{dist/serialization/resources/windows/client/requests/SessionContentPromptHandlerRequestBody.d.ts → serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.d.ts} +5 -4
- package/serialization/resources/windows/client/requests/SessionClickHandlerRequestBody.js +38 -0
- package/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.d.ts +17 -0
- package/serialization/resources/windows/client/requests/SessionHoverHandlerRequestBody.js +38 -0
- package/serialization/resources/windows/client/requests/SessionSummaryHandlerRequestBody.d.ts +2 -0
- package/serialization/resources/windows/client/requests/SessionSummaryHandlerRequestBody.js +2 -0
- package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.d.ts +19 -0
- package/serialization/resources/windows/client/requests/SessionTypeHandlerRequestBody.js +40 -0
- package/serialization/resources/windows/client/requests/index.d.ts +3 -1
- package/serialization/resources/windows/client/requests/index.js +7 -3
- package/serialization/types/ClickConfig.d.ts +10 -0
- package/serialization/types/ClickConfig.js +31 -0
- package/serialization/types/PageQueryConfig.d.ts +12 -0
- package/serialization/types/{PromptContentConfig.js → PageQueryConfig.js} +3 -4
- package/serialization/types/{PromptContentExperimentalConfig.d.ts → PageQueryExperimentalConfig.d.ts} +2 -2
- package/serialization/types/{PromptContentExperimentalConfig.js → PageQueryExperimentalConfig.js} +2 -2
- package/serialization/types/SessionConfigV1Proxy.d.ts +1 -1
- package/serialization/types/SessionConfigV1Proxy.js +5 -1
- package/serialization/types/SessionPageQueryHandlerRequestBody.d.ts +18 -0
- package/{dist/serialization/resources/windows/client/requests/SessionContentPromptHandlerRequestBody.js → serialization/types/SessionPageQueryHandlerRequestBody.js} +5 -3
- package/serialization/types/SummaryConfig.d.ts +1 -2
- package/serialization/types/SummaryConfig.js +1 -2
- package/serialization/types/index.d.ts +4 -2
- package/serialization/types/index.js +4 -2
- package/wrapper/AirtopClient.d.ts +6 -5
- package/wrapper/AirtopClient.js +11 -10
- package/wrapper/AirtopSessions.d.ts +11 -11
- package/wrapper/AirtopSessions.js +16 -17
- package/wrapper/AirtopWindows.d.ts +62 -14
- package/wrapper/AirtopWindows.js +73 -31
- package/api/types/PromptContentConfig.d.ts +0 -8
- package/dist/api/types/PromptContentConfig.d.ts +0 -8
- package/dist/serialization/types/PromptContentConfig.d.ts +0 -13
- package/serialization/types/PromptContentConfig.d.ts +0 -13
- /package/api/resources/windows/client/requests/{SessionContentPromptHandlerRequestBody.js → SessionClickHandlerRequestBody.js} +0 -0
- /package/api/{types/PromptContentConfig.js → resources/windows/client/requests/SessionHoverHandlerRequestBody.js} +0 -0
- /package/api/{types/PromptContentExperimentalConfig.js → resources/windows/client/requests/SessionTypeHandlerRequestBody.js} +0 -0
- /package/{dist/api/resources/windows/client/requests/SessionContentPromptHandlerRequestBody.js → api/types/ClickConfig.js} +0 -0
- /package/{dist/api/types/PromptContentConfig.js → api/types/PageQueryConfig.js} +0 -0
- /package/{dist/api/types/PromptContentExperimentalConfig.js → api/types/PageQueryExperimentalConfig.js} +0 -0
@@ -17,24 +17,32 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
|
|
17
17
|
};
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
19
19
|
exports.AirtopSessions = void 0;
|
20
|
-
|
21
|
-
|
22
|
-
|
20
|
+
const Client_1 = require("../api/resources/sessions/client/Client");
|
21
|
+
class AirtopSessions extends Client_1.Sessions {
|
22
|
+
constructor(_options, debug = false) {
|
23
|
+
super(_options);
|
24
|
+
this._options = _options;
|
23
25
|
this.debug = debug;
|
24
|
-
this._sessions = airtopClient.sessions;
|
25
26
|
}
|
26
27
|
log(message) {
|
27
28
|
if (this.debug) {
|
28
29
|
console.log(message);
|
29
30
|
}
|
30
31
|
}
|
31
|
-
|
32
|
-
|
33
|
-
|
32
|
+
/**
|
33
|
+
* @param {Airtop.SessionRestInputV1} request
|
34
|
+
* @param {Sessions.RequestOptions} requestOptions - Request-specific configuration.
|
35
|
+
*
|
36
|
+
* @example
|
37
|
+
* await client.sessions.create()
|
38
|
+
*/
|
34
39
|
create(request, requestOptions) {
|
40
|
+
const _super = Object.create(null, {
|
41
|
+
create: { get: () => super.create }
|
42
|
+
});
|
35
43
|
var _a;
|
36
44
|
return __awaiter(this, void 0, void 0, function* () {
|
37
|
-
const createSessionResponse = yield
|
45
|
+
const createSessionResponse = yield _super.create.call(this, request, requestOptions);
|
38
46
|
if (!createSessionResponse.data) {
|
39
47
|
throw new Error(`Error creating browser session`);
|
40
48
|
}
|
@@ -82,14 +90,5 @@ class AirtopSessions {
|
|
82
90
|
return null;
|
83
91
|
});
|
84
92
|
}
|
85
|
-
getInfo(id, requestOptions) {
|
86
|
-
return this._sessions.getinfo(id, requestOptions);
|
87
|
-
}
|
88
|
-
terminate(id, requestOptions) {
|
89
|
-
return this._sessions.terminate(id, requestOptions);
|
90
|
-
}
|
91
|
-
events(id, requestOptions) {
|
92
|
-
return this._sessions.events(id, requestOptions);
|
93
|
-
}
|
94
93
|
}
|
95
94
|
exports.AirtopSessions = AirtopSessions;
|
@@ -14,22 +14,70 @@ declare namespace seleniumWebdriver {
|
|
14
14
|
createCDPConnection(domain: string): Promise<any>;
|
15
15
|
}
|
16
16
|
}
|
17
|
-
import
|
18
|
-
import
|
19
|
-
import
|
20
|
-
|
21
|
-
|
22
|
-
private airtopClient;
|
17
|
+
import * as Airtop from "../api";
|
18
|
+
import { Windows as WindowsClass, Windows as WindowsNamespace } from "../api/resources/windows/client/Client";
|
19
|
+
import * as core from "../core";
|
20
|
+
export declare class AirtopWindows extends WindowsClass {
|
21
|
+
readonly _options: WindowsNamespace.Options;
|
23
22
|
private apiKeySupplier;
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
23
|
+
constructor(_options: WindowsNamespace.Options, apiKeySupplier: core.Supplier<core.BearerToken | undefined>);
|
24
|
+
/**
|
25
|
+
* @param {string} sessionId - The session id for the window.
|
26
|
+
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
27
|
+
* @param {Airtop.SessionContentPromptHandlerRequestBody} request
|
28
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
29
|
+
*
|
30
|
+
* @deprecated Use pageQuery instead
|
31
|
+
* @example
|
32
|
+
* await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
33
|
+
* prompt: "What is the main idea of this page?"
|
34
|
+
* })
|
35
|
+
*/
|
36
|
+
promptContent(sessionId: string, windowId: string, request: Omit<Airtop.SessionPageQueryHandlerRequestBody, "configuration"> & {
|
37
|
+
configuration?: Omit<Airtop.SessionPageQueryHandlerRequestBody["configuration"], "outputSchema"> & {
|
38
|
+
outputSchema?: string | object;
|
39
|
+
};
|
40
|
+
}, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.AiPromptResponse>;
|
41
|
+
/**
|
42
|
+
* @param {string} sessionId - The session id for the window.
|
43
|
+
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
44
|
+
* @param {Airtop.SessionPageQueryHandlerRequestBody} request
|
45
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
46
|
+
*
|
47
|
+
* @example
|
48
|
+
* await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
49
|
+
* prompt: "What is the main idea of this page?"
|
50
|
+
* })
|
51
|
+
*/
|
52
|
+
pageQuery(sessionId: string, windowId: string, request: Omit<Airtop.SessionPageQueryHandlerRequestBody, "configuration"> & {
|
53
|
+
configuration?: Omit<Airtop.SessionPageQueryHandlerRequestBody["configuration"], "outputSchema"> & {
|
54
|
+
outputSchema?: string | object;
|
55
|
+
};
|
56
|
+
}, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.AiPromptResponse>;
|
57
|
+
/**
|
58
|
+
* @param {string} sessionId - The session id for the window.
|
59
|
+
* @param {string} windowId - The Airtop window id of the browser window to scrape.
|
60
|
+
* @param {Airtop.ScrapeContentRequest} request
|
61
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
62
|
+
*
|
63
|
+
* @example
|
64
|
+
* await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
|
65
|
+
*/
|
31
66
|
scrapeContent(sessionId: string, windowId: string, request?: Airtop.ScrapeContentRequest, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.ScrapeResponse>;
|
32
|
-
|
67
|
+
/**
|
68
|
+
* @param {string} sessionId - The session id for the window.
|
69
|
+
* @param {string} windowId - The Airtop window id of the browser window to summarize.
|
70
|
+
* @param {Airtop.SessionSummaryHandlerRequestBody} request
|
71
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
72
|
+
*
|
73
|
+
* @example
|
74
|
+
* await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
|
75
|
+
*/
|
76
|
+
summarizeContent(sessionId: string, windowId: string, request?: Omit<Airtop.SessionSummaryHandlerRequestBody, "configuration"> & {
|
77
|
+
configuration?: Omit<Airtop.SessionSummaryHandlerRequestBody["configuration"], "outputSchema"> & {
|
78
|
+
outputSchema?: string | object;
|
79
|
+
};
|
80
|
+
}, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.AiPromptResponse>;
|
33
81
|
getWindowInfoForPuppeteerPage(session: Airtop.ExternalSessionWithConnectionInfo, page: puppeteer.Page, request?: Airtop.GetWindowInfoRequest, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.WindowResponse>;
|
34
82
|
getWindowInfoForPlaywrightPage(session: Airtop.ExternalSessionWithConnectionInfo, page: playwright.Page, request?: Airtop.GetWindowInfoRequest, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.WindowResponse>;
|
35
83
|
private executeSeleniumCDPCommand;
|
@@ -37,43 +37,85 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
37
37
|
Object.defineProperty(exports, "__esModule", { value: true });
|
38
38
|
exports.AirtopWindows = void 0;
|
39
39
|
const node_fetch_1 = __importDefault(require("node-fetch"));
|
40
|
+
const Client_1 = require("../api/resources/windows/client/Client");
|
40
41
|
const core = __importStar(require("../core"));
|
41
|
-
class AirtopWindows {
|
42
|
-
constructor(
|
43
|
-
|
42
|
+
class AirtopWindows extends Client_1.Windows {
|
43
|
+
constructor(_options, apiKeySupplier) {
|
44
|
+
super(_options);
|
45
|
+
this._options = _options;
|
44
46
|
this.apiKeySupplier = apiKeySupplier;
|
45
|
-
this._windows = airtopClient.windows;
|
46
47
|
}
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
48
|
+
/**
|
49
|
+
* @param {string} sessionId - The session id for the window.
|
50
|
+
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
51
|
+
* @param {Airtop.SessionContentPromptHandlerRequestBody} request
|
52
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
53
|
+
*
|
54
|
+
* @deprecated Use pageQuery instead
|
55
|
+
* @example
|
56
|
+
* await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
57
|
+
* prompt: "What is the main idea of this page?"
|
58
|
+
* })
|
59
|
+
*/
|
60
|
+
promptContent(sessionId, windowId, request, requestOptions) {
|
61
|
+
const _super = Object.create(null, {
|
62
|
+
promptContent: { get: () => super.promptContent }
|
55
63
|
});
|
56
|
-
|
57
|
-
close(sessionId, windowId, requestOptions) {
|
64
|
+
var _a, _b;
|
58
65
|
return __awaiter(this, void 0, void 0, function* () {
|
59
|
-
return
|
66
|
+
return _super.promptContent.call(this, sessionId, windowId, Object.assign(Object.assign({}, request), { configuration: Object.assign(Object.assign({}, request.configuration), { outputSchema: typeof ((_a = request.configuration) === null || _a === void 0 ? void 0 : _a.outputSchema) === "object"
|
67
|
+
? JSON.stringify(request.configuration.outputSchema)
|
68
|
+
: (_b = request.configuration) === null || _b === void 0 ? void 0 : _b.outputSchema }) }), Object.assign(Object.assign({ timeoutInSeconds: 600 }, requestOptions), { maxRetries: 0 }));
|
60
69
|
});
|
61
70
|
}
|
62
|
-
|
63
|
-
|
64
|
-
|
71
|
+
/**
|
72
|
+
* @param {string} sessionId - The session id for the window.
|
73
|
+
* @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
|
74
|
+
* @param {Airtop.SessionPageQueryHandlerRequestBody} request
|
75
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
76
|
+
*
|
77
|
+
* @example
|
78
|
+
* await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
79
|
+
* prompt: "What is the main idea of this page?"
|
80
|
+
* })
|
81
|
+
*/
|
82
|
+
pageQuery(sessionId, windowId, request, requestOptions) {
|
83
|
+
const _super = Object.create(null, {
|
84
|
+
pageQuery: { get: () => super.pageQuery }
|
65
85
|
});
|
66
|
-
|
67
|
-
promptContent(sessionId, windowId, request, requestOptions) {
|
86
|
+
var _a, _b;
|
68
87
|
return __awaiter(this, void 0, void 0, function* () {
|
69
|
-
return
|
88
|
+
return _super.pageQuery.call(this, sessionId, windowId, Object.assign(Object.assign({}, request), { configuration: Object.assign(Object.assign({}, request.configuration), { outputSchema: typeof ((_a = request.configuration) === null || _a === void 0 ? void 0 : _a.outputSchema) === "object"
|
89
|
+
? JSON.stringify(request.configuration.outputSchema)
|
90
|
+
: (_b = request.configuration) === null || _b === void 0 ? void 0 : _b.outputSchema }) }), Object.assign(Object.assign({ timeoutInSeconds: 600 }, requestOptions), { maxRetries: 0 }));
|
70
91
|
});
|
71
92
|
}
|
93
|
+
/**
|
94
|
+
* @param {string} sessionId - The session id for the window.
|
95
|
+
* @param {string} windowId - The Airtop window id of the browser window to scrape.
|
96
|
+
* @param {Airtop.ScrapeContentRequest} request
|
97
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
98
|
+
*
|
99
|
+
* @example
|
100
|
+
* await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
|
101
|
+
*/
|
72
102
|
scrapeContent(sessionId, windowId, request, requestOptions) {
|
73
|
-
return
|
103
|
+
return super.scrapeContent(sessionId, windowId, request, Object.assign({ timeoutInSeconds: 600 }, requestOptions));
|
74
104
|
}
|
105
|
+
/**
|
106
|
+
* @param {string} sessionId - The session id for the window.
|
107
|
+
* @param {string} windowId - The Airtop window id of the browser window to summarize.
|
108
|
+
* @param {Airtop.SessionSummaryHandlerRequestBody} request
|
109
|
+
* @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
|
110
|
+
*
|
111
|
+
* @example
|
112
|
+
* await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
|
113
|
+
*/
|
75
114
|
summarizeContent(sessionId, windowId, request, requestOptions) {
|
76
|
-
|
115
|
+
var _a, _b, _c;
|
116
|
+
return super.summarizeContent(sessionId, windowId, Object.assign(Object.assign({}, request), { configuration: Object.assign(Object.assign({}, request === null || request === void 0 ? void 0 : request.configuration), { outputSchema: typeof ((_a = request === null || request === void 0 ? void 0 : request.configuration) === null || _a === void 0 ? void 0 : _a.outputSchema) === "object"
|
117
|
+
? JSON.stringify((_b = request === null || request === void 0 ? void 0 : request.configuration) === null || _b === void 0 ? void 0 : _b.outputSchema)
|
118
|
+
: (_c = request === null || request === void 0 ? void 0 : request.configuration) === null || _c === void 0 ? void 0 : _c.outputSchema }) }), Object.assign(Object.assign({ timeoutInSeconds: 600 }, requestOptions), { maxRetries: 0 }));
|
77
119
|
}
|
78
120
|
getWindowInfoForPuppeteerPage(session, page, request, requestOptions) {
|
79
121
|
return __awaiter(this, void 0, void 0, function* () {
|
@@ -85,10 +127,10 @@ class AirtopWindows {
|
|
85
127
|
return __awaiter(this, void 0, void 0, function* () {
|
86
128
|
// Retrieve target information
|
87
129
|
const cdpSession = yield page.context().newCDPSession(page);
|
88
|
-
const { targetInfo } = yield cdpSession.send(
|
130
|
+
const { targetInfo } = yield cdpSession.send("Target.getTargetInfo");
|
89
131
|
const targetId = targetInfo.targetId;
|
90
132
|
if (!targetId) {
|
91
|
-
throw new Error(
|
133
|
+
throw new Error("TargetId not found");
|
92
134
|
}
|
93
135
|
return yield this.getWindowInfo(session.id, targetId, request, requestOptions);
|
94
136
|
});
|
@@ -98,17 +140,17 @@ class AirtopWindows {
|
|
98
140
|
// Get the current WebDriver session ID
|
99
141
|
const webDriverSessionId = (yield driver.getSession()).getId();
|
100
142
|
if (!webDriverSessionId) {
|
101
|
-
throw new Error(
|
143
|
+
throw new Error("No WebDriver session available");
|
102
144
|
}
|
103
145
|
const chromedriverSessionUrl = `${session.chromedriverUrl}/session/${webDriverSessionId}/chromium/send_command_and_get_result`;
|
104
146
|
const response = yield (0, node_fetch_1.default)(chromedriverSessionUrl, {
|
105
|
-
method:
|
147
|
+
method: "POST",
|
106
148
|
headers: {
|
107
|
-
|
149
|
+
"Content-Type": "application/json",
|
108
150
|
Authorization: `Bearer ${apiKey}`,
|
109
151
|
},
|
110
152
|
body: JSON.stringify({
|
111
|
-
cmd:
|
153
|
+
cmd: "Target.getTargetInfo",
|
112
154
|
params: {},
|
113
155
|
}),
|
114
156
|
});
|
@@ -119,10 +161,10 @@ class AirtopWindows {
|
|
119
161
|
var _a, _b;
|
120
162
|
return __awaiter(this, void 0, void 0, function* () {
|
121
163
|
const apiKey = yield core.Supplier.get(this.apiKeySupplier);
|
122
|
-
const result = yield this.executeSeleniumCDPCommand(driver, session, apiKey ||
|
164
|
+
const result = yield this.executeSeleniumCDPCommand(driver, session, apiKey || "");
|
123
165
|
const targetId = (_b = (_a = result === null || result === void 0 ? void 0 : result.value) === null || _a === void 0 ? void 0 : _a.targetInfo) === null || _b === void 0 ? void 0 : _b.targetId;
|
124
166
|
if (!targetId) {
|
125
|
-
throw new Error(
|
167
|
+
throw new Error("TargetId not found");
|
126
168
|
}
|
127
169
|
return yield this.getWindowInfo(session.id, targetId, request, requestOptions);
|
128
170
|
});
|
package/package.json
CHANGED
package/reference.md
CHANGED
@@ -244,7 +244,7 @@ await client.sessions.create();
|
|
244
244
|
</dl>
|
245
245
|
</details>
|
246
246
|
|
247
|
-
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">
|
247
|
+
<details><summary><code>client.sessions.<a href="/src/api/resources/sessions/client/Client.ts">getInfo</a>(id) -> Airtop.SessionResponse</code></summary>
|
248
248
|
<dl>
|
249
249
|
<dd>
|
250
250
|
|
@@ -272,7 +272,7 @@ Get a session by ID
|
|
272
272
|
<dd>
|
273
273
|
|
274
274
|
```typescript
|
275
|
-
await client.sessions.
|
275
|
+
await client.sessions.getInfo("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b");
|
276
276
|
```
|
277
277
|
|
278
278
|
</dd>
|
@@ -679,10 +679,221 @@ await client.windows.close("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "7334da2a-91b
|
|
679
679
|
</dl>
|
680
680
|
</details>
|
681
681
|
|
682
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">click</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
683
|
+
<dl>
|
684
|
+
<dd>
|
685
|
+
|
686
|
+
#### 🔌 Usage
|
687
|
+
|
688
|
+
<dl>
|
689
|
+
<dd>
|
690
|
+
|
691
|
+
<dl>
|
692
|
+
<dd>
|
693
|
+
|
694
|
+
```typescript
|
695
|
+
await client.windows.click("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
696
|
+
elementDescription: "The login button",
|
697
|
+
});
|
698
|
+
```
|
699
|
+
|
700
|
+
</dd>
|
701
|
+
</dl>
|
702
|
+
</dd>
|
703
|
+
</dl>
|
704
|
+
|
705
|
+
#### ⚙️ Parameters
|
706
|
+
|
707
|
+
<dl>
|
708
|
+
<dd>
|
709
|
+
|
710
|
+
<dl>
|
711
|
+
<dd>
|
712
|
+
|
713
|
+
**sessionId:** `string` — The session id for the window.
|
714
|
+
|
715
|
+
</dd>
|
716
|
+
</dl>
|
717
|
+
|
718
|
+
<dl>
|
719
|
+
<dd>
|
720
|
+
|
721
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
722
|
+
|
723
|
+
</dd>
|
724
|
+
</dl>
|
725
|
+
|
726
|
+
<dl>
|
727
|
+
<dd>
|
728
|
+
|
729
|
+
**request:** `Airtop.SessionClickHandlerRequestBody`
|
730
|
+
|
731
|
+
</dd>
|
732
|
+
</dl>
|
733
|
+
|
734
|
+
<dl>
|
735
|
+
<dd>
|
736
|
+
|
737
|
+
**requestOptions:** `Windows.RequestOptions`
|
738
|
+
|
739
|
+
</dd>
|
740
|
+
</dl>
|
741
|
+
</dd>
|
742
|
+
</dl>
|
743
|
+
|
744
|
+
</dd>
|
745
|
+
</dl>
|
746
|
+
</details>
|
747
|
+
|
748
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">hover</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
749
|
+
<dl>
|
750
|
+
<dd>
|
751
|
+
|
752
|
+
#### 🔌 Usage
|
753
|
+
|
754
|
+
<dl>
|
755
|
+
<dd>
|
756
|
+
|
757
|
+
<dl>
|
758
|
+
<dd>
|
759
|
+
|
760
|
+
```typescript
|
761
|
+
await client.windows.hover("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430");
|
762
|
+
```
|
763
|
+
|
764
|
+
</dd>
|
765
|
+
</dl>
|
766
|
+
</dd>
|
767
|
+
</dl>
|
768
|
+
|
769
|
+
#### ⚙️ Parameters
|
770
|
+
|
771
|
+
<dl>
|
772
|
+
<dd>
|
773
|
+
|
774
|
+
<dl>
|
775
|
+
<dd>
|
776
|
+
|
777
|
+
**sessionId:** `string` — The session id for the window.
|
778
|
+
|
779
|
+
</dd>
|
780
|
+
</dl>
|
781
|
+
|
782
|
+
<dl>
|
783
|
+
<dd>
|
784
|
+
|
785
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
786
|
+
|
787
|
+
</dd>
|
788
|
+
</dl>
|
789
|
+
|
790
|
+
<dl>
|
791
|
+
<dd>
|
792
|
+
|
793
|
+
**request:** `Airtop.SessionHoverHandlerRequestBody`
|
794
|
+
|
795
|
+
</dd>
|
796
|
+
</dl>
|
797
|
+
|
798
|
+
<dl>
|
799
|
+
<dd>
|
800
|
+
|
801
|
+
**requestOptions:** `Windows.RequestOptions`
|
802
|
+
|
803
|
+
</dd>
|
804
|
+
</dl>
|
805
|
+
</dd>
|
806
|
+
</dl>
|
807
|
+
|
808
|
+
</dd>
|
809
|
+
</dl>
|
810
|
+
</details>
|
811
|
+
|
812
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">pageQuery</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
813
|
+
<dl>
|
814
|
+
<dd>
|
815
|
+
|
816
|
+
#### 🔌 Usage
|
817
|
+
|
818
|
+
<dl>
|
819
|
+
<dd>
|
820
|
+
|
821
|
+
<dl>
|
822
|
+
<dd>
|
823
|
+
|
824
|
+
```typescript
|
825
|
+
await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
826
|
+
prompt: "What is the main idea of this page?",
|
827
|
+
});
|
828
|
+
```
|
829
|
+
|
830
|
+
</dd>
|
831
|
+
</dl>
|
832
|
+
</dd>
|
833
|
+
</dl>
|
834
|
+
|
835
|
+
#### ⚙️ Parameters
|
836
|
+
|
837
|
+
<dl>
|
838
|
+
<dd>
|
839
|
+
|
840
|
+
<dl>
|
841
|
+
<dd>
|
842
|
+
|
843
|
+
**sessionId:** `string` — The session id for the window.
|
844
|
+
|
845
|
+
</dd>
|
846
|
+
</dl>
|
847
|
+
|
848
|
+
<dl>
|
849
|
+
<dd>
|
850
|
+
|
851
|
+
**windowId:** `string` — The Airtop window id of the browser window to target with an Airtop AI prompt.
|
852
|
+
|
853
|
+
</dd>
|
854
|
+
</dl>
|
855
|
+
|
856
|
+
<dl>
|
857
|
+
<dd>
|
858
|
+
|
859
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
860
|
+
|
861
|
+
</dd>
|
862
|
+
</dl>
|
863
|
+
|
864
|
+
<dl>
|
865
|
+
<dd>
|
866
|
+
|
867
|
+
**requestOptions:** `Windows.RequestOptions`
|
868
|
+
|
869
|
+
</dd>
|
870
|
+
</dl>
|
871
|
+
</dd>
|
872
|
+
</dl>
|
873
|
+
|
874
|
+
</dd>
|
875
|
+
</dl>
|
876
|
+
</details>
|
877
|
+
|
682
878
|
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">promptContent</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
683
879
|
<dl>
|
684
880
|
<dd>
|
685
881
|
|
882
|
+
#### 📝 Description
|
883
|
+
|
884
|
+
<dl>
|
885
|
+
<dd>
|
886
|
+
|
887
|
+
<dl>
|
888
|
+
<dd>
|
889
|
+
|
890
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint instead.
|
891
|
+
|
892
|
+
</dd>
|
893
|
+
</dl>
|
894
|
+
</dd>
|
895
|
+
</dl>
|
896
|
+
|
686
897
|
#### 🔌 Usage
|
687
898
|
|
688
899
|
<dl>
|
@@ -726,7 +937,7 @@ await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
726
937
|
<dl>
|
727
938
|
<dd>
|
728
939
|
|
729
|
-
**request:** `Airtop.
|
940
|
+
**request:** `Airtop.SessionPageQueryHandlerRequestBody`
|
730
941
|
|
731
942
|
</dd>
|
732
943
|
</dl>
|
@@ -813,6 +1024,21 @@ await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334
|
|
813
1024
|
<dl>
|
814
1025
|
<dd>
|
815
1026
|
|
1027
|
+
#### 📝 Description
|
1028
|
+
|
1029
|
+
<dl>
|
1030
|
+
<dd>
|
1031
|
+
|
1032
|
+
<dl>
|
1033
|
+
<dd>
|
1034
|
+
|
1035
|
+
This endpoint is deprecated. Please use the `pageQuery` endpoint and ask for a summary in the prompt instead.
|
1036
|
+
|
1037
|
+
</dd>
|
1038
|
+
</dl>
|
1039
|
+
</dd>
|
1040
|
+
</dl>
|
1041
|
+
|
816
1042
|
#### 🔌 Usage
|
817
1043
|
|
818
1044
|
<dl>
|
@@ -872,3 +1098,69 @@ await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0
|
|
872
1098
|
</dd>
|
873
1099
|
</dl>
|
874
1100
|
</details>
|
1101
|
+
|
1102
|
+
<details><summary><code>client.windows.<a href="/src/api/resources/windows/client/Client.ts">type</a>(sessionId, windowId, { ...params }) -> Airtop.AiPromptResponse</code></summary>
|
1103
|
+
<dl>
|
1104
|
+
<dd>
|
1105
|
+
|
1106
|
+
#### 🔌 Usage
|
1107
|
+
|
1108
|
+
<dl>
|
1109
|
+
<dd>
|
1110
|
+
|
1111
|
+
<dl>
|
1112
|
+
<dd>
|
1113
|
+
|
1114
|
+
```typescript
|
1115
|
+
await client.windows.type("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
|
1116
|
+
text: "Example text",
|
1117
|
+
});
|
1118
|
+
```
|
1119
|
+
|
1120
|
+
</dd>
|
1121
|
+
</dl>
|
1122
|
+
</dd>
|
1123
|
+
</dl>
|
1124
|
+
|
1125
|
+
#### ⚙️ Parameters
|
1126
|
+
|
1127
|
+
<dl>
|
1128
|
+
<dd>
|
1129
|
+
|
1130
|
+
<dl>
|
1131
|
+
<dd>
|
1132
|
+
|
1133
|
+
**sessionId:** `string` — The session id for the window.
|
1134
|
+
|
1135
|
+
</dd>
|
1136
|
+
</dl>
|
1137
|
+
|
1138
|
+
<dl>
|
1139
|
+
<dd>
|
1140
|
+
|
1141
|
+
**windowId:** `string` — The Airtop window id of the browser window.
|
1142
|
+
|
1143
|
+
</dd>
|
1144
|
+
</dl>
|
1145
|
+
|
1146
|
+
<dl>
|
1147
|
+
<dd>
|
1148
|
+
|
1149
|
+
**request:** `Airtop.SessionTypeHandlerRequestBody`
|
1150
|
+
|
1151
|
+
</dd>
|
1152
|
+
</dl>
|
1153
|
+
|
1154
|
+
<dl>
|
1155
|
+
<dd>
|
1156
|
+
|
1157
|
+
**requestOptions:** `Windows.RequestOptions`
|
1158
|
+
|
1159
|
+
</dd>
|
1160
|
+
</dl>
|
1161
|
+
</dd>
|
1162
|
+
</dl>
|
1163
|
+
|
1164
|
+
</dd>
|
1165
|
+
</dl>
|
1166
|
+
</details>
|
@@ -4,13 +4,14 @@
|
|
4
4
|
import * as serializers from "../../../../index";
|
5
5
|
import * as Airtop from "../../../../../api/index";
|
6
6
|
import * as core from "../../../../../core";
|
7
|
-
|
8
|
-
export declare
|
7
|
+
import { ClickConfig } from "../../../../types/ClickConfig";
|
8
|
+
export declare const SessionClickHandlerRequestBody: core.serialization.Schema<serializers.SessionClickHandlerRequestBody.Raw, Airtop.SessionClickHandlerRequestBody>;
|
9
|
+
export declare namespace SessionClickHandlerRequestBody {
|
9
10
|
interface Raw {
|
10
11
|
clientRequestId?: string | null;
|
12
|
+
configuration?: ClickConfig.Raw | null;
|
11
13
|
costThresholdCredits?: number | null;
|
12
|
-
|
13
|
-
prompt: string;
|
14
|
+
elementDescription: string;
|
14
15
|
timeThresholdSeconds?: number | null;
|
15
16
|
}
|
16
17
|
}
|