@hatchet-dev/typescript-sdk 1.0.2 → 1.0.4

package/v1/task.d.ts

@@ -2,6 +2,7 @@ import { ConcurrencyLimitStrategy } from '../protoc/v1/workflows';
 import { Context, CreateStep, DurableContext } from '../step';
 import { Conditions } from './conditions';
 import { Duration } from './client/duration';
+import { InputType, OutputType, UnknownInputType } from './types';
 /**
  * Options for configuring the concurrency for a task.
  */
@@ -28,14 +29,14 @@ export type TaskConcurrency = {
      */
     limitStrategy?: ConcurrencyLimitStrategy;
 };
-export type TaskFn<T, K> = (input: T, ctx: Context<T>) => K | Promise<K>;
-export type DurableTaskFn<T, K> = (input: T, ctx: DurableContext<T>) => K | Promise<K>;
+export type TaskFn<I extends InputType = UnknownInputType, O extends OutputType = void, C = Context<I>> = (input: I, ctx: C) => O | Promise<O>;
+export type DurableTaskFn<I extends InputType = UnknownInputType, O extends OutputType = void> = TaskFn<I, O, DurableContext<I>>;
 /**
  * Options for creating a hatchet task which is an atomic unit of work in a workflow.
- * @template T The input type for the task function.
- * @template K The return type of the task function (can be inferred from the return value of fn).
+ * @template I The input type for the task function.
+ * @template O The return type of the task function (can be inferred from the return value of fn).
  */
