@hatchet-dev/typescript-sdk 1.16.0 → 1.17.0

package/protoc/dispatcher/dispatcher.js

@@ -5,7 +5,7 @@
 //   protoc               v3.19.1
 // source: dispatcher/dispatcher.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DispatcherDefinition = exports.GetVersionResponse = exports.GetVersionRequest = exports.ReleaseSlotResponse = exports.ReleaseSlotRequest = exports.RefreshTimeoutResponse = exports.RefreshTimeoutRequest = exports.HeartbeatResponse = exports.HeartbeatRequest = exports.OverridesDataResponse = exports.OverridesData = exports.StepRunResult = exports.WorkflowRunEvent = exports.WorkflowEvent = exports.SubscribeToWorkflowRunsRequest = exports.SubscribeToWorkflowEventsRequest = exports.ActionEventResponse = exports.StepActionEvent = exports.GroupKeyActionEvent = exports.WorkerUnsubscribeResponse = exports.WorkerUnsubscribeRequest = exports.WorkerListenRequest = exports.AssignedAction = exports.UpsertWorkerLabelsResponse = exports.UpsertWorkerLabelsRequest_LabelsEntry = exports.UpsertWorkerLabelsRequest = exports.WorkerRegisterResponse = exports.WorkerRegisterRequest_SlotConfigEntry = exports.WorkerRegisterRequest_LabelsEntry = exports.WorkerRegisterRequest = exports.RuntimeInfo = exports.WorkerLabels = exports.WorkflowRunEventType = exports.ResourceEventType = exports.ResourceType = exports.StepActionEventType = exports.GroupKeyActionEventType = exports.ActionType = exports.SDKS = exports.protobufPackage = void 0;
+exports.DispatcherDefinition = exports.GetVersionResponse = exports.GetVersionRequest = exports.RestoreEvictedTaskResponse = exports.RestoreEvictedTaskRequest = exports.ReleaseSlotResponse = exports.ReleaseSlotRequest = exports.RefreshTimeoutResponse = exports.RefreshTimeoutRequest = exports.HeartbeatResponse = exports.HeartbeatRequest = exports.OverridesDataResponse = exports.OverridesData = exports.StepRunResult = exports.WorkflowRunEvent = exports.WorkflowEvent = exports.SubscribeToWorkflowRunsRequest = exports.SubscribeToWorkflowEventsRequest = exports.ActionEventResponse = exports.StepActionEvent = exports.GroupKeyActionEvent = exports.WorkerUnsubscribeResponse = exports.WorkerUnsubscribeRequest = exports.WorkerListenRequest = exports.AssignedAction = exports.UpsertWorkerLabelsResponse = exports.UpsertWorkerLabelsRequest_LabelsEntry = exports.UpsertWorkerLabelsRequest = exports.WorkerRegisterResponse = exports.WorkerRegisterRequest_SlotConfigEntry = exports.WorkerRegisterRequest_LabelsEntry = exports.WorkerRegisterRequest = exports.RuntimeInfo = exports.WorkerLabels = exports.WorkflowRunEventType = exports.ResourceEventType = exports.ResourceType = exports.StepActionEventType = exports.GroupKeyActionEventType = exports.ActionType = exports.SDKS = exports.protobufPackage = void 0;
 exports.sDKSFromJSON = sDKSFromJSON;
 exports.sDKSToJSON = sDKSToJSON;
 exports.actionTypeFromJSON = actionTypeFromJSON;
