@hatchet-dev/typescript-sdk 1.22.3 → 1.23.1

package/v1/examples/support_agent_tools/agent-claude.js

@@ -0,0 +1,109 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const tools_1 = require("./tools");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, e_1, _b, _c;
+        const lookupCustomerTool = (0, tools_1.createLookupCustomerToolClaude)();
+        const checkOrderStatusTool = (0, tools_1.createCheckOrderStatusToolClaude)();
+        const ticketTool = (0, tools_1.createTicketToolClaude)();
+        // The Claude Agent SDK is ESM-only, so avoid loading it at module import time.
+        // Run this example with an ESM-compatible TypeScript runner.
+        const { query, createSdkMcpServer } = yield Promise.resolve().then(() => __importStar(require('@anthropic-ai/claude-agent-sdk')));
+        // Wrap the tools in an in-process MCP server
+        const supportServer = createSdkMcpServer({
+            name: 'support',
+            version: '1.0.0',
+            tools: [lookupCustomerTool, checkOrderStatusTool, ticketTool],
+        });
+        try {
+            for (var _d = true, _e = __asyncValues(query({
+                prompt: 'Customer C-100 says order ORD-9987 has not arrived. ' +
+                    'Look up the customer, check the order status, and create a ' +
+                    'support ticket if the order has a known issue or delayed delivery. ' +
+                    'If you create a ticket, use priority "high", subject ' +
+                    '"Delayed order ORD-9987", and a body that summarizes the known ' +
+                    'carrier delay. Then summarize what happened.',
+                options: {
+                    mcpServers: { support: supportServer },
+                    allowedTools: [
+                        `mcp__${supportServer.name}__${lookupCustomerTool.name}`,
+                        `mcp__${supportServer.name}__${checkOrderStatusTool.name}`,
+                        `mcp__${supportServer.name}__${ticketTool.name}`,
+                    ],
+                },
+            })), _f; _f = yield _e.next(), _a = _f.done, !_a; _d = true) {
+                _c = _f.value;
+                _d = false;
+                const message = _c;
+                // "result" is the final message after all tool calls complete
+                if (message.type === 'result' && message.subtype === 'success') {
+                    console.log(message.result);
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+    });
+}
+if (require.main === module) {
+    main()
+        .catch(console.error)
+        .finally(() => {
+        process.exit(0);
+    });
+}

package/v1/examples/support_agent_tools/agent-openai.d.ts

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

package/v1/examples/support_agent_tools/agent-openai.js

@@ -0,0 +1,73 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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 tools_1 = require("./tools");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const lookupCustomerTool = (0, tools_1.createLookupCustomerToolOpenai)();
+        const checkOrderStatusTool = (0, tools_1.createCheckOrderStatusToolOpenai)();
+        const ticketTool = (0, tools_1.createTicketToolOpenai)();
+        // Dynamic import — @openai/agents crashes at load time with Zod v3, so we delay
+        // the import until after mcpTool has already verified Zod v4 is available.
+        const { Agent, run } = yield Promise.resolve().then(() => __importStar(require('@openai/agents')));
+        const agent = new Agent({
+            name: 'support-agent',
+            tools: [lookupCustomerTool, checkOrderStatusTool, ticketTool],
+        });
+        const result = yield run(agent, 'Customer C-100 says order ORD-9987 has not arrived. ' +
+            'Look up the customer, check the order status, and create a ' +
+            'support ticket if the order has a known issue or delayed delivery. ' +
+            'If you create a ticket, use priority "high", subject ' +
+            '"Delayed order ORD-9987", and a body that summarizes the known ' +
+            'carrier delay. Then summarize what happened.');
+        console.log(result.finalOutput);
+    });
+}
+if (require.main === module) {
+    main()
+        .catch(console.error)
+        .finally(() => {
+        process.exit(0);
+    });
+}

package/v1/examples/support_agent_tools/tools.d.ts

