@hira-core/sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,266 @@
+import * as puppeteer from 'puppeteer-core';
+import { Browser, Page, Frame, ElementHandle } from 'puppeteer-core';
+import { EventEmitter } from 'events';
+import { IWorkerLogMessage, ProfileStatus } from '@packages/shared';
+
+interface IGpmProfile {
+    id: string;
+    name: string;
+    raw_proxy?: string;
+    browser_type: "chromium" | "firefox";
+    browser_version: string;
+    group_id?: string;
+    profile_path: string;
+    note: string;
+    created_at: string;
+}
+type IInputType = "text" | "number" | "boolean" | "select" | "textarea";
+type InputTypeMap = {
+    text: string;
+    number: number;
+    boolean: boolean;
+    select: string;
+    textarea: string;
+};
+interface IInputField {
+    key: string;
+    label: string;
+    type: IInputType;
+    required?: boolean;
+    defaultValue?: string | number | boolean;
+    placeholder?: string;
+    options?: {
+        label: string;
+        value: string | number;
+    }[];
+}
+interface IFlowConfig {
+    globalInput: readonly IInputField[];
+    profileInput: readonly IInputField[];
+}
+type InferFields<T extends readonly IInputField[]> = {
+    [K in T[number] as K["key"]]: K["type"] extends keyof InputTypeMap ? InputTypeMap[K["type"]] : unknown;
+};
+type InferGlobalInput<T extends IFlowConfig> = InferFields<T["globalInput"]>;
+type InferProfileInput<T extends IFlowConfig> = InferFields<T["profileInput"]>;
+interface IProfileSetting<TProfileInput = Record<string, unknown>> {
+    profileName: string;
+    data?: TProfileInput;
+}
+interface IAntidetectConfig<TProfileInput = Record<string, unknown>> {
+    name: string;
+    profileSettings: IProfileSetting<TProfileInput>[];
+}
+interface IExecutionConfig {
+    concurrency: number;
+    delayBetweenProfilesMs?: number;
+    maxRetries?: number;
+    keepOpenOnError?: boolean;
+}
+interface IBrowserWindowConfig {
+    width: number;
+    height: number;
+    scale: number;
+}
+interface IFlowRunParams<TConfig extends IFlowConfig = IFlowConfig> {
+    antidetect: IAntidetectConfig<Partial<InferProfileInput<TConfig>>>;
+    execution: IExecutionConfig;
+    window: IBrowserWindowConfig;
+    globalInput?: InferGlobalInput<TConfig>;
+}
+type FlowLogLevel = "info" | "warn" | "error" | "debug" | "success";
+interface IFlowLogEntry {
+    level: FlowLogLevel;
+    message: string;
+    timestamp: string;
+    context?: string;
+    metadata?: any;
+}
+type LogContext = string | number | boolean | null | undefined | Error | Record<string, unknown> | Array<unknown> | unknown;
+interface ILogger {
+    log(message: string, context?: LogContext): void;
+    info(message: string, context?: LogContext): void;
+    warn(message: string, context?: LogContext): void;
+    error(message: string, context?: LogContext): void;
+    debug(message: string, context?: LogContext): void;
+    success(message: string, context?: LogContext): void;
+    logWithProfile(level: string, message: string, profileName: string, context?: LogContext): void;
+}
+interface IScriptContext<TConfig extends IFlowConfig = IFlowConfig> {
+    browser: Browser;
+    page: Page;
+    profile: IGpmProfile;
+    index: number;
+    globalInput: InferGlobalInput<TConfig>;
+    profileInput: InferProfileInput<TConfig>;
+    logger: ILogger;
+}
+interface IBrowserAdapter {
+    open(profileName: string, index: number, windowConfig?: IBrowserWindowConfig): Promise<{
+        browser: Browser;
+        page: Page;
+        profile: IGpmProfile;
+    }>;
+    close(profileId: string): Promise<void>;
+}
+interface IGpmStartProfileParams {
+    profile_id: string;
+    addination_args?: string;
+    win_scale?: number;
+    win_pos?: string;
+    win_size?: string;
+}
+interface IResGpmStartProfileData {
+    success: boolean;
+    profile_id: string;
+    browser_location: string;
+    remote_debugging_address: string;
+    driver_path: string;
+}
+interface IGpmRes<T> {
+    success: boolean;
+    data?: T;
+    message: string;
+}
+interface IGpmResListProfile {
+    success: boolean;
+    data: IGpmProfile[];
+    pagination: {
+        total: number;
+        page: number;
+        page_size: number;
+        total_page: number;
+    };
+    message: string;
+}
+interface IGpmListProfilesParams {
+    group_id?: string;
+    page?: number;
+    per_page?: number;
+    sort?: number;
+    search?: string[];
+}
+
+declare abstract class BaseFlow<TConfig extends IFlowConfig = IFlowConfig> {
+    protected logger: ILogger;
+    protected browserAdapter: IBrowserAdapter;
+    readonly flowConfig: TConfig;
+    constructor(logger: ILogger, browserAdapter: IBrowserAdapter, config: TConfig);
+    protected log(message: string, profileName?: string): void;
+    protected error(message: string, profileName?: string): void;
+    protected sleep(ms: number): Promise<void>;
+    run(params: IFlowRunParams<TConfig>): Promise<void>;
+    protected processProfileWithRetry(setting: IProfileSetting<Partial<InferProfileInput<TConfig>>>, index: number, params: IFlowRunParams<TConfig>): Promise<void>;
+    private processProfile;
+    abstract script(context: IScriptContext<TConfig>): Promise<unknown>;
+    createProfileSetting(profileName: string, data?: Partial<InferProfileInput<TConfig>>): IProfileSetting<Partial<InferProfileInput<TConfig>>>;
+    createRunParams(params: IFlowRunParams<TConfig>): IFlowRunParams<TConfig>;
+}
+type FlowRunParams<T extends BaseFlow<any>> = T extends BaseFlow<infer TConfig> ? IFlowRunParams<TConfig> : never;
+type FlowProfileSetting<T extends BaseFlow<any>> = T extends BaseFlow<infer TConfig> ? IProfileSetting<Partial<InferProfileInput<TConfig>>> : never;
+
+declare enum AntidetectProvider {
+    GPM = "gpm",
+    HIDEMIUM = "hidemium",
+    GENLOGIN = "genlogin"
+}
+declare abstract class AntidetectBaseFlow<TConfig extends IFlowConfig = IFlowConfig> extends BaseFlow<TConfig> {
+    protected provider: AntidetectProvider;
+    constructor(provider: AntidetectProvider, logger: ILogger, config: TConfig);
+    get currentAdapter(): IBrowserAdapter;
+}
+
+declare class GpmService {
+    private api;
+    private apiUrl;
+    constructor(apiUrl?: string);
+    startProfile(params: IGpmStartProfileParams, maxRetries?: number, delayMs?: number): Promise<IResGpmStartProfileData | null>;
+    stopProfile(id: string, maxRetries?: number, delayMs?: number): Promise<boolean>;
+    getProfiles(params?: IGpmListProfilesParams): Promise<IGpmProfile[]>;
+    createProfile(config: Partial<IGpmProfile>): Promise<IGpmProfile | null>;
+    deleteProfile(id: string): Promise<boolean>;
+    updateProxy(id: string, proxy: string): Promise<boolean>;
+    checkHealth(): Promise<boolean>;
+    connectToBrowser(debugAddress: string, maxRetries?: number, delayMs?: number): Promise<Browser>;
+}
+
+declare class GpmStandaloneAdapter implements IBrowserAdapter {
+    private apiUrl;
+    private screenResolution;
+    readonly service: GpmService;
+    private readonly openedProfiles;
+    private readonly pendingProfiles;
+    private readonly logger;
+    private readonly boundLoggers;
+    constructor(logger: ILogger);
+    private getBoundLogger;
+    open(profileName: string, index: number, windowConfig: IBrowserWindowConfig): Promise<{
+        browser: puppeteer.Browser;
+        page: puppeteer.Page;
+        profile: IGpmProfile;
+    }>;
+    close(profileId: string): Promise<void>;
+    closeAll(delayBetweenMs?: number): Promise<void>;
+}
+
+declare class BrowserUtils {
+    private ctx;
+    private logger;
+    constructor(context: IScriptContext);
+    private checkAbort;
+    sleep(ms: number): Promise<void>;
+    waitForElement(selector: string, timeout?: number, scope?: Frame): Promise<ElementHandle | null>;
+    click(target: string | ElementHandle, options?: {
+        delay?: number;
+        timeout?: number;
+        frame?: Frame;
+    }): Promise<boolean>;
+    type(selector: string, text: string, options?: {
+        delay?: number;
+        frame?: Frame;
+    }): Promise<boolean>;
+    getText(selector: string, frame?: Frame): Promise<string | null>;
+    exists(selector: string, timeout?: number, frame?: Frame): Promise<boolean>;
+    goto(url: string, options?: {
+        waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2";
+    }): Promise<boolean>;
+    waitForNavigation(options?: {
+        timeout?: number;
+        waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2";
+    }): Promise<boolean>;
+    screenshot(path?: string): Promise<unknown>;
+    switchToPopup(matcher: string | RegExp, timeout?: number): Promise<puppeteer.Page | null>;
+    switchToTabIndex(index: number): Promise<puppeteer.Page | null>;
+    closeCurrentTab(): Promise<void>;
+    closeOtherTabs(): Promise<void>;
+    logConfig(config: Record<string, unknown>, label?: string): Promise<void>;
+    logProfileInput(): Promise<void>;
+    logGlobalInput(): Promise<void>;
+    private shortSelector;
+    private log;
+    private actionDelay;
+    private rawSleep;
+}
+
+declare class FlowLogger extends EventEmitter implements ILogger {
+    private _context?;
+    private parentPort;
+    private readonly isWorker;
+    constructor(_context?: string | undefined);
+    private serialize;
+    private dispatch;
+    private printToConsole;
+    private buildMsg;
+    log(message: string, context?: LogContext): void;
+    info(message: string, context?: LogContext): void;
+    success(message: string, context?: LogContext): void;
+    warn(message: string, context?: LogContext): void;
+    error(message: string, context?: LogContext): void;
+    debug(message: string, context?: LogContext): void;
+    custom(label: string, message: string, color?: string): void;
+    logWithProfile(level: IWorkerLogMessage["level"], message: string, profileName: string, context?: LogContext): void;
+    createBoundLogger(profileName: string): ILogger;
+    profileEvent(profileName: string, message: string, status: ProfileStatus, context?: LogContext): void;
+}
+
+export { AntidetectBaseFlow, AntidetectProvider, BaseFlow, BrowserUtils, type FlowLogLevel, FlowLogger, type FlowProfileSetting, type FlowRunParams, GpmStandaloneAdapter, type IAntidetectConfig, type IBrowserAdapter, type IBrowserWindowConfig, type IExecutionConfig, type IFlowConfig, type IFlowLogEntry, type IFlowRunParams, type IGpmListProfilesParams, type IGpmProfile, type IGpmRes, type IGpmResListProfile, type IGpmStartProfileParams, type IInputField, type ILogger, type IProfileSetting, type IResGpmStartProfileData, type IScriptContext, type InferGlobalInput, type InferProfileInput, type LogContext };