@hatchet-dev/typescript-sdk 0.20.1 → 0.20.3

package/clients/hatchet-client/hatchet-logger.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HatchetLogger = exports.DEFAULT_LOGGER = void 0;
+/* eslint-disable no-console */
 const logger_1 = require("../../util/logger");
 const DEFAULT_LOGGER = (context, logLevel) => new HatchetLogger(context, logLevel);
 exports.DEFAULT_LOGGER = DEFAULT_LOGGER;
@@ -9,7 +10,7 @@ class HatchetLogger {
         this.logLevel = logLevel;
         this.context = context;
     }
-    log(level, message, color) {
+    log(level, message, color = '37') {
         if (logger_1.LogLevelEnum[level] >= logger_1.LogLevelEnum[this.logLevel]) {
             const time = new Date().toLocaleString('en-US', {
                 month: '2-digit',
@@ -20,7 +21,22 @@ class HatchetLogger {
                 second: '2-digit',
             });
             // eslint-disable-next-line no-console
-            console.log(`🪓 ${process.pid} | ${time} ${color && `\x1b[${color}m`} [${level}/${this.context}] ${message}\x1b[0m`);
+            // eslint-disable-next-line prefer-destructuring
+            let print = console.log;
+            if (level === 'ERROR') {
+                print = console.error;
+            }
+            if (level === 'WARN') {
+                print = console.warn;
+            }
+            if (level === 'INFO') {
+                print = console.info;
+            }
+            if (level === 'DEBUG') {
+                print = console.debug;
+            }
+            // eslint-disable-next-line no-console
+            print(`🪓 ${process.pid} | ${time} ${color && `\x1b[${color || ''}m`} [${level}/${this.context}] ${message}\x1b[0m`);
         }
     }
     debug(message) {

package/clients/listener/listener-client.js

@@ -92,6 +92,7 @@ const workflowStatusMap = {
     [data_contracts_1.WorkflowRunStatus.PENDING]: undefined,
     [data_contracts_1.WorkflowRunStatus.RUNNING]: undefined,
     [data_contracts_1.WorkflowRunStatus.QUEUED]: undefined,
+    [data_contracts_1.WorkflowRunStatus.BACKOFF]: undefined,
 };
 class RunEventListener {
     constructor(client) {

package/clients/rest/generated/Api.d.ts

@@ -1,6 +1,195 @@
-import { AcceptInviteRequest, APIErrors, APIMeta, BulkCreateEventRequest, BulkCreateEventResponse, CancelEventRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreateCronWorkflowTriggerRequest, CreateEventRequest, CreateSNSIntegrationRequest, CreateTenantAlertEmailGroupRequest, CreateTenantInviteRequest, CreateTenantRequest, CronWorkflows, CronWorkflowsList, CronWorkflowsOrderByField, Event, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, ListAPIMetaIntegration, ListAPITokensResponse, ListSlackWebhooks, ListSNSIntegrations, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, RateLimitList, RateLimitOrderByDirection, RateLimitOrderByField, RejectInviteRequest, ReplayEventRequest, ReplayWorkflowRunsRequest, ReplayWorkflowRunsResponse, RerunStepRunRequest, ScheduledRunStatus, ScheduledWorkflows, ScheduledWorkflowsList, ScheduledWorkflowsOrderByField, ScheduleWorkflowRunRequest, SNSIntegration, StepRun, StepRunArchiveList, StepRunEventList, Tenant, TenantAlertEmailGroup, TenantAlertEmailGroupList, TenantAlertingSettings, TenantInvite, TenantInviteList, TenantMember, TenantMemberList, TenantQueueMetrics, TenantResourcePolicy, TenantStepRunQueueMetrics, TriggerWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantRequest, UpdateWorkerRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, WebhookWorkerCreated, WebhookWorkerCreateRequest, WebhookWorkerListResponse, WebhookWorkerRequestListResponse, Worker, WorkerList, Workflow, WorkflowID, WorkflowKindList, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunOrderByDirection, WorkflowRunOrderByField, WorkflowRunsCancelRequest, WorkflowRunShape, WorkflowRunsMetrics, WorkflowRunStatus, WorkflowRunStatusList, WorkflowUpdateRequest, WorkflowVersion, WorkflowWorkersCount } from './data-contracts';
+import { AcceptInviteRequest, APIErrors, APIMeta, BulkCreateEventRequest, BulkCreateEventResponse, CancelEventRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreateCronWorkflowTriggerRequest, CreateEventRequest, CreateSNSIntegrationRequest, CreateTenantAlertEmailGroupRequest, CreateTenantInviteRequest, CreateTenantRequest, CronWorkflows, CronWorkflowsList, CronWorkflowsOrderByField, Event, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, ListAPIMetaIntegration, ListAPITokensResponse, ListSlackWebhooks, ListSNSIntegrations, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, RateLimitList, RateLimitOrderByDirection, RateLimitOrderByField, RejectInviteRequest, ReplayEventRequest, ReplayWorkflowRunsRequest, ReplayWorkflowRunsResponse, RerunStepRunRequest, ScheduledRunStatus, ScheduledWorkflows, ScheduledWorkflowsList, ScheduledWorkflowsOrderByField, ScheduleWorkflowRunRequest, SNSIntegration, StepRun, StepRunArchiveList, StepRunEventList, Tenant, TenantAlertEmailGroup, TenantAlertEmailGroupList, TenantAlertingSettings, TenantInvite, TenantInviteList, TenantMember, TenantMemberList, TenantQueueMetrics, TenantResourcePolicy, TenantStepRunQueueMetrics, TriggerWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantRequest, UpdateWorkerRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, V1CancelTaskRequest, V1DagChildren, V1ReplayTaskRequest, V1Task, V1TaskEventList, V1TaskPointMetrics, V1TaskRunMetrics, V1TaskStatus, V1TaskSummaryList, V1WorkflowRunDetails, WebhookWorkerCreated, WebhookWorkerCreateRequest, WebhookWorkerListResponse, WebhookWorkerRequestListResponse, Worker, WorkerList, Workflow, WorkflowID, WorkflowKindList, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunOrderByDirection, WorkflowRunOrderByField, WorkflowRunsCancelRequest, WorkflowRunShape, WorkflowRunsMetrics, WorkflowRunStatus, WorkflowRunStatusList, WorkflowUpdateRequest, WorkflowVersion, WorkflowWorkersCount } from './data-contracts';
 import { HttpClient, RequestParams } from './http-client';
 export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
+    /**
+     * @description Get a task by id
+     *
+     * @tags Task
+     * @name V1TaskGet
+     * @summary Get a task
+     * @request GET:/api/v1/stable/tasks/{task}
+     * @secure
+     */
+    v1TaskGet: (task: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1Task, any>>;
+    /**
+     * @description List events for a task
+     *
+     * @tags Task
+     * @name V1TaskEventList
+     * @summary List events for a task
+     * @request GET:/api/v1/stable/tasks/{task}/task-events
+     * @secure
+     */
+    v1TaskEventList: (task: string, query?: {
+        /**
+         * The number to skip
+         * @format int64
+         */
+        offset?: number;
+        /**
+         * The number to limit by
+         * @format int64
+         */
+        limit?: number;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskEventList, any>>;
+    /**
+     * @description Cancel tasks
+     *
+     * @tags Task
+     * @name V1TaskCancel
+     * @summary Cancel tasks
+     * @request POST:/api/v1/stable/tenants/{tenant}/tasks/cancel
+     * @secure
+     */
+    v1TaskCancel: (tenant: string, data: V1CancelTaskRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Replay tasks
+     *
+     * @tags Task
+     * @name V1TaskReplay
+     * @summary Replay tasks
+     * @request POST:/api/v1/stable/tenants/{tenant}/tasks/replay
+     * @secure
+     */
+    v1TaskReplay: (tenant: string, data: V1ReplayTaskRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Lists all tasks that belong a specific list of dags
+     *
+     * @tags Task
+     * @name V1DagListTasks
+     * @summary List tasks
+     * @request GET:/api/v1/stable/dags/tasks
+     * @secure
+     */
+    v1DagListTasks: (query: {
+        /** The external id of the DAG */
+        dag_ids: string[];
+        /**
+         * The tenant id
+         * @format uuid
+         * @minLength 36
+         * @maxLength 36
+         */
+        tenant: string;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1DagChildren[], any>>;
+    /**
+     * @description Lists workflow runs for a tenant.
+     *
+     * @tags Workflow Runs
+     * @name V1WorkflowRunList
+     * @summary List workflow runs
+     * @request GET:/api/v1/stable/tenants/{tenant}/workflow-runs
+     * @secure
+     */
+    v1WorkflowRunList: (tenant: string, query: {
+        /**
+         * The number to skip
+         * @format int64
+         */
+        offset?: number;
+        /**
+         * The number to limit by
+         * @format int64
+         */
+        limit?: number;
+        /** A list of statuses to filter by */
+        statuses?: V1TaskStatus[];
+        /**
+         * The earliest date to filter by
+         * @format date-time
+         */
+        since: string;
+        /**
+         * The latest date to filter by
+         * @format date-time
+         */
+        until?: string;
+        /** Additional metadata k-v pairs to filter by */
+        additional_metadata?: string[];
+        /** The workflow ids to find runs for */
+        workflow_ids?: string[];
+        /**
+         * The worker id to filter by
+         * @format uuid
+         * @minLength 36
+         * @maxLength 36
+         */
+        worker_id?: string;
+        /** Whether to include DAGs or only to include tasks */
+        only_tasks: boolean;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskSummaryList, any>>;
+    /**
+     * @description Get a workflow run and its metadata to display on the "detail" page
+     *
+     * @tags Workflow Runs
+     * @name V1WorkflowRunGet
+     * @summary List tasks
+     * @request GET:/api/v1/stable/workflow-runs/{v1-workflow-run}
+     * @secure
+     */
+    v1WorkflowRunGet: (v1WorkflowRun: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1WorkflowRunDetails, any>>;
+    /**
+     * @description List all tasks for a workflow run
+     *
+     * @tags Workflow Runs
+     * @name V1WorkflowRunTaskEventsList
+     * @summary List tasks
+     * @request GET:/api/v1/stable/workflow-runs/{v1-workflow-run}/task-events
+     * @secure
+     */
+    v1WorkflowRunTaskEventsList: (v1WorkflowRun: string, query?: {
+        /**
+         * The number to skip
+         * @format int64
+         */
+        offset?: number;
+        /**
+         * The number to limit by
+         * @format int64
+         */
+        limit?: number;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskEventList, any>>;
+    /**
+     * @description Get a summary of task run metrics for a tenant
+     *
+     * @tags Task
+     * @name V1TaskListStatusMetrics
+     * @summary Get task metrics
+     * @request GET:/api/v1/stable/tenants/{tenant}/task-metrics
+     * @secure
+     */
+    v1TaskListStatusMetrics: (tenant: string, query: {
+        /**
+         * The start time to get metrics for
+         * @format date-time
+         */
+        since: string;
+        /** The workflow id to find runs for */
+        workflow_ids?: string[];
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskRunMetrics, any>>;
+    /**
+     * @description Get a minute by minute breakdown of task metrics for a tenant
+     *
+     * @tags Task
+     * @name V1TaskGetPointMetrics
+     * @summary Get task point metrics
+     * @request GET:/api/v1/stable/tenants/{tenant}/task-point-metrics
+     * @secure
+     */
+    v1TaskGetPointMetrics: (tenant: string, query?: {
+        /**
+         * The time after the task was created
+         * @format date-time
+         * @example "2021-01-01T00:00:00Z"
+         */
+        createdAfter?: string;
+        /**
+         * The time before the task was completed
+         * @format date-time
+         * @example "2021-01-01T00:00:00Z"
+         */
+        finishedBefore?: string;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskPointMetrics, any>>;
     /**
      * @description Gets the readiness status
      *
@@ -1247,4 +1436,15 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     monitoringPostRunProbe: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Get the version of the server
+     *
+     * @name InfoGetVersion
+     * @summary We return the version for the currently running server
+     * @request GET:/api/v1/version
+     */
+    infoGetVersion: (params?: RequestParams) => Promise<import("axios").AxiosResponse<{
+        /** @example "1.0.0" */
+        version: string;
+    }, any>>;
 }

package/clients/rest/generated/Api.js

@@ -15,6 +15,106 @@ const http_client_1 = require("./http-client");
 class Api extends http_client_1.HttpClient {
     constructor() {
         super(...arguments);
+        /**
+         * @description Get a task by id
+         *
+         * @tags Task
+         * @name V1TaskGet
+         * @summary Get a task
+         * @request GET:/api/v1/stable/tasks/{task}
+         * @secure
+         */
+        this.v1TaskGet = (task, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tasks/${task}`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description List events for a task
+         *
+         * @tags Task
+         * @name V1TaskEventList
+         * @summary List events for a task
+         * @request GET:/api/v1/stable/tasks/{task}/task-events
+         * @secure
+         */
+        this.v1TaskEventList = (task, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tasks/${task}/task-events`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Cancel tasks
+         *
+         * @tags Task
+         * @name V1TaskCancel
+         * @summary Cancel tasks
+         * @request POST:/api/v1/stable/tenants/{tenant}/tasks/cancel
+         * @secure
+         */
+        this.v1TaskCancel = (tenant, data, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/tasks/cancel`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json }, params));
+        /**
+         * @description Replay tasks
+         *
+         * @tags Task
+         * @name V1TaskReplay
+         * @summary Replay tasks
+         * @request POST:/api/v1/stable/tenants/{tenant}/tasks/replay
+         * @secure
+         */
+        this.v1TaskReplay = (tenant, data, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/tasks/replay`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json }, params));
+        /**
+         * @description Lists all tasks that belong a specific list of dags
+         *
+         * @tags Task
+         * @name V1DagListTasks
+         * @summary List tasks
+         * @request GET:/api/v1/stable/dags/tasks
+         * @secure
+         */
+        this.v1DagListTasks = (query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/dags/tasks`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Lists workflow runs for a tenant.
+         *
+         * @tags Workflow Runs
+         * @name V1WorkflowRunList
+         * @summary List workflow runs
+         * @request GET:/api/v1/stable/tenants/{tenant}/workflow-runs
+         * @secure
+         */
+        this.v1WorkflowRunList = (tenant, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/workflow-runs`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Get a workflow run and its metadata to display on the "detail" page
+         *
+         * @tags Workflow Runs
+         * @name V1WorkflowRunGet
+         * @summary List tasks
+         * @request GET:/api/v1/stable/workflow-runs/{v1-workflow-run}
+         * @secure
+         */
+        this.v1WorkflowRunGet = (v1WorkflowRun, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/workflow-runs/${v1WorkflowRun}`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description List all tasks for a workflow run
+         *
+         * @tags Workflow Runs
+         * @name V1WorkflowRunTaskEventsList
+         * @summary List tasks
+         * @request GET:/api/v1/stable/workflow-runs/{v1-workflow-run}/task-events
+         * @secure
+         */
+        this.v1WorkflowRunTaskEventsList = (v1WorkflowRun, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/workflow-runs/${v1WorkflowRun}/task-events`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Get a summary of task run metrics for a tenant
+         *
+         * @tags Task
+         * @name V1TaskListStatusMetrics
+         * @summary Get task metrics
+         * @request GET:/api/v1/stable/tenants/{tenant}/task-metrics
+         * @secure
+         */
+        this.v1TaskListStatusMetrics = (tenant, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/task-metrics`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Get a minute by minute breakdown of task metrics for a tenant
+         *
+         * @tags Task
+         * @name V1TaskGetPointMetrics
+         * @summary Get task point metrics
+         * @request GET:/api/v1/stable/tenants/{tenant}/task-point-metrics
+         * @secure
+         */
+        this.v1TaskGetPointMetrics = (tenant, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/task-point-metrics`, method: 'GET', query: query, secure: true, format: 'json' }, params));
         /**
          * @description Gets the readiness status
          *
@@ -927,6 +1027,14 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.monitoringPostRunProbe = (tenant, params = {}) => this.request(Object.assign({ path: `/api/v1/monitoring/${tenant}/probe`, method: 'POST', secure: true }, params));
+        /**
+         * @description Get the version of the server
+         *
+         * @name InfoGetVersion
+         * @summary We return the version for the currently running server
+         * @request GET:/api/v1/version
+         */
+        this.infoGetVersion = (params = {}) => this.request(Object.assign({ path: `/api/v1/version`, method: 'GET', format: 'json' }, params));
     }
 }
 exports.Api = Api;