@hatchet-dev/typescript-sdk 0.6.1 → 0.7.0

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

@@ -18,5 +18,6 @@ export declare class DispatcherClient {
     sendStepActionEvent(in_: StepActionEvent): 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>;
 }
 export {};

package/clients/dispatcher/dispatcher-client.js

@@ -58,5 +58,18 @@ class DispatcherClient {
             });
         });
     }
+    refreshTimeout(incrementTimeoutBy, stepRunId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return this.client.refreshTimeout({
+                    stepRunId,
+                    incrementTimeoutBy,
+                });
+            }
+            catch (e) {
+                throw new hatchet_error_1.default(e.message);
+            }
+        });
+    }
 }
 exports.DispatcherClient = DispatcherClient;

package/package.json

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

package/protoc/dispatcher/dispatcher.d.ts

@@ -211,6 +211,20 @@ export interface HeartbeatRequest {
 }
 export interface HeartbeatResponse {
 }
+export interface RefreshTimeoutRequest {
+    /** the id of the step run to release */
+    stepRunId: string;
+    incrementTimeoutBy: string;
+}
+export interface RefreshTimeoutResponse {
+    timeoutAt: Date | undefined;
+}
+export interface ReleaseSlotRequest {
+    /** the id of the step run to release */
+    stepRunId: string;
+}
+export interface ReleaseSlotResponse {
+}
 export declare const WorkerRegisterRequest: {
     encode(message: WorkerRegisterRequest, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): WorkerRegisterRequest;
@@ -355,6 +369,38 @@ export declare const HeartbeatResponse: {
     create(base?: DeepPartial<HeartbeatResponse>): HeartbeatResponse;
     fromPartial(_: DeepPartial<HeartbeatResponse>): HeartbeatResponse;
 };
+export declare const RefreshTimeoutRequest: {
+    encode(message: RefreshTimeoutRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): RefreshTimeoutRequest;
+    fromJSON(object: any): RefreshTimeoutRequest;
+    toJSON(message: RefreshTimeoutRequest): unknown;
+    create(base?: DeepPartial<RefreshTimeoutRequest>): RefreshTimeoutRequest;
+    fromPartial(object: DeepPartial<RefreshTimeoutRequest>): RefreshTimeoutRequest;
+};
+export declare const RefreshTimeoutResponse: {
+    encode(message: RefreshTimeoutResponse, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): RefreshTimeoutResponse;
+    fromJSON(object: any): RefreshTimeoutResponse;
+    toJSON(message: RefreshTimeoutResponse): unknown;
+    create(base?: DeepPartial<RefreshTimeoutResponse>): RefreshTimeoutResponse;
+    fromPartial(object: DeepPartial<RefreshTimeoutResponse>): RefreshTimeoutResponse;
+};
+export declare const ReleaseSlotRequest: {
+    encode(message: ReleaseSlotRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): ReleaseSlotRequest;
+    fromJSON(object: any): ReleaseSlotRequest;
+    toJSON(message: ReleaseSlotRequest): unknown;
+    create(base?: DeepPartial<ReleaseSlotRequest>): ReleaseSlotRequest;
+    fromPartial(object: DeepPartial<ReleaseSlotRequest>): ReleaseSlotRequest;
+};
+export declare const ReleaseSlotResponse: {
+    encode(_: ReleaseSlotResponse, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): ReleaseSlotResponse;
+    fromJSON(_: any): ReleaseSlotResponse;
+    toJSON(_: ReleaseSlotResponse): unknown;
+    create(base?: DeepPartial<ReleaseSlotResponse>): ReleaseSlotResponse;
+    fromPartial(_: DeepPartial<ReleaseSlotResponse>): ReleaseSlotResponse;
+};
 export type DispatcherDefinition = typeof DispatcherDefinition;
 export declare const DispatcherDefinition: {
     readonly name: "Dispatcher";
@@ -585,6 +631,50 @@ export declare const DispatcherDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly refreshTimeout: {
+            readonly name: "RefreshTimeout";
+            readonly requestType: {
+                encode(message: RefreshTimeoutRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): RefreshTimeoutRequest;
+                fromJSON(object: any): RefreshTimeoutRequest;
+                toJSON(message: RefreshTimeoutRequest): unknown;
+                create(base?: DeepPartial<RefreshTimeoutRequest>): RefreshTimeoutRequest;
+                fromPartial(object: DeepPartial<RefreshTimeoutRequest>): RefreshTimeoutRequest;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                encode(message: RefreshTimeoutResponse, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): RefreshTimeoutResponse;
+                fromJSON(object: any): RefreshTimeoutResponse;
+                toJSON(message: RefreshTimeoutResponse): unknown;
+                create(base?: DeepPartial<RefreshTimeoutResponse>): RefreshTimeoutResponse;
+                fromPartial(object: DeepPartial<RefreshTimeoutResponse>): RefreshTimeoutResponse;
+            };
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly releaseSlot: {
+            readonly name: "ReleaseSlot";
+            readonly requestType: {
+                encode(message: ReleaseSlotRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): ReleaseSlotRequest;
+                fromJSON(object: any): ReleaseSlotRequest;
+                toJSON(message: ReleaseSlotRequest): unknown;
+                create(base?: DeepPartial<ReleaseSlotRequest>): ReleaseSlotRequest;
+                fromPartial(object: DeepPartial<ReleaseSlotRequest>): ReleaseSlotRequest;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                encode(_: ReleaseSlotResponse, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): ReleaseSlotResponse;
+                fromJSON(_: any): ReleaseSlotResponse;
+                toJSON(_: ReleaseSlotResponse): unknown;
+                create(base?: DeepPartial<ReleaseSlotResponse>): ReleaseSlotResponse;
+                fromPartial(_: DeepPartial<ReleaseSlotResponse>): ReleaseSlotResponse;
+            };
+            readonly responseStream: false;
+            readonly options: {};
+        };
     };
 };
 export interface DispatcherServiceImplementation<CallContextExt = {}> {
@@ -603,6 +693,8 @@ export interface DispatcherServiceImplementation<CallContextExt = {}> {
     sendGroupKeyActionEvent(request: GroupKeyActionEvent, context: CallContext & CallContextExt): Promise<DeepPartial<ActionEventResponse>>;
     putOverridesData(request: OverridesData, context: CallContext & CallContextExt): Promise<DeepPartial<OverridesDataResponse>>;
     unsubscribe(request: WorkerUnsubscribeRequest, context: CallContext & CallContextExt): Promise<DeepPartial<WorkerUnsubscribeResponse>>;
+    refreshTimeout(request: RefreshTimeoutRequest, context: CallContext & CallContextExt): Promise<DeepPartial<RefreshTimeoutResponse>>;
+    releaseSlot(request: ReleaseSlotRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ReleaseSlotResponse>>;
 }
 export interface DispatcherClient<CallOptionsExt = {}> {
     register(request: DeepPartial<WorkerRegisterRequest>, options?: CallOptions & CallOptionsExt): Promise<WorkerRegisterResponse>;
@@ -620,6 +712,8 @@ export interface DispatcherClient<CallOptionsExt = {}> {
     sendGroupKeyActionEvent(request: DeepPartial<GroupKeyActionEvent>, options?: CallOptions & CallOptionsExt): Promise<ActionEventResponse>;
     putOverridesData(request: DeepPartial<OverridesData>, options?: CallOptions & CallOptionsExt): Promise<OverridesDataResponse>;
     unsubscribe(request: DeepPartial<WorkerUnsubscribeRequest>, options?: CallOptions & CallOptionsExt): Promise<WorkerUnsubscribeResponse>;
+    refreshTimeout(request: DeepPartial<RefreshTimeoutRequest>, options?: CallOptions & CallOptionsExt): Promise<RefreshTimeoutResponse>;
+    releaseSlot(request: DeepPartial<ReleaseSlotRequest>, options?: CallOptions & CallOptionsExt): Promise<ReleaseSlotResponse>;
 }
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {

package/protoc/dispatcher/dispatcher.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DispatcherDefinition = 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.WorkerRegisterResponse = exports.WorkerRegisterRequest = exports.workflowRunEventTypeToJSON = exports.workflowRunEventTypeFromJSON = exports.WorkflowRunEventType = exports.resourceEventTypeToJSON = exports.resourceEventTypeFromJSON = exports.ResourceEventType = exports.resourceTypeToJSON = exports.resourceTypeFromJSON = exports.ResourceType = exports.stepActionEventTypeToJSON = exports.stepActionEventTypeFromJSON = exports.StepActionEventType = exports.groupKeyActionEventTypeToJSON = exports.groupKeyActionEventTypeFromJSON = exports.GroupKeyActionEventType = exports.actionTypeToJSON = exports.actionTypeFromJSON = exports.ActionType = exports.protobufPackage = void 0;
+exports.DispatcherDefinition = 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.WorkerRegisterResponse = exports.WorkerRegisterRequest = exports.workflowRunEventTypeToJSON = exports.workflowRunEventTypeFromJSON = exports.WorkflowRunEventType = exports.resourceEventTypeToJSON = exports.resourceEventTypeFromJSON = exports.ResourceEventType = exports.resourceTypeToJSON = exports.resourceTypeFromJSON = exports.ResourceType = exports.stepActionEventTypeToJSON = exports.stepActionEventTypeFromJSON = exports.StepActionEventType = exports.groupKeyActionEventTypeToJSON = exports.groupKeyActionEventTypeFromJSON = exports.GroupKeyActionEventType = exports.actionTypeToJSON = exports.actionTypeFromJSON = exports.ActionType = exports.protobufPackage = void 0;
 const _m0 = __importStar(require("protobufjs/minimal"));
 const timestamp_1 = require("../google/protobuf/timestamp");
 exports.protobufPackage = '';
@@ -1978,6 +1978,214 @@ exports.HeartbeatResponse = {
         return message;
     },
 };
+function createBaseRefreshTimeoutRequest() {
+    return { stepRunId: '', incrementTimeoutBy: '' };
+}
+exports.RefreshTimeoutRequest = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.stepRunId !== '') {
+            writer.uint32(10).string(message.stepRunId);
+        }
+        if (message.incrementTimeoutBy !== '') {
+            writer.uint32(18).string(message.incrementTimeoutBy);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseRefreshTimeoutRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.stepRunId = reader.string();
+                    continue;
+                case 2:
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.incrementTimeoutBy = reader.string();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            stepRunId: isSet(object.stepRunId) ? globalThis.String(object.stepRunId) : '',
+            incrementTimeoutBy: isSet(object.incrementTimeoutBy)
+                ? globalThis.String(object.incrementTimeoutBy)
+                : '',
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.stepRunId !== '') {
+            obj.stepRunId = message.stepRunId;
+        }
+        if (message.incrementTimeoutBy !== '') {
+            obj.incrementTimeoutBy = message.incrementTimeoutBy;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.RefreshTimeoutRequest.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b;
+        const message = createBaseRefreshTimeoutRequest();
+        message.stepRunId = (_a = object.stepRunId) !== null && _a !== void 0 ? _a : '';
+        message.incrementTimeoutBy = (_b = object.incrementTimeoutBy) !== null && _b !== void 0 ? _b : '';
+        return message;
+    },
+};
+function createBaseRefreshTimeoutResponse() {
+    return { timeoutAt: undefined };
+}
+exports.RefreshTimeoutResponse = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.timeoutAt !== undefined) {
+            timestamp_1.Timestamp.encode(toTimestamp(message.timeoutAt), writer.uint32(10).fork()).ldelim();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseRefreshTimeoutResponse();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.timeoutAt = fromTimestamp(timestamp_1.Timestamp.decode(reader, reader.uint32()));
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return { timeoutAt: isSet(object.timeoutAt) ? fromJsonTimestamp(object.timeoutAt) : undefined };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.timeoutAt !== undefined) {
+            obj.timeoutAt = message.timeoutAt.toISOString();
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.RefreshTimeoutResponse.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a;
+        const message = createBaseRefreshTimeoutResponse();
+        message.timeoutAt = (_a = object.timeoutAt) !== null && _a !== void 0 ? _a : undefined;
+        return message;
+    },
+};
+function createBaseReleaseSlotRequest() {
+    return { stepRunId: '' };
+}
+exports.ReleaseSlotRequest = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.stepRunId !== '') {
+            writer.uint32(10).string(message.stepRunId);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseReleaseSlotRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.stepRunId = reader.string();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return { stepRunId: isSet(object.stepRunId) ? globalThis.String(object.stepRunId) : '' };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.stepRunId !== '') {
+            obj.stepRunId = message.stepRunId;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.ReleaseSlotRequest.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a;
+        const message = createBaseReleaseSlotRequest();
+        message.stepRunId = (_a = object.stepRunId) !== null && _a !== void 0 ? _a : '';
+        return message;
+    },
+};
+function createBaseReleaseSlotResponse() {
+    return {};
+}
+exports.ReleaseSlotResponse = {
+    encode(_, writer = _m0.Writer.create()) {
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseReleaseSlotResponse();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(_) {
+        return {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.ReleaseSlotResponse.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(_) {
+        const message = createBaseReleaseSlotResponse();
+        return message;
+    },
+};
 exports.DispatcherDefinition = {
     name: 'Dispatcher',
     fullName: 'Dispatcher',
@@ -2067,6 +2275,22 @@ exports.DispatcherDefinition = {
             responseStream: false,
             options: {},
         },
+        refreshTimeout: {
+            name: 'RefreshTimeout',
+            requestType: exports.RefreshTimeoutRequest,
+            requestStream: false,
+            responseType: exports.RefreshTimeoutResponse,
+            responseStream: false,
+            options: {},
+        },
+        releaseSlot: {
+            name: 'ReleaseSlot',
+            requestType: exports.ReleaseSlotRequest,
+            requestStream: false,
+            responseType: exports.ReleaseSlotResponse,
+            responseStream: false,
+            options: {},
+        },
     },
 };
 function toTimestamp(date) {

package/step.d.ts

@@ -86,6 +86,14 @@ export declare class Context<T, K> {
     workflowRunId(): string;
     playground(name: string, defaultValue?: string): string;
     log(message: string, level?: LogLevel): void;
+    /**
+     * Refreshes the timeout for the current step.
+     * @param incrementBy - The interval by which to increment the timeout.
+     *                     The interval should be specified in the format of '10s' for 10 seconds,
+     *                     '1m' for 1 minute, or '1d' for 1 day.
+     */
+    refreshTimeout(incrementBy: string): Promise<void>;
+    releaseSlot(): Promise<void>;
     putStream(data: string | Uint8Array): Promise<void>;
     spawnWorkflow<P = unknown, Q = unknown>(workflowName: string, input: Q, key?: string): ChildWorkflowRef<P>;
 }

package/step.js

@@ -188,6 +188,30 @@ class Context {
         }
         this.client.event.putLog(stepRunId, message, level);
     }
+    /**
+     * Refreshes the timeout for the current step.
+     * @param incrementBy - The interval by which to increment the timeout.
+     *                     The interval should be specified in the format of '10s' for 10 seconds,
+     *                     '1m' for 1 minute, or '1d' for 1 day.
+     */
+    refreshTimeout(incrementBy) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { stepRunId } = this.action;
+            if (!stepRunId) {
+                // log a warning
+                this.logger.warn('cannot refresh timeout from context without stepRunId');
+                return;
+            }
+            yield this.client.dispatcher.refreshTimeout(incrementBy, stepRunId);
+        });
+    }
+    releaseSlot() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.client.dispatcher.client.releaseSlot({
+                stepRunId: this.action.stepRunId,
+            });
+        });
+    }
     putStream(data) {
         return __awaiter(this, void 0, void 0, function* () {
             const { stepRunId } = this.action;