@skyvern/client 1.0.2 → 1.0.3
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/README.md +1 -1
- package/dist/cjs/Client.d.ts +15 -3
- package/dist/cjs/Client.js +66 -7
- package/dist/cjs/api/client/requests/CreateCredentialRequest.d.ts +1 -1
- package/dist/cjs/api/client/requests/DownloadFilesRequest.d.ts +37 -0
- package/dist/cjs/api/client/requests/LoginRequest.d.ts +6 -6
- package/dist/cjs/api/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.d.ts +0 -2
- package/dist/cjs/api/resources/index.js +1 -6
- package/dist/cjs/api/types/ActionBlock.d.ts +1 -0
- package/dist/cjs/api/types/ActionBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/ActionType.d.ts +1 -0
- package/dist/cjs/api/types/ActionType.js +1 -0
- package/dist/cjs/api/types/BranchCondition.d.ts +2 -1
- package/dist/cjs/api/types/BranchConditionCriteria.d.ts +10 -0
- package/dist/cjs/api/types/BranchConditionYaml.d.ts +7 -0
- package/dist/cjs/api/types/BranchCriteriaYaml.d.ts +12 -0
- package/dist/cjs/api/types/BranchCriteriaYaml.js +11 -0
- package/dist/cjs/api/types/CodeBlock.d.ts +1 -0
- package/dist/cjs/api/types/CodeBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/ConditionalBlock.d.ts +1 -0
- package/dist/cjs/api/types/ConditionalBlockYaml.d.ts +11 -0
- package/dist/cjs/api/types/CredentialResponse.d.ts +1 -1
- package/dist/cjs/api/types/CredentialTypeOutput.d.ts +1 -0
- package/dist/cjs/api/types/CredentialTypeOutput.js +1 -0
- package/dist/cjs/api/types/DownloadToS3Block.d.ts +1 -0
- package/dist/cjs/api/types/DownloadToS3BlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/ExtractionBlock.d.ts +1 -0
- package/dist/cjs/api/types/ExtractionBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/FileDownloadBlock.d.ts +1 -0
- package/dist/cjs/api/types/FileDownloadBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/FileParserBlock.d.ts +1 -0
- package/dist/cjs/api/types/FileParserBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/FileUploadBlock.d.ts +1 -0
- package/dist/cjs/api/types/FileUploadBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/ForLoopBlock.d.ts +1 -0
- package/dist/cjs/api/types/ForLoopBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/ForLoopBlockYamlLoopBlocksItem.d.ts +4 -1
- package/dist/cjs/api/types/HttpRequestBlock.d.ts +2 -0
- package/dist/cjs/api/types/HttpRequestBlockYaml.d.ts +2 -0
- package/dist/cjs/api/types/HumanInteractionBlock.d.ts +1 -0
- package/dist/cjs/api/types/HumanInteractionBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/JinjaBranchCriteria.d.ts +7 -0
- package/dist/cjs/api/types/LoginBlock.d.ts +1 -0
- package/dist/cjs/api/types/LoginBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/NavigationBlock.d.ts +1 -0
- package/dist/cjs/api/types/NavigationBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/PdfParserBlock.d.ts +1 -0
- package/dist/cjs/api/types/PdfParserBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/PromptAction.d.ts +11 -0
- package/dist/cjs/api/types/PromptBranchCriteria.d.ts +7 -0
- package/dist/cjs/api/types/RunSdkActionRequestAction.d.ts +7 -1
- package/dist/cjs/api/types/SecretCredential.d.ts +9 -0
- package/dist/cjs/api/types/SecretCredential.js +3 -0
- package/dist/cjs/api/types/SecretCredentialResponse.d.ts +7 -0
- package/dist/cjs/api/types/SecretCredentialResponse.js +3 -0
- package/dist/cjs/api/types/SendEmailBlock.d.ts +1 -0
- package/dist/cjs/api/types/SendEmailBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/SkyvernForgeSdkSchemasCredentialsCredentialType.d.ts +1 -0
- package/dist/cjs/api/types/SkyvernForgeSdkSchemasCredentialsCredentialType.js +1 -0
- package/dist/cjs/api/types/TaskBlock.d.ts +1 -0
- package/dist/cjs/api/types/TaskBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/TaskV2Block.d.ts +1 -0
- package/dist/cjs/api/types/TaskV2BlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/TextPromptBlock.d.ts +1 -0
- package/dist/cjs/api/types/TextPromptBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/UploadToS3Block.d.ts +1 -0
- package/dist/cjs/api/types/UploadToS3BlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/UrlBlock.d.ts +1 -0
- package/dist/cjs/api/types/UrlBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/ValidateAction.d.ts +9 -0
- package/dist/cjs/api/types/ValidateAction.js +3 -0
- package/dist/cjs/api/types/ValidationBlock.d.ts +1 -0
- package/dist/cjs/api/types/ValidationBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/WaitBlock.d.ts +1 -0
- package/dist/cjs/api/types/WaitBlockYaml.d.ts +1 -0
- package/dist/cjs/api/types/WorkflowDefinitionYamlBlocksItem.d.ts +4 -1
- package/dist/cjs/api/types/WorkflowRunBlock.d.ts +4 -0
- package/dist/cjs/api/types/index.d.ts +10 -2
- package/dist/cjs/api/types/index.js +10 -2
- package/dist/cjs/index.d.ts +3 -1
- package/dist/cjs/index.js +7 -2
- package/dist/cjs/library/Skyvern.d.ts +124 -0
- package/dist/cjs/library/Skyvern.js +315 -0
- package/dist/cjs/library/SkyvernBrowser.d.ts +76 -0
- package/dist/cjs/library/SkyvernBrowser.js +119 -0
- package/dist/cjs/library/SkyvernBrowserPage.d.ts +69 -0
- package/dist/cjs/library/SkyvernBrowserPage.js +162 -0
- package/dist/cjs/library/SkyvernBrowserPageAgent.d.ts +135 -0
- package/dist/cjs/library/SkyvernBrowserPageAgent.js +256 -0
- package/dist/cjs/library/SkyvernBrowserPageAi.d.ts +85 -0
- package/dist/cjs/library/SkyvernBrowserPageAi.js +248 -0
- package/dist/cjs/library/constants.d.ts +3 -0
- package/dist/cjs/library/constants.js +6 -0
- package/dist/cjs/library/index.d.ts +10 -0
- package/dist/cjs/library/index.js +20 -0
- package/dist/cjs/library/logger.d.ts +15 -0
- package/dist/cjs/library/logger.js +56 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +15 -3
- package/dist/esm/Client.mjs +66 -7
- package/dist/esm/api/client/requests/CreateCredentialRequest.d.mts +1 -1
- package/dist/esm/api/client/requests/DownloadFilesRequest.d.mts +37 -0
- package/dist/esm/api/client/requests/LoginRequest.d.mts +6 -6
- package/dist/esm/api/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/index.d.mts +0 -2
- package/dist/esm/api/resources/index.mjs +0 -2
- package/dist/esm/api/types/ActionBlock.d.mts +1 -0
- package/dist/esm/api/types/ActionBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/ActionType.d.mts +1 -0
- package/dist/esm/api/types/ActionType.mjs +1 -0
- package/dist/esm/api/types/BranchCondition.d.mts +2 -1
- package/dist/esm/api/types/BranchConditionCriteria.d.mts +10 -0
- package/dist/esm/api/types/BranchConditionYaml.d.mts +7 -0
- package/dist/esm/api/types/BranchCriteriaYaml.d.mts +12 -0
- package/dist/esm/api/types/BranchCriteriaYaml.mjs +8 -0
- package/dist/esm/api/types/CodeBlock.d.mts +1 -0
- package/dist/esm/api/types/CodeBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/ConditionalBlock.d.mts +1 -0
- package/dist/esm/api/types/ConditionalBlockYaml.d.mts +11 -0
- package/dist/esm/api/types/CredentialResponse.d.mts +1 -1
- package/dist/esm/api/types/CredentialTypeOutput.d.mts +1 -0
- package/dist/esm/api/types/CredentialTypeOutput.mjs +1 -0
- package/dist/esm/api/types/DownloadToS3Block.d.mts +1 -0
- package/dist/esm/api/types/DownloadToS3BlockYaml.d.mts +1 -0
- package/dist/esm/api/types/ExtractionBlock.d.mts +1 -0
- package/dist/esm/api/types/ExtractionBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/FileDownloadBlock.d.mts +1 -0
- package/dist/esm/api/types/FileDownloadBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/FileParserBlock.d.mts +1 -0
- package/dist/esm/api/types/FileParserBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/FileUploadBlock.d.mts +1 -0
- package/dist/esm/api/types/FileUploadBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/ForLoopBlock.d.mts +1 -0
- package/dist/esm/api/types/ForLoopBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/ForLoopBlockYamlLoopBlocksItem.d.mts +4 -1
- package/dist/esm/api/types/HttpRequestBlock.d.mts +2 -0
- package/dist/esm/api/types/HttpRequestBlockYaml.d.mts +2 -0
- package/dist/esm/api/types/HumanInteractionBlock.d.mts +1 -0
- package/dist/esm/api/types/HumanInteractionBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/JinjaBranchCriteria.d.mts +7 -0
- package/dist/esm/api/types/LoginBlock.d.mts +1 -0
- package/dist/esm/api/types/LoginBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/NavigationBlock.d.mts +1 -0
- package/dist/esm/api/types/NavigationBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/PdfParserBlock.d.mts +1 -0
- package/dist/esm/api/types/PdfParserBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/PromptAction.d.mts +11 -0
- package/dist/esm/api/types/PromptBranchCriteria.d.mts +7 -0
- package/dist/esm/api/types/RunSdkActionRequestAction.d.mts +7 -1
- package/dist/esm/api/types/SecretCredential.d.mts +9 -0
- package/dist/esm/api/types/SecretCredential.mjs +2 -0
- package/dist/esm/api/types/SecretCredentialResponse.d.mts +7 -0
- package/dist/esm/api/types/SecretCredentialResponse.mjs +2 -0
- package/dist/esm/api/types/SendEmailBlock.d.mts +1 -0
- package/dist/esm/api/types/SendEmailBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/SkyvernForgeSdkSchemasCredentialsCredentialType.d.mts +1 -0
- package/dist/esm/api/types/SkyvernForgeSdkSchemasCredentialsCredentialType.mjs +1 -0
- package/dist/esm/api/types/TaskBlock.d.mts +1 -0
- package/dist/esm/api/types/TaskBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/TaskV2Block.d.mts +1 -0
- package/dist/esm/api/types/TaskV2BlockYaml.d.mts +1 -0
- package/dist/esm/api/types/TextPromptBlock.d.mts +1 -0
- package/dist/esm/api/types/TextPromptBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/UploadToS3Block.d.mts +1 -0
- package/dist/esm/api/types/UploadToS3BlockYaml.d.mts +1 -0
- package/dist/esm/api/types/UrlBlock.d.mts +1 -0
- package/dist/esm/api/types/UrlBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/ValidateAction.d.mts +9 -0
- package/dist/esm/api/types/ValidateAction.mjs +2 -0
- package/dist/esm/api/types/ValidationBlock.d.mts +1 -0
- package/dist/esm/api/types/ValidationBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/WaitBlock.d.mts +1 -0
- package/dist/esm/api/types/WaitBlockYaml.d.mts +1 -0
- package/dist/esm/api/types/WorkflowDefinitionYamlBlocksItem.d.mts +4 -1
- package/dist/esm/api/types/WorkflowRunBlock.d.mts +4 -0
- package/dist/esm/api/types/index.d.mts +10 -2
- package/dist/esm/api/types/index.mjs +10 -2
- package/dist/esm/index.d.mts +3 -1
- package/dist/esm/index.mjs +2 -1
- package/dist/esm/library/Skyvern.d.mts +124 -0
- package/dist/esm/library/Skyvern.mjs +278 -0
- package/dist/esm/library/SkyvernBrowser.d.mts +76 -0
- package/dist/esm/library/SkyvernBrowser.mjs +115 -0
- package/dist/esm/library/SkyvernBrowserPage.d.mts +69 -0
- package/dist/esm/library/SkyvernBrowserPage.mjs +158 -0
- package/dist/esm/library/SkyvernBrowserPageAgent.d.mts +135 -0
- package/dist/esm/library/SkyvernBrowserPageAgent.mjs +252 -0
- package/dist/esm/library/SkyvernBrowserPageAi.d.mts +85 -0
- package/dist/esm/library/SkyvernBrowserPageAi.mjs +244 -0
- package/dist/esm/library/constants.d.mts +3 -0
- package/dist/esm/library/constants.mjs +3 -0
- package/dist/esm/library/index.d.mts +10 -0
- package/dist/esm/library/index.mjs +7 -0
- package/dist/esm/library/logger.d.mts +15 -0
- package/dist/esm/library/logger.mjs +52 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +4 -1
- package/reference.md +0 -411
- package/dist/cjs/api/resources/workflows/client/Client.d.ts +0 -108
- package/dist/cjs/api/resources/workflows/client/Client.js +0 -465
- package/dist/cjs/api/resources/workflows/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/workflows/client/index.js +0 -17
- package/dist/cjs/api/resources/workflows/client/requests/DeleteFolderV1FoldersFolderIdDeleteRequest.d.ts +0 -10
- package/dist/cjs/api/resources/workflows/client/requests/FolderCreate.d.ts +0 -12
- package/dist/cjs/api/resources/workflows/client/requests/FolderUpdate.d.ts +0 -10
- package/dist/cjs/api/resources/workflows/client/requests/GetFoldersV1FoldersGetRequest.d.ts +0 -16
- package/dist/cjs/api/resources/workflows/client/requests/UpdateWorkflowFolderRequest.d.ts +0 -8
- package/dist/cjs/api/resources/workflows/client/requests/index.d.ts +0 -5
- package/dist/cjs/api/resources/workflows/client/requests/index.js +0 -2
- package/dist/cjs/api/resources/workflows/index.d.ts +0 -1
- package/dist/cjs/api/resources/workflows/index.js +0 -17
- package/dist/cjs/api/types/BranchCriteria.d.ts +0 -8
- package/dist/cjs/api/types/Folder.d.ts +0 -15
- package/dist/esm/api/resources/workflows/client/Client.d.mts +0 -108
- package/dist/esm/api/resources/workflows/client/Client.mjs +0 -428
- package/dist/esm/api/resources/workflows/client/index.d.mts +0 -1
- package/dist/esm/api/resources/workflows/client/index.mjs +0 -1
- package/dist/esm/api/resources/workflows/client/requests/DeleteFolderV1FoldersFolderIdDeleteRequest.d.mts +0 -10
- package/dist/esm/api/resources/workflows/client/requests/FolderCreate.d.mts +0 -12
- package/dist/esm/api/resources/workflows/client/requests/FolderUpdate.d.mts +0 -10
- package/dist/esm/api/resources/workflows/client/requests/GetFoldersV1FoldersGetRequest.d.mts +0 -16
- package/dist/esm/api/resources/workflows/client/requests/UpdateWorkflowFolderRequest.d.mts +0 -8
- package/dist/esm/api/resources/workflows/client/requests/index.d.mts +0 -5
- package/dist/esm/api/resources/workflows/client/requests/index.mjs +0 -1
- package/dist/esm/api/resources/workflows/index.d.mts +0 -1
- package/dist/esm/api/resources/workflows/index.mjs +0 -1
- package/dist/esm/api/types/BranchCriteria.d.mts +0 -8
- package/dist/esm/api/types/Folder.d.mts +0 -15
- /package/dist/cjs/api/{resources/workflows/client/requests/DeleteFolderV1FoldersFolderIdDeleteRequest.js → client/requests/DownloadFilesRequest.js} +0 -0
- /package/dist/cjs/api/{resources/workflows/client/requests/FolderCreate.js → types/BranchConditionCriteria.js} +0 -0
- /package/dist/cjs/api/{resources/workflows/client/requests/FolderUpdate.js → types/BranchConditionYaml.js} +0 -0
- /package/dist/cjs/api/{resources/workflows/client/requests/GetFoldersV1FoldersGetRequest.js → types/ConditionalBlockYaml.js} +0 -0
- /package/dist/cjs/api/{resources/workflows/client/requests/UpdateWorkflowFolderRequest.js → types/JinjaBranchCriteria.js} +0 -0
- /package/dist/cjs/api/types/{BranchCriteria.js → PromptAction.js} +0 -0
- /package/dist/cjs/api/types/{Folder.js → PromptBranchCriteria.js} +0 -0
- /package/dist/esm/api/{resources/workflows/client/requests/DeleteFolderV1FoldersFolderIdDeleteRequest.mjs → client/requests/DownloadFilesRequest.mjs} +0 -0
- /package/dist/esm/api/{resources/workflows/client/requests/FolderCreate.mjs → types/BranchConditionCriteria.mjs} +0 -0
- /package/dist/esm/api/{resources/workflows/client/requests/FolderUpdate.mjs → types/BranchConditionYaml.mjs} +0 -0
- /package/dist/esm/api/{resources/workflows/client/requests/GetFoldersV1FoldersGetRequest.mjs → types/ConditionalBlockYaml.mjs} +0 -0
- /package/dist/esm/api/{resources/workflows/client/requests/UpdateWorkflowFolderRequest.mjs → types/JinjaBranchCriteria.mjs} +0 -0
- /package/dist/esm/api/types/{BranchCriteria.mjs → PromptAction.mjs} +0 -0
- /package/dist/esm/api/types/{Folder.mjs → PromptBranchCriteria.mjs} +0 -0
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Prompt action parameters.
|
|
3
|
+
*/
|
|
4
|
+
export interface PromptAction {
|
|
5
|
+
/** The prompt to send to the LLM */
|
|
6
|
+
prompt: string;
|
|
7
|
+
/** Optional JSON schema to structure the response */
|
|
8
|
+
schema?: Record<string, unknown>;
|
|
9
|
+
/** Optional model configuration */
|
|
10
|
+
model?: Record<string, unknown>;
|
|
11
|
+
}
|
|
@@ -2,7 +2,7 @@ import type * as Skyvern from "../index.js";
|
|
|
2
2
|
/**
|
|
3
3
|
* The action to execute with its specific parameters
|
|
4
4
|
*/
|
|
5
|
-
export type RunSdkActionRequestAction = Skyvern.RunSdkActionRequestAction.AiAct | Skyvern.RunSdkActionRequestAction.AiClick | Skyvern.RunSdkActionRequestAction.AiInputText | Skyvern.RunSdkActionRequestAction.AiSelectOption | Skyvern.RunSdkActionRequestAction.AiUploadFile | Skyvern.RunSdkActionRequestAction.Extract | Skyvern.RunSdkActionRequestAction.LocateElement;
|
|
5
|
+
export type RunSdkActionRequestAction = Skyvern.RunSdkActionRequestAction.AiAct | Skyvern.RunSdkActionRequestAction.AiClick | Skyvern.RunSdkActionRequestAction.AiInputText | Skyvern.RunSdkActionRequestAction.AiSelectOption | Skyvern.RunSdkActionRequestAction.AiUploadFile | Skyvern.RunSdkActionRequestAction.Extract | Skyvern.RunSdkActionRequestAction.LocateElement | Skyvern.RunSdkActionRequestAction.Prompt | Skyvern.RunSdkActionRequestAction.Validate;
|
|
6
6
|
export declare namespace RunSdkActionRequestAction {
|
|
7
7
|
interface AiAct extends Skyvern.ActAction {
|
|
8
8
|
type: "ai_act";
|
|
@@ -25,4 +25,10 @@ export declare namespace RunSdkActionRequestAction {
|
|
|
25
25
|
interface LocateElement extends Skyvern.LocateElementAction {
|
|
26
26
|
type: "locate_element";
|
|
27
27
|
}
|
|
28
|
+
interface Prompt extends Skyvern.PromptAction {
|
|
29
|
+
type: "prompt";
|
|
30
|
+
}
|
|
31
|
+
interface Validate extends Skyvern.ValidateAction {
|
|
32
|
+
type: "validate";
|
|
33
|
+
}
|
|
28
34
|
}
|
|
@@ -8,6 +8,7 @@ export interface SendEmailBlock {
|
|
|
8
8
|
continue_on_failure?: boolean;
|
|
9
9
|
model?: Record<string, unknown>;
|
|
10
10
|
disable_cache?: boolean;
|
|
11
|
+
next_loop_on_failure?: boolean;
|
|
11
12
|
smtp_host: Skyvern.AwsSecretParameter;
|
|
12
13
|
smtp_port: Skyvern.AwsSecretParameter;
|
|
13
14
|
smtp_username: Skyvern.AwsSecretParameter;
|
|
@@ -5,6 +5,7 @@ export interface SendEmailBlockYaml {
|
|
|
5
5
|
next_block_label?: string;
|
|
6
6
|
continue_on_failure?: boolean;
|
|
7
7
|
model?: Record<string, unknown>;
|
|
8
|
+
next_loop_on_failure?: boolean;
|
|
8
9
|
smtp_host_secret_parameter_key: string;
|
|
9
10
|
smtp_port_secret_parameter_key: string;
|
|
10
11
|
smtp_username_secret_parameter_key: string;
|
|
@@ -2,5 +2,6 @@
|
|
|
2
2
|
export declare const SkyvernForgeSdkSchemasCredentialsCredentialType: {
|
|
3
3
|
readonly Password: "password";
|
|
4
4
|
readonly CreditCard: "credit_card";
|
|
5
|
+
readonly Secret: "secret";
|
|
5
6
|
};
|
|
6
7
|
export type SkyvernForgeSdkSchemasCredentialsCredentialType = (typeof SkyvernForgeSdkSchemasCredentialsCredentialType)[keyof typeof SkyvernForgeSdkSchemasCredentialsCredentialType];
|
|
@@ -5,6 +5,7 @@ export interface ValidationBlockYaml {
|
|
|
5
5
|
next_block_label?: string;
|
|
6
6
|
continue_on_failure?: boolean;
|
|
7
7
|
model?: Record<string, unknown>;
|
|
8
|
+
next_loop_on_failure?: boolean;
|
|
8
9
|
complete_criterion?: string;
|
|
9
10
|
terminate_criterion?: string;
|
|
10
11
|
error_code_mapping?: Record<string, string | undefined>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type * as Skyvern from "../index.js";
|
|
2
|
-
export type WorkflowDefinitionYamlBlocksItem = Skyvern.WorkflowDefinitionYamlBlocksItem.Action | Skyvern.WorkflowDefinitionYamlBlocksItem.Code | Skyvern.WorkflowDefinitionYamlBlocksItem.DownloadToS3 | Skyvern.WorkflowDefinitionYamlBlocksItem.Extraction | Skyvern.WorkflowDefinitionYamlBlocksItem.FileDownload | Skyvern.WorkflowDefinitionYamlBlocksItem.FileUpload | Skyvern.WorkflowDefinitionYamlBlocksItem.FileUrlParser | Skyvern.WorkflowDefinitionYamlBlocksItem.ForLoop | Skyvern.WorkflowDefinitionYamlBlocksItem.GotoUrl | Skyvern.WorkflowDefinitionYamlBlocksItem.HttpRequest | Skyvern.WorkflowDefinitionYamlBlocksItem.HumanInteraction | Skyvern.WorkflowDefinitionYamlBlocksItem.Login | Skyvern.WorkflowDefinitionYamlBlocksItem.Navigation | Skyvern.WorkflowDefinitionYamlBlocksItem.PdfParser | Skyvern.WorkflowDefinitionYamlBlocksItem.SendEmail | Skyvern.WorkflowDefinitionYamlBlocksItem.Task | Skyvern.WorkflowDefinitionYamlBlocksItem.TaskV2 | Skyvern.WorkflowDefinitionYamlBlocksItem.TextPrompt | Skyvern.WorkflowDefinitionYamlBlocksItem.UploadToS3 | Skyvern.WorkflowDefinitionYamlBlocksItem.Validation | Skyvern.WorkflowDefinitionYamlBlocksItem.Wait;
|
|
2
|
+
export type WorkflowDefinitionYamlBlocksItem = Skyvern.WorkflowDefinitionYamlBlocksItem.Action | Skyvern.WorkflowDefinitionYamlBlocksItem.Code | Skyvern.WorkflowDefinitionYamlBlocksItem.Conditional | Skyvern.WorkflowDefinitionYamlBlocksItem.DownloadToS3 | Skyvern.WorkflowDefinitionYamlBlocksItem.Extraction | Skyvern.WorkflowDefinitionYamlBlocksItem.FileDownload | Skyvern.WorkflowDefinitionYamlBlocksItem.FileUpload | Skyvern.WorkflowDefinitionYamlBlocksItem.FileUrlParser | Skyvern.WorkflowDefinitionYamlBlocksItem.ForLoop | Skyvern.WorkflowDefinitionYamlBlocksItem.GotoUrl | Skyvern.WorkflowDefinitionYamlBlocksItem.HttpRequest | Skyvern.WorkflowDefinitionYamlBlocksItem.HumanInteraction | Skyvern.WorkflowDefinitionYamlBlocksItem.Login | Skyvern.WorkflowDefinitionYamlBlocksItem.Navigation | Skyvern.WorkflowDefinitionYamlBlocksItem.PdfParser | Skyvern.WorkflowDefinitionYamlBlocksItem.SendEmail | Skyvern.WorkflowDefinitionYamlBlocksItem.Task | Skyvern.WorkflowDefinitionYamlBlocksItem.TaskV2 | Skyvern.WorkflowDefinitionYamlBlocksItem.TextPrompt | Skyvern.WorkflowDefinitionYamlBlocksItem.UploadToS3 | Skyvern.WorkflowDefinitionYamlBlocksItem.Validation | Skyvern.WorkflowDefinitionYamlBlocksItem.Wait;
|
|
3
3
|
export declare namespace WorkflowDefinitionYamlBlocksItem {
|
|
4
4
|
interface Action extends Skyvern.ActionBlockYaml {
|
|
5
5
|
block_type: "action";
|
|
@@ -7,6 +7,9 @@ export declare namespace WorkflowDefinitionYamlBlocksItem {
|
|
|
7
7
|
interface Code extends Skyvern.CodeBlockYaml {
|
|
8
8
|
block_type: "code";
|
|
9
9
|
}
|
|
10
|
+
interface Conditional extends Skyvern.ConditionalBlockYaml {
|
|
11
|
+
block_type: "conditional";
|
|
12
|
+
}
|
|
10
13
|
interface DownloadToS3 extends Skyvern.DownloadToS3BlockYaml {
|
|
11
14
|
block_type: "download_to_s3";
|
|
12
15
|
}
|
|
@@ -36,6 +36,10 @@ export interface WorkflowRunBlock {
|
|
|
36
36
|
instructions?: string;
|
|
37
37
|
positive_descriptor?: string;
|
|
38
38
|
negative_descriptor?: string;
|
|
39
|
+
executed_branch_id?: string;
|
|
40
|
+
executed_branch_expression?: string;
|
|
41
|
+
executed_branch_result?: boolean;
|
|
42
|
+
executed_branch_next_block?: string;
|
|
39
43
|
}
|
|
40
44
|
export declare namespace WorkflowRunBlock {
|
|
41
45
|
type Output = Record<string, unknown> | unknown[] | string;
|
|
@@ -20,7 +20,9 @@ export * from "./BitwardenSensitiveInformationParameter.js";
|
|
|
20
20
|
export * from "./BitwardenSensitiveInformationParameterYaml.js";
|
|
21
21
|
export * from "./BlockType.js";
|
|
22
22
|
export * from "./BranchCondition.js";
|
|
23
|
-
export * from "./
|
|
23
|
+
export * from "./BranchConditionCriteria.js";
|
|
24
|
+
export * from "./BranchConditionYaml.js";
|
|
25
|
+
export * from "./BranchCriteriaYaml.js";
|
|
24
26
|
export * from "./BrowserProfile.js";
|
|
25
27
|
export * from "./BrowserSessionResponse.js";
|
|
26
28
|
export * from "./ClickAction.js";
|
|
@@ -29,6 +31,7 @@ export * from "./CodeBlock.js";
|
|
|
29
31
|
export * from "./CodeBlockParametersItem.js";
|
|
30
32
|
export * from "./CodeBlockYaml.js";
|
|
31
33
|
export * from "./ConditionalBlock.js";
|
|
34
|
+
export * from "./ConditionalBlockYaml.js";
|
|
32
35
|
export * from "./ContextParameter.js";
|
|
33
36
|
export * from "./ContextParameterSource.js";
|
|
34
37
|
export * from "./ContextParameterYaml.js";
|
|
@@ -56,7 +59,6 @@ export * from "./FileStorageType.js";
|
|
|
56
59
|
export * from "./FileType.js";
|
|
57
60
|
export * from "./FileUploadBlock.js";
|
|
58
61
|
export * from "./FileUploadBlockYaml.js";
|
|
59
|
-
export * from "./Folder.js";
|
|
60
62
|
export * from "./ForLoopBlock.js";
|
|
61
63
|
export * from "./ForLoopBlockLoopBlocksItem.js";
|
|
62
64
|
export * from "./ForLoopBlockLoopOver.js";
|
|
@@ -73,6 +75,7 @@ export * from "./HumanInteractionBlockParametersItem.js";
|
|
|
73
75
|
export * from "./HumanInteractionBlockYaml.js";
|
|
74
76
|
export * from "./InputOrSelectContext.js";
|
|
75
77
|
export * from "./InputTextAction.js";
|
|
78
|
+
export * from "./JinjaBranchCriteria.js";
|
|
76
79
|
export * from "./LocateElementAction.js";
|
|
77
80
|
export * from "./LoginBlock.js";
|
|
78
81
|
export * from "./LoginBlockParametersItem.js";
|
|
@@ -90,6 +93,8 @@ export * from "./OutputParameterYaml.js";
|
|
|
90
93
|
export * from "./PasswordCredentialResponse.js";
|
|
91
94
|
export * from "./PdfParserBlock.js";
|
|
92
95
|
export * from "./PdfParserBlockYaml.js";
|
|
96
|
+
export * from "./PromptAction.js";
|
|
97
|
+
export * from "./PromptBranchCriteria.js";
|
|
93
98
|
export * from "./ProxyLocation.js";
|
|
94
99
|
export * from "./RunEngine.js";
|
|
95
100
|
export * from "./RunSdkActionRequestAction.js";
|
|
@@ -98,6 +103,8 @@ export * from "./RunStatus.js";
|
|
|
98
103
|
export * from "./Script.js";
|
|
99
104
|
export * from "./ScriptFileCreate.js";
|
|
100
105
|
export * from "./ScriptRunResponse.js";
|
|
106
|
+
export * from "./SecretCredential.js";
|
|
107
|
+
export * from "./SecretCredentialResponse.js";
|
|
101
108
|
export * from "./SelectOption.js";
|
|
102
109
|
export * from "./SelectOptionAction.js";
|
|
103
110
|
export * from "./SendEmailBlock.js";
|
|
@@ -126,6 +133,7 @@ export * from "./UrlBlock.js";
|
|
|
126
133
|
export * from "./UrlBlockParametersItem.js";
|
|
127
134
|
export * from "./UrlBlockYaml.js";
|
|
128
135
|
export * from "./UserDefinedError.js";
|
|
136
|
+
export * from "./ValidateAction.js";
|
|
129
137
|
export * from "./ValidationBlock.js";
|
|
130
138
|
export * from "./ValidationBlockParametersItem.js";
|
|
131
139
|
export * from "./ValidationBlockYaml.js";
|
|
@@ -36,7 +36,9 @@ __exportStar(require("./BitwardenSensitiveInformationParameter.js"), exports);
|
|
|
36
36
|
__exportStar(require("./BitwardenSensitiveInformationParameterYaml.js"), exports);
|
|
37
37
|
__exportStar(require("./BlockType.js"), exports);
|
|
38
38
|
__exportStar(require("./BranchCondition.js"), exports);
|
|
39
|
-
__exportStar(require("./
|
|
39
|
+
__exportStar(require("./BranchConditionCriteria.js"), exports);
|
|
40
|
+
__exportStar(require("./BranchConditionYaml.js"), exports);
|
|
41
|
+
__exportStar(require("./BranchCriteriaYaml.js"), exports);
|
|
40
42
|
__exportStar(require("./BrowserProfile.js"), exports);
|
|
41
43
|
__exportStar(require("./BrowserSessionResponse.js"), exports);
|
|
42
44
|
__exportStar(require("./ClickAction.js"), exports);
|
|
@@ -45,6 +47,7 @@ __exportStar(require("./CodeBlock.js"), exports);
|
|
|
45
47
|
__exportStar(require("./CodeBlockParametersItem.js"), exports);
|
|
46
48
|
__exportStar(require("./CodeBlockYaml.js"), exports);
|
|
47
49
|
__exportStar(require("./ConditionalBlock.js"), exports);
|
|
50
|
+
__exportStar(require("./ConditionalBlockYaml.js"), exports);
|
|
48
51
|
__exportStar(require("./ContextParameter.js"), exports);
|
|
49
52
|
__exportStar(require("./ContextParameterSource.js"), exports);
|
|
50
53
|
__exportStar(require("./ContextParameterYaml.js"), exports);
|
|
@@ -72,7 +75,6 @@ __exportStar(require("./FileStorageType.js"), exports);
|
|
|
72
75
|
__exportStar(require("./FileType.js"), exports);
|
|
73
76
|
__exportStar(require("./FileUploadBlock.js"), exports);
|
|
74
77
|
__exportStar(require("./FileUploadBlockYaml.js"), exports);
|
|
75
|
-
__exportStar(require("./Folder.js"), exports);
|
|
76
78
|
__exportStar(require("./ForLoopBlock.js"), exports);
|
|
77
79
|
__exportStar(require("./ForLoopBlockLoopBlocksItem.js"), exports);
|
|
78
80
|
__exportStar(require("./ForLoopBlockLoopOver.js"), exports);
|
|
@@ -89,6 +91,7 @@ __exportStar(require("./HumanInteractionBlockParametersItem.js"), exports);
|
|
|
89
91
|
__exportStar(require("./HumanInteractionBlockYaml.js"), exports);
|
|
90
92
|
__exportStar(require("./InputOrSelectContext.js"), exports);
|
|
91
93
|
__exportStar(require("./InputTextAction.js"), exports);
|
|
94
|
+
__exportStar(require("./JinjaBranchCriteria.js"), exports);
|
|
92
95
|
__exportStar(require("./LocateElementAction.js"), exports);
|
|
93
96
|
__exportStar(require("./LoginBlock.js"), exports);
|
|
94
97
|
__exportStar(require("./LoginBlockParametersItem.js"), exports);
|
|
@@ -106,6 +109,8 @@ __exportStar(require("./OutputParameterYaml.js"), exports);
|
|
|
106
109
|
__exportStar(require("./PasswordCredentialResponse.js"), exports);
|
|
107
110
|
__exportStar(require("./PdfParserBlock.js"), exports);
|
|
108
111
|
__exportStar(require("./PdfParserBlockYaml.js"), exports);
|
|
112
|
+
__exportStar(require("./PromptAction.js"), exports);
|
|
113
|
+
__exportStar(require("./PromptBranchCriteria.js"), exports);
|
|
109
114
|
__exportStar(require("./ProxyLocation.js"), exports);
|
|
110
115
|
__exportStar(require("./RunEngine.js"), exports);
|
|
111
116
|
__exportStar(require("./RunSdkActionRequestAction.js"), exports);
|
|
@@ -114,6 +119,8 @@ __exportStar(require("./RunStatus.js"), exports);
|
|
|
114
119
|
__exportStar(require("./Script.js"), exports);
|
|
115
120
|
__exportStar(require("./ScriptFileCreate.js"), exports);
|
|
116
121
|
__exportStar(require("./ScriptRunResponse.js"), exports);
|
|
122
|
+
__exportStar(require("./SecretCredential.js"), exports);
|
|
123
|
+
__exportStar(require("./SecretCredentialResponse.js"), exports);
|
|
117
124
|
__exportStar(require("./SelectOption.js"), exports);
|
|
118
125
|
__exportStar(require("./SelectOptionAction.js"), exports);
|
|
119
126
|
__exportStar(require("./SendEmailBlock.js"), exports);
|
|
@@ -142,6 +149,7 @@ __exportStar(require("./UrlBlock.js"), exports);
|
|
|
142
149
|
__exportStar(require("./UrlBlockParametersItem.js"), exports);
|
|
143
150
|
__exportStar(require("./UrlBlockYaml.js"), exports);
|
|
144
151
|
__exportStar(require("./UserDefinedError.js"), exports);
|
|
152
|
+
__exportStar(require("./ValidateAction.js"), exports);
|
|
145
153
|
__exportStar(require("./ValidationBlock.js"), exports);
|
|
146
154
|
__exportStar(require("./ValidationBlockParametersItem.js"), exports);
|
|
147
155
|
__exportStar(require("./ValidationBlockYaml.js"), exports);
|
package/dist/cjs/index.d.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
|
-
export * as
|
|
1
|
+
export * as SkyvernApi from "./api/index.js";
|
|
2
2
|
export type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
|
|
3
3
|
export { SkyvernClient } from "./Client.js";
|
|
4
4
|
export { SkyvernEnvironment } from "./environments.js";
|
|
5
5
|
export { SkyvernError, SkyvernTimeoutError } from "./errors/index.js";
|
|
6
|
+
export { Skyvern, SkyvernBrowser, SkyvernBrowserPageAgent, SkyvernBrowserPageAi } from "./library/index.js";
|
|
7
|
+
export type { SkyvernOptions, SkyvernBrowserPage } from "./library/index.js";
|
package/dist/cjs/index.js
CHANGED
|
@@ -33,8 +33,8 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
33
33
|
};
|
|
34
34
|
})();
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.SkyvernTimeoutError = exports.SkyvernError = exports.SkyvernEnvironment = exports.SkyvernClient = exports.
|
|
37
|
-
exports.
|
|
36
|
+
exports.SkyvernBrowserPageAi = exports.SkyvernBrowserPageAgent = exports.SkyvernBrowser = exports.Skyvern = exports.SkyvernTimeoutError = exports.SkyvernError = exports.SkyvernEnvironment = exports.SkyvernClient = exports.SkyvernApi = void 0;
|
|
37
|
+
exports.SkyvernApi = __importStar(require("./api/index.js"));
|
|
38
38
|
var Client_js_1 = require("./Client.js");
|
|
39
39
|
Object.defineProperty(exports, "SkyvernClient", { enumerable: true, get: function () { return Client_js_1.SkyvernClient; } });
|
|
40
40
|
var environments_js_1 = require("./environments.js");
|
|
@@ -42,3 +42,8 @@ Object.defineProperty(exports, "SkyvernEnvironment", { enumerable: true, get: fu
|
|
|
42
42
|
var index_js_1 = require("./errors/index.js");
|
|
43
43
|
Object.defineProperty(exports, "SkyvernError", { enumerable: true, get: function () { return index_js_1.SkyvernError; } });
|
|
44
44
|
Object.defineProperty(exports, "SkyvernTimeoutError", { enumerable: true, get: function () { return index_js_1.SkyvernTimeoutError; } });
|
|
45
|
+
var index_js_2 = require("./library/index.js");
|
|
46
|
+
Object.defineProperty(exports, "Skyvern", { enumerable: true, get: function () { return index_js_2.Skyvern; } });
|
|
47
|
+
Object.defineProperty(exports, "SkyvernBrowser", { enumerable: true, get: function () { return index_js_2.SkyvernBrowser; } });
|
|
48
|
+
Object.defineProperty(exports, "SkyvernBrowserPageAgent", { enumerable: true, get: function () { return index_js_2.SkyvernBrowserPageAgent; } });
|
|
49
|
+
Object.defineProperty(exports, "SkyvernBrowserPageAi", { enumerable: true, get: function () { return index_js_2.SkyvernBrowserPageAi; } });
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import type * as SkyvernApi from "../api/index.js";
|
|
2
|
+
import type { BaseClientOptions } from "../BaseClient.js";
|
|
3
|
+
import { SkyvernClient } from "../Client.js";
|
|
4
|
+
import { SkyvernEnvironment } from "../environments.js";
|
|
5
|
+
import { SkyvernBrowser } from "./SkyvernBrowser.js";
|
|
6
|
+
import type { ProxyLocation } from "../api/index.js";
|
|
7
|
+
import * as core from "../core/index.js";
|
|
8
|
+
export interface SkyvernOptions extends BaseClientOptions {
|
|
9
|
+
apiKey: string;
|
|
10
|
+
}
|
|
11
|
+
export interface RunTaskOptions extends SkyvernApi.RunTaskRequest {
|
|
12
|
+
waitForCompletion?: boolean;
|
|
13
|
+
timeout?: number;
|
|
14
|
+
}
|
|
15
|
+
export interface RunWorkflowOptions extends SkyvernApi.RunWorkflowRequest {
|
|
16
|
+
waitForCompletion?: boolean;
|
|
17
|
+
timeout?: number;
|
|
18
|
+
}
|
|
19
|
+
export interface LoginOptions extends SkyvernApi.LoginRequest {
|
|
20
|
+
waitForCompletion?: boolean;
|
|
21
|
+
timeout?: number;
|
|
22
|
+
}
|
|
23
|
+
export interface DownloadFilesOptions extends SkyvernApi.DownloadFilesRequest {
|
|
24
|
+
waitForCompletion?: boolean;
|
|
25
|
+
timeout?: number;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Main entry point for the Skyvern SDK.
|
|
29
|
+
*
|
|
30
|
+
* This class provides methods to launch and connect to browsers (both local and cloud-hosted),
|
|
31
|
+
* and access the Skyvern API client for task and workflow management. It combines browser
|
|
32
|
+
* automation capabilities with AI-powered task execution.
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```typescript
|
|
36
|
+
* // Remote mode: Connect to Skyvern Cloud (API key required)
|
|
37
|
+
* const skyvern = new Skyvern({ apiKey: "your-api-key" });
|
|
38
|
+
*
|
|
39
|
+
* // Launch a cloud browser
|
|
40
|
+
* const browser = await skyvern.launchCloudBrowser();
|
|
41
|
+
* const page = await browser.getWorkingPage();
|
|
42
|
+
*
|
|
43
|
+
* // Execute AI-powered tasks
|
|
44
|
+
* await page.agent.runTask("Fill out the form and submit it");
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
export declare class Skyvern extends SkyvernClient {
|
|
48
|
+
private readonly _apiKey;
|
|
49
|
+
private readonly _environment;
|
|
50
|
+
private readonly _browsers;
|
|
51
|
+
constructor(options: SkyvernOptions);
|
|
52
|
+
get environment(): SkyvernEnvironment | string;
|
|
53
|
+
runTask(request: RunTaskOptions, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<SkyvernApi.TaskRunResponse>;
|
|
54
|
+
private __runTaskWithCompletion;
|
|
55
|
+
runWorkflow(request: RunWorkflowOptions, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<SkyvernApi.WorkflowRunResponse>;
|
|
56
|
+
private __runWorkflowWithCompletion;
|
|
57
|
+
login(request: LoginOptions, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<SkyvernApi.WorkflowRunResponse>;
|
|
58
|
+
private __loginWithCompletion;
|
|
59
|
+
downloadFiles(request: DownloadFilesOptions, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<SkyvernApi.WorkflowRunResponse>;
|
|
60
|
+
private __downloadFilesWithCompletion;
|
|
61
|
+
/**
|
|
62
|
+
* Launch a new cloud-hosted browser session.
|
|
63
|
+
*
|
|
64
|
+
* This creates a new browser session in Skyvern's cloud infrastructure and connects to it.
|
|
65
|
+
*
|
|
66
|
+
* @param options - Optional configuration
|
|
67
|
+
* @param options.timeout - Timeout in minutes for the session. Timeout is applied after the session is started.
|
|
68
|
+
* Must be between 5 and 1440. Defaults to 60.
|
|
69
|
+
* @param options.proxyLocation - Geographic proxy location to route the browser traffic through.
|
|
70
|
+
* This is only available in Skyvern Cloud.
|
|
71
|
+
*
|
|
72
|
+
* @returns SkyvernBrowser instance connected to the new cloud session.
|
|
73
|
+
*/
|
|
74
|
+
launchCloudBrowser(options?: {
|
|
75
|
+
timeout?: number;
|
|
76
|
+
proxyLocation?: SkyvernApi.ProxyLocation;
|
|
77
|
+
}): Promise<SkyvernBrowser>;
|
|
78
|
+
/**
|
|
79
|
+
* Connect to an existing cloud-hosted browser session by ID.
|
|
80
|
+
*
|
|
81
|
+
* @param browserSessionId - The ID of the cloud browser session to connect to.
|
|
82
|
+
*
|
|
83
|
+
* @returns SkyvernBrowser instance connected to the cloud session.
|
|
84
|
+
*/
|
|
85
|
+
connectToCloudBrowserSession(browserSessionId: string): Promise<SkyvernBrowser>;
|
|
86
|
+
/**
|
|
87
|
+
* Get or create a cloud browser session.
|
|
88
|
+
*
|
|
89
|
+
* This method attempts to reuse the most recent available cloud browser session.
|
|
90
|
+
* If no session exists, it creates a new one. This is useful for cost efficiency
|
|
91
|
+
* and session persistence.
|
|
92
|
+
*
|
|
93
|
+
* @param options - Optional configuration
|
|
94
|
+
* @param options.timeout - Timeout in minutes for the session. Timeout is applied after the session is started.
|
|
95
|
+
* Must be between 5 and 1440. Defaults to 60. Only used when creating a new session.
|
|
96
|
+
* @param options.proxyLocation - Geographic proxy location to route the browser traffic through.
|
|
97
|
+
* This is only available in Skyvern Cloud. Only used when creating a new session.
|
|
98
|
+
*
|
|
99
|
+
* @returns SkyvernBrowser instance connected to an existing or new cloud session.
|
|
100
|
+
*/
|
|
101
|
+
useCloudBrowser(options?: {
|
|
102
|
+
timeout?: number;
|
|
103
|
+
proxyLocation?: ProxyLocation;
|
|
104
|
+
}): Promise<SkyvernBrowser>;
|
|
105
|
+
/**
|
|
106
|
+
* Connect to an existing browser instance via Chrome DevTools Protocol (CDP).
|
|
107
|
+
*
|
|
108
|
+
* Use this to connect to a browser that's already running with CDP enabled,
|
|
109
|
+
* whether local or remote.
|
|
110
|
+
*
|
|
111
|
+
* @param cdpUrl - The CDP WebSocket URL (e.g., "http://localhost:9222").
|
|
112
|
+
*
|
|
113
|
+
* @returns SkyvernBrowser instance connected to the existing browser.
|
|
114
|
+
*/
|
|
115
|
+
connectToBrowserOverCdp(cdpUrl: string): Promise<SkyvernBrowser>;
|
|
116
|
+
/**
|
|
117
|
+
* Close all browsers and release resources.
|
|
118
|
+
*/
|
|
119
|
+
close(): Promise<void>;
|
|
120
|
+
_untrackBrowser(browser: SkyvernBrowser): void;
|
|
121
|
+
private _ensureCloudEnvironment;
|
|
122
|
+
private _connectToCloudBrowserSession;
|
|
123
|
+
private _waitForRunCompletion;
|
|
124
|
+
}
|