@@ -0,0 +1,45 @@
+type CustomerInfo = {
+    customerId: string;
+    name: string;
+    email: string;
+    plan: string;
+    accountStatus: string;
+    defaultOrderId: string;
+    supportTier: string;
+};
+type OrderStatus = {
+    orderId: string;
+    status: string;
+    lastUpdated: string;
+    estimatedDelivery: string;
+    knownIssue: string | null;
+    carrier: string;
+    trackingNumber: string;
+};
+type TicketResult = {
+    ticketId: string;
+    status: string;
+    priority: string;
+    routingTeam: string;
+    summary: string;
+};
+export declare const lookupCustomer: import("../..").TaskWorkflowDeclaration<{
+    customerId: string;
+}, CustomerInfo, {}, {}, {}, {}>;
+export declare const checkOrderStatus: import("../..").TaskWorkflowDeclaration<{
+    orderId: string;
+}, OrderStatus, {}, {}, {}, {}>;
+export declare const createTicket: import("../..").TaskWorkflowDeclaration<{
+    customerId: string;
+    orderId: string;
+    subject: string;
+    body: string;
+    priority: string;
+}, TicketResult, {}, {}, {}, {}>;
+export declare function createLookupCustomerToolClaude(): import("@anthropic-ai/claude-agent-sdk").SdkMcpToolDefinition;
+export declare function createCheckOrderStatusToolClaude(): import("@anthropic-ai/claude-agent-sdk").SdkMcpToolDefinition;
+export declare function createTicketToolClaude(): import("@anthropic-ai/claude-agent-sdk").SdkMcpToolDefinition;
+export declare function createLookupCustomerToolOpenai(): import("@openai/agents").FunctionTool;
+export declare function createCheckOrderStatusToolOpenai(): import("@openai/agents").FunctionTool;
+export declare function createTicketToolOpenai(): import("@openai/agents").FunctionTool;
+export {};

package/v1/examples/support_agent_tools/tools.js

@@ -0,0 +1,144 @@
+"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.createTicket = exports.checkOrderStatus = exports.lookupCustomer = void 0;
+exports.createLookupCustomerToolClaude = createLookupCustomerToolClaude;
+exports.createCheckOrderStatusToolClaude = createCheckOrderStatusToolClaude;
+exports.createTicketToolClaude = createTicketToolClaude;
+exports.createLookupCustomerToolOpenai = createLookupCustomerToolOpenai;
+exports.createCheckOrderStatusToolOpenai = createCheckOrderStatusToolOpenai;
+exports.createTicketToolOpenai = createTicketToolOpenai;
+// > Setup
+const v4_1 = require("zod/v4");
+const hatchet_client_1 = require("../hatchet-client");
+// !!
+// > Models
+const CustomerLookupInput = v4_1.z.object({
+    customerId: v4_1.z.string(),
+});
+const OrderStatusInput = v4_1.z.object({
+    orderId: v4_1.z.string(),
+});
+const CreateTicketInput = v4_1.z.object({
+    customerId: v4_1.z.string(),
+    orderId: v4_1.z.string(),
+    subject: v4_1.z.string(),
+    body: v4_1.z.string(),
+    priority: v4_1.z.string(),
+});
+// !!
+// > Fixture data
+const CUSTOMERS = {
+    'C-100': {
+        customerId: 'C-100',
+        name: 'Alice Martin',
+        email: 'alice@example.com',
+        plan: 'business',
+        accountStatus: 'active',
+        defaultOrderId: 'ORD-9987',
+        supportTier: 'priority',
+    },
+};
+const ORDERS = {
+    'ORD-9987': {
+        orderId: 'ORD-9987',
+        status: 'delayed',
+        lastUpdated: '2026-05-20T14:30:00Z',
+        estimatedDelivery: '2026-05-28',
+        knownIssue: 'Carrier reported weather delay at regional hub',
+        carrier: 'FastShip',
+        trackingNumber: 'FS-482910',
+    },
+};
+// !!
+// > Lookup customer
+exports.lookupCustomer = hatchet_client_1.hatchet.task({
+    name: 'lookup-customer',
+    inputValidator: CustomerLookupInput,
+    description: 'Look up a customer by ID and return their profile, plan, and support tier.',
+    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+        const customer = CUSTOMERS[input.customerId];
+        if (!customer) {
+            return {
+                customerId: input.customerId,
+                name: 'Unknown',
+                email: 'unknown@example.com',
+                plan: 'none',
+                accountStatus: 'not_found',
+                defaultOrderId: '',
+                supportTier: 'standard',
+            };
+        }
+        return customer;
+    }),
+});
+// !!
+// > Check order status
+exports.checkOrderStatus = hatchet_client_1.hatchet.task({
+    name: 'check-order-status',
+    inputValidator: OrderStatusInput,
+    description: 'Check the current status, carrier, and any known issues for an order.',
+    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+        const order = ORDERS[input.orderId];
+        if (!order) {
+            return {
+                orderId: input.orderId,
+                status: 'not_found',
+                lastUpdated: '',
+                estimatedDelivery: '',
+                knownIssue: null,
+                carrier: 'unknown',
+                trackingNumber: '',
+            };
+        }
+        return order;
+    }),
+});
+// !!
+// > Create ticket
+exports.createTicket = hatchet_client_1.hatchet.task({
+    name: 'create-ticket',
+    inputValidator: CreateTicketInput,
+    description: 'Create a support ticket for a customer issue and return the ticket ID and routing.',
+    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+        const ticketId = `TICKET-${input.customerId}-001`;
+        return {
+            ticketId,
+            status: 'open',
+            priority: input.priority,
+            routingTeam: 'shipping-support',
+            summary: `Ticket ${ticketId} created for ${input.customerId} regarding order ${input.orderId}: ${input.subject}`,
+        };
+    }),
+});
+// !!
+// > Create Claude tools
+function createLookupCustomerToolClaude() {
+    return exports.lookupCustomer.mcpTool('claude');
+}
+function createCheckOrderStatusToolClaude() {
+    return exports.checkOrderStatus.mcpTool('claude');
+}
+function createTicketToolClaude() {
+    return exports.createTicket.mcpTool('claude');
+}
+// !!
+// > Create openai tools
+function createLookupCustomerToolOpenai() {
+    return exports.lookupCustomer.mcpTool('openai');
+}
+function createCheckOrderStatusToolOpenai() {
+    return exports.checkOrderStatus.mcpTool('openai');
+}
+function createTicketToolOpenai() {
+    return exports.createTicket.mcpTool('openai');
+}
+// !!

