@intuned/runtime 1.0.5

package/dist/common/runApi/types.d.ts

@@ -0,0 +1,702 @@
+import type { StorageState } from "../contextStorageStateHelpers";
+import type { Payload } from "../../runtime/export";
+import type { Result } from "neverthrow";
+import type { RunAutomationError } from "./errors";
+import z from "zod";
+export interface PayloadToAppend {
+    apiName: string;
+    parameters: Record<string, any>;
+}
+export interface RunAutomationSuccessResult {
+    result: any;
+    status: number;
+    payloadToAppend: PayloadToAppend[] | null;
+    session?: StorageState;
+}
+export interface RunAutomationErrorResult {
+    error: string;
+    message: string;
+    status?: number;
+    details?: any;
+    [key: string]: any;
+}
+export type RunAutomationResult = RunAutomationSuccessResult | RunAutomationErrorResult;
+export interface RunAutomationResponse {
+    status: number;
+    body: RunAutomationResult;
+}
+export declare const runApiSessionSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"file">;
+    path: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "file";
+    path: string;
+}, {
+    type: "file";
+    path: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"state">;
+    state: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        cookies: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            value: z.ZodString;
+            domain: z.ZodString;
+            path: z.ZodString;
+            expires: z.ZodNumber;
+            httpOnly: z.ZodBoolean;
+            secure: z.ZodBoolean;
+            sameSite: z.ZodEnum<["Strict", "Lax", "None"]>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            name: string;
+            path: string;
+            domain: string;
+            expires: number;
+            httpOnly: boolean;
+            secure: boolean;
+            sameSite: "Strict" | "Lax" | "None";
+        }, {
+            value: string;
+            name: string;
+            path: string;
+            domain: string;
+            expires: number;
+            httpOnly: boolean;
+            secure: boolean;
+            sameSite: "Strict" | "Lax" | "None";
+        }>, "many">;
+        origins: z.ZodArray<z.ZodObject<{
+            origin: z.ZodString;
+            localStorage: z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+                value: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                value: string;
+                name: string;
+            }, {
+                value: string;
+                name: string;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            origin: string;
+            localStorage: {
+                value: string;
+                name: string;
+            }[];
+        }, {
+            origin: string;
+            localStorage: {
+                value: string;
+                name: string;
+            }[];
+        }>, "many">;
+        sessionStorage: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            origin: z.ZodString;
+            sessionStorage: z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+                value: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                value: string;
+                name: string;
+            }, {
+                value: string;
+                name: string;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            sessionStorage: {
+                value: string;
+                name: string;
+            }[];
+            origin: string;
+        }, {
+            sessionStorage: {
+                value: string;
+                name: string;
+            }[];
+            origin: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        cookies: {
+            value: string;
+            name: string;
+            path: string;
+            domain: string;
+            expires: number;
+            httpOnly: boolean;
+            secure: boolean;
+            sameSite: "Strict" | "Lax" | "None";
+        }[];
+        origins: {
+            origin: string;
+            localStorage: {
+                value: string;
+                name: string;
+            }[];
+        }[];
+        sessionStorage?: {
+            sessionStorage: {
+                value: string;
+                name: string;
+            }[];
+            origin: string;
+        }[] | undefined;
+    }, {
+        cookies: {
+            value: string;
+            name: string;
+            path: string;
+            domain: string;
+            expires: number;
+            httpOnly: boolean;
+            secure: boolean;
+            sameSite: "Strict" | "Lax" | "None";
+        }[];
+        origins: {
+            origin: string;
+            localStorage: {
+                value: string;
+                name: string;
+            }[];
+        }[];
+        sessionStorage?: {
+            sessionStorage: {
+                value: string;
+                name: string;
+            }[];
+            origin: string;
+        }[] | undefined;
+    }>>>;
+}, "strip", z.ZodTypeAny, {
+    type: "state";
+    state?: {
+        cookies: {
+            value: string;
+            name: string;
+            path: string;
+            domain: string;
+            expires: number;
+            httpOnly: boolean;
+            secure: boolean;
+            sameSite: "Strict" | "Lax" | "None";
+        }[];
+        origins: {
+            origin: string;
+            localStorage: {
+                value: string;
+                name: string;
+            }[];
+        }[];
+        sessionStorage?: {
+            sessionStorage: {
+                value: string;
+                name: string;
+            }[];
+            origin: string;
+        }[] | undefined;
+    } | null | undefined;
+}, {
+    type: "state";
+    state?: {
+        cookies: {
+            value: string;
+            name: string;
+            path: string;
+            domain: string;
+            expires: number;
+            httpOnly: boolean;
+            secure: boolean;
+            sameSite: "Strict" | "Lax" | "None";
+        }[];
+        origins: {
+            origin: string;
+            localStorage: {
+                value: string;
+                name: string;
+            }[];
+        }[];
+        sessionStorage?: {
+            sessionStorage: {
+                value: string;
+                name: string;
+            }[];
+            origin: string;
+        }[] | undefined;
+    } | null | undefined;
+}>]>;
+export declare const runApiParametersSchema: z.ZodObject<{
+    automationFunction: z.ZodObject<{
+        name: z.ZodString;
+        params: z.ZodOptional<z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        params?: any;
+    }, {
+        name: string;
+        params?: any;
+    }>;
+    tracing: z.ZodDefault<z.ZodOptional<z.ZodDiscriminatedUnion<"enabled", [z.ZodObject<{
+        enabled: z.ZodLiteral<false>;
+    }, "strip", z.ZodTypeAny, {
+        enabled: false;
+    }, {
+        enabled: false;
+    }>, z.ZodObject<{
+        enabled: z.ZodLiteral<true>;
+        filePath: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        enabled: true;
+        filePath: string;
+    }, {
+        enabled: true;
+        filePath: string;
+    }>]>>>;
+    auth: z.ZodOptional<z.ZodObject<{
+        session: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+            type: z.ZodLiteral<"file">;
+            path: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "file";
+            path: string;
+        }, {
+            type: "file";
+            path: string;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"state">;
+            state: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                cookies: z.ZodArray<z.ZodObject<{
+                    name: z.ZodString;
+                    value: z.ZodString;
+                    domain: z.ZodString;
+                    path: z.ZodString;
+                    expires: z.ZodNumber;
+                    httpOnly: z.ZodBoolean;
+                    secure: z.ZodBoolean;
+                    sameSite: z.ZodEnum<["Strict", "Lax", "None"]>;
+                }, "strip", z.ZodTypeAny, {
+                    value: string;
+                    name: string;
+                    path: string;
+                    domain: string;
+                    expires: number;
+                    httpOnly: boolean;
+                    secure: boolean;
+                    sameSite: "Strict" | "Lax" | "None";
+                }, {
+                    value: string;
+                    name: string;
+                    path: string;
+                    domain: string;
+                    expires: number;
+                    httpOnly: boolean;
+                    secure: boolean;
+                    sameSite: "Strict" | "Lax" | "None";
+                }>, "many">;
+                origins: z.ZodArray<z.ZodObject<{
+                    origin: z.ZodString;
+                    localStorage: z.ZodArray<z.ZodObject<{
+                        name: z.ZodString;
+                        value: z.ZodString;
+                    }, "strip", z.ZodTypeAny, {
+                        value: string;
+                        name: string;
+                    }, {
+                        value: string;
+                        name: string;
+                    }>, "many">;
+                }, "strip", z.ZodTypeAny, {
+                    origin: string;
+                    localStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                }, {
+                    origin: string;
+                    localStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                }>, "many">;
+                sessionStorage: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    origin: z.ZodString;
+                    sessionStorage: z.ZodArray<z.ZodObject<{
+                        name: z.ZodString;
+                        value: z.ZodString;
+                    }, "strip", z.ZodTypeAny, {
+                        value: string;
+                        name: string;
+                    }, {
+                        value: string;
+                        name: string;
+                    }>, "many">;
+                }, "strip", z.ZodTypeAny, {
+                    sessionStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                    origin: string;
+                }, {
+                    sessionStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                    origin: string;
+                }>, "many">>;
+            }, "strip", z.ZodTypeAny, {
+                cookies: {
+                    value: string;
+                    name: string;
+                    path: string;
+                    domain: string;
+                    expires: number;
+                    httpOnly: boolean;
+                    secure: boolean;
+                    sameSite: "Strict" | "Lax" | "None";
+                }[];
+                origins: {
+                    origin: string;
+                    localStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                }[];
+                sessionStorage?: {
+                    sessionStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                    origin: string;
+                }[] | undefined;
+            }, {
+                cookies: {
+                    value: string;
+                    name: string;
+                    path: string;
+                    domain: string;
+                    expires: number;
+                    httpOnly: boolean;
+                    secure: boolean;
+                    sameSite: "Strict" | "Lax" | "None";
+                }[];
+                origins: {
+                    origin: string;
+                    localStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                }[];
+                sessionStorage?: {
+                    sessionStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                    origin: string;
+                }[] | undefined;
+            }>>>;
+        }, "strip", z.ZodTypeAny, {
+            type: "state";
+            state?: {
+                cookies: {
+                    value: string;
+                    name: string;
+                    path: string;
+                    domain: string;
+                    expires: number;
+                    httpOnly: boolean;
+                    secure: boolean;
+                    sameSite: "Strict" | "Lax" | "None";
+                }[];
+                origins: {
+                    origin: string;
+                    localStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                }[];
+                sessionStorage?: {
+                    sessionStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                    origin: string;
+                }[] | undefined;
+            } | null | undefined;
+        }, {
+            type: "state";
+            state?: {
+                cookies: {
+                    value: string;
+                    name: string;
+                    path: string;
+                    domain: string;
+                    expires: number;
+                    httpOnly: boolean;
+                    secure: boolean;
+                    sameSite: "Strict" | "Lax" | "None";
+                }[];
+                origins: {
+                    origin: string;
+                    localStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                }[];
+                sessionStorage?: {
+                    sessionStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                    origin: string;
+                }[] | undefined;
+            } | null | undefined;
+        }>]>;
+        runCheck: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        session: {
+            type: "file";
+            path: string;
+        } | {
+            type: "state";
+            state?: {
+                cookies: {
+                    value: string;
+                    name: string;
+                    path: string;
+                    domain: string;
+                    expires: number;
+                    httpOnly: boolean;
+                    secure: boolean;
+                    sameSite: "Strict" | "Lax" | "None";
+                }[];
+                origins: {
+                    origin: string;
+                    localStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                }[];
+                sessionStorage?: {
+                    sessionStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                    origin: string;
+                }[] | undefined;
+            } | null | undefined;
+        };
+        runCheck: boolean;
+    }, {
+        session: {
+            type: "file";
+            path: string;
+        } | {
+            type: "state";
+            state?: {
+                cookies: {
+                    value: string;
+                    name: string;
+                    path: string;
+                    domain: string;
+                    expires: number;
+                    httpOnly: boolean;
+                    secure: boolean;
+                    sameSite: "Strict" | "Lax" | "None";
+                }[];
+                origins: {
+                    origin: string;
+                    localStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                }[];
+                sessionStorage?: {
+                    sessionStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                    origin: string;
+                }[] | undefined;
+            } | null | undefined;
+        };
+        runCheck?: boolean | undefined;
+    }>>;
+    runOptions: z.ZodDefault<z.ZodDiscriminatedUnion<"environment", [z.ZodObject<{
+        environment: z.ZodLiteral<"standalone">;
+        headless: z.ZodDefault<z.ZodBoolean>;
+        proxy: z.ZodOptional<z.ZodObject<{
+            server: z.ZodString;
+            username: z.ZodString;
+            password: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            server: string;
+            username: string;
+            password: string;
+        }, {
+            server: string;
+            username: string;
+            password: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        environment: "standalone";
+        headless: boolean;
+        proxy?: {
+            server: string;
+            username: string;
+            password: string;
+        } | undefined;
+    }, {
+        environment: "standalone";
+        headless?: boolean | undefined;
+        proxy?: {
+            server: string;
+            username: string;
+            password: string;
+        } | undefined;
+    }>, z.ZodObject<{
+        environment: z.ZodLiteral<"cdp">;
+        cdpAddress: z.ZodString;
+        mode: z.ZodUnion<[z.ZodLiteral<"vanilla">, z.ZodLiteral<"playwright">, z.ZodLiteral<"playwright-standalone">, z.ZodLiteral<"playwright-headless">]>;
+    }, "strip", z.ZodTypeAny, {
+        mode: "vanilla" | "playwright" | "playwright-standalone" | "playwright-headless";
+        environment: "cdp";
+        cdpAddress: string;
+    }, {
+        mode: "vanilla" | "playwright" | "playwright-standalone" | "playwright-headless";
+        environment: "cdp";
+        cdpAddress: string;
+    }>]>>;
+    retrieveSession: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    automationFunction: {
+        name: string;
+        params?: any;
+    };
+    tracing: {
+        enabled: false;
+    } | {
+        enabled: true;
+        filePath: string;
+    };
+    runOptions: {
+        environment: "standalone";
+        headless: boolean;
+        proxy?: {
+            server: string;
+            username: string;
+            password: string;
+        } | undefined;
+    } | {
+        mode: "vanilla" | "playwright" | "playwright-standalone" | "playwright-headless";
+        environment: "cdp";
+        cdpAddress: string;
+    };
+    retrieveSession: boolean;
+    auth?: {
+        session: {
+            type: "file";
+            path: string;
+        } | {
+            type: "state";
+            state?: {
+                cookies: {
+                    value: string;
+                    name: string;
+                    path: string;
+                    domain: string;
+                    expires: number;
+                    httpOnly: boolean;
+                    secure: boolean;
+                    sameSite: "Strict" | "Lax" | "None";
+                }[];
+                origins: {
+                    origin: string;
+                    localStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                }[];
+                sessionStorage?: {
+                    sessionStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                    origin: string;
+                }[] | undefined;
+            } | null | undefined;
+        };
+        runCheck: boolean;
+    } | undefined;
+}, {
+    automationFunction: {
+        name: string;
+        params?: any;
+    };
+    tracing?: {
+        enabled: false;
+    } | {
+        enabled: true;
+        filePath: string;
+    } | undefined;
+    auth?: {
+        session: {
+            type: "file";
+            path: string;
+        } | {
+            type: "state";
+            state?: {
+                cookies: {
+                    value: string;
+                    name: string;
+                    path: string;
+                    domain: string;
+                    expires: number;
+                    httpOnly: boolean;
+                    secure: boolean;
+                    sameSite: "Strict" | "Lax" | "None";
+                }[];
+                origins: {
+                    origin: string;
+                    localStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                }[];
+                sessionStorage?: {
+                    sessionStorage: {
+                        value: string;
+                        name: string;
+                    }[];
+                    origin: string;
+                }[] | undefined;
+            } | null | undefined;
+        };
+        runCheck?: boolean | undefined;
+    } | undefined;
+    runOptions?: {
+        environment: "standalone";
+        headless?: boolean | undefined;
+        proxy?: {
+            server: string;
+            username: string;
+            password: string;
+        } | undefined;
+    } | {
+        mode: "vanilla" | "playwright" | "playwright-standalone" | "playwright-headless";
+        environment: "cdp";
+        cdpAddress: string;
+    } | undefined;
+    retrieveSession?: boolean | undefined;
+}>;
+export type RunApiSession = z.infer<typeof runApiSessionSchema>;
+export type RunApiParameters = z.input<typeof runApiParametersSchema>;
+export type ExtendedRunApiParameters = RunApiParameters & {
+    abortSignal?: AbortSignal;
+    importFunction?: (name: string) => Promise<any> | undefined;
+};
+export type RunApiResultOk<R = any> = {
+    result: R;
+    extendedPayloads?: Payload[];
+};
+export type RunApiResultWithSessionOk<R = any> = RunApiResultOk<R> & {
+    session: StorageState;
+};
+export type RunApiResult<R = any, FullResult extends RunApiResultOk<R> = RunApiResultOk<R>> = Result<FullResult, RunAutomationError>;