@hatchet-dev/typescript-sdk 1.11.0 → 1.12.1

package/clients/admin/admin-client.d.ts

@@ -19,6 +19,16 @@ export type WorkflowRun<T = object> = {
     input: T;
     options?: {
         parentId?: string | undefined;
+        /**
+         * (optional) the parent task external run id.
+         *
+         * This is the field understood by the workflows gRPC API.
+         */
+        parentTaskRunExternalId?: string | undefined;
+        /**
+         * @deprecated Use `parentTaskRunExternalId` instead.
+         * Kept for backward compatibility; will be mapped to `parentTaskRunExternalId`.
+         */
         parentStepRunId?: string | undefined;
         childIndex?: number | undefined;
         childKey?: string | undefined;
@@ -65,6 +75,14 @@ export declare class AdminClient {
      */
     run_workflow<T = object>(workflowName: string, input: T, options?: {
         parentId?: string | undefined;
+        /**
+         * (optional) the parent task external run id.
+         */
+        parentTaskRunExternalId?: string | undefined;
+        /**
+         * @deprecated Use `parentTaskRunExternalId` instead.
+         * Kept for backward compatibility; will be mapped to `parentTaskRunExternalId`.
+         */
         parentStepRunId?: string | undefined;
         childIndex?: number | undefined;
         childKey?: string | undefined;
@@ -80,6 +98,16 @@ export declare class AdminClient {
      */
     runWorkflow<Q = object, P = object>(workflowName: string, input: Q, options?: {
         parentId?: string | undefined;
+        /**
+         * (optional) the parent task external run id.
+         *
+         * This is the field understood by the workflows gRPC API.
+         */
+        parentTaskRunExternalId?: string | undefined;
+        /**
+         * @deprecated Use `parentTaskRunExternalId` instead.
+         * Kept for backward compatibility; will be mapped to `parentTaskRunExternalId`.
+         */
         parentStepRunId?: string | undefined;
         childIndex?: number | undefined;
         childKey?: string | undefined;
@@ -98,6 +126,16 @@ export declare class AdminClient {
         input: Q;
         options?: {
             parentId?: string | undefined;
+            /**
+             * (optional) the parent task external run id.
+             *
+             * This is the field understood by the workflows gRPC API.
+             */
+            parentTaskRunExternalId?: string | undefined;
+            /**
+             * @deprecated Use `parentTaskRunExternalId` instead.
+             * Kept for backward compatibility; will be mapped to `parentTaskRunExternalId`.
+             */
             parentStepRunId?: string | undefined;
             childIndex?: number | undefined;
             childKey?: string | undefined;

package/clients/admin/admin-client.js

@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -120,9 +131,11 @@ class AdminClient {
         const computedName = (0, apply_namespace_1.applyNamespace)(workflowName, this.config.namespace);
         try {
             const inputStr = JSON.stringify(input);
-            const resp = this.client.triggerWorkflow(Object.assign(Object.assign({ name: computedName, input: inputStr }, options), { additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
-                    ? JSON.stringify(options === null || options === void 0 ? void 0 : options.additionalMetadata)
-                    : undefined, priority: options === null || options === void 0 ? void 0 : options.priority }));
+            const opts = options !== null && options !== void 0 ? options : {};
+            const { additionalMetadata, parentStepRunId, parentTaskRunExternalId } = opts, rest = __rest(opts, ["additionalMetadata", "parentStepRunId", "parentTaskRunExternalId"]);
+            const resp = this.client.triggerWorkflow(Object.assign(Object.assign({ name: computedName, input: inputStr }, rest), { 
+                // API expects `parentTaskRunExternalId`; accept the old name as an alias.
+                parentTaskRunExternalId: parentTaskRunExternalId !== null && parentTaskRunExternalId !== void 0 ? parentTaskRunExternalId : parentStepRunId, additionalMetadata: additionalMetadata ? JSON.stringify(additionalMetadata) : undefined, priority: opts.priority }));
             return new workflow_run_ref_1.default(resp, this.listenerClient, this.workflows, options === null || options === void 0 ? void 0 : options.parentId);
         }
         catch (e) {
@@ -140,9 +153,9 @@ class AdminClient {
         const workflowRequests = workflowRuns.map(({ workflowName, input, options }) => {
             const computedName = (0, apply_namespace_1.applyNamespace)(workflowName, this.config.namespace);
             const inputStr = JSON.stringify(input);
-            return Object.assign(Object.assign({ name: computedName, input: inputStr }, options), { additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
-                    ? JSON.stringify(options.additionalMetadata)
-                    : undefined });
+            const opts = options !== null && options !== void 0 ? options : {};
+            const { additionalMetadata, parentStepRunId, parentTaskRunExternalId } = opts, rest = __rest(opts, ["additionalMetadata", "parentStepRunId", "parentTaskRunExternalId"]);
+            return Object.assign(Object.assign({ name: computedName, input: inputStr }, rest), { parentTaskRunExternalId: parentTaskRunExternalId !== null && parentTaskRunExternalId !== void 0 ? parentTaskRunExternalId : parentStepRunId, additionalMetadata: additionalMetadata ? JSON.stringify(additionalMetadata) : undefined });
         });
         try {
             // Call the bulk trigger workflow method

package/clients/dispatcher/action-listener.d.ts

@@ -7,8 +7,12 @@ declare enum ListenStrategy {
     LISTEN_STRATEGY_V1 = 1,
     LISTEN_STRATEGY_V2 = 2
 }
-export interface Action extends AssignedAction {
-}
+export type Action = AssignedAction & {
+    /** @deprecated use taskRunId */
+    stepRunId?: string;
+    /** @deprecated use taskId */
+    stepId?: string;
+};
 export type ActionKey = string;
 export declare function createActionKey(action: Action): ActionKey;
 export declare class ActionListener {

package/clients/dispatcher/action-listener.js

@@ -55,7 +55,7 @@ function createActionKey(action) {
         case dispatcher_1.ActionType.CANCEL_STEP_RUN:
         case dispatcher_1.ActionType.START_STEP_RUN:
         case dispatcher_1.ActionType.UNRECOGNIZED:
-            return `${action.stepRunId}/${action.retryCount}`;
+            return `${action.taskRunExternalId}/${action.retryCount}`;
         default:
             // eslint-disable-next-line no-case-declarations
             const exhaustivenessCheck = action.actionType;
@@ -84,7 +84,7 @@ class ActionListener {
                                 _c = listenClient_1_1.value;
                                 _d = false;
                                 const assignedAction = _c;
-                                const action = Object.assign({}, assignedAction);
+                                const action = Object.assign(Object.assign({}, assignedAction), { stepRunId: assignedAction.taskRunExternalId, stepId: assignedAction.taskId });
                                 yield yield __await(action);
                             }
                         }

package/clients/dispatcher/dispatcher-client.d.ts

@@ -1,16 +1,29 @@
 import { Channel, ClientFactory } from 'nice-grpc';
-import { DispatcherClient as PbDispatcherClient, StepActionEvent, GroupKeyActionEvent, OverridesData, DeepPartial, RuntimeInfo } from '../../protoc/dispatcher';
+import { DispatcherClient as PbDispatcherClient, StepActionEvent, GroupKeyActionEvent, OverridesData, DeepPartial, WorkerLabels as PbWorkerAffinityConfig, RuntimeInfo } from '../../protoc/dispatcher';
 import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
+import { SlotConfig } from '../../v1/slot-types';
 import { ActionListener } from './action-listener';
 export type WorkerLabels = Record<string, string | number | undefined>;
 interface GetActionListenerOptions {
     workerName: string;
     services: string[];
     actions: string[];
+    slotConfig?: SlotConfig;
+    /** @deprecated use slotConfig */
+    slots?: number;
+    /** @deprecated use slotConfig */
+    durableSlots?: number;
+    /** @deprecated use slots */
     maxRuns?: number;
     labels: Record<string, string | number | undefined>;
 }
+type StepActionEventInput = StepActionEvent & {
+    /** @deprecated use taskId */
+    stepId?: string;
+    /** @deprecated use taskRunId */
+    stepRunId?: string;
+};
 export declare class DispatcherClient {
     config: ClientConfig;
     client: PbDispatcherClient;
@@ -18,10 +31,16 @@ export declare class DispatcherClient {
     constructor(config: ClientConfig, channel: Channel, factory: ClientFactory);
     getRuntimeInfo(): RuntimeInfo;
     getActionListener(options: GetActionListenerOptions): Promise<ActionListener>;
-    sendStepActionEvent(in_: StepActionEvent): Promise<import("../../protoc/dispatcher").ActionEventResponse>;
+    /**
+     * Calls the GetVersion RPC. Returns the engine semantic version string.
+     * Throws a gRPC error with code UNIMPLEMENTED on older engines.
+     */
+    getVersion(): Promise<string>;
+    sendStepActionEvent(in_: StepActionEventInput): Promise<import("../../protoc/dispatcher").ActionEventResponse>;
     sendGroupKeyActionEvent(in_: GroupKeyActionEvent): Promise<import("../../protoc/dispatcher").ActionEventResponse>;
     putOverridesData(in_: DeepPartial<OverridesData>): Promise<void | import("../../protoc/dispatcher").OverridesDataResponse>;
-    refreshTimeout(incrementTimeoutBy: string, stepRunId: string): Promise<import("../../protoc/dispatcher").RefreshTimeoutResponse>;
+    refreshTimeout(incrementTimeoutBy: string, taskRunExternalId: string): Promise<import("../../protoc/dispatcher").RefreshTimeoutResponse>;
     upsertWorkerLabels(workerId: string, labels: WorkerLabels): Promise<import("../../protoc/dispatcher").UpsertWorkerLabelsResponse>;
 }
+export declare function mapLabels(in_: WorkerLabels): Record<string, PbWorkerAffinityConfig>;
 export {};

package/clients/dispatcher/dispatcher-client.js

@@ -8,15 +8,28 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DispatcherClient = void 0;
+exports.mapLabels = mapLabels;
 const dispatcher_1 = require("../../protoc/dispatcher");
 const hatchet_error_1 = __importDefault(require("../../util/errors/hatchet-error"));
 const retrier_1 = require("../../util/retrier");
 const version_1 = require("../../version");
+const slot_types_1 = require("../../v1/slot-types");
 const action_listener_1 = require("./action-listener");
 class DispatcherClient {
     constructor(config, channel, factory) {
@@ -35,14 +48,38 @@ class DispatcherClient {
     getActionListener(options) {
         return __awaiter(this, void 0, void 0, function* () {
             // Register the worker
-            const registration = yield this.client.register(Object.assign(Object.assign({}, options), { labels: options.labels ? mapLabels(options.labels) : undefined, runtimeInfo: this.getRuntimeInfo() }));
+            const slotConfig = options.slotConfig ||
+                (options.slots || options.durableSlots || options.maxRuns
+                    ? Object.assign(Object.assign({}, (options.slots || options.maxRuns
+                        ? { [slot_types_1.SlotType.Default]: options.slots || options.maxRuns || 0 }
+                        : {})), (options.durableSlots ? { [slot_types_1.SlotType.Durable]: options.durableSlots } : {})) : undefined);
+            const registration = yield this.client.register({
+                workerName: options.workerName,
+                services: options.services,
+                actions: options.actions,
+                slotConfig,
+                labels: options.labels ? mapLabels(options.labels) : undefined,
+                runtimeInfo: this.getRuntimeInfo(),
+            });
             return new action_listener_1.ActionListener(this, registration.workerId);
         });
     }
+    /**
+     * Calls the GetVersion RPC. Returns the engine semantic version string.
+     * Throws a gRPC error with code UNIMPLEMENTED on older engines.
+     */
+    getVersion() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.client.getVersion({});
+            return response.version;
+        });
+    }
     sendStepActionEvent(in_) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { taskId, taskRunExternalId } = in_, rest = __rest(in_, ["taskId", "taskRunExternalId"]);
+            const event = Object.assign(Object.assign({}, rest), { taskId: taskId !== null && taskId !== void 0 ? taskId : '', taskRunExternalId: taskRunExternalId !== null && taskRunExternalId !== void 0 ? taskRunExternalId : '' });
             try {
-                return yield (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () { return this.client.sendStepActionEvent(in_); }), this.logger);
+                return yield (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () { return this.client.sendStepActionEvent(event); }), this.logger);
             }
             catch (e) {
                 throw new hatchet_error_1.default(e.message);
@@ -66,11 +103,11 @@ class DispatcherClient {
             });
         });
     }
-    refreshTimeout(incrementTimeoutBy, stepRunId) {
+    refreshTimeout(incrementTimeoutBy, taskRunExternalId) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 return this.client.refreshTimeout({
-                    stepRunId,
+                    taskRunExternalId,
                     incrementTimeoutBy,
                 });
             }

package/clients/event/event-client.d.ts

@@ -32,7 +32,7 @@ export declare class EventClient {
     constructor(config: ClientConfig, channel: Channel, factory: ClientFactory, hatchetClient: LegacyHatchetClient);
     push<T>(type: string, input: T, options?: PushEventOptions): Promise<import("../../protoc/events/events").Event>;
     bulkPush<T>(type: string, inputs: EventWithMetadata<T>[], options?: PushEventOptions): Promise<import("../../protoc/events/events").Events>;
-    putLog(stepRunId: string, log: string, level?: LogLevel, taskRetryCount?: number, metadata?: Record<string, any>): Promise<void>;
-    putStream(stepRunId: string, data: string | Uint8Array, index: number | undefined): Promise<void>;
+    putLog(taskRunExternalId: string, log: string, level?: LogLevel, taskRetryCount?: number, metadata?: Record<string, any>): Promise<void>;
+    putStream(taskRunExternalId: string, data: string | Uint8Array, index: number | undefined): Promise<void>;
     list(opts?: Parameters<typeof this.api.v1EventList>[1]): Promise<import("../rest/generated/data-contracts").V1EventList>;
 }

package/clients/event/event-client.js

@@ -87,7 +87,7 @@ class EventClient {
             throw new hatchet_error_1.default(e.message);
         }
     }
-    putLog(stepRunId, log, level, taskRetryCount, metadata) {
+    putLog(taskRunExternalId, log, level, taskRetryCount, metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const createdAt = new Date();
             if (log.length > 1000) {
@@ -97,7 +97,7 @@ class EventClient {
             //  fire and forget the log
             yield this.client
                 .putLog({
-                stepRunId,
+                taskRunExternalId,
                 createdAt,
                 message: log,
                 level: level || LogLevel.INFO,
@@ -110,7 +110,7 @@ class EventClient {
             });
         });
     }
-    putStream(stepRunId, data, index) {
+    putStream(taskRunExternalId, data, index) {
         return __awaiter(this, void 0, void 0, function* () {
             const createdAt = new Date();
             let dataBytes;
@@ -125,7 +125,7 @@ class EventClient {
             }
             (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () {
                 return this.client.putStreamEvent({
-                    stepRunId,
+                    taskRunExternalId,
                     createdAt,
                     message: dataBytes,
                     eventIndex: index,

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

@@ -64,12 +64,12 @@ class HatchetLogger {
     }
     warn(message, error) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.log('WARN', `${message} ${error}`, '93');
+            yield this.log('WARN', error ? `${message} ${error}` : message, '93');
         });
     }
     error(message, error) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.log('ERROR', `${message} ${error}`, '91');
+            yield this.log('ERROR', error ? `${message} ${error}` : message, '91');
         });
     }
     util(key, message, extra) {

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

@@ -1,4 +1,4 @@
-import { APIErrors, APIMeta, AcceptInviteRequest, BulkCreateEventRequest, CancelEventRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreateCronWorkflowTriggerRequest, CreateEventRequest, CreateSNSIntegrationRequest, CreateTenantAlertEmailGroupRequest, CreateTenantInviteRequest, CreateTenantRequest, CronWorkflows, CronWorkflowsList, CronWorkflowsOrderByField, Event, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, Events, ListAPIMetaIntegration, ListAPITokensResponse, ListSNSIntegrations, ListSlackWebhooks, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, RateLimitList, RateLimitOrderByDirection, RateLimitOrderByField, RejectInviteRequest, ReplayEventRequest, ReplayWorkflowRunsRequest, ReplayWorkflowRunsResponse, RerunStepRunRequest, SNSIntegration, ScheduleWorkflowRunRequest, ScheduledRunStatus, ScheduledWorkflows, ScheduledWorkflowsBulkDeleteRequest, ScheduledWorkflowsBulkDeleteResponse, ScheduledWorkflowsBulkUpdateRequest, ScheduledWorkflowsBulkUpdateResponse, ScheduledWorkflowsList, ScheduledWorkflowsOrderByField, StepRun, StepRunArchiveList, StepRunEventList, TaskStats, Tenant, TenantAlertEmailGroup, TenantAlertEmailGroupList, TenantAlertingSettings, TenantInvite, TenantInviteList, TenantMember, TenantMemberList, TenantQueueMetrics, TenantResourcePolicy, TenantStepRunQueueMetrics, TriggerWorkflowRunRequest, UpdateCronWorkflowTriggerRequest, UpdateScheduledWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantMemberRequest, UpdateTenantRequest, UpdateWorkerRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, V1CELDebugRequest, V1CELDebugResponse, V1CancelTaskRequest, V1CancelledTasks, V1CreateFilterRequest, V1CreateWebhookRequest, V1DagChildren, V1Event, V1EventList, V1Filter, V1FilterList, V1LogLineList, V1ReplayTaskRequest, V1ReplayedTasks, V1TaskEventList, V1TaskPointMetrics, V1TaskRunMetrics, V1TaskStatus, V1TaskSummary, V1TaskSummaryList, V1TaskTimingList, V1TriggerWorkflowRunRequest, V1UpdateFilterRequest, V1UpdateWebhookRequest, V1Webhook, V1WebhookList, V1WebhookSourceName, V1WorkflowRunDetails, V1WorkflowRunDisplayNameList, V1WorkflowRunExternalIdList, WebhookWorkerCreateRequest, WebhookWorkerCreated, WebhookWorkerListResponse, WebhookWorkerRequestListResponse, Worker, WorkerList, Workflow, WorkflowID, WorkflowKindList, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunOrderByDirection, WorkflowRunOrderByField, WorkflowRunShape, WorkflowRunStatus, WorkflowRunStatusList, WorkflowRunsCancelRequest, WorkflowRunsMetrics, WorkflowUpdateRequest, WorkflowVersion, WorkflowWorkersCount } from './data-contracts';
+import { APIErrors, APIMeta, AcceptInviteRequest, BulkCreateEventRequest, CancelEventRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreateCronWorkflowTriggerRequest, CreateEventRequest, CreateSNSIntegrationRequest, CreateTenantAlertEmailGroupRequest, CreateTenantInviteRequest, CreateTenantRequest, CronWorkflows, CronWorkflowsList, CronWorkflowsOrderByField, Event, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, Events, ListAPIMetaIntegration, ListAPITokensResponse, ListSNSIntegrations, ListSlackWebhooks, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, RateLimitList, RateLimitOrderByDirection, RateLimitOrderByField, RejectInviteRequest, ReplayEventRequest, ReplayWorkflowRunsRequest, ReplayWorkflowRunsResponse, RerunStepRunRequest, SNSIntegration, ScheduleWorkflowRunRequest, ScheduledRunStatus, ScheduledWorkflows, ScheduledWorkflowsBulkDeleteRequest, ScheduledWorkflowsBulkDeleteResponse, ScheduledWorkflowsBulkUpdateRequest, ScheduledWorkflowsBulkUpdateResponse, ScheduledWorkflowsList, ScheduledWorkflowsOrderByField, StepRun, StepRunArchiveList, StepRunEventList, TaskStats, Tenant, TenantAlertEmailGroup, TenantAlertEmailGroupList, TenantAlertingSettings, TenantInvite, TenantInviteList, TenantMember, TenantMemberList, TenantQueueMetrics, TenantResourcePolicy, TenantStepRunQueueMetrics, TriggerWorkflowRunRequest, UpdateCronWorkflowTriggerRequest, UpdateScheduledWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantMemberRequest, UpdateTenantRequest, UpdateWorkerRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, V1CELDebugRequest, V1CELDebugResponse, V1CancelTaskRequest, V1CancelledTasks, V1CreateFilterRequest, V1CreateWebhookRequest, V1DagChildren, V1Event, V1EventList, V1Filter, V1FilterList, V1LogLineLevel, V1LogLineList, V1LogLineOrderByDirection, V1ReplayTaskRequest, V1ReplayedTasks, V1TaskEventList, V1TaskPointMetrics, V1TaskRunMetrics, V1TaskStatus, V1TaskSummary, V1TaskSummaryList, V1TaskTimingList, V1TriggerWorkflowRunRequest, V1UpdateFilterRequest, V1UpdateWebhookRequest, V1Webhook, V1WebhookList, V1WebhookSourceName, V1WorkflowRunDetails, V1WorkflowRunDisplayNameList, V1WorkflowRunExternalIdList, WebhookWorkerCreateRequest, WebhookWorkerCreated, WebhookWorkerListResponse, WebhookWorkerRequestListResponse, Worker, WorkerList, Workflow, WorkflowID, WorkflowKindList, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunOrderByDirection, WorkflowRunOrderByField, WorkflowRunShape, WorkflowRunStatus, WorkflowRunStatusList, WorkflowRunsCancelRequest, WorkflowRunsMetrics, WorkflowUpdateRequest, WorkflowVersion, WorkflowWorkersCount } from './data-contracts';
 import { HttpClient, RequestParams } from './http-client';
 export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
     /**
@@ -60,6 +60,14 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          * @format date-time
          */
         until?: string;
+        /** A full-text search query to filter for */
+        search?: string;
+        /** The log level(s) to include */
+        levels?: V1LogLineLevel[];
+        /** The direction to order by */
+        order_by_direction?: V1LogLineOrderByDirection;
+        /** The attempt number to filter for */
+        attempt?: number;
     }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1LogLineList, any, {}>>;
     /**
      * @description Cancel tasks

package/clients/rest/generated/data-contracts.d.ts

@@ -17,7 +17,8 @@ export declare enum WebhookWorkerRequestMethod {
 export declare enum WorkerRuntimeSDKs {
     GOLANG = "GOLANG",
     PYTHON = "PYTHON",
-    TYPESCRIPT = "TYPESCRIPT"
+    TYPESCRIPT = "TYPESCRIPT",
+    RUBY = "RUBY"
 }
 export declare enum WorkerType {
     SELFHOSTED = "SELFHOSTED",
@@ -91,6 +92,10 @@ export declare enum StepRunStatus {
     CANCELLING = "CANCELLING",
     BACKOFF = "BACKOFF"
 }
+export declare enum ConcurrencyScope {
+    WORKFLOW = "WORKFLOW",
+    TASK = "TASK"
+}
 export declare enum ConcurrencyLimitStrategy {
     CANCEL_IN_PROGRESS = "CANCEL_IN_PROGRESS",
     DROP_NEWEST = "DROP_NEWEST",
@@ -160,7 +165,6 @@ export declare enum TenantResource {
     WORKER = "WORKER",
     WORKER_SLOT = "WORKER_SLOT",
     EVENT = "EVENT",
-    WORKFLOW_RUN = "WORKFLOW_RUN",
     TASK_RUN = "TASK_RUN",
     CRON = "CRON",
     SCHEDULE = "SCHEDULE",
@@ -192,7 +196,8 @@ export declare enum V1WebhookSourceName {
     GITHUB = "GITHUB",
     STRIPE = "STRIPE",
     SLACK = "SLACK",
-    LINEAR = "LINEAR"
+    LINEAR = "LINEAR",
+    SVIX = "SVIX"
 }
 export declare enum TenantEnvironment {
     Local = "local",
@@ -203,6 +208,10 @@ export declare enum TenantVersion {
     V0 = "V0",
     V1 = "V1"
 }
+export declare enum V1LogLineOrderByDirection {
+    ASC = "ASC",
+    DESC = "DESC"
+}
 export declare enum V1LogLineLevel {
     DEBUG = "DEBUG",
     INFO = "INFO",
@@ -870,7 +879,7 @@ export type V1CreateWebhookRequestHMAC = V1CreateWebhookRequestBase & {
 export type V1CreateWebhookRequest = V1CreateWebhookRequestBasicAuth | V1CreateWebhookRequestAPIKey | V1CreateWebhookRequestHMAC;
 export interface V1UpdateWebhookRequest {
     /** The CEL expression to use for the event key. This is used to create the event key from the webhook payload. */
-    eventKeyExpression: string;
+    eventKeyExpression?: string;
     /** The CEL expression to use for the scope. This is used to filter the correct workflow to trigger. */
     scopeExpression?: string;
     /** The static payload to use for the webhook. This is used to send a static payload with the webhook. */
@@ -1392,6 +1401,10 @@ export interface Step {
     action: string;
     /** The timeout of the step. */
     timeout?: string;
+    /** Whether the step is durable. */
+    isDurable?: boolean;
+    /** Slot requests for the step (slot_type -> units). */
+    slotRequests?: Record<string, number>;
     children?: string[];
     parents?: string[];
 }
@@ -1598,6 +1611,21 @@ export interface WorkflowTriggers {
     events?: WorkflowTriggerEventRef[];
     crons?: WorkflowTriggerCronRef[];
 }
+export interface ConcurrencySetting {
+    /**
+     * The maximum number of concurrent workflow runs.
+     * @format int32
+     */
+    maxRuns: number;
+    /** The strategy to use when the concurrency limit is reached. */
+    limitStrategy: ConcurrencyLimitStrategy;
+    /** The concurrency expression, used to generate a key from task inputs, metadata, etc. */
+    expression: string;
+    /** The readable id of the step to which this concurrency setting applies. */
+    stepReadableId?: string;
+    /** The scope of the concurrency setting. */
+    scope: ConcurrencyScope;
+}
 export interface WorkflowVersion {
     metadata: APIResourceMeta;
     /** The version of the workflow. */
@@ -1618,6 +1646,9 @@ export interface WorkflowVersion {
     scheduleTimeout?: string;
     jobs?: Job[];
     workflowConfig?: object;
+    v1Concurrency?: ConcurrencySetting[];
+    /** The JSON schema for the workflow input. */
+    inputJsonSchema?: object;
 }
 export interface TriggerWorkflowRunRequest {
     input: object;
@@ -1900,6 +1931,13 @@ export interface RecentStepRuns {
     /** @format uuid */
     workflowRunId: string;
 }
+/** Slot availability and limits for a slot type. */
+export interface WorkerSlotConfig {
+    /** The number of available units for this slot type. */
+    available?: number;
+    /** The maximum number of units for this slot type. */
+    limit: number;
+}
 export interface WorkerLabel {
     metadata: APIResourceMeta;
     /** The key of the label. */
@@ -1941,10 +1979,8 @@ export interface Worker {
     recentStepRuns?: RecentStepRuns[];
     /** The status of the worker. */
     status?: 'ACTIVE' | 'INACTIVE' | 'PAUSED';
-    /** The maximum number of runs this worker can execute concurrently. */
-    maxRuns?: number;
-    /** The number of runs this worker can execute concurrently. */
-    availableRuns?: number;
+    /** Slot availability and limits for this worker (slot_type -> { available, limit }). */
+    slotConfig?: Record<string, WorkerSlotConfig>;
     /**
      * the id of the assigned dispatcher, in UUID format
      * @format uuid

package/clients/rest/generated/data-contracts.js

@@ -11,7 +11,7 @@
  * ---------------------------------------------------------------
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.V1TaskStatus = exports.V1WorkflowType = exports.V1TaskEventType = exports.V1LogLineLevel = exports.TenantVersion = exports.TenantEnvironment = exports.V1WebhookSourceName = exports.V1WebhookAuthType = exports.V1WebhookHMACAlgorithm = exports.V1WebhookHMACEncoding = exports.V1CELDebugResponseStatus = exports.TenantResource = exports.TenantMemberRole = exports.WorkflowRunStatus = exports.EventOrderByField = exports.EventOrderByDirection = exports.RateLimitOrderByField = exports.RateLimitOrderByDirection = exports.ScheduledWorkflowsMethod = exports.ScheduledWorkflowsOrderByField = exports.WorkflowRunOrderByDirection = exports.ScheduledRunStatus = exports.CronWorkflowsMethod = exports.CronWorkflowsOrderByField = exports.ConcurrencyLimitStrategy = exports.StepRunStatus = exports.JobRunStatus = exports.LogLineLevel = exports.LogLineOrderByField = exports.LogLineOrderByDirection = exports.StepRunEventReason = exports.StepRunEventSeverity = exports.WorkflowKind = exports.WorkflowRunOrderByField = exports.WorkerType = exports.WorkerRuntimeSDKs = exports.WebhookWorkerRequestMethod = exports.PullRequestState = exports.V1TaskRunStatus = void 0;
+exports.V1TaskStatus = exports.V1WorkflowType = exports.V1TaskEventType = exports.V1LogLineLevel = exports.V1LogLineOrderByDirection = exports.TenantVersion = exports.TenantEnvironment = exports.V1WebhookSourceName = exports.V1WebhookAuthType = exports.V1WebhookHMACAlgorithm = exports.V1WebhookHMACEncoding = exports.V1CELDebugResponseStatus = exports.TenantResource = exports.TenantMemberRole = exports.WorkflowRunStatus = exports.EventOrderByField = exports.EventOrderByDirection = exports.RateLimitOrderByField = exports.RateLimitOrderByDirection = exports.ScheduledWorkflowsMethod = exports.ScheduledWorkflowsOrderByField = exports.WorkflowRunOrderByDirection = exports.ScheduledRunStatus = exports.CronWorkflowsMethod = exports.CronWorkflowsOrderByField = exports.ConcurrencyLimitStrategy = exports.ConcurrencyScope = exports.StepRunStatus = exports.JobRunStatus = exports.LogLineLevel = exports.LogLineOrderByField = exports.LogLineOrderByDirection = exports.StepRunEventReason = exports.StepRunEventSeverity = exports.WorkflowKind = exports.WorkflowRunOrderByField = exports.WorkerType = exports.WorkerRuntimeSDKs = exports.WebhookWorkerRequestMethod = exports.PullRequestState = exports.V1TaskRunStatus = void 0;
 var V1TaskRunStatus;
 (function (V1TaskRunStatus) {
     V1TaskRunStatus["PENDING"] = "PENDING";
@@ -36,6 +36,7 @@ var WorkerRuntimeSDKs;
     WorkerRuntimeSDKs["GOLANG"] = "GOLANG";
     WorkerRuntimeSDKs["PYTHON"] = "PYTHON";
     WorkerRuntimeSDKs["TYPESCRIPT"] = "TYPESCRIPT";
+    WorkerRuntimeSDKs["RUBY"] = "RUBY";
 })(WorkerRuntimeSDKs || (exports.WorkerRuntimeSDKs = WorkerRuntimeSDKs = {}));
 var WorkerType;
 (function (WorkerType) {
@@ -119,6 +120,11 @@ var StepRunStatus;
     StepRunStatus["CANCELLING"] = "CANCELLING";
     StepRunStatus["BACKOFF"] = "BACKOFF";
 })(StepRunStatus || (exports.StepRunStatus = StepRunStatus = {}));
+var ConcurrencyScope;
+(function (ConcurrencyScope) {
+    ConcurrencyScope["WORKFLOW"] = "WORKFLOW";
+    ConcurrencyScope["TASK"] = "TASK";
+})(ConcurrencyScope || (exports.ConcurrencyScope = ConcurrencyScope = {}));
 var ConcurrencyLimitStrategy;
 (function (ConcurrencyLimitStrategy) {
     ConcurrencyLimitStrategy["CANCEL_IN_PROGRESS"] = "CANCEL_IN_PROGRESS";
@@ -202,7 +208,6 @@ var TenantResource;
     TenantResource["WORKER"] = "WORKER";
     TenantResource["WORKER_SLOT"] = "WORKER_SLOT";
     TenantResource["EVENT"] = "EVENT";
-    TenantResource["WORKFLOW_RUN"] = "WORKFLOW_RUN";
     TenantResource["TASK_RUN"] = "TASK_RUN";
     TenantResource["CRON"] = "CRON";
     TenantResource["SCHEDULE"] = "SCHEDULE";
@@ -240,6 +245,7 @@ var V1WebhookSourceName;
     V1WebhookSourceName["STRIPE"] = "STRIPE";
     V1WebhookSourceName["SLACK"] = "SLACK";
     V1WebhookSourceName["LINEAR"] = "LINEAR";
+    V1WebhookSourceName["SVIX"] = "SVIX";
 })(V1WebhookSourceName || (exports.V1WebhookSourceName = V1WebhookSourceName = {}));
 var TenantEnvironment;
 (function (TenantEnvironment) {
@@ -252,6 +258,11 @@ var TenantVersion;
     TenantVersion["V0"] = "V0";
     TenantVersion["V1"] = "V1";
 })(TenantVersion || (exports.TenantVersion = TenantVersion = {}));
+var V1LogLineOrderByDirection;
+(function (V1LogLineOrderByDirection) {
+    V1LogLineOrderByDirection["ASC"] = "ASC";
+    V1LogLineOrderByDirection["DESC"] = "DESC";
+})(V1LogLineOrderByDirection || (exports.V1LogLineOrderByDirection = V1LogLineOrderByDirection = {}));
 var V1LogLineLevel;
 (function (V1LogLineLevel) {
     V1LogLineLevel["DEBUG"] = "DEBUG";

package/clients/worker/worker.js

@@ -187,7 +187,7 @@ class V0Worker {
                     return step(context);
                 });
                 const success = (result) => __awaiter(this, void 0, void 0, function* () {
-                    this.logger.info(`Task run ${action.stepRunId} succeeded`);
+                    this.logger.info(`Task run ${action.taskRunExternalId} succeeded`);
                     try {
                         // Send the action event to the dispatcher
                         const event = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_COMPLETED, false, result || null, action.retryCount);
@@ -212,7 +212,7 @@ class V0Worker {
                     }
                 });
                 const failure = (error) => __awaiter(this, void 0, void 0, function* () {
-                    this.logger.error(`Task run ${action.stepRunId} failed: ${error.message}`);
+                    this.logger.error(`Task run ${action.taskRunExternalId} failed: ${error.message}`);
                     if (error.stack) {
                         this.logger.error(error.stack);
                     }
@@ -257,10 +257,10 @@ class V0Worker {
                 catch (e) {
                     const message = (e === null || e === void 0 ? void 0 : e.message) || String(e);
                     if (message.includes('Cancelled')) {
-                        this.logger.debug(`Task run ${action.stepRunId} was cancelled`);
+                        this.logger.debug(`Task run ${action.taskRunExternalId} was cancelled`);
                     }
                     else {
-                        this.logger.error(`Could not wait for task run ${action.stepRunId} to finish. ` +
+                        this.logger.error(`Could not wait for task run ${action.taskRunExternalId} to finish. ` +
                             `See https://docs.hatchet.run/home/cancellation for best practices on handling cancellation: `, e);
                     }
                 }
@@ -291,7 +291,7 @@ class V0Worker {
                     return step(context);
                 });
                 const success = (result) => {
-                    this.logger.info(`Task run ${action.stepRunId} succeeded`);
+                    this.logger.info(`Task run ${action.taskRunExternalId} succeeded`);
                     try {
                         // Send the action event to the dispatcher
                         const event = this.getGroupKeyActionEvent(action, dispatcher_1.GroupKeyActionEventType.GROUP_KEY_EVENT_TYPE_COMPLETED, result);
@@ -345,8 +345,8 @@ class V0Worker {
             workerId: this.name,
             jobId: action.jobId,
             jobRunId: action.jobRunId,
-            stepId: action.stepId,
-            stepRunId: action.stepRunId,
+            taskId: action.taskId,
+            taskRunExternalId: action.taskRunExternalId,
             actionId: action.actionId,
             eventTimestamp: new Date(),
             eventType,
@@ -371,9 +371,9 @@ class V0Worker {
     }
     handleCancelStepRun(action) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { stepRunId } = action;
+            const { taskRunExternalId } = action;
             try {
-                this.logger.info(`Cancelling task run ${action.stepRunId}`);
+                this.logger.info(`Cancelling task run ${action.taskRunExternalId}`);
                 const future = this.futures[(0, action_listener_1.createActionKey)(action)];
                 const context = this.contexts[(0, action_listener_1.createActionKey)(action)];
                 if (context && context.controller) {
@@ -381,7 +381,7 @@ class V0Worker {
                 }
                 if (future) {
                     future.promise.catch(() => {
-                        this.logger.info(`Cancelled task run ${action.stepRunId}`);
+                        this.logger.info(`Cancelled task run ${action.taskRunExternalId}`);
                     });
                     future.cancel('Cancelled by worker');
                     yield future.promise;
@@ -389,7 +389,7 @@ class V0Worker {
             }
             catch (e) {
                 // Expected: the promise rejects when cancelled
-                this.logger.debug(`Task run ${stepRunId} cancellation completed`);
+                this.logger.debug(`Task run ${taskRunExternalId} cancellation completed`);
             }
             finally {
                 delete this.futures[(0, action_listener_1.createActionKey)(action)];

package/examples/webhooks.d.ts

@@ -0,0 +1 @@
+export {};