@hatchet-dev/typescript-sdk 1.26.2 → 1.27.0

package/package.json

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

package/protoc/v1/workflows.d.ts

@@ -45,6 +45,13 @@ export declare enum ConcurrencyLimitStrategy {
 }
 export declare function concurrencyLimitStrategyFromJSON(object: any): ConcurrencyLimitStrategy;
 export declare function concurrencyLimitStrategyToJSON(object: ConcurrencyLimitStrategy): string;
+export declare enum IdempotencyMethod {
+    TTL = 0,
+    STATUS = 1,
+    UNRECOGNIZED = -1
+}
+export declare function idempotencyMethodFromJSON(object: any): IdempotencyMethod;
+export declare function idempotencyMethodToJSON(object: IdempotencyMethod): string;
 export interface CancelTasksRequest {
     /** a list of external UUIDs */
     externalIds: string[];
@@ -136,8 +143,10 @@ export interface CreateWorkflowVersionRequest {
 export interface IdempotencyConfig {
     /** a CEL expression for determining the idempotency key for workflow runs */
     expression: string;
-    /** time-to-live for idempotency keys in milliseconds */
+    /** time-to-live for idempotency keys in milliseconds. if the method is `STATUS`, this is a "fallback" - the longest the key can live before it's evicted */
     ttlMs: number;
+    /** the method to use for idempotency, defaults to TTL */
+    method?: IdempotencyMethod | undefined;
 }
 export interface IdempotencyCollisionError {
     /** the external ID of the existing workflow run that caused the collision */

package/protoc/v1/workflows.js

@@ -5,7 +5,7 @@
 //   protoc               v3.19.1
 // source: v1/workflows.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdminServiceDefinition = exports.GetRunDetailsResponse_TaskRunsEntry = exports.GetRunDetailsResponse = exports.TaskRunDetail = exports.GetRunDetailsRequest = exports.CreateWorkflowVersionResponse = exports.CreateTaskRateLimit = exports.CreateTaskOpts_SlotRequestsEntry = exports.CreateTaskOpts_WorkerLabelsEntry = exports.CreateTaskOpts = exports.Concurrency = exports.DefaultFilter = exports.BulkTriggerIdempotencyCollisionError = exports.IdempotencyCollisionError = exports.IdempotencyConfig = exports.CreateWorkflowVersionRequest = exports.BranchDurableTaskResponse = exports.BranchDurableTaskRequest = exports.TriggerWorkflowRunResponse = exports.TriggerWorkflowRunRequest_DesiredWorkerLabelsEntry = exports.TriggerWorkflowRunRequest = exports.ReplayTasksResponse = exports.CancelTasksResponse = exports.TasksFilter = exports.ReplayTasksRequest = exports.CancelTasksRequest = exports.ConcurrencyLimitStrategy = exports.RunStatus = exports.RateLimitDuration = exports.StickyStrategy = exports.protobufPackage = void 0;
+exports.AdminServiceDefinition = exports.GetRunDetailsResponse_TaskRunsEntry = exports.GetRunDetailsResponse = exports.TaskRunDetail = exports.GetRunDetailsRequest = exports.CreateWorkflowVersionResponse = exports.CreateTaskRateLimit = exports.CreateTaskOpts_SlotRequestsEntry = exports.CreateTaskOpts_WorkerLabelsEntry = exports.CreateTaskOpts = exports.Concurrency = exports.DefaultFilter = exports.BulkTriggerIdempotencyCollisionError = exports.IdempotencyCollisionError = exports.IdempotencyConfig = exports.CreateWorkflowVersionRequest = exports.BranchDurableTaskResponse = exports.BranchDurableTaskRequest = exports.TriggerWorkflowRunResponse = exports.TriggerWorkflowRunRequest_DesiredWorkerLabelsEntry = exports.TriggerWorkflowRunRequest = exports.ReplayTasksResponse = exports.CancelTasksResponse = exports.TasksFilter = exports.ReplayTasksRequest = exports.CancelTasksRequest = exports.IdempotencyMethod = exports.ConcurrencyLimitStrategy = exports.RunStatus = exports.RateLimitDuration = exports.StickyStrategy = exports.protobufPackage = void 0;
 exports.stickyStrategyFromJSON = stickyStrategyFromJSON;
 exports.stickyStrategyToJSON = stickyStrategyToJSON;
 exports.rateLimitDurationFromJSON = rateLimitDurationFromJSON;
@@ -14,6 +14,8 @@ exports.runStatusFromJSON = runStatusFromJSON;
 exports.runStatusToJSON = runStatusToJSON;
 exports.concurrencyLimitStrategyFromJSON = concurrencyLimitStrategyFromJSON;
 exports.concurrencyLimitStrategyToJSON = concurrencyLimitStrategyToJSON;
+exports.idempotencyMethodFromJSON = idempotencyMethodFromJSON;
+exports.idempotencyMethodToJSON = idempotencyMethodToJSON;
 /* eslint-disable */
 const wire_1 = require("@bufbuild/protobuf/wire");
 const timestamp_1 = require("../google/protobuf/timestamp");
@@ -218,6 +220,37 @@ function concurrencyLimitStrategyToJSON(object) {
             return 'UNRECOGNIZED';
     }
 }
+var IdempotencyMethod;
+(function (IdempotencyMethod) {
+    IdempotencyMethod[IdempotencyMethod["TTL"] = 0] = "TTL";
+    IdempotencyMethod[IdempotencyMethod["STATUS"] = 1] = "STATUS";
+    IdempotencyMethod[IdempotencyMethod["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(IdempotencyMethod || (exports.IdempotencyMethod = IdempotencyMethod = {}));
+function idempotencyMethodFromJSON(object) {
+    switch (object) {
+        case 0:
+        case 'TTL':
+            return IdempotencyMethod.TTL;
+        case 1:
+        case 'STATUS':
+            return IdempotencyMethod.STATUS;
+        case -1:
+        case 'UNRECOGNIZED':
+        default:
+            return IdempotencyMethod.UNRECOGNIZED;
+    }
+}
+function idempotencyMethodToJSON(object) {
+    switch (object) {
+        case IdempotencyMethod.TTL:
+            return 'TTL';
+        case IdempotencyMethod.STATUS:
+            return 'STATUS';
+        case IdempotencyMethod.UNRECOGNIZED:
+        default:
+            return 'UNRECOGNIZED';
+    }
+}
 function createBaseCancelTasksRequest() {
     return { externalIds: [], filter: undefined };
 }
@@ -1422,7 +1455,7 @@ exports.CreateWorkflowVersionRequest = {
     },
 };
 function createBaseIdempotencyConfig() {
-    return { expression: '', ttlMs: 0 };
+    return { expression: '', ttlMs: 0, method: undefined };
 }
 exports.IdempotencyConfig = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -1432,6 +1465,9 @@ exports.IdempotencyConfig = {
         if (message.ttlMs !== 0) {
             writer.uint32(16).int64(message.ttlMs);
         }
+        if (message.method !== undefined) {
+            writer.uint32(24).int32(message.method);
+        }
         return writer;
     },
     decode(input, length) {
@@ -1455,6 +1491,13 @@ exports.IdempotencyConfig = {
                     message.ttlMs = longToNumber(reader.int64());
                     continue;
                 }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.method = reader.int32();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1471,6 +1514,7 @@ exports.IdempotencyConfig = {
                 : isSet(object.ttl_ms)
                     ? globalThis.Number(object.ttl_ms)
                     : 0,
+            method: isSet(object.method) ? idempotencyMethodFromJSON(object.method) : undefined,
         };
     },
     toJSON(message) {
@@ -1481,16 +1525,20 @@ exports.IdempotencyConfig = {
         if (message.ttlMs !== 0) {
             obj.ttlMs = Math.round(message.ttlMs);
         }
+        if (message.method !== undefined) {
+            obj.method = idempotencyMethodToJSON(message.method);
+        }
         return obj;
     },
     create(base) {
         return exports.IdempotencyConfig.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b;
+        var _a, _b, _c;
         const message = createBaseIdempotencyConfig();
         message.expression = (_a = object.expression) !== null && _a !== void 0 ? _a : '';
         message.ttlMs = (_b = object.ttlMs) !== null && _b !== void 0 ? _b : 0;
+        message.method = (_c = object.method) !== null && _c !== void 0 ? _c : undefined;
         return message;
     },
 };

package/v1/client/worker/worker-internal.js

@@ -63,6 +63,7 @@ const dispatcher_1 = require("../../../protoc/dispatcher");
 const hatchet_promise_1 = __importStar(require("../../../util/hatchet-promise/hatchet-promise"));
 const workflows_1 = require("../../../protoc/workflows");
 const logger_1 = require("../../../util/logger");
+const workflows_2 = require("../../../protoc/v1/workflows");
 const task_1 = require("../../task");
 const transformer_1 = require("../../conditions/transformer");
 const z = __importStar(require("zod/v4"));
@@ -338,7 +339,12 @@ class InternalWorker {
                     idempotency: workflow.idempotency
                         ? {
                             expression: workflow.idempotency.expression,
-                            ttlMs: workflow.idempotency.ttlMs,
+                            ttlMs: workflow.idempotency.strategy === 'status'
+                                ? workflow.idempotency.fallbackTtlMs
+                                : workflow.idempotency.ttlMs,
+                            method: workflow.idempotency.strategy === 'status'
+                                ? workflows_2.IdempotencyMethod.STATUS
+                                : workflows_2.IdempotencyMethod.TTL,
                         }
                         : undefined,
                 });

package/v1/examples/idempotency/workflow.d.ts

@@ -8,3 +8,6 @@ export declare const idempotentTask: import("../..").TaskWorkflowDeclaration<Ide
 export declare const idempotentTaskShortWindow: import("../..").TaskWorkflowDeclaration<IdempotencyInput, {
     result: string;
 }, {}, {}, {}, {}>;
+export declare const idempotentStatusBasedTask: import("../..").TaskWorkflowDeclaration<IdempotencyInput, {
+    result: string;
+}, {}, {}, {}, {}>;

package/v1/examples/idempotency/workflow.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.idempotentTaskShortWindow = exports.idempotentTask = exports.EVENT_KEY = void 0;
+exports.idempotentStatusBasedTask = exports.idempotentTaskShortWindow = exports.idempotentTask = exports.EVENT_KEY = void 0;
 const hatchet_client_1 = require("../hatchet-client");
 exports.EVENT_KEY = 'ts-e2e:idempotency-example';
 // > idempotency
@@ -37,3 +37,16 @@ exports.idempotentTaskShortWindow = hatchet_client_1.hatchet.task({
         return { result: `Hello, world from task ${input.id}` };
     }),
 });
+// > status-based-idempotency
+exports.idempotentStatusBasedTask = hatchet_client_1.hatchet.task({
+    name: 'ts-e2e-idempotent-status-based-task',
+    idempotency: {
+        strategy: 'status',
+        expression: 'input.id',
+        fallbackTtlMs: 10000,
+    },
+    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+        return { result: `Hello, world from task ${input.id}` };
+    }),
+});
+// !!

package/v1/task.d.ts

@@ -56,10 +56,22 @@ export type TTLBasedIdempotencyConfig = BaseIdempotencyConfig & {
      */
     ttlMs: number;
 };
+/**
+ * Status-based idempotency: keeps the idempotency key alive until the associated run
+ * reaches a terminal status. `fallbackTtlMs` caps how long the key can live before it's evicted.
+ */
+export type StatusBasedIdempotencyConfig = BaseIdempotencyConfig & {
+    strategy: 'status';
+    /**
+     * Fallback time-to-live (in milliseconds): the longest the idempotency key can live
+     * before it's evicted, even if the run has not reached a terminal status.
+     */
+    fallbackTtlMs: number;
+};
 /**
  * Union of all supported idempotency configurations.
  */
-export type IdempotencyConfig = TTLBasedIdempotencyConfig;
+export type IdempotencyConfig = TTLBasedIdempotencyConfig | StatusBasedIdempotencyConfig;
 export declare class NonRetryableError extends Error {
     constructor(message?: string);
 }

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.26.2";
+export declare const HATCHET_VERSION = "1.27.0";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HATCHET_VERSION = void 0;
-exports.HATCHET_VERSION = '1.26.2';
+exports.HATCHET_VERSION = '1.27.0';