@hatchet-dev/typescript-sdk 1.25.0 → 1.26.1

package/v1/examples/e2e-worker.js

@@ -32,17 +32,18 @@ const workflow_11 = require("./durable_sleep/workflow");
 const workflow_12 = require("./logger/workflow");
 const workflow_13 = require("./non_retryable/workflow");
 const workflow_14 = require("./on_failure/workflow");
-const workflow_15 = require("./on_event/workflow");
-const workflow_16 = require("./return_exceptions/workflow");
-const workflow_17 = require("./run_details/workflow");
+const workflow_15 = require("./idempotency/workflow");
+const workflow_16 = require("./on_event/workflow");
+const workflow_17 = require("./return_exceptions/workflow");
+const workflow_18 = require("./run_details/workflow");
 const e2e_workflows_1 = require("./simple/e2e-workflows");
-const workflow_18 = require("./streaming/workflow");
-const workflow_19 = require("./timeout/workflow");
-const workflow_20 = require("./webhooks/workflow");
-const workflow_21 = require("./child_index/workflow");
-const workflow_22 = require("./support_agent/workflow");
-const workflow_23 = require("./welcome_email/workflow");
-const workflow_24 = require("./pdf_pipeline/workflow");
+const workflow_19 = require("./streaming/workflow");
+const workflow_20 = require("./timeout/workflow");
+const workflow_21 = require("./webhooks/workflow");
+const workflow_22 = require("./child_index/workflow");
+const workflow_23 = require("./support_agent/workflow");
+const workflow_24 = require("./welcome_email/workflow");
+const workflow_25 = require("./pdf_pipeline/workflow");
 const workflows = [
     workflow_1.bulkChild,
     workflow_1.bulkParentWorkflow,
@@ -86,25 +87,27 @@ const workflows = [
     (0, workflow_12.createLoggingWorkflow)(hatchet_client_1.hatchet),
     workflow_13.nonRetryableWorkflow,
     workflow_14.failureWorkflow,
-    workflow_15.lower,
-    workflow_16.returnExceptionsTask,
-    workflow_17.runDetailTestWorkflow,
+    workflow_15.idempotentTask,
+    workflow_15.idempotentTaskShortWindow,
+    workflow_16.lower,
+    workflow_17.returnExceptionsTask,
+    workflow_18.runDetailTestWorkflow,
     e2e_workflows_1.helloWorld,
     e2e_workflows_1.helloWorldDurable,
-    workflow_18.streamingTask,
-    workflow_19.timeoutTask,
-    workflow_19.refreshTimeoutTask,
-    workflow_20.webhookWorkflow,
-    workflow_21.childIndexChild,
-    workflow_21.childIndexParent,
-    workflow_21.scenarioTask,
-    workflow_21.orchestratorTask,
-    workflow_22.supportAgent,
-    workflow_22.triageTicket,
-    workflow_22.generateReply,
-    workflow_22.escalateTicket,
-    workflow_23.welcomeEmail,
-    workflow_24.pdfPipeline,
+    workflow_19.streamingTask,
+    workflow_20.timeoutTask,
+    workflow_20.refreshTimeoutTask,
+    workflow_21.webhookWorkflow,
+    workflow_22.childIndexChild,
+    workflow_22.childIndexParent,
+    workflow_22.scenarioTask,
+    workflow_22.orchestratorTask,
+    workflow_23.supportAgent,
+    workflow_23.triageTicket,
+    workflow_23.generateReply,
+    workflow_23.escalateTicket,
+    workflow_24.welcomeEmail,
+    workflow_25.pdfPipeline,
 ];
 function main() {
     return __awaiter(this, void 0, void 0, function* () {

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

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

package/v1/examples/idempotency/run.js

@@ -0,0 +1,37 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const v1_1 = require("../..");
+const workflow_1 = require("./workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // > trigger
+        const ref1 = yield workflow_1.idempotentTask.runNoWait({ id: '123' });
+        let runId2;
+        try {
+            const ref2 = yield workflow_1.idempotentTask.runNoWait({ id: '123' });
+            runId2 = yield ref2.getWorkflowRunId();
+        }
+        catch (e) {
+            if (e instanceof v1_1.IdempotencyCollisionError) {
+                console.log(`Run with external ID ${e.existingRunExternalId} already exists for this idempotency key`);
+                runId2 = e.existingRunExternalId;
+            }
+            else {
+                throw e;
+            }
+        }
+        const res1 = yield ref1.result();
+        console.log(`Result: ${JSON.stringify(res1)}, run ID: ${runId2}`);
+        // !!
+    });
+}
+main().catch(console.error);

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

@@ -0,0 +1,10 @@
+export declare const EVENT_KEY = "ts-e2e:idempotency-example";
+export type IdempotencyInput = {
+    id: string;
+};
+export declare const idempotentTask: import("../..").TaskWorkflowDeclaration<IdempotencyInput, {
+    result: string;
+}, {}, {}, {}, {}>;
+export declare const idempotentTaskShortWindow: import("../..").TaskWorkflowDeclaration<IdempotencyInput, {
+    result: string;
+}, {}, {}, {}, {}>;

package/v1/examples/idempotency/workflow.js

@@ -0,0 +1,39 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.idempotentTaskShortWindow = exports.idempotentTask = exports.EVENT_KEY = void 0;
+const hatchet_client_1 = require("../hatchet-client");
+exports.EVENT_KEY = 'ts-e2e:idempotency-example';
+// > idempotency
+exports.idempotentTask = hatchet_client_1.hatchet.task({
+    name: 'ts-e2e-idempotent-task',
+    idempotency: {
+        strategy: 'ttl',
+        expression: 'input.id',
+        ttlMs: 60000,
+    },
+    onEvents: [exports.EVENT_KEY],
+    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+        return { result: `Hello, world from task ${input.id}` };
+    }),
+});
+// !!
+exports.idempotentTaskShortWindow = hatchet_client_1.hatchet.task({
+    name: 'ts-e2e-idempotent-task-short-window',
+    idempotency: {
+        strategy: 'ttl',
+        expression: 'input.id',
+        ttlMs: 2000,
+    },
+    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+        return { result: `Hello, world from task ${input.id}` };
+    }),
+});