package/v1/examples/support_agent_tools/worker.d.ts

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

package/v1/examples/support_agent_tools/worker.js

@@ -0,0 +1,24 @@
+"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 hatchet_client_1 = require("../hatchet-client");
+const tools_1 = require("./tools");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker = yield hatchet_client_1.hatchet.worker('support-tools-worker', {
+            workflows: [tools_1.lookupCustomer, tools_1.checkOrderStatus, tools_1.createTicket],
+        });
+        yield worker.start();
+    });
+}
+if (require.main === module) {
+    main();
+}

package/v1/examples/webhooks/workflow.js

@@ -26,9 +26,9 @@ exports.handleStripePayment = hatchet_client_1.hatchet.task({
     on: {
         event: 'stripe:payment_intent.succeeded',
     },
-    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
         const { customer, amount } = input.data.object;
-        console.log(`Payment of ${amount} from ${customer}`);
+        ctx.logger.info(`Payment of ${amount} from ${customer}`);
         return { customer, amount };
     }),
 });
@@ -37,11 +37,11 @@ exports.handleGitHubPR = hatchet_client_1.hatchet.task({
     on: {
         event: 'github:pull_request:opened',
     },
-    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
         const repo = input.repository.full_name;
         const prNumber = input.pull_request.number;
         const { title } = input.pull_request;
-        console.log(`PR #${prNumber} opened on ${repo}: ${title}`);
+        ctx.logger.info(`PR #${prNumber} opened on ${repo}: ${title}`);
         return { repo, pr: prNumber };
     }),
 });
@@ -50,9 +50,9 @@ exports.handleSlackMention = hatchet_client_1.hatchet.task({
     on: {
         event: 'slack:event:app_mention',
     },
-    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
         const { user, text, channel } = input.event;
-        console.log(`Mentioned by ${user} in ${channel}: ${text}`);
+        ctx.logger.info(`Mentioned by ${user} in ${channel}: ${text}`);
         return { handled: true };
     }),
 });