-export type CreateBaseTaskOpts<T, K, C> = {
+export type CreateBaseTaskOpts<I extends InputType = UnknownInputType, O extends OutputType = void, C = TaskFn<I, O>> = {
     /**
      * The name of the task.
      */
@@ -50,7 +51,7 @@ export type CreateBaseTaskOpts<T, K, C> = {
     /**
      * @deprecated use executionTimeout instead
      */
-    timeout?: CreateStep<T, K>['timeout'];
+    timeout?: CreateStep<I, O>['timeout'];
     /**
      * (optional) execution timeout duration for the task after it starts running
      * go duration format (e.g., "1s", "5m", "1h").
@@ -70,17 +71,17 @@ export type CreateBaseTaskOpts<T, K, C> = {
      *
      * default: 0
      */
-    retries?: CreateStep<T, K>['retries'];
+    retries?: CreateStep<I, O>['retries'];
     /**
      * (optional) backoff strategy configuration for retries.
      * - factor: Base of the exponential backoff (base ^ retry count)
      * - maxSeconds: Maximum backoff duration in seconds
      */
-    backoff?: CreateStep<T, K>['backoff'];
+    backoff?: CreateStep<I, O>['backoff'];
     /**
      * (optional) rate limits for the task.
      */
-    rateLimits?: CreateStep<T, K>['rate_limits'];
+    rateLimits?: CreateStep<I, O>['rate_limits'];
     /**
      * (optional) worker labels for task routing and scheduling.
      * Each label can be a simple string/number value or an object with additional configuration:
@@ -89,18 +90,18 @@ export type CreateBaseTaskOpts<T, K, C> = {
      * - weight: Priority weight for worker selection
      * - comparator: Custom comparison logic for label matching
      */
-    desiredWorkerLabels?: CreateStep<T, K>['worker_labels'];
+    desiredWorkerLabels?: CreateStep<I, O>['worker_labels'];
     /**
      * (optional) the concurrency options for the task
      */
     concurrency?: TaskConcurrency | TaskConcurrency[];
 };
-export type CreateWorkflowTaskOpts<T, K, C = TaskFn<T, K>> = CreateBaseTaskOpts<T, K, C> & {
+export type CreateWorkflowTaskOpts<I extends InputType = UnknownInputType, O extends OutputType = void, C extends TaskFn<I, O> | DurableTaskFn<I, O> = TaskFn<I, O>> = CreateBaseTaskOpts<I, O, C> & {
     /**
      * Parent tasks that must complete before this task runs.
      * Used to define the directed acyclic graph (DAG) of the workflow.
      */
-    parents?: CreateWorkflowTaskOpts<T, any, any>[];
+    parents?: CreateWorkflowTaskOpts<I, any, any>[];
     /**
      * (optional) the conditions to match before the task is queued
      * all provided conditions must be met (AND logic)
@@ -154,28 +155,28 @@ export type CreateWorkflowTaskOpts<T, K, C = TaskFn<T, K>> = CreateBaseTaskOpts<
      */
     skipIf?: Conditions | Conditions[];
 };
-export type CreateStandaloneTaskOpts<T, K> = CreateBaseTaskOpts<T, K, TaskFn<T, K>>;
+export type CreateStandaloneTaskOpts<I extends InputType = UnknownInputType, O extends OutputType = void, C extends TaskFn<I, O> = TaskFn<I, O>> = CreateBaseTaskOpts<I, O, C>;
 /**
  * Options for creating a hatchet durable task which is an atomic unit of work in a workflow.
- * @template T The input type for the task function.
- * @template K The return type of the task function (can be inferred from the return value of fn).
+ * @template I The input type for the task function.
+ * @template O The return type of the task function (can be inferred from the return value of fn).
  */
-export type CreateWorkflowDurableTaskOpts<T, K> = CreateWorkflowTaskOpts<T, K, DurableTaskFn<T, K>>;
+export type CreateWorkflowDurableTaskOpts<I extends InputType = UnknownInputType, O extends OutputType = void, C extends DurableTaskFn<I, O> = DurableTaskFn<I, O>> = CreateWorkflowTaskOpts<I, O, C>;
 /**
  * Options for creating a hatchet task which is an atomic unit of work in a workflow.
- * @template T The input type for the task function.
- * @template K The return type of the task function (can be inferred from the return value of fn).
+ * @template I The input type for the task function.
+ * @template O The return type of the task function (can be inferred from the return value of fn).
  */
-export type CreateStandaloneDurableTaskOpts<T, K> = CreateBaseTaskOpts<T, K, DurableTaskFn<T, K>>;
+export type CreateStandaloneDurableTaskOpts<I extends InputType = UnknownInputType, O extends OutputType = void, C extends DurableTaskFn<I, O> = DurableTaskFn<I, O>> = CreateBaseTaskOpts<I, O, C>;
 /**
  * Options for configuring the onSuccess task that is invoked when a task succeeds.
- * @template T The input type for the task function.
- * @template K The return type of the task function (can be inferred from the return value of fn).
+ * @template I The input type for the task function.
+ * @template O The return type of the task function (can be inferred from the return value of fn).
  */
-export type CreateOnSuccessTaskOpts<T, K> = Omit<CreateBaseTaskOpts<T, K, TaskFn<T, K>>, 'name'>;
+export type CreateOnSuccessTaskOpts<I extends InputType = UnknownInputType, O extends OutputType = void, C extends TaskFn<I, O> = TaskFn<I, O>> = Omit<CreateBaseTaskOpts<I, O, C>, 'name'>;
 /**
  * Options for configuring the onFailure task that is invoked when a task fails.
- * @template T The input type for the task function.
- * @template K The return type of the task function (can be inferred from the return value of fn).
+ * @template I The input type for the task function.
+ * @template O The return type of the task function (can be inferred from the return value of fn).
  */
-export type CreateOnFailureTaskOpts<T, K> = Omit<CreateBaseTaskOpts<T, K, TaskFn<T, K>>, 'name'>;
+export type CreateOnFailureTaskOpts<I extends InputType = UnknownInputType, O extends OutputType = void, C extends TaskFn<I, O> = TaskFn<I, O>> = Omit<CreateBaseTaskOpts<I, O, C>, 'name'>;

package/v1/types.d.ts

@@ -0,0 +1,17 @@
+export type JsonPrimitive = string | number | boolean | null | undefined;
+export type JsonArray = JsonValue[];
+export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+export type JsonObject = {
+    [Key in string]: JsonValue;
+} & {
+    [Key in string]?: JsonValue | undefined;
+};
+export type InputType = JsonObject;
+export type UnknownInputType = {};
+export type OutputType = JsonObject | void;
+type IsValidWorkflowOutput<T> = T extends Record<string, JsonObject> ? true : false;
+export type WorkflowOutputType<T = any> = IsValidWorkflowOutput<T> extends true ? T : (Record<string, JsonObject> | void) & {
+    [ERROR_WORKFLOW_OUTPUT]?: 'Workflow output must be shaped as Record<"task-name", JsonObject>. Each property must be an object, not a primitive value.';
+};
+declare const ERROR_WORKFLOW_OUTPUT: unique symbol;
+export {};

package/v1/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.0.2";
+export declare const HATCHET_VERSION = "1.0.4";

package/version.js

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

package/workflow.d.ts

@@ -380,10 +380,6 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         } | undefined;
     }[];
     id: string;
-    version?: string | undefined;
-    scheduleTimeout?: string | undefined;
-    sticky?: PbStickyStrategy | undefined;
-    timeout?: string | undefined;
     on?: {
         cron: string;
         event?: undefined;
@@ -391,6 +387,10 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         event: string;
         cron?: undefined;
     } | undefined;
+    version?: string | undefined;
+    scheduleTimeout?: string | undefined;
+    sticky?: PbStickyStrategy | undefined;
+    timeout?: string | undefined;
     onFailure?: {
         name: string;
         timeout?: string | undefined;
@@ -442,10 +442,6 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         } | undefined;
     }[];
     id: string;
-    version?: string | undefined;
-    scheduleTimeout?: string | undefined;
-    sticky?: PbStickyStrategy | undefined;
-    timeout?: string | undefined;
     on?: {
         cron: string;
         event?: undefined;
@@ -453,6 +449,10 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         event: string;
         cron?: undefined;
     } | undefined;
+    version?: string | undefined;
+    scheduleTimeout?: string | undefined;
+    sticky?: PbStickyStrategy | undefined;
+    timeout?: string | undefined;
     onFailure?: {
         name: string;
         timeout?: string | undefined;