@keboola/api-client 25.0.0 → 29.0.0

package/dist/queue/index.d.cts

@@ -1,337 +1,414 @@
-import { G as GetQueueJobPath, c as components, S as SearchJobsQuery, a as SearchAllJobsQuery, C as CreateJobBody, K as KillJobPath, b as SearchGroupedJobsQuery, O as OrchestrationRerunPlanPath } from '../types-BX1xr4CX.cjs';
-import { C as ClientInitOptions } from '../types-UwuKN9Kx.cjs';
-import '../types-gcShAmmi.cjs';
-import 'qs';
-
+import { ut as Poller } from "../index-DplMbm9E.cjs";
+import { n as ClientInitOptions } from "../types-C8XiTXxi.cjs";
+import { a as OrchestrationRerunPlanPath, c as SearchAllJobsQuery, d as SearchJobsQuery, l as SearchGroupedJobsQuery, n as GetQueueJobPath, p as components, r as KillJobPath, t as CreateJobBody } from "../types-CexuN7Mw.cjs";
+//#region src/clients/queue/queueClient.d.ts
 declare const createQueueClient: ({ baseUrl, middlewares, auth }: ClientInitOptions) => {
-    getJob: (jobId: GetQueueJobPath["jobId"], signal?: AbortSignal) => Promise<{
-        id: string;
-        runId: string;
-        branchId?: string;
-        project: {
-            id: string;
-        };
-        token: {
-            id?: string;
-            description?: string;
-        };
-        status: components["schemas"]["JobStatus"];
-        desiredStatus?: "processing" | "terminating" | null;
-        component: string;
-        mode: "run" | "debug";
-        tag?: string | null;
-        config?: string | null;
-        configRow?: string | null;
-        configData?: Record<string, never> | null;
-        result?: {
-            images?: {
-                digests?: string[];
-                id?: string;
-            }[];
-            configVersion?: number;
-            message?: string;
-        } | null;
-        createdTime: string;
-        startTime?: string | null;
-        endTime?: string | null;
-        delayedStartTime?: string | null;
-        durationSeconds?: number | null;
-        isFinished: boolean;
-        url: string;
-        variableValuesId?: string | null;
-        variableValuesData?: {
-            values?: {
-                name?: string;
-                value?: string;
-            }[];
-        } | null;
-        backend?: {
-            type?: string;
-            containerType?: string;
-            context?: string;
-        } | null;
-        metrics?: {
-            storage?: {
-                inputTablesBytesSum?: number;
-                outputTablesBytesSum?: number;
-            };
-            backend?: {
-                type?: string;
-                containerType?: string;
-                context?: string;
-            };
-        } | null;
-        type?: components["schemas"]["JobType"];
-        orchestrationTaskId?: string | null;
-        previousJobId?: string | null;
-        onlyOrchestrationTaskIds?: string[] | null;
-    }>;
-    searchJobs: (query?: SearchJobsQuery, signal?: AbortSignal) => Promise<{
-        id: string;
-        runId: string;
-        branchId?: string;
-        project: {
-            id: string;
-        };
-        token: {
-            id?: string;
-            description?: string;
-        };
-        status: components["schemas"]["JobStatus"];
-        desiredStatus?: "processing" | "terminating" | null;
-        component: string;
-        mode: "run" | "debug";
-        tag?: string | null;
-        config?: string | null;
-        configRow?: string | null;
-        configData?: Record<string, never> | null;
-        result?: {
-            images?: {
-                digests?: string[];
-                id?: string;
-            }[];
-            configVersion?: number;
-            message?: string;
-        } | null;
-        createdTime: string;
-        startTime?: string | null;
-        endTime?: string | null;
-        delayedStartTime?: string | null;
-        durationSeconds?: number | null;
-        isFinished: boolean;
-        url: string;
-        variableValuesId?: string | null;
-        variableValuesData?: {
-            values?: {
-                name?: string;
-                value?: string;
-            }[];
-        } | null;
-        backend?: {
-            type?: string;
-            containerType?: string;
-            context?: string;
-        } | null;
-        metrics?: {
-            storage?: {
-                inputTablesBytesSum?: number;
-                outputTablesBytesSum?: number;
-            };
-            backend?: {
-                type?: string;
-                containerType?: string;
-                context?: string;
-            };
-        } | null;
-        type?: components["schemas"]["JobType"];
-        orchestrationTaskId?: string | null;
-        previousJobId?: string | null;
-        onlyOrchestrationTaskIds?: string[] | null;
-    }[]>;
-    searchAllJobs: (query: SearchAllJobsQuery, signal?: AbortSignal) => Promise<{
-        id: string;
-        runId: string;
-        branchId?: string;
-        project: {
-            id: string;
-        };
-        token: {
-            id?: string;
-            description?: string;
-        };
-        status: components["schemas"]["JobStatus"];
-        desiredStatus?: "processing" | "terminating" | null;
-        component: string;
-        mode: "run" | "debug";
-        tag?: string | null;
-        config?: string | null;
-        configRow?: string | null;
-        configData?: Record<string, never> | null;
-        result?: {
-            images?: {
-                digests?: string[];
-                id?: string;
-            }[];
-            configVersion?: number;
-            message?: string;
-        } | null;
-        createdTime: string;
-        startTime?: string | null;
-        endTime?: string | null;
-        delayedStartTime?: string | null;
-        durationSeconds?: number | null;
-        isFinished: boolean;
-        url: string;
-        variableValuesId?: string | null;
-        variableValuesData?: {
-            values?: {
-                name?: string;
-                value?: string;
-            }[];
-        } | null;
-        backend?: {
-            type?: string;
-            containerType?: string;
-            context?: string;
-        } | null;
-        metrics?: {
-            storage?: {
-                inputTablesBytesSum?: number;
-                outputTablesBytesSum?: number;
-            };
-            backend?: {
-                type?: string;
-                containerType?: string;
-                context?: string;
-            };
-        } | null;
-        type?: components["schemas"]["JobType"];
-        orchestrationTaskId?: string | null;
-        previousJobId?: string | null;
-        onlyOrchestrationTaskIds?: string[] | null;
-    }[]>;
-    createJob: (body: CreateJobBody, signal?: AbortSignal) => Promise<{
-        id: string;
-        runId: string;
-        branchId?: string;
-        project: {
-            id: string;
-        };
-        token: {
-            id?: string;
-            description?: string;
-        };
-        status: components["schemas"]["JobStatus"];
-        desiredStatus?: "processing" | "terminating" | null;
-        component: string;
-        mode: "run" | "debug";
-        tag?: string | null;
-        config?: string | null;
-        configRow?: string | null;
-        configData?: Record<string, never> | null;
-        result?: {
-            images?: {
-                digests?: string[];
-                id?: string;
-            }[];
-            configVersion?: number;
-            message?: string;
-        } | null;
-        createdTime: string;
-        startTime?: string | null;
-        endTime?: string | null;
-        delayedStartTime?: string | null;
-        durationSeconds?: number | null;
-        isFinished: boolean;
-        url: string;
-        variableValuesId?: string | null;
-        variableValuesData?: {
-            values?: {
-                name?: string;
-                value?: string;
-            }[];
-        } | null;
-        backend?: {
-            type?: string;
-            containerType?: string;
-            context?: string;
-        } | null;
-        metrics?: {
-            storage?: {
-                inputTablesBytesSum?: number;
-                outputTablesBytesSum?: number;
-            };
-            backend?: {
-                type?: string;
-                containerType?: string;
-                context?: string;
-            };
-        } | null;
-        type?: components["schemas"]["JobType"];
-        orchestrationTaskId?: string | null;
-        previousJobId?: string | null;
-        onlyOrchestrationTaskIds?: string[] | null;
-    }>;
-    killJob: (jobId: KillJobPath["jobId"], signal?: AbortSignal) => Promise<{
-        id: string;
-        runId: string;
-        branchId?: string;
-        project: {
-            id: string;
-        };
-        token: {
-            id?: string;
-            description?: string;
-        };
-        status: components["schemas"]["JobStatus"];
-        desiredStatus?: "processing" | "terminating" | null;
-        component: string;
-        mode: "run" | "debug";
-        tag?: string | null;
-        config?: string | null;
-        configRow?: string | null;
-        configData?: Record<string, never> | null;
-        result?: {
-            images?: {
-                digests?: string[];
-                id?: string;
-            }[];
-            configVersion?: number;
-            message?: string;
-        } | null;
-        createdTime: string;
-        startTime?: string | null;
-        endTime?: string | null;
-        delayedStartTime?: string | null;
-        durationSeconds?: number | null;
-        isFinished: boolean;
-        url: string;
-        variableValuesId?: string | null;
-        variableValuesData?: {
-            values?: {
-                name?: string;
-                value?: string;
-            }[];
-        } | null;
-        backend?: {
-            type?: string;
-            containerType?: string;
-            context?: string;
-        } | null;
-        metrics?: {
-            storage?: {
-                inputTablesBytesSum?: number;
-                outputTablesBytesSum?: number;
-            };
-            backend?: {
-                type?: string;
-                containerType?: string;
-                context?: string;
-            };
-        } | null;
-        type?: components["schemas"]["JobType"];
-        orchestrationTaskId?: string | null;
-        previousJobId?: string | null;
-        onlyOrchestrationTaskIds?: string[] | null;
-    }>;
-    searchGroupedJobs: (query: SearchGroupedJobsQuery, signal?: AbortSignal) => Promise<{
-        group?: {
-            [key: string]: string;
-        };
-        jobs?: components["schemas"]["Job"][];
-    }[]>;
-    getOrchestrationRerunPlan: (jobId: OrchestrationRerunPlanPath["jobId"], signal?: AbortSignal) => Promise<{
-        jobId?: string;
-        configId?: string | null;
-        matchedTasks?: {
-            taskId?: string;
-            matched?: boolean;
-            jobId?: string | null;
-            componentId?: string | null;
-            configId?: string | null;
-            status?: components["schemas"]["JobStatus"] & unknown;
-        }[];
-    }>;
+  healthCheck: (signal?: AbortSignal) => Promise<unknown>;
+  poller: ({ id, component }: {
+    id: GetQueueJobPath['jobId'];
+    component: string;
+  }, { interval, maxAttempts, timeout, signal }?: {
+    interval?: number;
+    maxAttempts?: number;
+    timeout?: number;
+    signal?: AbortSignal;
+  }) => Poller<{
+    id: string;
+    runId: string;
+    branchId?: string;
+    project: {
+      id: string;
+    };
+    token: {
+      id?: string;
+      description?: string;
+    };
+    status: components['schemas']['JobStatus'];
+    desiredStatus?: 'processing' | 'terminating' | null;
+    component: string;
+    mode: 'run' | 'debug';
+    tag?: string | null;
+    config?: string | null;
+    configRow?: string | null;
+    configData?: Record<string, never> | null;
+    result?: {
+      images?: {
+        digests?: string[];
+        id?: string;
+      }[];
+      configVersion?: number;
+      message?: string;
+    } | null;
+    createdTime: string;
+    startTime?: string | null;
+    endTime?: string | null;
+    delayedStartTime?: string | null;
+    durationSeconds?: number | null;
+    isFinished: boolean;
+    url: string;
+    variableValuesId?: string | null;
+    variableValuesData?: {
+      values?: {
+        name?: string;
+        value?: string;
+      }[];
+    } | null;
+    backend?: {
+      type?: string;
+      containerType?: string;
+      context?: string;
+    } | null;
+    metrics?: {
+      storage?: {
+        inputTablesBytesSum?: number;
+        outputTablesBytesSum?: number;
+      };
+      backend?: {
+        type?: string;
+        containerType?: string;
+        context?: string;
+      };
+    } | null;
+    type?: components['schemas']['JobType'];
+    orchestrationTaskId?: string | null;
+    previousJobId?: string | null;
+    onlyOrchestrationTaskIds?: string[] | null;
+    onlyFlowTaskIds?: string[] | null;
+  }>;
+  getJob: (jobId: GetQueueJobPath['jobId'], signal?: AbortSignal) => Promise<{
+    id: string;
+    runId: string;
+    branchId?: string;
+    project: {
+      id: string;
+    };
+    token: {
+      id?: string;
+      description?: string;
+    };
+    status: components['schemas']['JobStatus'];
+    desiredStatus?: 'processing' | 'terminating' | null;
+    component: string;
+    mode: 'run' | 'debug';
+    tag?: string | null;
+    config?: string | null;
+    configRow?: string | null;
+    configData?: Record<string, never> | null;
+    result?: {
+      images?: {
+        digests?: string[];
+        id?: string;
+      }[];
+      configVersion?: number;
+      message?: string;
+    } | null;
+    createdTime: string;
+    startTime?: string | null;
+    endTime?: string | null;
+    delayedStartTime?: string | null;
+    durationSeconds?: number | null;
+    isFinished: boolean;
+    url: string;
+    variableValuesId?: string | null;
+    variableValuesData?: {
+      values?: {
+        name?: string;
+        value?: string;
+      }[];
+    } | null;
+    backend?: {
+      type?: string;
+      containerType?: string;
+      context?: string;
+    } | null;
+    metrics?: {
+      storage?: {
+        inputTablesBytesSum?: number;
+        outputTablesBytesSum?: number;
+      };
+      backend?: {
+        type?: string;
+        containerType?: string;
+        context?: string;
+      };
+    } | null;
+    type?: components['schemas']['JobType'];
+    orchestrationTaskId?: string | null;
+    previousJobId?: string | null;
+    onlyOrchestrationTaskIds?: string[] | null;
+    onlyFlowTaskIds?: string[] | null;
+  }>;
+  searchJobs: (query?: SearchJobsQuery, signal?: AbortSignal) => Promise<{
+    id: string;
+    runId: string;
+    branchId?: string;
+    project: {
+      id: string;
+    };
+    token: {
+      id?: string;
+      description?: string;
+    };
+    status: components['schemas']['JobStatus'];
+    desiredStatus?: 'processing' | 'terminating' | null;
+    component: string;
+    mode: 'run' | 'debug';
+    tag?: string | null;
+    config?: string | null;
+    configRow?: string | null;
+    configData?: Record<string, never> | null;
+    result?: {
+      images?: {
+        digests?: string[];
+        id?: string;
+      }[];
+      configVersion?: number;
+      message?: string;
+    } | null;
+    createdTime: string;
+    startTime?: string | null;
+    endTime?: string | null;
+    delayedStartTime?: string | null;
+    durationSeconds?: number | null;
+    isFinished: boolean;
+    url: string;
+    variableValuesId?: string | null;
+    variableValuesData?: {
+      values?: {
+        name?: string;
+        value?: string;
+      }[];
+    } | null;
+    backend?: {
+      type?: string;
+      containerType?: string;
+      context?: string;
+    } | null;
+    metrics?: {
+      storage?: {
+        inputTablesBytesSum?: number;
+        outputTablesBytesSum?: number;
+      };
+      backend?: {
+        type?: string;
+        containerType?: string;
+        context?: string;
+      };
+    } | null;
+    type?: components['schemas']['JobType'];
+    orchestrationTaskId?: string | null;
+    previousJobId?: string | null;
+    onlyOrchestrationTaskIds?: string[] | null;
+    onlyFlowTaskIds?: string[] | null;
+  }[]>;
+  searchAllJobs: (query: SearchAllJobsQuery, signal?: AbortSignal) => Promise<{
+    id: string;
+    runId: string;
+    branchId?: string;
+    project: {
+      id: string;
+    };
+    token: {
+      id?: string;
+      description?: string;
+    };
+    status: components['schemas']['JobStatus'];
+    desiredStatus?: 'processing' | 'terminating' | null;
+    component: string;
+    mode: 'run' | 'debug';
+    tag?: string | null;
+    config?: string | null;
+    configRow?: string | null;
+    configData?: Record<string, never> | null;
+    result?: {
+      images?: {
+        digests?: string[];
+        id?: string;
+      }[];
+      configVersion?: number;
+      message?: string;
+    } | null;
+    createdTime: string;
+    startTime?: string | null;
+    endTime?: string | null;
+    delayedStartTime?: string | null;
+    durationSeconds?: number | null;
+    isFinished: boolean;
+    url: string;
+    variableValuesId?: string | null;
+    variableValuesData?: {
+      values?: {
+        name?: string;
+        value?: string;
+      }[];
+    } | null;
+    backend?: {
+      type?: string;
+      containerType?: string;
+      context?: string;
+    } | null;
+    metrics?: {
+      storage?: {
+        inputTablesBytesSum?: number;
+        outputTablesBytesSum?: number;
+      };
+      backend?: {
+        type?: string;
+        containerType?: string;
+        context?: string;
+      };
+    } | null;
+    type?: components['schemas']['JobType'];
+    orchestrationTaskId?: string | null;
+    previousJobId?: string | null;
+    onlyOrchestrationTaskIds?: string[] | null;
+    onlyFlowTaskIds?: string[] | null;
+  }[]>;
+  createJob: (body: CreateJobBody, signal?: AbortSignal) => Promise<{
+    id: string;
+    runId: string;
+    branchId?: string;
+    project: {
+      id: string;
+    };
+    token: {
+      id?: string;
+      description?: string;
+    };
+    status: components['schemas']['JobStatus'];
+    desiredStatus?: 'processing' | 'terminating' | null;
+    component: string;
+    mode: 'run' | 'debug';
+    tag?: string | null;
+    config?: string | null;
+    configRow?: string | null;
+    configData?: Record<string, never> | null;
+    result?: {
+      images?: {
+        digests?: string[];
+        id?: string;
+      }[];
+      configVersion?: number;
+      message?: string;
+    } | null;
+    createdTime: string;
+    startTime?: string | null;
+    endTime?: string | null;
+    delayedStartTime?: string | null;
+    durationSeconds?: number | null;
+    isFinished: boolean;
+    url: string;
+    variableValuesId?: string | null;
+    variableValuesData?: {
+      values?: {
+        name?: string;
+        value?: string;
+      }[];
+    } | null;
+    backend?: {
+      type?: string;
+      containerType?: string;
+      context?: string;
+    } | null;
+    metrics?: {
+      storage?: {
+        inputTablesBytesSum?: number;
+        outputTablesBytesSum?: number;
+      };
+      backend?: {
+        type?: string;
+        containerType?: string;
+        context?: string;
+      };
+    } | null;
+    type?: components['schemas']['JobType'];
+    orchestrationTaskId?: string | null;
+    previousJobId?: string | null;
+    onlyOrchestrationTaskIds?: string[] | null;
+    onlyFlowTaskIds?: string[] | null;
+  }>;
+  killJob: (jobId: KillJobPath['jobId'], signal?: AbortSignal) => Promise<{
+    id: string;
+    runId: string;
+    branchId?: string;
+    project: {
+      id: string;
+    };
+    token: {
+      id?: string;
+      description?: string;
+    };
+    status: components['schemas']['JobStatus'];
+    desiredStatus?: 'processing' | 'terminating' | null;
+    component: string;
+    mode: 'run' | 'debug';
+    tag?: string | null;
+    config?: string | null;
+    configRow?: string | null;
+    configData?: Record<string, never> | null;
+    result?: {
+      images?: {
+        digests?: string[];
+        id?: string;
+      }[];
+      configVersion?: number;
+      message?: string;
+    } | null;
+    createdTime: string;
+    startTime?: string | null;
+    endTime?: string | null;
+    delayedStartTime?: string | null;
+    durationSeconds?: number | null;
+    isFinished: boolean;
+    url: string;
+    variableValuesId?: string | null;
+    variableValuesData?: {
+      values?: {
+        name?: string;
+        value?: string;
+      }[];
+    } | null;
+    backend?: {
+      type?: string;
+      containerType?: string;
+      context?: string;
+    } | null;
+    metrics?: {
+      storage?: {
+        inputTablesBytesSum?: number;
+        outputTablesBytesSum?: number;
+      };
+      backend?: {
+        type?: string;
+        containerType?: string;
+        context?: string;
+      };
+    } | null;
+    type?: components['schemas']['JobType'];
+    orchestrationTaskId?: string | null;
+    previousJobId?: string | null;
+    onlyOrchestrationTaskIds?: string[] | null;
+    onlyFlowTaskIds?: string[] | null;
+  }>;
+  searchGroupedJobs: (query: SearchGroupedJobsQuery, signal?: AbortSignal) => Promise<{
+    group?: {
+      [key: string]: string;
+    };
+    jobs?: components['schemas']['Job'][];
+  }[]>;
+  getOrchestrationRerunPlan: (jobId: OrchestrationRerunPlanPath['jobId'], signal?: AbortSignal) => Promise<{
+    jobId?: string;
+    configId?: string | null;
+    matchedTasks?: {
+      taskId?: string;
+      matched?: boolean;
+      jobId?: string | null;
+      componentId?: string | null;
+      configId?: string | null;
+      status?: components['schemas']['JobStatus'] & unknown;
+    }[];
+  }>;
 };
-
+//#endregion
 export { createQueueClient };
+//# sourceMappingURL=index.d.cts.map