@hatchet-dev/typescript-sdk 1.9.5 → 1.9.7

package/clients/worker/worker.d.ts

@@ -39,7 +39,7 @@ export declare class V0Worker {
     });
     private registerActions;
     getHandler(workflows: Workflow[]): WebhookHandler;
-    registerWebhook(webhook: WebhookWorkerCreateRequest): Promise<import("axios").AxiosResponse<import("../rest/generated/data-contracts").WebhookWorkerCreated, any>>;
+    registerWebhook(webhook: WebhookWorkerCreateRequest): Promise<import("axios").AxiosResponse<import("../rest/generated/data-contracts").WebhookWorkerCreated, any, {}>>;
     /**
      * @deprecated use registerWorkflow instead
      */

package/dist/version-check.js

@@ -0,0 +1,65 @@
+/* eslint-disable no-console */
+const fs = require('fs');
+const path = require('path');
+const semver = require('semver');
+
+const WARNINGS = {
+  '1.4.0':
+    'Breaking Changes in v1.4.0: This release fixes a critical bug which makes the runNoWait methods async. You will need to await this method to access the runRef.',
+};
+
+try {
+  // Get the current package version
+  // eslint-disable-next-line global-require
+  const currentVersion = require('../package.json').version;
+
+  // Look for the package.json in various possible locations
+  const possiblePaths = [
+    // npm
+    path.join(process.cwd(), 'package.json'),
+    // pnpm
+    path.join(process.cwd(), '..', 'package.json'),
+    // yarn
+    path.join(process.cwd(), '..', '..', 'package.json'),
+    // monorepo setup
+    path.join(process.cwd(), '..', '..', '..', 'package.json'),
+  ];
+
+  let parentPackagePath = null;
+  for (const possiblePath of possiblePaths) {
+    if (fs.existsSync(possiblePath)) {
+      parentPackagePath = possiblePath;
+      break;
+    }
+  }
+
+  if (parentPackagePath) {
+    const parentPackage = JSON.parse(fs.readFileSync(parentPackagePath, 'utf8'));
+    const dependencies = {
+      ...parentPackage.dependencies,
+      ...parentPackage.devDependencies,
+    };
+
+    const installedVersion = dependencies['@hatchet-dev/typescript-sdk'];
+
+    // If there's no installed version, this is a first-time install
+    if (!installedVersion) {
+      // Show all warnings for the current version
+      for (const [version, warning] of Object.entries(WARNINGS)) {
+        if (semver.gte(currentVersion, version)) {
+          console.warn('\x1b[33m%s\x1b[0m', warning);
+        }
+      }
+    } else {
+      // Check for specific version warnings
+      for (const [version, warning] of Object.entries(WARNINGS)) {
+        if (semver.gte(currentVersion, version) && semver.lt(installedVersion, version)) {
+          console.warn('\x1b[33m%s\x1b[0m', warning);
+        }
+      }
+    }
+  }
+} catch (error) {
+  // Silently fail - this is just a warning system
+  // console.error(error);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "1.9.5",
+  "version": "1.9.7",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -15,30 +15,6 @@
     "type": "git",
     "url": "https://github.com/hatchet-dev/hatchet.git"
   },
-  "scripts": {
-    "build": "echo 'build hatchet sdk with `npm run tsc:build` to ensure it is not build during the publish step' && exit 0",
-    "prepare": "npm run build",
-    "postinstall": "node scripts/version-check.js",
-    "dump-version": "node -e \"console.log('export const HATCHET_VERSION = \\'' + require('./package.json').version + '\\';');\" > src/version.ts",
-    "tsc:build": "npm run dump-version && tsc && resolve-tspaths",
-    "test:unit": "jest --testMatch='**/*.test.ts'",
-    "test:e2e": "jest --testMatch='**/*.e2e.ts'",
-    "test:unit:watch": "jest --testMatch='**/*.test.ts' --watch",
-    "generate": "pnpm run '/generate-.*/'",
-    "generate-api": "npx --yes swagger-cli bundle ../../api-contracts/openapi/openapi.yaml --outfile openapi.yaml --type yaml && npx swagger-typescript-api@13.1.0 generate -p openapi.yaml -o src/clients/rest/generated -n hatchet.ts --modular --axios",
-    "generate-protoc": "./generate-protoc.sh",
-    "lint:check": "npm run eslint:check && npm run prettier:check",
-    "lint:fix": "npm run eslint:fix && npm run prettier:fix",
-    "eslint:check": "eslint \"{src,tests}/**/*.{ts,tsx,js}\"",
-    "eslint:fix": "eslint \"{src,tests}/**/*.{ts,tsx,js}\" --fix",
-    "prettier:check": "prettier \"src/**/*.{ts,tsx}\" --list-different",
-    "prettier:fix": "prettier \"src/**/*.{ts,tsx}\" --write",
-    "prepublish": "cp package.json dist/package.json; cp README.md dist/; cp -r scripts dist/",
-    "publish:ci": "rm -rf ./dist && npm run dump-version && npm run tsc:build && npm run prepublish && cd dist && npm publish --access public --no-git-checks",
-    "publish:ci:alpha": "rm -rf ./dist && npm run dump-version && npm run tsc:build && npm run prepublish && cd dist && npm publish --access public --no-git-checks --tag alpha",
-    "generate-docs": "typedoc",
-    "exec": "npx dotenv -- ts-node -r tsconfig-paths/register --project tsconfig.json"
-  },
   "keywords": [],
   "author": "",
   "license": "MIT",
