@airtop/sdk 0.1.4 → 0.1.6

package/wrapper/AirtopWindows.d.ts

@@ -14,22 +14,70 @@ declare namespace seleniumWebdriver {
         createCDPConnection(domain: string): Promise<any>;
     }
 }
-import { AirtopClient as FernClient } from '../Client';
-import * as Airtop from '../api';
-import { Windows as WindowsNamespace } from '../api/resources/windows/client/Client';
-import * as core from '../core';
-export declare class AirtopWindows {
-    private airtopClient;
+import * as Airtop from "../api";
+import { Windows as WindowsClass, Windows as WindowsNamespace } from "../api/resources/windows/client/Client";
+import * as core from "../core";
+export declare class AirtopWindows extends WindowsClass {
+    readonly _options: WindowsNamespace.Options;
     private apiKeySupplier;
-    private _windows;
-    constructor(airtopClient: FernClient, apiKeySupplier: core.Supplier<core.BearerToken | undefined>);
-    create(sessionId: string, request: Airtop.CreateWindowInputV1Body, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.WindowIdResponse>;
-    loadUrl(sessionId: string, windowId: string, request: Airtop.WindowLoadUrlV1Body, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.EmptyResponse>;
-    close(sessionId: string, windowId: string, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.WindowIdResponse>;
-    getWindowInfo(sessionId: string, windowId: string, request?: Airtop.GetWindowInfoRequest, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.WindowResponse>;
-    promptContent(sessionId: string, windowId: string, request: Airtop.SessionContentPromptHandlerRequestBody, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.AiPromptResponse>;
+    constructor(_options: WindowsNamespace.Options, apiKeySupplier: core.Supplier<core.BearerToken | undefined>);
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
+     * @param {Airtop.SessionContentPromptHandlerRequestBody} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @deprecated Use pageQuery instead
+     * @example
+     *     await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         prompt: "What is the main idea of this page?"
+     *     })
+     */
+    promptContent(sessionId: string, windowId: string, request: Omit<Airtop.SessionPageQueryHandlerRequestBody, "configuration"> & {
+        configuration?: Omit<Airtop.SessionPageQueryHandlerRequestBody["configuration"], "outputSchema"> & {
+            outputSchema?: string | object;
+        };
+    }, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.AiPromptResponse>;
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
+     * @param {Airtop.SessionPageQueryHandlerRequestBody} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         prompt: "What is the main idea of this page?"
+     *     })
+     */
+    pageQuery(sessionId: string, windowId: string, request: Omit<Airtop.SessionPageQueryHandlerRequestBody, "configuration"> & {
+        configuration?: Omit<Airtop.SessionPageQueryHandlerRequestBody["configuration"], "outputSchema"> & {
+            outputSchema?: string | object;
+        };
+    }, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.AiPromptResponse>;
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to scrape.
+     * @param {Airtop.ScrapeContentRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
+     */
     scrapeContent(sessionId: string, windowId: string, request?: Airtop.ScrapeContentRequest, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.ScrapeResponse>;
-    summarizeContent(sessionId: string, windowId: string, request?: Airtop.SessionSummaryHandlerRequestBody, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.AiPromptResponse>;
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to summarize.
+     * @param {Airtop.SessionSummaryHandlerRequestBody} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
+     */
+    summarizeContent(sessionId: string, windowId: string, request?: Omit<Airtop.SessionSummaryHandlerRequestBody, "configuration"> & {
+        configuration?: Omit<Airtop.SessionSummaryHandlerRequestBody["configuration"], "outputSchema"> & {
+            outputSchema?: string | object;
+        };
+    }, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.AiPromptResponse>;
     getWindowInfoForPuppeteerPage(session: Airtop.ExternalSessionWithConnectionInfo, page: puppeteer.Page, request?: Airtop.GetWindowInfoRequest, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.WindowResponse>;
     getWindowInfoForPlaywrightPage(session: Airtop.ExternalSessionWithConnectionInfo, page: playwright.Page, request?: Airtop.GetWindowInfoRequest, requestOptions?: WindowsNamespace.RequestOptions): Promise<Airtop.WindowResponse>;
     private executeSeleniumCDPCommand;

package/wrapper/AirtopWindows.js

@@ -37,43 +37,85 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AirtopWindows = void 0;
 const node_fetch_1 = __importDefault(require("node-fetch"));
+const Client_1 = require("../api/resources/windows/client/Client");
 const core = __importStar(require("../core"));
-class AirtopWindows {
-    constructor(airtopClient, apiKeySupplier) {
-        this.airtopClient = airtopClient;
+class AirtopWindows extends Client_1.Windows {
+    constructor(_options, apiKeySupplier) {
+        super(_options);
+        this._options = _options;
         this.apiKeySupplier = apiKeySupplier;
-        this._windows = airtopClient.windows;
     }
-    create(sessionId, request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this._windows.create(sessionId, request, requestOptions);
-        });
-    }
-    loadUrl(sessionId, windowId, request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this._windows.loadUrl(sessionId, windowId, request, requestOptions);
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
+     * @param {Airtop.SessionContentPromptHandlerRequestBody} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @deprecated Use pageQuery instead
+     * @example
+     *     await client.windows.promptContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         prompt: "What is the main idea of this page?"
+     *     })
+     */
+    promptContent(sessionId, windowId, request, requestOptions) {
+        const _super = Object.create(null, {
+            promptContent: { get: () => super.promptContent }
         });
-    }
-    close(sessionId, windowId, requestOptions) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            return this._windows.close(sessionId, windowId, requestOptions);
+            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"
+                        ? JSON.stringify(request.configuration.outputSchema)
+                        : (_b = request.configuration) === null || _b === void 0 ? void 0 : _b.outputSchema }) }), Object.assign(Object.assign({ timeoutInSeconds: 600 }, requestOptions), { maxRetries: 0 }));
         });
     }
-    getWindowInfo(sessionId, windowId, request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this._windows.getWindowInfo(sessionId, windowId, request, requestOptions);
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to target with an Airtop AI prompt.
+     * @param {Airtop.SessionPageQueryHandlerRequestBody} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.pageQuery("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430", {
+     *         prompt: "What is the main idea of this page?"
+     *     })
+     */
+    pageQuery(sessionId, windowId, request, requestOptions) {
+        const _super = Object.create(null, {
+            pageQuery: { get: () => super.pageQuery }
         });
-    }
-    promptContent(sessionId, windowId, request, requestOptions) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            return this._windows.promptContent(sessionId, windowId, request, Object.assign(Object.assign({ timeoutInSeconds: 600 }, requestOptions), { maxRetries: 0 }));
+            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"
+                        ? JSON.stringify(request.configuration.outputSchema)
+                        : (_b = request.configuration) === null || _b === void 0 ? void 0 : _b.outputSchema }) }), Object.assign(Object.assign({ timeoutInSeconds: 600 }, requestOptions), { maxRetries: 0 }));
         });
     }
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to scrape.
+     * @param {Airtop.ScrapeContentRequest} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.scrapeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
+     */
     scrapeContent(sessionId, windowId, request, requestOptions) {
-        return this._windows.scrapeContent(sessionId, windowId, request, Object.assign({ timeoutInSeconds: 600 }, requestOptions));
+        return super.scrapeContent(sessionId, windowId, request, Object.assign({ timeoutInSeconds: 600 }, requestOptions));
     }
