@hatchet-dev/typescript-sdk 1.28.2 → 1.29.1

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, FeatureFlagEvaluationResult, FeatureFlagId, ListAPIMetaIntegration, ListAPITokensResponse, ListSNSIntegrations, ListSlackWebhooks, OtelSpanList, 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, TriggerRunResult, TriggerWorkflowRunRequest, UpdateCronWorkflowTriggerRequest, UpdateScheduledWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantMemberRequest, UpdateTenantRequest, UpdateWorkerRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, V1AdditionalMetadataOperator, V1BranchDurableTaskRequest, V1BranchDurableTaskResponse, V1CELDebugRequest, V1CELDebugResponse, V1CancelTaskRequest, V1CancelledTasks, V1CreateFilterRequest, V1CreateWebhookRequest, V1DagChildren, V1DurableEventLogList, V1Event, V1EventList, V1Filter, V1FilterList, V1LogLineLevel, V1LogLineList, V1LogLineOrderByDirection, V1LogsPointMetrics, V1ReplayTaskRequest, V1ReplayedTasks, V1RestoreTaskResponse, V1RunningFilter, V1TaskEventList, V1TaskPointMetrics, V1TaskRunMetrics, V1TaskStatus, V1TaskSummary, V1TaskSummaryList, V1TaskTimingList, V1TriggerWorkflowRunRequest, V1UpdateFilterRequest, V1UpdateWebhookRequest, V1Webhook, V1WebhookList, V1WebhookResponse, V1WebhookSourceName, V1WorkflowRunDetails, V1WorkflowRunDisplayNameList, V1WorkflowRunExternalIdList, WebhookWorkerCreateRequest, WebhookWorkerCreated, WebhookWorkerListResponse, WebhookWorkerRequestListResponse, Worker, WorkerList, WorkerStatus, 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, FeatureFlagEvaluationResult, FeatureFlagId, ListAPIMetaIntegration, ListAPITokensResponse, ListSNSIntegrations, ListSlackWebhooks, OtelSpanList, 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, TriggerRunResult, TriggerWorkflowRunRequest, UpdateCronWorkflowTriggerRequest, UpdateScheduledWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantMemberRequest, UpdateTenantRequest, UpdateWorkerRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, V1AdditionalMetadataOperator, V1BranchDurableTaskRequest, V1BranchDurableTaskResponse, V1CELDebugRequest, V1CELDebugResponse, V1CancelTaskRequest, V1CancelledTasks, V1CreateFilterRequest, V1CreateHTTPOperatorRequest, V1CreateWebhookRequest, V1DagChildren, V1DurableEventLogList, V1Event, V1EventList, V1Filter, V1FilterList, V1HTTPOperator, V1HTTPOperatorList, V1LogLineLevel, V1LogLineList, V1LogLineOrderByDirection, V1LogsPointMetrics, V1ReplayTaskRequest, V1ReplayedTasks, V1RestoreTaskResponse, V1RunningFilter, V1TaskEventList, V1TaskPointMetrics, V1TaskRunMetrics, V1TaskStatus, V1TaskSummary, V1TaskSummaryList, V1TaskTimingList, V1TriggerWorkflowRunRequest, V1UpdateFilterRequest, V1UpdateHTTPOperatorRequest, V1UpdateWebhookRequest, V1Webhook, V1WebhookList, V1WebhookResponse, V1WebhookSourceName, V1WorkflowRunDetails, V1WorkflowRunDisplayNameList, V1WorkflowRunExternalIdList, WebhookWorkerCreateRequest, WebhookWorkerCreated, WebhookWorkerListResponse, WebhookWorkerRequestListResponse, Worker, WorkerList, WorkerStatus, 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> {
     /**
@@ -601,6 +601,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      *
      * @tags Filter
      * @name V1FilterDelete
+     * @summary Delete a filter
      * @request DELETE:/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
      * @secure
      */
@@ -610,6 +611,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      *
      * @tags Filter
      * @name V1FilterUpdate
+     * @summary Update a filter
      * @request PATCH:/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
      * @secure
      */
@@ -664,6 +666,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      *
      * @tags Webhook
      * @name V1WebhookDelete
+     * @summary Delete a webhook
      * @request DELETE:/api/v1/stable/tenants/{tenant}/webhooks/{v1-webhook}
      * @secure
      */
@@ -687,6 +690,67 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     v1WebhookUpdate: (tenant: string, v1Webhook: string, data: V1UpdateWebhookRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1Webhook, any, {}>>;
+    /**
+     * @description Lists all HTTP operators for a tenant.
+     *
+     * @tags Operator
+     * @name V1HttpOperatorList
+     * @summary List HTTP operators
+     * @request GET:/api/v1/stable/tenants/{tenant}/operators/http
+     * @secure
+     */
+    v1HttpOperatorList: (tenant: 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<V1HTTPOperatorList, any, {}>>;
+    /**
+     * @description Create a new HTTP operator
+     *
+     * @tags Operator
+     * @name V1HttpOperatorCreate
+     * @summary Create an HTTP operator
+     * @request POST:/api/v1/stable/tenants/{tenant}/operators/http
+     * @secure
+     */
+    v1HttpOperatorCreate: (tenant: string, data: V1CreateHTTPOperatorRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1HTTPOperator, any, {}>>;
+    /**
+     * @description Get an HTTP operator by its id
+     *
+     * @tags Operator
+     * @name V1HttpOperatorGet
+     * @summary Get an HTTP operator
+     * @request GET:/api/v1/stable/operators/http/{v1-http-operator}
+     * @secure
+     */
+    v1HttpOperatorGet: (v1HttpOperator: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1HTTPOperator, any, {}>>;
+    /**
+     * @description Update an HTTP operator
+     *
+     * @tags Operator
+     * @name V1HttpOperatorUpdate
+     * @summary Update an HTTP operator
+     * @request PATCH:/api/v1/stable/operators/http/{v1-http-operator}
+     * @secure
+     */
+    v1HttpOperatorUpdate: (v1HttpOperator: string, data: V1UpdateHTTPOperatorRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1HTTPOperator, any, {}>>;
+    /**
+     * @description Delete an HTTP operator
+     *
+     * @tags Operator
+     * @name V1HttpOperatorDelete
+     * @summary Delete an HTTP operator
+     * @request DELETE:/api/v1/stable/operators/http/{v1-http-operator}
+     * @secure
+     */
+    v1HttpOperatorDelete: (v1HttpOperator: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1HTTPOperator, any, {}>>;
     /**
      * @description Evaluate a CEL expression against provided input data.
      *

package/clients/rest/generated/Api.js

@@ -301,6 +301,7 @@ class Api extends http_client_1.HttpClient {
          *
          * @tags Filter
          * @name V1FilterDelete
+         * @summary Delete a filter
          * @request DELETE:/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
          * @secure
          */
@@ -310,6 +311,7 @@ class Api extends http_client_1.HttpClient {
          *
          * @tags Filter
          * @name V1FilterUpdate
+         * @summary Update a filter
          * @request PATCH:/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
          * @secure
          */
@@ -349,6 +351,7 @@ class Api extends http_client_1.HttpClient {
          *
          * @tags Webhook
          * @name V1WebhookDelete
+         * @summary Delete a webhook
          * @request DELETE:/api/v1/stable/tenants/{tenant}/webhooks/{v1-webhook}
          * @secure
          */
@@ -372,6 +375,56 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.v1WebhookUpdate = (tenant, v1Webhook, data, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/webhooks/${v1Webhook}`, method: 'PATCH', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Lists all HTTP operators for a tenant.
+         *
+         * @tags Operator
+         * @name V1HttpOperatorList
+         * @summary List HTTP operators
+         * @request GET:/api/v1/stable/tenants/{tenant}/operators/http
+         * @secure
+         */
+        this.v1HttpOperatorList = (tenant, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/operators/http`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Create a new HTTP operator
+         *
+         * @tags Operator
+         * @name V1HttpOperatorCreate
+         * @summary Create an HTTP operator
+         * @request POST:/api/v1/stable/tenants/{tenant}/operators/http
+         * @secure
+         */
+        this.v1HttpOperatorCreate = (tenant, data, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/operators/http`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Get an HTTP operator by its id
+         *
+         * @tags Operator
+         * @name V1HttpOperatorGet
+         * @summary Get an HTTP operator
+         * @request GET:/api/v1/stable/operators/http/{v1-http-operator}
+         * @secure
+         */
+        this.v1HttpOperatorGet = (v1HttpOperator, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/operators/http/${v1HttpOperator}`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description Update an HTTP operator
+         *
+         * @tags Operator
+         * @name V1HttpOperatorUpdate
+         * @summary Update an HTTP operator
+         * @request PATCH:/api/v1/stable/operators/http/{v1-http-operator}
+         * @secure
+         */
+        this.v1HttpOperatorUpdate = (v1HttpOperator, data, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/operators/http/${v1HttpOperator}`, method: 'PATCH', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Delete an HTTP operator
+         *
+         * @tags Operator
+         * @name V1HttpOperatorDelete
+         * @summary Delete an HTTP operator
+         * @request DELETE:/api/v1/stable/operators/http/{v1-http-operator}
+         * @secure
+         */
+        this.v1HttpOperatorDelete = (v1HttpOperator, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/operators/http/${v1HttpOperator}`, method: 'DELETE', secure: true, format: 'json' }, params));
         /**
          * @description Evaluate a CEL expression against provided input data.
          *

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

@@ -141,6 +141,10 @@ export declare enum ScheduledWorkflowsMethod {
     DEFAULT = "DEFAULT",
     API = "API"
 }
+export declare enum WorkflowPauseScheduledCronRunQueueBehavior {
+    DROP = "DROP",
+    QUEUE = "QUEUE"
+}
 export declare enum RateLimitOrderByDirection {
     Asc = "asc",
     Desc = "desc"
@@ -169,7 +173,8 @@ export declare enum WorkflowRunStatus {
 export declare enum TenantMemberRole {
     OWNER = "OWNER",
     ADMIN = "ADMIN",
-    MEMBER = "MEMBER"
+    MEMBER = "MEMBER",
+    VIEWER = "VIEWER"
 }
 export declare enum TenantResource {
     WORKER = "WORKER",
@@ -415,6 +420,8 @@ export interface V1TaskSummary {
     parentTaskExternalId?: string;
     /** The idempotency key that was claimed by the task run */
     idempotencyKey?: string;
+    /** True when input, output, and event payload fields were omitted because the caller cannot view payloads. Additional metadata is still included. */
+    payloadsRestricted?: boolean;
 }
 export interface APIError {
     /**
@@ -638,6 +645,8 @@ export interface V1WorkflowRun {
      * @maxLength 36
      */
     parentTaskExternalId?: string;
+    /** True when input, output, and event payload fields were omitted because the caller cannot view payloads. Additional metadata is still included. */
+    payloadsRestricted?: boolean;
 }
 export interface WorkflowRunShapeItemForWorkflowRunDetails {
     /**
@@ -957,6 +966,8 @@ export interface V1Event {
     triggeredRuns?: V1EventTriggeredRun[];
     /** The name of the webhook that triggered this event, if applicable. */
     triggeringWebhookName?: string;
+    /** True when the event payload was omitted because the caller cannot view payloads. Additional metadata is still included. */
+    payloadsRestricted?: boolean;
 }
 export interface V1EventList {
     pagination?: PaginationResponse;
@@ -1104,6 +1115,58 @@ export interface V1UpdateWebhookRequest {
     /** Whether to return the triggered event as the response payload when this webhook is triggered */
     returnEventAsResponsePayload?: boolean;
 }
+export interface V1HTTPOperator {
+    metadata: APIResourceMeta;
+    /**
+     * The ID of the tenant associated with this operator.
+     * @format uuid
+     */
+    tenantId: string;
+    /** The name of the operator. */
+    name: string;
+    /** The HTTPS endpoint (https, port 443) that assigned tasks are delivered to. */
+    triggerEndpoint: string;
+    /** The HTTPS endpoint polled periodically to discover the actions this operator handles. */
+    healthcheckEndpoint: string;
+    /**
+     * The per-request timeout backstop, in seconds.
+     * @format int32
+     */
+    requestTimeoutSeconds: number;
+}
+export interface V1HTTPOperatorList {
+    pagination?: PaginationResponse;
+    rows?: V1HTTPOperator[];
+}
+export interface V1CreateHTTPOperatorRequest {
+    /** The name of the operator. */
+    name: string;
+    /** The HTTPS endpoint (https, port 443) that assigned tasks are delivered to. */
+    triggerEndpoint: string;
+    /** The HTTPS endpoint polled periodically to discover the actions this operator handles. */
+    healthcheckEndpoint: string;
+    /** The secret used to HMAC-sign delivered requests (sent in the X-Hatchet-Signature header). Write-only: it is never returned in responses. */
+    signingSecret: string;
+    /**
+     * The per-request timeout backstop, in seconds.
+     * @format int32
+     */
+    requestTimeoutSeconds: number;
+}
+/** Fields to update on an HTTP operator. Omitted fields are left unchanged. */
+export interface V1UpdateHTTPOperatorRequest {
+    /** The HTTPS endpoint (https, port 443) that assigned tasks are delivered to. */
+    triggerEndpoint?: string;
+    /** An optional HTTPS endpoint polled to verify the operator endpoint is reachable. */
+    healthcheckEndpoint?: string;
+    /** The secret used to HMAC-sign delivered requests. Write-only: it is never returned in responses. Provide a new value to rotate it. */
+    signingSecret?: string;
+    /**
+     * Optional override for the per-request timeout backstop, in seconds.
+     * @format int32
+     */
+    requestTimeoutSeconds?: number;
+}
 export interface V1CELDebugRequest {
     /** The CEL expression to evaluate */
     expression: string;
@@ -1189,6 +1252,11 @@ export interface APIMeta {
      * @example "eyJhbGciOiJFUzI1NiIs..."
      */
     authDisabledToken?: string;
+    /**
+     * whether this instance is running in embedded mode
+     * @example false
+     */
+    embedded?: boolean;
 }
 export interface APIMetaIntegration {
     /**
@@ -1336,6 +1404,8 @@ export interface TenantMember {
     user: UserTenantPublic;
     /** The role of the user in the tenant. */
     role: TenantMemberRole;
+    /** Whether this member can view task, event, and log payloads in the dashboard and REST API. OWNER and ADMIN always can, regardless of this flag. Defaults to true. */
+    canViewPayloads?: boolean;
     /** The tenant associated with this tenant member. */
     tenant?: Tenant;
     /** Whether this membership was explicitly granted (as opposed to synced via user-group tags). Only explicit members can have their role edited or be removed. */
@@ -1351,6 +1421,8 @@ export interface TenantInvite {
     email: string;
     /** The role of the user in the tenant. */
     role: TenantMemberRole;
+    /** Whether the invited user can view payloads. Defaults to true. */
+    canViewPayloads?: boolean;
     /** The tenant id associated with this tenant invite. */
     tenantId: string;
     /** The tenant name for the tenant. */
@@ -1434,10 +1506,14 @@ export interface CreateTenantInviteRequest {
     email: string;
     /** The role of the user in the tenant. */
     role: TenantMemberRole;
+    /** Whether the invited user can view payloads. Defaults to true. */
+    canViewPayloads?: boolean;
 }
 export interface UpdateTenantInviteRequest {
     /** The role of the user in the tenant. */
     role: TenantMemberRole;
+    /** Whether the invited user can view payloads. */
+    canViewPayloads?: boolean;
 }
 export interface APIToken {
     metadata: APIResourceMeta;
@@ -1597,6 +1673,8 @@ export interface TenantMemberList {
 export interface UpdateTenantMemberRequest {
     /** The role of the user in the tenant. */
     role: TenantMemberRole;
+    /** Whether this member can view payloads. Ignored for OWNER and ADMIN, who always can. */
+    canViewPayloads?: boolean;
 }
 export interface EventData {
     /** The data for the event (JSON bytes). */
@@ -1610,6 +1688,10 @@ export interface Workflow {
     description?: string;
     /** Whether the workflow is paused. */
     isPaused?: boolean;
+    /** The behavior of cron runs triggered while the workflow is paused. */
+    pausedWorkflowCronRunQueueBehavior?: WorkflowPauseScheduledCronRunQueueBehavior;
+    /** The behavior of scheduled runs triggered while the workflow is paused. */
+    pausedWorkflowScheduledRunQueueBehavior?: WorkflowPauseScheduledCronRunQueueBehavior;
     versions?: WorkflowVersionMeta[];
     /** The tags of the workflow. */
     tags?: WorkflowTag[];
@@ -1831,9 +1913,23 @@ export interface UpdateCronWorkflowTriggerRequest {
 export interface WorkflowRunsCancelRequest {
     workflowRunIds: string[];
 }
+export interface PauseWorkflowRequestPause {
+    /** Discriminator indicating this request pauses the workflow. */
+    action: 'pause';
+    /** The behavior of cron runs triggered while the workflow is paused. */
+    pausedWorkflowCronRunQueueBehavior: WorkflowPauseScheduledCronRunQueueBehavior;
+    /** The behavior of scheduled runs triggered while the workflow is paused. */
+    pausedWorkflowScheduledRunQueueBehavior: WorkflowPauseScheduledCronRunQueueBehavior;
+    /** The TTL for queued runs while the workflow is paused before they get dropped, expressed as a Go-style duration string (e.g. "1d7h30m"). */
+    pausedWorkflowQueueTTL: string;
+}
+export interface PauseWorkflowRequestUnpause {
+    /** Discriminator indicating this request unpauses the workflow. */
+    action: 'unpause';
+}
+export type PauseWorkflowRequest = PauseWorkflowRequestPause | PauseWorkflowRequestUnpause;
 export interface WorkflowUpdateRequest {
-    /** Whether the workflow is paused. */
-    isPaused?: boolean;
+    pause?: PauseWorkflowRequest;
 }
 export interface WorkflowConcurrency {
     /**

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.V1LogLineOrderByDirection = exports.V1AdditionalMetadataOperator = exports.V1RunningFilter = exports.V1DurableEventLogKind = exports.V1DurableWaitConditionKind = exports.OtelSpanKind = exports.OtelStatusCode = 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.StepRunEventReason = exports.StepRunEventSeverity = exports.WorkflowKind = exports.WorkflowRunOrderByField = exports.WorkerStatus = exports.WorkerType = exports.WorkerRuntimeSDKs = exports.WebhookWorkerRequestMethod = exports.FeatureFlagId = exports.PullRequestState = exports.LogLineLevel = exports.LogLineOrderByField = exports.LogLineOrderByDirection = exports.V1TaskRunStatus = void 0;
+exports.V1TaskStatus = exports.V1WorkflowType = exports.V1TaskEventType = exports.V1LogLineLevel = exports.V1LogLineOrderByDirection = exports.V1AdditionalMetadataOperator = exports.V1RunningFilter = exports.V1DurableEventLogKind = exports.V1DurableWaitConditionKind = exports.OtelSpanKind = exports.OtelStatusCode = 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.WorkflowPauseScheduledCronRunQueueBehavior = exports.ScheduledWorkflowsMethod = exports.ScheduledWorkflowsOrderByField = exports.WorkflowRunOrderByDirection = exports.ScheduledRunStatus = exports.CronWorkflowsMethod = exports.CronWorkflowsOrderByField = exports.ConcurrencyLimitStrategy = exports.ConcurrencyScope = exports.StepRunStatus = exports.JobRunStatus = exports.StepRunEventReason = exports.StepRunEventSeverity = exports.WorkflowKind = exports.WorkflowRunOrderByField = exports.WorkerStatus = exports.WorkerType = exports.WorkerRuntimeSDKs = exports.WebhookWorkerRequestMethod = exports.FeatureFlagId = exports.PullRequestState = exports.LogLineLevel = exports.LogLineOrderByField = exports.LogLineOrderByDirection = exports.V1TaskRunStatus = void 0;
 var V1TaskRunStatus;
 (function (V1TaskRunStatus) {
     V1TaskRunStatus["PENDING"] = "PENDING";
@@ -179,6 +179,11 @@ var ScheduledWorkflowsMethod;
     ScheduledWorkflowsMethod["DEFAULT"] = "DEFAULT";
     ScheduledWorkflowsMethod["API"] = "API";
 })(ScheduledWorkflowsMethod || (exports.ScheduledWorkflowsMethod = ScheduledWorkflowsMethod = {}));
+var WorkflowPauseScheduledCronRunQueueBehavior;
+(function (WorkflowPauseScheduledCronRunQueueBehavior) {
+    WorkflowPauseScheduledCronRunQueueBehavior["DROP"] = "DROP";
+    WorkflowPauseScheduledCronRunQueueBehavior["QUEUE"] = "QUEUE";
+})(WorkflowPauseScheduledCronRunQueueBehavior || (exports.WorkflowPauseScheduledCronRunQueueBehavior = WorkflowPauseScheduledCronRunQueueBehavior = {}));
 var RateLimitOrderByDirection;
 (function (RateLimitOrderByDirection) {
     RateLimitOrderByDirection["Asc"] = "asc";
@@ -214,6 +219,7 @@ var TenantMemberRole;
     TenantMemberRole["OWNER"] = "OWNER";
     TenantMemberRole["ADMIN"] = "ADMIN";
     TenantMemberRole["MEMBER"] = "MEMBER";
+    TenantMemberRole["VIEWER"] = "VIEWER";
 })(TenantMemberRole || (exports.TenantMemberRole = TenantMemberRole = {}));
 var TenantResource;
 (function (TenantResource) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "1.28.2",
+  "version": "1.29.1",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [

package/v1/client/client.d.ts

@@ -1,6 +1,6 @@
 /**
  * This is the TypeScript SDK reference, documenting methods available for interacting with Hatchet resources.
- * Check out the [user guide](https://docs.hatchet.run/home/) for an introduction to getting your first tasks running.
+ * Check out the [user guide](https://docs.hatchet.run/v1) for an introduction to getting your first tasks running.
  *
  * @module Hatchet TypeScript SDK Reference
  */

package/v1/client/client.js

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * This is the TypeScript SDK reference, documenting methods available for interacting with Hatchet resources.
- * Check out the [user guide](https://docs.hatchet.run/home/) for an introduction to getting your first tasks running.
+ * Check out the [user guide](https://docs.hatchet.run/v1) for an introduction to getting your first tasks running.
  *
  * @module Hatchet TypeScript SDK Reference
  */

package/v1/client/features/tenant.d.ts

@@ -1,6 +1,3 @@
-/**
- * @module Tenant Client
- */
 import { Tenant } from '../../../clients/rest/generated/data-contracts';
 import { HatchetClient } from '../client';
 /**

package/v1/client/worker/context.d.ts

@@ -87,7 +87,7 @@ export declare class Context<T, K = {}> {
     worker: ContextWorker;
     overridesData: Record<string, any>;
     _logger: Logger;
-    /** @deprecated — kept for backward compat; prefer {@link nextChildIndex}. */
+    /** @deprecated Kept for backward compat; prefer {@link nextChildIndex}. */
     spawnIndex: number;
     streamIndex: number;
     protected nextChildIndex(n?: number): number;

package/v1/client/worker/context.js

@@ -89,7 +89,7 @@ class Context {
         // @deprecated use ctx.abortController instead
         this.controller = new AbortController();
         this.overridesData = {};
-        /** @deprecated — kept for backward compat; prefer {@link nextChildIndex}. */
+        /** @deprecated Kept for backward compat; prefer {@link nextChildIndex}. */
         this.spawnIndex = 0;
         this.streamIndex = 0;
         try {
@@ -139,7 +139,7 @@ class Context {
             var _a, _b;
             if (this.action.batchId) {
                 // Batch tasks share one context across every buffered member, so there is no single
-                // task-run id to cancel — cancel every member of the batch instead. `this.data` is
+                // task-run id to cancel, so cancel every member of the batch instead. `this.data` is
                 // the raw batch-items map for a START_BATCH action, keyed by each member's
                 // task-run external id.
                 const memberIds = Object.keys((_a = this.data) !== null && _a !== void 0 ? _a : {});

package/v1/declaration.js

@@ -93,7 +93,7 @@ class BaseWorkflowDeclaration {
                     : undefined,
                 warn: (message) => this.client.admin.logger.warn(message),
             });
-            // Snapshot childIndex before incrementing — shared with Context.spawnIndex
+            // Snapshot childIndex before incrementing (shared with Context.spawnIndex)
             // via parentRunContextManager so both spawning APIs produce unique indices.
             const baseChildIndex = parentRunContext === null || parentRunContext === void 0 ? void 0 : parentRunContext.childIndex;
             const inputCount = Array.isArray(input) ? input.length : 1;

package/v1/embedded.d.ts

@@ -0,0 +1,71 @@
+import type { AxiosRequestConfig } from 'axios';
+import type { ClientConfig, HatchetClientOptions } from '../clients/hatchet-client';
+import { HatchetClient } from './client/client';
+export interface EmbeddedOptions {
+    /**
+     * hatchet-embedded release tag to download (defaults to HATCHET_CLIENT_EMBEDDED_VERSION or
+     * latest). Tags correspond to the Hatchet engine version baked into the sidecar,
+     * so pinning this pins the engine.
+     */
+    version?: string;
+    /** path to an existing sidecar binary, skips the download (or HATCHET_CLIENT_EMBEDDED_BINARY_PATH) */
+    binaryPath?: string;
+    /**
+     * expected sha256 hex digest of the sidecar binary. When set, it replaces the
+     * release's checksums.txt as the trust anchor, so a compromised release
+     * channel cannot substitute the binary. Pin it together with `version`.
+     */
+    checksum?: string;
+    /** use an existing Postgres instead of the bundled one */
+    databaseUrl?: string;
+    /** store the bundled Postgres runtime and data under this directory */
+    postgresDataDir?: string;
+    grpcPort?: number;
+    apiPort?: number;
+    /** set to false to start only the engine + gRPC, no REST API */
+    startApi?: boolean;
+    /** set to false to skip running migrations on startup */
+    runMigrations?: boolean;
+    /** use RabbitMQ instead of the Postgres message queue */
+    rabbitmqUrl?: string;
+    logLevel?: string;
+    readyTimeoutMs?: number;
+}
+export interface EmbeddedSidecar {
+    token: string;
+    tenantId: string;
+    grpcAddress: string;
+    apiUrl: string;
+    stop: () => Promise<void>;
+}
+/**
+ * Gracefully stops every sidecar started in this process by
+ * `HatchetEmbeddedClient.init()` (or `startEmbeddedSidecar`) and resolves once
+ * they have fully exited, including their bundled Postgres. Call this before
+ * your process exits so the engine's shutdown output does not print after
+ * your program has returned.
+ */
+export declare function stopEmbeddedSidecar(): Promise<void>;
+export declare function startEmbeddedSidecar(opts?: EmbeddedOptions): Promise<EmbeddedSidecar>;
+export declare class HatchetEmbeddedClient {
+    /**
+     * Runs a full Hatchet engine locally via the hatchet-embedded sidecar (downloaded
+     * on first use) and returns a client wired to it. By default the sidecar starts a
+     * bundled Postgres; pass `databaseUrl` to point it at your own instead.
+     * @param embeddedOpts - Options for the embedded engine (version, ports, database, ...).
+     * @param config - Optional configuration overrides for the client.
+     * @param options - Optional client options.
+     * @param axiosConfig - Optional Axios configuration for HTTP requests.
+     * @returns A new Hatchet client instance connected to the embedded engine.
+     */
+    static init<T extends Record<string, any> = {}, U extends Record<string, any> = {}>(embeddedOpts?: EmbeddedOptions, config?: Omit<Partial<ClientConfig>, 'middleware'>, options?: HatchetClientOptions, axiosConfig?: AxiosRequestConfig): Promise<EmbeddedClient<T, U>>;
+}
+export type EmbeddedClient<T extends Record<string, any> = {}, U extends Record<string, any> = {}> = HatchetClient<T, U> & {
+    /**
+     * Gracefully stops the embedded engine sidecar and resolves once it has
+     * fully exited, including its bundled Postgres. Call this before your
+     * process exits so the engine's shutdown output does not print after your
+     * program has returned.
+     */
+    stopEmbedded: () => Promise<void>;
+};