@@ -91,5 +67,28 @@
     "yaml": "^2.7.1",
     "zod": "^3.24.2"
   },
-  "packageManager": "pnpm@9.15.4+sha512.b2dc20e2fc72b3e18848459b37359a32064663e5627a51e4c74b2c29dd8e8e0491483c3abb40789cfd578bf362fb6ba8261b05f0387d76792ed6e23ea3b1b6a0"
-}
+  "packageManager": "pnpm@10.16.1",
+  "scripts": {
+    "build": "echo 'build hatchet sdk with `npm run tsc:build` to ensure it is not build during the publish step' && exit 0",
+    "postinstall": "node scripts/version-check.js",
+    "dump-version": "node -e \"console.log('export const HATCHET_VERSION = \\'' + require('./package.json').version + '\\';');\" > src/version.ts",
+    "tsc:build": "pnpm run dump-version && tsc && resolve-tspaths",
+    "test:unit": "jest --testMatch='**/*.test.ts'",
+    "test:e2e": "jest --testMatch='**/*.e2e.ts'",
+    "test:unit:watch": "jest --testMatch='**/*.test.ts' --watch",
+    "generate": "pnpm run '/generate-.*/'",
+    "generate-api": "npx --yes swagger-cli bundle ../../api-contracts/openapi/openapi.yaml --outfile openapi.yaml --type yaml && npx swagger-typescript-api@13.1.0 generate -p openapi.yaml -o src/clients/rest/generated -n hatchet.ts --modular --axios",
+    "generate-protoc": "./generate-protoc.sh",
+    "lint:check": "pnpm run eslint:check && pnpm run prettier:check",
+    "lint:fix": "pnpm run eslint:fix && pnpm run prettier:fix",
+    "eslint:check": "eslint \"{src,tests}/**/*.{ts,tsx,js}\"",
+    "eslint:fix": "eslint \"{src,tests}/**/*.{ts,tsx,js}\" --fix",
+    "prettier:check": "prettier \"src/**/*.{ts,tsx}\" --list-different",
+    "prettier:fix": "prettier \"src/**/*.{ts,tsx}\" --write",
+    "prepublish": "cp package.json dist/package.json; cp README.md dist/; cp -r scripts dist/",
+    "publish:ci": "rm -rf ./dist && pnpm run dump-version && pnpm run tsc:build && pnpm run prepublish && cd dist && pnpm publish --access public --no-git-checks",
+    "publish:ci:alpha": "rm -rf ./dist && pnpm run dump-version && pnpm run tsc:build && pnpm run prepublish && cd dist && pnpm publish --access public --no-git-checks --tag alpha",
+    "generate-docs": "typedoc",
+    "exec": "npx dotenv -- ts-node -r tsconfig-paths/register --project tsconfig.json"
+  }
+}

package/v1/client/features/runs.d.ts

@@ -68,8 +68,8 @@ export declare class RunsClient {
     get<T = any>(run: string | WorkflowRunRef<T>): Promise<import("../../../clients/rest/generated/data-contracts").V1WorkflowRunDetails>;
     get_status<T = any>(run: string | WorkflowRunRef<T>): Promise<V1TaskStatus>;
     list(opts?: Partial<ListRunsOpts>): Promise<import("../../../clients/rest/generated/data-contracts").V1TaskSummaryList>;
-    cancel(opts: CancelRunOpts): Promise<import("axios").AxiosResponse<import("../../../clients/rest/generated/data-contracts").V1CancelledTasks, any>>;
-    replay(opts: ReplayRunOpts): Promise<import("axios").AxiosResponse<import("../../../clients/rest/generated/data-contracts").V1ReplayedTasks, any>>;
+    cancel(opts: CancelRunOpts): Promise<import("axios").AxiosResponse<import("../../../clients/rest/generated/data-contracts").V1CancelledTasks, any, {}>>;
+    replay(opts: ReplayRunOpts): Promise<import("axios").AxiosResponse<import("../../../clients/rest/generated/data-contracts").V1ReplayedTasks, any, {}>>;
     private prepareFilter;
     private prepareListFilter;
     runRef<T extends Record<string, any> = any>(id: string): WorkflowRunRef<T>;

package/v1/client/worker/worker-internal.d.ts

@@ -38,7 +38,7 @@ export declare class V1Worker {
     });
     private registerActions;
     getHandler(workflows: Workflow[]): void;