@@ -61,8 +61,8 @@ exports.handleSlackCommand = hatchet_client_1.hatchet.task({
     on: {
         event: 'slack:command:/deploy',
     },
-    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
-        console.log(`${input.user_name} ran ${input.command} ${input.text}`);
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        ctx.logger.info(`${input.user_name} ran ${input.command} ${input.text}`);
         return { command: input.command, args: input.text };
     }),
 });
@@ -71,9 +71,9 @@ exports.handleSlackInteraction = hatchet_client_1.hatchet.task({
     on: {
         event: 'slack:interaction:block_actions',
     },
-    fn: (input) => __awaiter(void 0, void 0, void 0, function* () {
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
         const [action] = input.actions;
-        console.log(`${input.user.username} clicked button: ${action.action_id}`);
+        ctx.logger.info(`${input.user.username} clicked button: ${action.action_id}`);
         return { action: action.action_id };
     }),
 });

package/v1/examples/welcome_email/workflow.js

@@ -25,7 +25,7 @@ exports.welcomeEmail = hatchet_client_1.hatchet.durableTask({
     fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
         var _a, _b;
         // Step 1: Send the welcome email
-        console.log(`Sending welcome email to ${input.email}: finish your first onboarding step`);
+        ctx.logger.info(`Sending welcome email to ${input.email}: finish your first onboarding step`);
         // Step 2: Wait for the user to complete onboarding, or time out
         // (use a longer duration for a more realistic workflow)
         const now = yield ctx.now();
@@ -41,11 +41,11 @@ exports.welcomeEmail = hatchet_client_1.hatchet.durableTask({
         const onboardingCompleted = resolvedKey === exports.ONBOARDING_EVENT_KEY;
         if (onboardingCompleted) {
             // Step 3a: User completed onboarding -> skip follow-up
-            console.log(`User ${input.user_id} completed onboarding, skipping follow-up`);
+            ctx.logger.info(`User ${input.user_id} completed onboarding, skipping follow-up`);
             return { userId: input.user_id, welcomeSent: true, followUpSent: false };
         }
         // Step 3b: Timeout -> send follow-up email
-        console.log(`Sending follow-up email to ${input.email}: need help finishing onboarding?`);
+        ctx.logger.info(`Sending follow-up email to ${input.email}: need help finishing onboarding?`);
         return { userId: input.user_id, welcomeSent: true, followUpSent: true };
     }),
 });

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.22.3";
+export declare const HATCHET_VERSION = "1.23.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.22.3';
+exports.HATCHET_VERSION = '1.23.1';

package/workflow.js

@@ -18,8 +18,6 @@ exports.StickyStrategy = exports.ConcurrencyLimitStrategy = void 0;
 const v1_1 = require("./v1");
 Object.defineProperty(exports, "ConcurrencyLimitStrategy", { enumerable: true, get: function () { return v1_1.ConcurrencyLimitStrategy; } });
 Object.defineProperty(exports, "StickyStrategy", { enumerable: true, get: function () { return v1_1.StickyStrategy; } });
+const v0_deprecation_warning_1 = require("./util/v0-deprecation-warning");
 __exportStar(require("./legacy/workflow"), exports);
-console.warn('\x1b[31mDeprecation warning: The v0 sdk, including the workflow module has been deprecated and has been removed in release v1.14.0.\x1b[0m');
-console.warn('\x1b[31mPlease migrate to v1 SDK instead: https://docs.hatchet.run/home/v1-sdk-improvements\x1b[0m');
-console.warn('ConcurrencyLimitStrategy, StickyStrategy have been moved to @hatchet-dev/typescript-sdk/v1');
-console.warn('--------------------------------');
+(0, v0_deprecation_warning_1.emitV0RemovedWarning)('workflow', 'ConcurrencyLimitStrategy and StickyStrategy have been moved to @hatchet-dev/typescript-sdk/v1.');