@@ -1206,6 +1206,7 @@ function createBaseAssignedAction() {
         priority: 0,
         workflowId: undefined,
         workflowVersionId: undefined,
+        durableTaskInvocationCount: undefined,
     };
 }
 exports.AssignedAction = {
@@ -1270,6 +1271,9 @@ exports.AssignedAction = {
         if (message.workflowVersionId !== undefined) {
             writer.uint32(162).string(message.workflowVersionId);
         }
+        if (message.durableTaskInvocationCount !== undefined) {
+            writer.uint32(168).int32(message.durableTaskInvocationCount);
+        }
         return writer;
     },
     decode(input, length) {
@@ -1419,6 +1423,13 @@ exports.AssignedAction = {
                     message.workflowVersionId = reader.string();
                     continue;
                 }
+                case 21: {
+                    if (tag !== 168) {
+                        break;
+                    }
+                    message.durableTaskInvocationCount = reader.int32();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1463,6 +1474,9 @@ exports.AssignedAction = {
             workflowVersionId: isSet(object.workflowVersionId)
                 ? globalThis.String(object.workflowVersionId)
                 : undefined,
+            durableTaskInvocationCount: isSet(object.durableTaskInvocationCount)
+                ? globalThis.Number(object.durableTaskInvocationCount)
+                : undefined,
         };
     },
     toJSON(message) {
@@ -1527,13 +1541,16 @@ exports.AssignedAction = {
         if (message.workflowVersionId !== undefined) {
             obj.workflowVersionId = message.workflowVersionId;
         }
+        if (message.durableTaskInvocationCount !== undefined) {
+            obj.durableTaskInvocationCount = Math.round(message.durableTaskInvocationCount);
+        }
         return obj;
     },
     create(base) {
         return exports.AssignedAction.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w;
         const message = createBaseAssignedAction();
         message.tenantId = (_a = object.tenantId) !== null && _a !== void 0 ? _a : '';
         message.workflowRunId = (_b = object.workflowRunId) !== null && _b !== void 0 ? _b : '';
@@ -1555,6 +1572,7 @@ exports.AssignedAction = {
         message.priority = (_t = object.priority) !== null && _t !== void 0 ? _t : 0;
         message.workflowId = (_u = object.workflowId) !== null && _u !== void 0 ? _u : undefined;
         message.workflowVersionId = (_v = object.workflowVersionId) !== null && _v !== void 0 ? _v : undefined;
+        message.durableTaskInvocationCount = (_w = object.durableTaskInvocationCount) !== null && _w !== void 0 ? _w : undefined;
         return message;
     },
 };
@@ -3206,6 +3224,114 @@ exports.ReleaseSlotResponse = {
         return message;
     },
 };
+function createBaseRestoreEvictedTaskRequest() {
+    return { taskRunExternalId: '' };
+}
+exports.RestoreEvictedTaskRequest = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.taskRunExternalId !== '') {
+            writer.uint32(10).string(message.taskRunExternalId);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseRestoreEvictedTaskRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.taskRunExternalId = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            taskRunExternalId: isSet(object.taskRunExternalId)
+                ? globalThis.String(object.taskRunExternalId)
+                : '',
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.taskRunExternalId !== '') {
+            obj.taskRunExternalId = message.taskRunExternalId;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.RestoreEvictedTaskRequest.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a;
+        const message = createBaseRestoreEvictedTaskRequest();
+        message.taskRunExternalId = (_a = object.taskRunExternalId) !== null && _a !== void 0 ? _a : '';
+        return message;
+    },
+};
+function createBaseRestoreEvictedTaskResponse() {
+    return { requeued: false };
+}
+exports.RestoreEvictedTaskResponse = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.requeued !== false) {
+            writer.uint32(8).bool(message.requeued);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseRestoreEvictedTaskResponse();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 8) {
+                        break;
+                    }
+                    message.requeued = reader.bool();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return { requeued: isSet(object.requeued) ? globalThis.Boolean(object.requeued) : false };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.requeued !== false) {
+            obj.requeued = message.requeued;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.RestoreEvictedTaskResponse.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a;
+        const message = createBaseRestoreEvictedTaskResponse();
+        message.requeued = (_a = object.requeued) !== null && _a !== void 0 ? _a : false;
+        return message;
+    },
+};
 function createBaseGetVersionRequest() {
     return {};
 }
@@ -3400,6 +3526,14 @@ exports.DispatcherDefinition = {
             responseStream: false,
             options: {},
         },