-    registerWebhook(webhook: WebhookWorkerCreateRequest): Promise<import("axios").AxiosResponse<import("../../../clients/rest/generated/data-contracts").WebhookWorkerCreated, any>>;
+    registerWebhook(webhook: WebhookWorkerCreateRequest): Promise<import("axios").AxiosResponse<import("../../../clients/rest/generated/data-contracts").WebhookWorkerCreated, any, {}>>;
     /**
      * @deprecated use registerWorkflow instead
      */

package/v1/client/worker/worker.d.ts

@@ -85,7 +85,7 @@ export declare class Worker {
      * @param webhook - The webhook to register
      * @returns A promise that resolves when the webhook is registered
      */
-    registerWebhook(webhook: WebhookWorkerCreateRequest): Promise<import("axios").AxiosResponse<import("../../../clients/rest/generated/data-contracts").WebhookWorkerCreated, any>>;
+    registerWebhook(webhook: WebhookWorkerCreateRequest): Promise<import("axios").AxiosResponse<import("../../../clients/rest/generated/data-contracts").WebhookWorkerCreated, any, {}>>;
     isPaused(): Promise<boolean>;
     pause(): Promise<any[]>;
     unpause(): Promise<any[]>;

package/v1/examples/affinity/affinity-workers.js

@@ -31,6 +31,7 @@ workflow.task({
     }),
 });
 // !!
+// > Task with labels
 const childWorkflow = hatchet_client_1.hatchet.workflow({
     name: 'child-affinity-workflow',
     description: 'test',
@@ -47,6 +48,7 @@ childWorkflow.task({
         return { childStep1: 'childStep1 results!' };
     }),
 });
+// !!
 childWorkflow.task({
     name: 'child-step2',
     desiredWorkerLabels: {

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

@@ -10,4 +10,10 @@ type ParentInput = {
 export declare const parent: import("../..").TaskWorkflowDeclaration<ParentInput, {
     Result: number;
 }>;
+export declare const parentSingleChild: import("../..").TaskWorkflowDeclaration<import("../..").UnknownInputType, {
+    Result: number;
+}>;
+export declare const withErrorHandling: import("../..").TaskWorkflowDeclaration<import("../..").UnknownInputType, {
+    Result: number;
+}>;
 export {};

package/v1/examples/child_workflows/workflow.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parent = exports.child = void 0;
+exports.withErrorHandling = exports.parentSingleChild = exports.parent = exports.child = void 0;
 /* eslint-disable no-plusplus */
 // > Declaring a Child
 const hatchet_client_1 = require("../hatchet-client");
@@ -37,3 +37,33 @@ exports.parent = hatchet_client_1.hatchet.task({
     }),
 });
 // !!
+// > Parent with Single Child
+exports.parentSingleChild = hatchet_client_1.hatchet.task({
+    name: 'parent-single-child',
+    fn: () => __awaiter(void 0, void 0, void 0, function* () {
+        const childRes = yield exports.child.run({ N: 1 });
+        return {
+            Result: childRes.Value,
+        };
+    }),
+});
+// !!
+// > Parent with Error Handling
+exports.withErrorHandling = hatchet_client_1.hatchet.task({
+    name: 'parent-error-handling',
+    fn: () => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            const childRes = yield exports.child.run({ N: 1 });
+            return {
+                Result: childRes.Value,
+            };
+        }
+        catch (error) {
+            // decide how to proceed here
+            return {
+                Result: -1,
+            };
+        }
+    }),
+});
+// !!

package/v1/examples/dag/run.js

@@ -12,9 +12,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const workflow_1 = require("./workflow");
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
+        // > Run the workflow
         const res = yield workflow_1.dag.run({
             Message: 'hello world',
         });
+        // !!
         // eslint-disable-next-line no-console
         console.log(res.reverse.Transformed);
     });

package/v1/examples/dag/workflow.js

@@ -11,11 +11,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dag = void 0;
 const hatchet_client_1 = require("../hatchet-client");
+// !!
 // > Declaring a DAG Workflow
 // First, we declare the workflow
 exports.dag = hatchet_client_1.hatchet.workflow({
     name: 'simple',
 });
