@airtop/sdk 1.0.0-alpha2.19 → 1.0.0-alpha2.20

package/dist/index.d.cts

@@ -1085,173 +1085,31 @@ declare class AirtopClient extends AirtopBase {
 }
 
 /**
- * Enumeration of available plugin augmentation types.
- * Determines which part of the SDK a plugin can extend.
- * @group Plugin Development
- */
-declare enum AirtopPluginAugmentationType {
-    /** Plugin for extending the AirtopClient class */
-    AirtopClient = "AirtopClient",
-    /** Plugin for extending AirtopWindowClient class functionality */
-    AirtopWindowClient = "AirtopWindowClient",
-    /** Plugin for extending AirtopWindow class functionality */
-    AirtopWindow = "AirtopWindow",
-    /** Plugin for extending AirtopSession class functionality */
-    AirtopSessionClient = "AirtopSessionClient",
-    /** Plugin for extending AirtopSession class functionality */
-    AirtopSession = "AirtopSession",
-    /** Plugin for extending AirtopWindowScreenshot class functionality */
-    AirtopWindowScreenshot = "AirtopWindowScreenshot"
-}
-/**
- * Interface for plugins that extend the main AirtopClient class.
- * Plugins allow you to add custom functionality to the AirtopClient prototype.
- *
- * @group Plugin Development
- */
-interface AirtopClientPlugin {
-    /**
-     * Specifies that this plugin augments the main AirtopClient class.
-     * This type discrimination allows TypeScript to properly type-check plugin usage.
-     */
-    augmentationType: AirtopPluginAugmentationType.AirtopClient;
-    /**
-     * Function that performs the augmentation of the AirtopClient prototype.
-     *
-     * @param prototype - The AirtopClient class prototype being augmented
-     */
-    augment: (prototype: typeof AirtopClient.prototype) => void;
-}
-/**
- * Interface for plugins that extend the AirtopWindowClient class functionality.
- * These plugins can modify or enhance the behavior of all window instances
- * by modifying the prototype.
- *
- * @group Plugin Development
- */
-interface AirtopWindowClientPlugin {
-    /**
-     * Specifies that this plugin augments AirtopWindowClient class functionality.
-     * This type discrimination ensures proper type checking when using window plugins.
-     */
-    augmentationType: AirtopPluginAugmentationType.AirtopWindowClient;
-    /**
-     * Function that performs the augmentation of the AirtopWindowClient prototype.
-     *
-     * @param prototype - The AirtopWindowClient class prototype being augmented
-     */
-    augment: (prototype: typeof AirtopWindowClient.prototype) => void;
-}
-/**
- * Interface for plugins that extend the AirtopSessionClient class functionality.
- * These plugins can modify or enhance the behavior of all session instances
- * by modifying the prototype.
- *
- * @group Plugin Development
- */
-interface AirtopSessionClientPlugin {
-    /**
-     * Specifies that this plugin augments AirtopSessionClient class functionality.
-     * This type discrimination ensures proper type checking when using session plugins.
-     */
-    augmentationType: AirtopPluginAugmentationType.AirtopSessionClient;
-    /**
-     * Function that performs the augmentation of the AirtopSessionClient prototype.
-     *
-     * @param prototype - The AirtopSessionClient class prototype being augmented
-     */
-    augment: (prototype: typeof AirtopSessionClient.prototype) => void;
-}
-/**
- * Interface for plugins that extend the AirtopWindow class functionality.
- * These plugins can modify or enhance the behavior of window instances
- * by modifying the prototype.
- *
- * @group Plugin Development
- */
-interface AirtopWindowPlugin {
-    /**
-     * Specifies that this plugin augments AirtopWindow class functionality.
-     * This type discrimination ensures proper type checking when using window plugins.
-     */
-    augmentationType: AirtopPluginAugmentationType.AirtopWindow;
-    /**
-     * Function that performs the augmentation of the AirtopWindow prototype.
-     *
-     * @param prototype - The AirtopWindow class prototype being augmented
-     */
-    augment: (prototype: typeof AirtopWindow.prototype) => void;
-}
-/**
- * Interface for plugins that extend the AirtopSession class functionality.
- * These plugins can modify or enhance the behavior of session instances
- * by modifying the prototype.
- *
- * @group Plugin Development
+ * Provides utility methods for creating mock instances of Airtop classes.
+ * @hideconstructor
  */