+    /**
+     * @param {string} sessionId - The session id for the window.
+     * @param {string} windowId - The Airtop window id of the browser window to summarize.
+     * @param {Airtop.SessionSummaryHandlerRequestBody} request
+     * @param {Windows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.windows.summarizeContent("6aac6f73-bd89-4a76-ab32-5a6c422e8b0b", "0334da2a-91b0-42c5-6156-76a5eba87430")
+     */
     summarizeContent(sessionId, windowId, request, requestOptions) {
-        return this._windows.summarizeContent(sessionId, windowId, request, Object.assign(Object.assign({ timeoutInSeconds: 600 }, requestOptions), { maxRetries: 0 }));
+        var _a, _b, _c;
+        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"
+                    ? JSON.stringify((_b = request === null || request === void 0 ? void 0 : request.configuration) === null || _b === void 0 ? void 0 : _b.outputSchema)
+                    : (_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 }));
     }
     getWindowInfoForPuppeteerPage(session, page, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -85,10 +127,10 @@ class AirtopWindows {
         return __awaiter(this, void 0, void 0, function* () {
             // Retrieve target information
             const cdpSession = yield page.context().newCDPSession(page);
-            const { targetInfo } = yield cdpSession.send('Target.getTargetInfo');
+            const { targetInfo } = yield cdpSession.send("Target.getTargetInfo");
             const targetId = targetInfo.targetId;
             if (!targetId) {
-                throw new Error('TargetId not found');
+                throw new Error("TargetId not found");
             }
             return yield this.getWindowInfo(session.id, targetId, request, requestOptions);
         });
@@ -98,17 +140,17 @@ class AirtopWindows {
             // Get the current WebDriver session ID
             const webDriverSessionId = (yield driver.getSession()).getId();
             if (!webDriverSessionId) {
-                throw new Error('No WebDriver session available');
+                throw new Error("No WebDriver session available");
             }
             const chromedriverSessionUrl = `${session.chromedriverUrl}/session/${webDriverSessionId}/chromium/send_command_and_get_result`;
             const response = yield (0, node_fetch_1.default)(chromedriverSessionUrl, {
-                method: 'POST',
+                method: "POST",
                 headers: {
-                    'Content-Type': 'application/json',
+                    "Content-Type": "application/json",
                     Authorization: `Bearer ${apiKey}`,
                 },
                 body: JSON.stringify({
-                    cmd: 'Target.getTargetInfo',
+                    cmd: "Target.getTargetInfo",
                     params: {},
                 }),
             });
@@ -119,10 +161,10 @@ class AirtopWindows {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const apiKey = yield core.Supplier.get(this.apiKeySupplier);
-            const result = yield this.executeSeleniumCDPCommand(driver, session, apiKey || '');
+            const result = yield this.executeSeleniumCDPCommand(driver, session, apiKey || "");
             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;
             if (!targetId) {
-                throw new Error('TargetId not found');
+                throw new Error("TargetId not found");
             }
             return yield this.getWindowInfo(session.id, targetId, request, requestOptions);
         });

package/api/types/PromptContentConfig.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Airtop from "../index";
-export interface PromptContentConfig {
-    /** Experimental configuration options. These may be subject to change and are not guaranteed to be stable across versions. */
-    experimental?: Airtop.PromptContentExperimentalConfig;
-}

package/dist/api/types/PromptContentConfig.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Airtop from "../index";
-export interface PromptContentConfig {
-    /** Experimental configuration options. These may be subject to change and are not guaranteed to be stable across versions. */
-    experimental?: Airtop.PromptContentExperimentalConfig;
-}

package/dist/serialization/types/PromptContentConfig.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index";
-import * as Airtop from "../../api/index";
-import * as core from "../../core";
-import { PromptContentExperimentalConfig } from "./PromptContentExperimentalConfig";
-export declare const PromptContentConfig: core.serialization.ObjectSchema<serializers.PromptContentConfig.Raw, Airtop.PromptContentConfig>;
-export declare namespace PromptContentConfig {
-    interface Raw {
-        experimental?: PromptContentExperimentalConfig.Raw | null;
-    }
-}

package/serialization/types/PromptContentConfig.d.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index";
-import * as Airtop from "../../api/index";
-import * as core from "../../core";
-import { PromptContentExperimentalConfig } from "./PromptContentExperimentalConfig";
-export declare const PromptContentConfig: core.serialization.ObjectSchema<serializers.PromptContentConfig.Raw, Airtop.PromptContentConfig>;
-export declare namespace PromptContentConfig {
-    interface Raw {
-        experimental?: PromptContentExperimentalConfig.Raw | null;
-    }
-}