+        restoreEvictedTask: {
+            name: 'RestoreEvictedTask',
+            requestType: exports.RestoreEvictedTaskRequest,
+            requestStream: false,
+            responseType: exports.RestoreEvictedTaskResponse,
+            responseStream: false,
+            options: {},
+        },
         upsertWorkerLabels: {
             name: 'UpsertWorkerLabels',
             requestType: exports.UpsertWorkerLabelsRequest,

package/protoc/v1/dispatcher.d.ts

@@ -1,7 +1,142 @@
 import { BinaryReader, BinaryWriter } from '@bufbuild/protobuf/wire';
 import type { CallContext, CallOptions } from 'nice-grpc-common';
 import { DurableEventListenerConditions } from './shared/condition';
+import { TriggerWorkflowRequest } from './shared/trigger';
 export declare const protobufPackage = "v1";
+export declare enum DurableTaskErrorType {
+    DURABLE_TASK_ERROR_TYPE_UNSPECIFIED = 0,
+    DURABLE_TASK_ERROR_TYPE_NONDETERMINISM = 1,
+    UNRECOGNIZED = -1
+}
+export declare function durableTaskErrorTypeFromJSON(object: any): DurableTaskErrorType;
+export declare function durableTaskErrorTypeToJSON(object: DurableTaskErrorType): string;
+export interface DurableTaskRequestRegisterWorker {
+    workerId: string;
+}
+export interface DurableTaskResponseRegisterWorker {
+    workerId: string;
+}
+export interface DurableEventLogEntryRef {
+    durableTaskExternalId: string;
+    invocationCount: number;
+    branchId: number;
+    nodeId: number;
+}
+export interface DurableTaskRunAckEntry {
+    nodeId: number;
+    branchId: number;
+}
+export interface DurableTaskEventMemoAckResponse {
+    ref: DurableEventLogEntryRef | undefined;
+    memoAlreadyExisted: boolean;
+    memoResultPayload?: Uint8Array | undefined;
+}
+export interface DurableTaskEventTriggerRunsAckResponse {
+    durableTaskExternalId: string;
+    invocationCount: number;
+    runEntries: DurableTaskRunAckEntry[];
+}
+export interface DurableTaskEventWaitForAckResponse {
+    ref: DurableEventLogEntryRef | undefined;
+}
+export interface DurableTaskEventLogEntryCompletedResponse {
+    ref: DurableEventLogEntryRef | undefined;
+    payload: Uint8Array;
+}
+export interface DurableTaskEvictInvocationRequest {
+    invocationCount: number;
+    durableTaskExternalId: string;
+    reason?: string | undefined;
+}
+/** Sent by the server after recording eviction for an evict_invocation request. */
+export interface DurableTaskEvictionAckResponse {
+    invocationCount: number;
+    durableTaskExternalId: string;
+}
+export interface DurableTaskAwaitedCompletedEntry {
+    durableTaskExternalId: string;
+    branchId: number;
+    nodeId: number;
+    invocationCount: number;
+}
+/** Sent by the server to notify a worker that its invocation is stale and should be cancelled. */
+export interface DurableTaskServerEvictNotice {
+    durableTaskExternalId: string;
+    invocationCount: number;
+    reason: string;
+}
+export interface DurableTaskWorkerStatusRequest {
+    workerId: string;
+    waitingEntries: DurableTaskAwaitedCompletedEntry[];
+}
+export interface DurableTaskCompleteMemoRequest {
+    ref: DurableEventLogEntryRef | undefined;
+    payload: Uint8Array;
+    memoKey: Uint8Array;
+}
+export interface DurableTaskMemoRequest {
+    /**
+     * The invocation_count is a monotonically increasing count that uniquely identifies an "attempt"
+     * at running a durable task. Each time the task is started, it gets a new invocation count (which has)
+     * incremented by one since the previous invocation. This allows the server (and the worker) to have a way of
+     * differentiating between different attempts of the same task running in different places, to prevent race conditions
+     * and other problems from duplication. It also allows for older invocations to be evicted cleanly
+     */
+    invocationCount: number;
+    durableTaskExternalId: string;
+    key: Uint8Array;
+    /** optional payload because we can send a memo request to check if a memo already exists */
+    payload?: Uint8Array | undefined;
+}
+export interface DurableTaskTriggerRunsRequest {
+    /**
+     * The invocation_count is a monotonically increasing count that uniquely identifies an "attempt"
+     * at running a durable task. Each time the task is started, it gets a new invocation count (which has)
+     * incremented by one since the previous invocation. This allows the server (and the worker) to have a way of
+     * differentiating between different attempts of the same task running in different places, to prevent race conditions
+     * and other problems from duplication. It also allows for older invocations to be evicted cleanly
+     */
+    invocationCount: number;
+    durableTaskExternalId: string;
+    triggerOpts: TriggerWorkflowRequest[];
+}
+export interface DurableTaskWaitForRequest {
+    /**
+     * The invocation_count is a monotonically increasing count that uniquely identifies an "attempt"
+     * at running a durable task. Each time the task is started, it gets a new invocation count (which has)
+     * incremented by one since the previous invocation. This allows the server (and the worker) to have a way of
+     * differentiating between different attempts of the same task running in different places, to prevent race conditions
+     * and other problems from duplication. It also allows for older invocations to be evicted cleanly
+     */
+    invocationCount: number;
+    durableTaskExternalId: string;
+    /** Fields for DURABLE_TASK_TRIGGER_KIND_WAIT_FOR */
+    waitForConditions?: DurableEventListenerConditions | undefined;
+}
+export interface DurableTaskRequest {
+    registerWorker?: DurableTaskRequestRegisterWorker | undefined;
+    memo?: DurableTaskMemoRequest | undefined;
+    triggerRuns?: DurableTaskTriggerRunsRequest | undefined;
+    waitFor?: DurableTaskWaitForRequest | undefined;
+    evictInvocation?: DurableTaskEvictInvocationRequest | undefined;
+    workerStatus?: DurableTaskWorkerStatusRequest | undefined;
+    completeMemo?: DurableTaskCompleteMemoRequest | undefined;
+}
+export interface DurableTaskErrorResponse {
+    ref: DurableEventLogEntryRef | undefined;
+    errorType: DurableTaskErrorType;
+    errorMessage: string;
+}
+export interface DurableTaskResponse {
+    registerWorker?: DurableTaskResponseRegisterWorker | undefined;
+    memoAck?: DurableTaskEventMemoAckResponse | undefined;
+    triggerRunsAck?: DurableTaskEventTriggerRunsAckResponse | undefined;
+    waitForAck?: DurableTaskEventWaitForAckResponse | undefined;
+    entryCompleted?: DurableTaskEventLogEntryCompletedResponse | undefined;
+    error?: DurableTaskErrorResponse | undefined;
+    evictionAck?: DurableTaskEvictionAckResponse | undefined;
+    serverEvict?: DurableTaskServerEvictNotice | undefined;
+}
 export interface RegisterDurableEventRequest {
     /** external uuid for the task run */
     taskId: string;
@@ -24,6 +159,26 @@ export interface DurableEvent {
     /** the data for the event */
     data: Uint8Array;
 }
+export declare const DurableTaskRequestRegisterWorker: MessageFns<DurableTaskRequestRegisterWorker>;
+export declare const DurableTaskResponseRegisterWorker: MessageFns<DurableTaskResponseRegisterWorker>;
+export declare const DurableEventLogEntryRef: MessageFns<DurableEventLogEntryRef>;
+export declare const DurableTaskRunAckEntry: MessageFns<DurableTaskRunAckEntry>;
+export declare const DurableTaskEventMemoAckResponse: MessageFns<DurableTaskEventMemoAckResponse>;
+export declare const DurableTaskEventTriggerRunsAckResponse: MessageFns<DurableTaskEventTriggerRunsAckResponse>;
+export declare const DurableTaskEventWaitForAckResponse: MessageFns<DurableTaskEventWaitForAckResponse>;
+export declare const DurableTaskEventLogEntryCompletedResponse: MessageFns<DurableTaskEventLogEntryCompletedResponse>;
+export declare const DurableTaskEvictInvocationRequest: MessageFns<DurableTaskEvictInvocationRequest>;
+export declare const DurableTaskEvictionAckResponse: MessageFns<DurableTaskEvictionAckResponse>;
+export declare const DurableTaskAwaitedCompletedEntry: MessageFns<DurableTaskAwaitedCompletedEntry>;
+export declare const DurableTaskServerEvictNotice: MessageFns<DurableTaskServerEvictNotice>;
+export declare const DurableTaskWorkerStatusRequest: MessageFns<DurableTaskWorkerStatusRequest>;
+export declare const DurableTaskCompleteMemoRequest: MessageFns<DurableTaskCompleteMemoRequest>;
+export declare const DurableTaskMemoRequest: MessageFns<DurableTaskMemoRequest>;
+export declare const DurableTaskTriggerRunsRequest: MessageFns<DurableTaskTriggerRunsRequest>;
+export declare const DurableTaskWaitForRequest: MessageFns<DurableTaskWaitForRequest>;
+export declare const DurableTaskRequest: MessageFns<DurableTaskRequest>;
+export declare const DurableTaskErrorResponse: MessageFns<DurableTaskErrorResponse>;
+export declare const DurableTaskResponse: MessageFns<DurableTaskResponse>;
 export declare const RegisterDurableEventRequest: MessageFns<RegisterDurableEventRequest>;
 export declare const RegisterDurableEventResponse: MessageFns<RegisterDurableEventResponse>;
 export declare const ListenForDurableEventRequest: MessageFns<ListenForDurableEventRequest>;
@@ -33,6 +188,15 @@ export declare const V1DispatcherDefinition: {
     readonly name: "V1Dispatcher";
     readonly fullName: "v1.V1Dispatcher";
     readonly methods: {
+        readonly durableTask: {
+            readonly name: "DurableTask";
+            readonly requestType: MessageFns<DurableTaskRequest>;
+            readonly requestStream: true;
+            readonly responseType: MessageFns<DurableTaskResponse>;
+            readonly responseStream: true;
+            readonly options: {};
+        };
+        /** NOTE: deprecated after DurableEventLog is implemented */
         readonly registerDurableEvent: {
             readonly name: "RegisterDurableEvent";
             readonly requestType: MessageFns<RegisterDurableEventRequest>;
@@ -52,10 +216,14 @@ export declare const V1DispatcherDefinition: {
     };
 };
 export interface V1DispatcherServiceImplementation<CallContextExt = {}> {
+    durableTask(request: AsyncIterable<DurableTaskRequest>, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<DurableTaskResponse>>;
+    /** NOTE: deprecated after DurableEventLog is implemented */
     registerDurableEvent(request: RegisterDurableEventRequest, context: CallContext & CallContextExt): Promise<DeepPartial<RegisterDurableEventResponse>>;
     listenForDurableEvent(request: AsyncIterable<ListenForDurableEventRequest>, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<DurableEvent>>;
 }
 export interface V1DispatcherClient<CallOptionsExt = {}> {
+    durableTask(request: AsyncIterable<DeepPartial<DurableTaskRequest>>, options?: CallOptions & CallOptionsExt): AsyncIterable<DurableTaskResponse>;
+    /** NOTE: deprecated after DurableEventLog is implemented */
     registerDurableEvent(request: DeepPartial<RegisterDurableEventRequest>, options?: CallOptions & CallOptionsExt): Promise<RegisterDurableEventResponse>;
     listenForDurableEvent(request: AsyncIterable<DeepPartial<ListenForDurableEventRequest>>, options?: CallOptions & CallOptionsExt): AsyncIterable<DurableEvent>;
 }