-interface AirtopSessionPlugin {
-    /**
-     * Specifies that this plugin augments AirtopSession class functionality.
-     * This type discrimination ensures proper type checking when using session plugins.
-     */
-    augmentationType: AirtopPluginAugmentationType.AirtopSession;
+declare class AirtopMocks {
     /**
-     * Function that performs the augmentation of the AirtopSession prototype.
-     *
-     * @param prototype - The AirtopSession class prototype being augmented
+     * Creates an AirtopBase instance (the class used as the base for other Airtop classes) with a mock client and logger.
      */
-    augment: (prototype: typeof AirtopSession.prototype) => void;
-}
-/**
- * Interface for plugins that extend the AirtopWindowScreenshot class functionality.
- * These plugins can modify or enhance the behavior of screenshot instances
- * by modifying the prototype.
- *
- * @group Plugin Development
- */
-interface AirtopWindowScreenshotPlugin {
+    static getAirtopBaseMock(config?: Partial<CommonAirtopConfig>): AirtopBase;
     /**
-     * Specifies that this plugin augments AirtopWindowScreenshot class functionality.
-     * This type discrimination ensures proper type checking when using screenshot plugins.
+     * Creates an Airtop instance with a mock client and data.
      */
-    augmentationType: AirtopPluginAugmentationType.AirtopWindowScreenshot;
+    static getAirtopClientMock(config?: Partial<AirtopConstructorConfig>): AirtopClient;
     /**
-     * Function that performs the augmentation of the AirtopWindowScreenshot prototype.
-     *
-     * @param prototype - The AirtopWindowScreenshot class prototype being augmented
+     * Creates an AirtopSession instance with a mock client and data.
      */
-    augment: (prototype: typeof AirtopWindowScreenshot.prototype) => void;
-}
-/**
- * Union type of all possible plugin types.
- * Used when handling plugins generically.
- *
- * @group Plugin Development
- *
- * @see {@link AirtopClientPlugin | AirtopClientPlugin}
- * @see {@link AirtopWindowClientPlugin | AirtopWindowClientPlugin}
- * @see {@link AirtopSessionClientPlugin | AirtopSessionClientPlugin}
- * @see {@link AirtopWindowPlugin | AirtopWindowPlugin}
- * @see {@link AirtopSessionPlugin | AirtopSessionPlugin}
- * @see {@link AirtopWindowScreenshotPlugin | AirtopWindowScreenshotPlugin}
- */
-type AirtopPluginType = AirtopClientPlugin | AirtopWindowClientPlugin | AirtopSessionClientPlugin | AirtopWindowPlugin | AirtopSessionPlugin | AirtopWindowScreenshotPlugin;
-/**
- * Interface for registering plugins with the SDK.
- */
-interface AirtopPluginRegistration {
+    static getAirtopSessionMock(responseData?: Partial<AirtopSessionResponse>): AirtopSession;
     /**
-     * Array of plugins to add to the SDK.
+     * Creates an AirtopWindow instance with a mock client and data.
      */
-    pluginsToAdd: AirtopPluginType[];
+    static getAirtopWindowMock({ sessionId, windowData, }?: {
+        sessionId?: string;
+        windowData?: AirtopWindowGetInfoResponse;
+    }): AirtopWindow<AirtopWindowGetInfoResponse>;
 }
 
-/**
- * Registers a plugin with the SDK.
- * @param plugin - The plugin to register
- */
-declare function registerAirtopPlugin(plugin: AirtopPluginRegistration): void;
-
 interface AirtopAgentCreateAgentParams extends Airtop.AgentCreateAgentParams {
 }
 interface AirtopAgentGetAgentsParams extends Airtop.AgentGetAgentsParams {
@@ -1399,29 +1257,171 @@ declare class AirtopAgentClient extends AirtopBase {
 }
 
 /**
- * Provides utility methods for creating mock instances of Airtop classes.
- * @hideconstructor
+ * Enumeration of available plugin augmentation types.
+ * Determines which part of the SDK a plugin can extend.
+ * @group Plugin Development
  */
-declare class AirtopMocks {
+declare enum AirtopPluginAugmentationType {
+    /** Plugin for extending the AirtopClient class */
+    AirtopClient = "AirtopClient",
+    /** Plugin for extending AirtopWindowClient class functionality */
+    AirtopWindowClient = "AirtopWindowClient",
+    /** Plugin for extending AirtopWindow class functionality */
+    AirtopWindow = "AirtopWindow",
+    /** Plugin for extending AirtopSession class functionality */
+    AirtopSessionClient = "AirtopSessionClient",
+    /** Plugin for extending AirtopSession class functionality */
+    AirtopSession = "AirtopSession",
+    /** Plugin for extending AirtopWindowScreenshot class functionality */
+    AirtopWindowScreenshot = "AirtopWindowScreenshot"
+}
+/**
+ * Interface for plugins that extend the main AirtopClient class.
+ * Plugins allow you to add custom functionality to the AirtopClient prototype.
+ *
+ * @group Plugin Development
+ */
+interface AirtopClientPlugin {
     /**
-     * Creates an AirtopBase instance (the class used as the base for other Airtop classes) with a mock client and logger.
+     * Specifies that this plugin augments the main AirtopClient class.
+     * This type discrimination allows TypeScript to properly type-check plugin usage.
      */
-    static getAirtopBaseMock(config?: Partial<CommonAirtopConfig>): AirtopBase;
+    augmentationType: AirtopPluginAugmentationType.AirtopClient;
     /**
-     * Creates an Airtop instance with a mock client and data.
+     * Function that performs the augmentation of the AirtopClient prototype.
+     *
+     * @param prototype - The AirtopClient class prototype being augmented
      */
-    static getAirtopClientMock(config?: Partial<AirtopConstructorConfig>): AirtopClient;
+    augment: (prototype: typeof AirtopClient.prototype) => void;
+}
+/**
+ * Interface for plugins that extend the AirtopWindowClient class functionality.
+ * These plugins can modify or enhance the behavior of all window instances
+ * by modifying the prototype.
+ *
+ * @group Plugin Development
+ */
+interface AirtopWindowClientPlugin {
     /**
-     * Creates an AirtopSession instance with a mock client and data.
+     * Specifies that this plugin augments AirtopWindowClient class functionality.
+     * This type discrimination ensures proper type checking when using window plugins.
      */
-    static getAirtopSessionMock(responseData?: Partial<AirtopSessionResponse>): AirtopSession;
+    augmentationType: AirtopPluginAugmentationType.AirtopWindowClient;
     /**
-     * Creates an AirtopWindow instance with a mock client and data.
+     * Function that performs the augmentation of the AirtopWindowClient prototype.
+     *
+     * @param prototype - The AirtopWindowClient class prototype being augmented
      */
-    static getAirtopWindowMock({ sessionId, windowData, }?: {
-        sessionId?: string;
-        windowData?: AirtopWindowGetInfoResponse;
-    }): AirtopWindow<AirtopWindowGetInfoResponse>;
+    augment: (prototype: typeof AirtopWindowClient.prototype) => void;
+}
+/**
+ * Interface for plugins that extend the AirtopSessionClient class functionality.
+ * These plugins can modify or enhance the behavior of all session instances
+ * by modifying the prototype.
+ *
+ * @group Plugin Development
+ */
+interface AirtopSessionClientPlugin {
+    /**
+     * Specifies that this plugin augments AirtopSessionClient class functionality.
+     * This type discrimination ensures proper type checking when using session plugins.
+     */
+    augmentationType: AirtopPluginAugmentationType.AirtopSessionClient;
+    /**
+     * Function that performs the augmentation of the AirtopSessionClient prototype.
+     *
+     * @param prototype - The AirtopSessionClient class prototype being augmented
+     */
+    augment: (prototype: typeof AirtopSessionClient.prototype) => void;
+}
+/**
+ * Interface for plugins that extend the AirtopWindow class functionality.
+ * These plugins can modify or enhance the behavior of window instances
+ * by modifying the prototype.
+ *
+ * @group Plugin Development
+ */
+interface AirtopWindowPlugin {
+    /**
+     * Specifies that this plugin augments AirtopWindow class functionality.
+     * This type discrimination ensures proper type checking when using window plugins.
+     */
+    augmentationType: AirtopPluginAugmentationType.AirtopWindow;
+    /**
+     * Function that performs the augmentation of the AirtopWindow prototype.
+     *
+     * @param prototype - The AirtopWindow class prototype being augmented
+     */
+    augment: (prototype: typeof AirtopWindow.prototype) => void;
 }
+/**
+ * Interface for plugins that extend the AirtopSession class functionality.
+ * These plugins can modify or enhance the behavior of session instances
+ * by modifying the prototype.
+ *
+ * @group Plugin Development
+ */
+interface AirtopSessionPlugin {
+    /**
+     * Specifies that this plugin augments AirtopSession class functionality.
+     * This type discrimination ensures proper type checking when using session plugins.
+     */
+    augmentationType: AirtopPluginAugmentationType.AirtopSession;
+    /**
+     * Function that performs the augmentation of the AirtopSession prototype.
+     *
+     * @param prototype - The AirtopSession class prototype being augmented
+     */
+    augment: (prototype: typeof AirtopSession.prototype) => void;
+}
+/**
+ * Interface for plugins that extend the AirtopWindowScreenshot class functionality.
+ * These plugins can modify or enhance the behavior of screenshot instances
+ * by modifying the prototype.
+ *
+ * @group Plugin Development
+ */
+interface AirtopWindowScreenshotPlugin {
+    /**
+     * Specifies that this plugin augments AirtopWindowScreenshot class functionality.
+     * This type discrimination ensures proper type checking when using screenshot plugins.
+     */
+    augmentationType: AirtopPluginAugmentationType.AirtopWindowScreenshot;
+    /**
+     * Function that performs the augmentation of the AirtopWindowScreenshot prototype.
+     *
+     * @param prototype - The AirtopWindowScreenshot class prototype being augmented
+     */
+    augment: (prototype: typeof AirtopWindowScreenshot.prototype) => void;
+}
+/**
+ * Union type of all possible plugin types.
+ * Used when handling plugins generically.
+ *
+ * @group Plugin Development
+ *
+ * @see {@link AirtopClientPlugin | AirtopClientPlugin}
+ * @see {@link AirtopWindowClientPlugin | AirtopWindowClientPlugin}
+ * @see {@link AirtopSessionClientPlugin | AirtopSessionClientPlugin}
+ * @see {@link AirtopWindowPlugin | AirtopWindowPlugin}
+ * @see {@link AirtopSessionPlugin | AirtopSessionPlugin}
+ * @see {@link AirtopWindowScreenshotPlugin | AirtopWindowScreenshotPlugin}
+ */
+type AirtopPluginType = AirtopClientPlugin | AirtopWindowClientPlugin | AirtopSessionClientPlugin | AirtopWindowPlugin | AirtopSessionPlugin | AirtopWindowScreenshotPlugin;
+/**
+ * Interface for registering plugins with the SDK.
+ */
+interface AirtopPluginRegistration {
+    /**
+     * Array of plugins to add to the SDK.
+     */
+    pluginsToAdd: AirtopPluginType[];
+}
+
+/**
+ * Registers a plugin with the SDK.
+ * @param plugin - The plugin to register
+ */
+declare function registerAirtopPlugin(plugin: AirtopPluginRegistration): void;
 
 export { type AirtopAgentCancelInvocationParams, AirtopAgentClient, type AirtopAgentCreateAgentParams, type AirtopAgentCreateInvocationParams, type AirtopAgentCreateVersionParams, type AirtopAgentDeleteAgentsParams, type AirtopAgentDuplicateAgentParams, type AirtopAgentGetAgentsParams, type AirtopAgentGetInvocationsParams, type AirtopAgentGetVersionsParams, type AirtopAgentResponse, type AirtopAgentUpdateAgentParams, type AirtopAutomationData, type AirtopAutomationListResponse, type AirtopAutomationUpdateDescriptionConfig, AirtopBase, AirtopClient, type AirtopClientPlugin, type AirtopConstructorConfig, type AirtopCreateAgentInvocationResponse, type AirtopCreateAgentResponse, type AirtopCreateAgentVersionResponse, type AirtopDeleteAgentsResponse, type AirtopDuplicateAgentResponse, AirtopError, type AirtopFileListParams, type AirtopFileResponse, type AirtopFilesResponse, type AirtopGetAgentInvocationsResponse, type AirtopGetAgentResponse, type AirtopGetAgentVersionsResponse, type AirtopGetAgentsResponse, AirtopMocks, AirtopNode, type AirtopNodeApiResponseData, AirtopPluginAugmentationType, type AirtopPluginRegistration, type AirtopPluginType, type AirtopProfile, type AirtopRequestOptions, AirtopSession, AirtopSessionClient, type AirtopSessionClientPlugin, type AirtopSessionPlugin, type AirtopSessionResponse, type AirtopUpdateAgentResponse, AirtopWindow, AirtopWindowClient, type AirtopWindowClientPlugin, type AirtopWindowCreateResponse, type AirtopWindowGetInfoResponse, type AirtopWindowPlugin, AirtopWindowScreenshot, type AirtopWindowScreenshotPlugin, type AirtopWindowScreenshotResponse, type CommonAirtopConfig, type CommonResponse, type CommonWindowResponse, type CreateFileConfig, type CreateSessionConfig, type GetFilesConfig, type GetSessionsConfig, type OutputJsonSchemaConfig, type ScreenshotData, type SessionData, type SessionError, type SessionMetadata, type SessionServiceResponse, type SessionWarning, type WindowActConfig, type WindowActResponse, type WindowClickConfig, type WindowCreateData, type WindowError, type WindowExtractConfig, type WindowExtractResponse, type WindowFillFormConfig, type WindowFindManyConfig, type WindowFindManyResponse, type WindowFindOneConfig, type WindowFindOneResponse, type WindowGetConfig, type WindowHoverConfig, type WindowInfoData, type WindowLlmConfig, type WindowLlmResponse, type WindowLoadUrlConfig, type WindowMetadata, type WindowMonitorConfig, type WindowNavigateConfig, WindowNavigateDirection, type WindowNavigateResponse, type WindowPageQueryConfig, type WindowPaginatedExtractionConfig, type WindowPromptResponse, type WindowScrapeConfig, type WindowScrapeResponse, type WindowScreenshotConfig, type WindowScrollConfig, type WindowTypeConfig, type WindowWaitForPageConfig, type WindowWaitForPageResponse, type WindowWarning, registerAirtopPlugin };