+// !!
+// > First task
 // Next, we declare the tasks bound to the workflow
 const toLower = exports.dag.task({
     name: 'to-lower',
@@ -25,7 +28,8 @@ const toLower = exports.dag.task({
         };
     },
 });
-// Next, we declare the tasks bound to the workflow
+// !!
+// > Second task with parent
 exports.dag.task({
     name: 'reverse',
     parents: [toLower],
@@ -38,3 +42,16 @@ exports.dag.task({
     }),
 });
 // !!
+// > Accessing Parent Outputs
+exports.dag.task({
+    name: 'task-with-parent-output',
+    parents: [toLower],
+    fn: (input, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        const lower = yield ctx.parentOutput(toLower);
+        return {
+            Original: input.Message,
+            Transformed: lower.TransformedMessage.split('').reverse().join(''),
+        };
+    }),
+});
+// !!

package/v1/examples/hatchet-client.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hatchet = void 0;
+// > Create client
 const v1_1 = require("./..");
 exports.hatchet = v1_1.HatchetClient.init();
+// !!

package/v1/examples/on_event/event.js

@@ -18,6 +18,32 @@ function main() {
             ShouldSkip: false,
         });
         // !!
+        // > Push an Event with Metadata
+        const withMetadata = yield hatchet_client_1.hatchet.events.push('user:create', {
+            test: 'test',
+        }, {
+            additionalMetadata: {
+                source: 'api', // Arbitrary key-value pair
+            },
+        });
+        // !!
+        // > Bulk push events
+        const events = [
+            {
+                payload: { test: 'test1' },
+                additionalMetadata: { user_id: 'user1', source: 'test' },
+            },
+            {
+                payload: { test: 'test2' },
+                additionalMetadata: { user_id: 'user2', source: 'test' },
+            },
+            {
+                payload: { test: 'test3' },
+                additionalMetadata: { user_id: 'user3', source: 'test' },
+            },
+        ];
+        yield hatchet_client_1.hatchet.events.bulkPush('user:create', events);
+        // !!
         // eslint-disable-next-line no-console
         console.log(res.eventId);
     });

package/v1/examples/simple/replay-cancel.d.ts

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

package/v1/examples/simple/replay-cancel.js

@@ -0,0 +1,34 @@
+"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 data_contracts_1 = require("../../../clients/rest/generated/data-contracts");
+const hatchet_client_1 = require("../hatchet-client");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const { runs } = hatchet_client_1.hatchet;
+        // > API operations
+        // list all failed runs
+        const allFailedRuns = yield runs.list({
+            statuses: [data_contracts_1.V1TaskStatus.FAILED],
+        });
+        // replay by ids
+        yield runs.replay({ ids: (_a = allFailedRuns.rows) === null || _a === void 0 ? void 0 : _a.map((r) => r.metadata.id) });
+        // or you can run bulk operations with filters directly
+        yield runs.cancel({
+            filters: {
+                since: new Date('2025-03-27'),
+                additionalMetadata: { user: '123' },
+            },
+        });
+        // !!
+    });
+}

package/v1/examples/simple/run.js

@@ -56,6 +56,15 @@ function extra() {
             }),
         });
         // !!
+        // > Run with metadata
+        const withMetadata = workflow_1.simple.run({
+            Message: 'HeLlO WoRlD',
+        }, {
+            additionalMetadata: {
+                source: 'api', // Arbitrary key-value pair
+            },
+        });
+        // !!
     });
 }
 if (require.main === module) {

package/v1/examples/simple/typed-run-methods.d.ts

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

package/v1/examples/simple/typed-run-methods.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 workflow_1 = require("./workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // > Run methods
+        const input = { Message: 'Hello, World!' };
+        // run now
+        const result = yield workflow_1.simple.run(input);
+        const runReference = yield workflow_1.simple.runNoWait(input);
+        // or in the future
+        const runAt = new Date(new Date().setHours(12, 0, 0, 0) + 24 * 60 * 60 * 1000);
+        const scheduled = yield workflow_1.simple.schedule(runAt, input);
+        const cron = yield workflow_1.simple.cron('simple-daily', '0 0 * * *', input);
+        // !!
+    });
+}
+function runFlavors() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // > Run method flavors
+        const input = { Message: 'Hello, World!' };
+        // Run workflow and wait for the result
+        const result = yield workflow_1.simple.run(input);
+        // Enqueue workflow to be executed asynchronously
+        const runReference = yield workflow_1.simple.runNoWait(input);
+        // !!
+    });
+}

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.9.5";
+export declare const HATCHET_VERSION = "1.9.7";

package/version.js

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