package/v1/index.d.ts

@@ -12,6 +12,8 @@ export * from './slot-types';
 export * from '../legacy/legacy-transformer';
 export { NonDeterminismError } from '../util/errors/non-determinism-error';
 export { EvictionNotSupportedError } from '../util/errors/eviction-not-supported-error';
+export { IdempotencyCollisionError } from '../util/errors/idempotency-collision-error';
+export { BulkTriggerIdempotencyCollisionError } from '../util/errors/bulk-trigger-idempotency-collision-error';
 export { EvictionPolicy, DEFAULT_DURABLE_TASK_EVICTION_POLICY, } from './client/worker/eviction/eviction-policy';
 export { DurableEvictionConfig } from './client/worker/eviction/eviction-manager';
 export { MinEngineVersion, supportsEviction } from './client/worker/engine-version';

package/v1/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.supportsEviction = exports.MinEngineVersion = exports.DEFAULT_DURABLE_TASK_EVICTION_POLICY = exports.EvictionNotSupportedError = exports.NonDeterminismError = void 0;
+exports.supportsEviction = exports.MinEngineVersion = exports.DEFAULT_DURABLE_TASK_EVICTION_POLICY = exports.BulkTriggerIdempotencyCollisionError = exports.IdempotencyCollisionError = exports.EvictionNotSupportedError = exports.NonDeterminismError = void 0;
 __exportStar(require("./client/client"), exports);
 __exportStar(require("./client/features"), exports);
 __exportStar(require("./client/worker/worker"), exports);
@@ -30,6 +30,10 @@ var non_determinism_error_1 = require("../util/errors/non-determinism-error");
 Object.defineProperty(exports, "NonDeterminismError", { enumerable: true, get: function () { return non_determinism_error_1.NonDeterminismError; } });
 var eviction_not_supported_error_1 = require("../util/errors/eviction-not-supported-error");
 Object.defineProperty(exports, "EvictionNotSupportedError", { enumerable: true, get: function () { return eviction_not_supported_error_1.EvictionNotSupportedError; } });
+var idempotency_collision_error_1 = require("../util/errors/idempotency-collision-error");
+Object.defineProperty(exports, "IdempotencyCollisionError", { enumerable: true, get: function () { return idempotency_collision_error_1.IdempotencyCollisionError; } });
+var bulk_trigger_idempotency_collision_error_1 = require("../util/errors/bulk-trigger-idempotency-collision-error");
+Object.defineProperty(exports, "BulkTriggerIdempotencyCollisionError", { enumerable: true, get: function () { return bulk_trigger_idempotency_collision_error_1.BulkTriggerIdempotencyCollisionError; } });
 var eviction_policy_1 = require("./client/worker/eviction/eviction-policy");
 Object.defineProperty(exports, "DEFAULT_DURABLE_TASK_EVICTION_POLICY", { enumerable: true, get: function () { return eviction_policy_1.DEFAULT_DURABLE_TASK_EVICTION_POLICY; } });
 var engine_version_1 = require("./client/worker/engine-version");

package/v1/task.d.ts

@@ -36,6 +36,30 @@ export type Concurrency = {
  * @deprecated use Concurrency instead
  */
 export type TaskConcurrency = Concurrency;
+/**
+ * Base type for idempotency configurations.
+ */
+export type BaseIdempotencyConfig = {
+    /**
+     * CEL expression to create an idempotency key from input and metadata.
+     * @example "input.id" // use the 'id' field from input as the key
+     */
+    expression: string;
+};
+/**
+ * TTL-based idempotency: prevents duplicate runs within a sliding time window.
+ */
+export type TTLBasedIdempotencyConfig = BaseIdempotencyConfig & {
+    strategy: 'ttl';
+    /**
+     * How long the idempotency key should live (in milliseconds).
+     */
+    ttlMs: number;
+};
+/**
+ * Union of all supported idempotency configurations.
+ */
+export type IdempotencyConfig = TTLBasedIdempotencyConfig;
 export declare class NonRetryableError extends Error {
     constructor(message?: string);
 }

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.25.0";
+export declare const HATCHET_VERSION = "1.26.1";

package/version.js

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