octoparse-cli 0.1.14

package/node_modules/@octopus/engine/dist/enums/index.d.ts

@@ -0,0 +1,419 @@
+/** 任务类型 */
+export declare enum TaskType {
+    /** 自定义任务 */
+    Customize = 1,
+    /** 模板任务 */
+    Template = 10
+}
+export declare enum LogType {
+    Info = 0,
+    Error = 1,
+    Resource = 2,
+    DebugLogger = 3
+}
+export declare const RunnerStatus: {
+    readonly Completed: "completed";
+    readonly Stopped: "stopped";
+};
+export type RunnerStatus = (typeof RunnerStatus)[keyof typeof RunnerStatus];
+export declare const LogKey: {
+    Common: {
+        BeforeWaitTime: string;
+        BeforeWaitXPath: string;
+        Retry: {
+            URL: {
+                Found: string;
+                NotFound: string;
+            };
+            Text: {
+                Found: string;
+                NotFound: string;
+            };
+            XPath: {
+                Found: string;
+                NotFound: string;
+            };
+            Success: string;
+            Failure: string;
+        };
+        SwitchIP: string;
+        ResourceSWitchIp: string;
+        SwitchUA: string;
+        Scroll: {
+            Global: {
+                Screen: string;
+                Bottom: string;
+            };
+            Local: {
+                Screen: string;
+                Bottom: string;
+            };
+            Finish: string;
+        };
+        Ajax: {
+            Action: string;
+            Success: string;
+            Failure: string;
+        };
+        RemoteControlTip: string;
+    };
+    Navigate: {
+        Begin: string;
+        BeginWithLoop: string;
+        ClearCache: {
+            Success: string;
+            Failure: string;
+        };
+        Cookies: {
+            Success: string;
+            Failure: string;
+        };
+        Goto: {
+            Loading: string;
+            Success: string;
+            Failure: string;
+        };
+        Error: {
+            Timeout: string;
+            NotFondURL: string;
+        };
+    };
+    Click: {
+        Begin: string;
+        NewWindow: {
+            Action: string;
+            Loading: string;
+            Success: string;
+            Failure: string;
+        };
+        Error: {
+            Timeout: string;
+            NotFound: string;
+            HrefInvalid: string;
+        };
+    };
+    ExtractData: {
+        Begin: string;
+        Success: string;
+        Trigger: {
+            NotSave: string;
+            BreakLoop: string;
+            EndWorkflow: string;
+        };
+        Error: {
+            Empty: string;
+            Trigger: {
+                NotFoundField: string;
+            };
+        };
+    };
+    Loop: {
+        Begin: {
+            FixedItem: string;
+            FixedList: string;
+            VarilableList: string;
+            URLList: string;
+            TextList: string;
+            Scroll: string;
+        };
+        Action: string;
+        Error: string;
+        Finish: string;
+    };
+    EnterText: {
+        Begin: string;
+        Action: string;
+        Enter: string;
+        Error: {
+            NotString: string;
+        };
+    };
+    MouseOver: {
+        Begin: string;
+    };
+    EnterCapacha: {
+        Begin: string;
+        Action: string;
+        Complete: string;
+        ResourceCpathca: string;
+        PhotoCpathca: string;
+        RecaptchaV2Cpathca: string;
+        RecaptchaV3Cpathca: string;
+        HcaptchaCpathca: string;
+        Error: {
+            Retry: string;
+            Distance: string;
+            ClickArea: string;
+            InputNotFound: string;
+            ImageNotFound: string;
+            TipImageNotFound: string;
+            HuaKuaiImageNotFound: string;
+            Captcha: string;
+        };
+    };
+    SwitchCombo: {
+        Begin: string;
+    };
+    BackPreWebPage: {
+        Begin: string;
+    };
+    Condition: {
+        Begin: string;
+    };
+    Branch: {
+        Begin: string;
+        Action: {
+            Allow: string;
+            Text: {
+                Normal: {
+                    Success: string;
+                    Failure: string;
+                };
+                Loop: {
+                    Success: string;
+                    Failure: string;
+                };
+            };
+            Element: {
+                Normal: {
+                    Success: string;
+                    Failure: string;
+                };
+                Loop: {
+                    Success: string;
+                    Failure: string;
+                };
+            };
+        };
+    };
+    GlobalCookies: {
+        Success: string;
+        Failure: string;
+    };
+};
+export declare const enum ActionType {
+    Empty = "EmptyAction",
+    Navigate = "NavigateAction",
+    Click = "ClickAction",
+    ExtractData = "ExtractDataAction",
+    Loop = "LoopAction",
+    LoopStart = "LoopAction.Start",
+    EnterText = "EnterTextAction",
+    MouseOver = "MouseOverAction",
+    EnterCaptcha = "EnterCapachaAction",
+    SwitchCombo = "SwitchCombo2Action",
+    Condition = "ConditionAction",
+    Branch = "BranchAction",
+    BackPreWebPage = "BackPreWebPageAction"
+}
+export declare const enum CheckType {
+    DoNotCheck = "DoNotCheck",
+    ContainText = "ContainText",
+    ContainItem = "ContainItem",
+    URLContain = "URLContain",
+    XPathContain = "XPathContain",
+    Multiple = "Multiple"
+}
+export declare const enum ScrollType {
+    ScrollToBottom = 0,
+    ScrollOneScreen = 1
+}
+export declare const enum ScrollScope {
+    AllDocument = 0,
+    Local = 1
+}
+export declare const enum RetryConditionType {
+    DoNotCheck = "DoNotCheck",
+    ContainText = "ContainText",
+    ContainItem = "ContainItem",
+    URLContain = "URLContain",
+    XPathContain = "XPathContain",
+    Multiple = "Multiple"
+}
+export declare const enum ActionTags {
+    FixedList = "xml:LoopAction.FixedList",
+    TextList = "xml:LoopAction.TextList",
+    URLList = "xml:LoopAction.URLList",
+    ExtractTemplate = "xml:ExtractDataAction.ExtractTemplate",
+    NavigateRetryConditions = "xml:NavigateAction.RetryConditions",
+    NavigateRequestHeaders = "xml:NavigateAction.RequestHeaders",
+    NavigateRetryUserAgent = "xml:NavigateAction.UserAgents",
+    ClickActionRetryConditions = "xml:ClickAction.RetryConditions",
+    ClickActionRequestHeaders = "xml:ClickAction.RequestHeaders",
+    ClickActionRetryUserAgent = "xml:ClickAction.UserAgents",
+    Operation = "xml:Operation",
+    Parameter = "xml:Parameter",
+    Trigger = "xml:ExtractDataAction.Triggers"
+}
+export declare enum CaptchaFailureElementType {
+    XPath = "XPath",
+    Text = "Text"
+}
+export declare const enum ExtractTextType {
+    ExtractText = "ExtractText",
+    ExtractHtml = "ExtractHtml",
+    ExtractHref = "ExtractHref",
+    ExtractPageURL = "ExtractPageURL",
+    ExtractPageSource = "ExtractPageSource",
+    ExtractSrc = "ExtractSrc",
+    ExtractPageTitle = "ExtractPageTitle",
+    ExtractValue = "ExtractValue",
+    GenerateFixedValue = "GenerateFixedValue",
+    ExtractAddTaskSourceUrl = "ExtractAddTaskSourceUrl",
+    GenerateCurrentDateTime = "GenerateCurrentDateTime",
+    ExtractOuterHtml = "ExtractOuterHtml",
+    ExtractOCR = "ExtractOCR",
+    ExtractSelectText = "ExtractSelectText",
+    ExtractCustomizeField = "ExtractCustomizeField",
+    /** 文件、视频、音频、文档类型 */
+    /** 视频音频地址因为可能是从video/audio标签上src获取的，也可能是a标签上href获取的 */
+    ExtractVideoSrc = "ExtractVideoSrc",
+    ExtractVideoHref = "ExtractVideoHref",
+    ExtractAudioSrc = "ExtractAudioSrc",
+    ExtractAudioHref = "ExtractAudioHref",
+    ExtractDocumentHref = "ExtractDocumentHref",
+    ExtractFileHref = "ExtractFileHref",
+    ExtractFileField = "ExtractFileField"
+}
+export declare const extractFunctions: Partial<Record<ExtractTextType, (ele: HTMLElement) => string>>;
+export declare const enum LoopType {
+    FixedItem = "FixedItem",
+    FixedItemList = "FixedItemList",
+    VarilableItemList = "VarilableItemList",
+    URLList = "URLList",
+    TextList = "TextList",
+    ScrollWeb = "ScrollWeb"
+}
+export declare const enum NavigateType {
+    OpenWebpage = "OpenWebpage",
+    OpenJson = "OpenJson",
+    None = "None"
+}
+export declare const enum BaseActionQueueType {
+    CurrentLoopValue = "_current_loop_value",
+    LoopValueArray = "_loop_values",
+    CurrentLoopIsSkipFlag = "_current_loop_isskip",
+    IsOnlySkipOneLoopFlag = "_is_only_skip_one_loop",
+    IsClickNotFoundFlag = "_is_click_not_found",
+    CurrentIsSkipActionUtilNextLoopFlag = "_current_is_skip_action_util_next_loop",
+    IdentifiedLoopExtractDataCount = "_identified_loop_extract_data_count",
+    IdentifiedEachLoopExtractDataCount = "_identified_each_loop_extract_data_count",
+    NextItemOffset = "_next_loop_item_offset",
+    /** 记录每个循环的循环次数 */
+    LoopCount = "_loop_count",
+    /** 记录上次采集循环抽样数据 */
+    SamplingElementsMap = "_sampling_elements_map",
+    /** 判断当前页面的url */
+    CurrentPageTempUrl = "_temp_url",
+    /** 用来判断URL是否相等的标识 */
+    JudgeUrlEqual = "_url_equal_flag",
+    /** 连续无效翻页计数 */
+    ContinuousInvalidPageCount = "_continuous_invalid_page_count",
+    /** 记录连续循环点击加载更多按钮，一直没有新数据的循环次数 */
+    ContinuousClickLoadNoNewDataCount = "_continuous_click_load_no_new_data_count",
+    /** 缓存网页滚动条距离顶部的高度 */
+    WebScrollTopTemp = "_web_scroll_top_temp",
+    /** 文档的高度 */
+    WebDocumentHeight = "_web_document_height_temp",
+    /** 记录连续滚动网页，滚动条高度一只没有变化的循环次数 */
+    ContinuousScrollTopFixedWebCount = "_continuous_scroll_top_fixed_web_count",
+    CurrentLoopUrl = "_currentloopurl",
+    NextLoopOffset = "NextLoopOffset"
+}
+export declare const enum FuncRetryType {
+    None = 1,
+    IsLoaded = 2,
+    IsClick = 3
+}
+export declare const enum CaptchaCompleteStatus {
+    Default = 0,
+    Success = 1,
+    ImageNotFound = 2,
+    InputNotFound = 3,
+    SubmitNotFound = 4,
+    CapachaResultError = 5,
+    MaxCapachaRetryReached = 6,
+    SubImageNotFound = 7,
+    Unknown = 100
+}
+export declare enum ElementNotFoundHandleType {
+    NotHandle = 0,
+    AllowEmpty = 1,
+    AllowSkip = 2,
+    SetBackup = 3,
+    ModifyXPath = 4
+}
+export declare enum LocalCaptchaType {
+    /** 图片验证码,答案是字符串的类型(text) */
+    TextInput = 0,
+    /** 数字字母混合 */
+    Chars = 1,
+    /** 需要一次或者多次拖动([p1a, p1b, speed1], [p2a, p2b, speed2]) */
+    Drags = 2,
+    /** 谷歌验证码 V2 版本 */
+    reCAPTCHA_V2 = 3,
+    /** hCaptcha */
+    HCaptcha = 4,
+    /** 滑块拼图验证码 */
+    Silder = 64,
+    /** 点选验证码 */
+    Click = 65,
+    /** 滑动验证码（没有缺口和背景图，直接滑动到底的类型） */
+    SilderWithoutImage = 128,
+    /** 谷歌验证码V3 版本 */
+    ReCAPTCHA_V3 = 63,
+    /** 使用callback解决的方式 */
+    reCAPTCHA_V2_Callback = 100,
+    HCaptcha_Callback = 101,
+    reCAPTCHA_V3_Callback = 102,
+    Cloudflare = 999
+}
+export declare enum CaptchaAvailableStatus {
+    None = 0,
+    Success = 1,
+    AccountExpired = 2,
+    NoBalance = 3,
+    ReachTodayLimit = 4,
+    ServerError = 9
+}
+export declare enum IpProxyFromType {
+    None = 0,
+    Strong = 1,
+    Custom = 2,
+    Fake = 3
+}
+export declare enum UserAgentSwitchType {
+    None = 0,
+    Custom = 1,
+    FollowIP = 2
+}
+export declare enum CookieClearType {
+    None = 0,
+    Custom = 1,
+    FollowIP = 2
+}
+export declare enum CaptchaEventType {
+    /** 发送验证码参数事件 */
+    RequestCaptchaToken = "request-captcha-token",
+    /** 获取验证码Token事件 */
+    DeliverCaptchaToken = "deliver-captcha-token"
+}
+/** 下载文件字段文件命名方式 */
+export declare enum DownloadFileRenameType {
+    SourceFileName = 0,
+    SourceFileMD5 = 1,
+    AcquisitionTime = 2,
+    FieldValue = 3
+}
+/** 文件名称重复时操作方式 */
+export declare enum DownloadFileNameRepeatType {
+    AutoRename = 0,
+    Cover = 1,
+    SkipNonDownload = 2
+}
+/** 包含多个URL的间隔方式 */
+export declare enum MutipleUrlSplitType {
+    LineBreak = 0,
+    Comma = 1,
+    Blank = 2
+}