@hatchet-dev/typescript-sdk 1.1.8-alpha.2 → 1.2.0

package/clients/admin/admin-client.d.ts

@@ -4,7 +4,7 @@ import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
 import WorkflowRunRef from '../../util/workflow-run-ref';
 import { AdminServiceClient, CreateWorkflowVersionRequest } from '../../protoc/v1/workflows';
-import { RunsClient } from '../../v1';
+import { Priority, RunsClient } from '../../v1';
 import { Api } from '../rest';
 import { WebhookWorkerCreateRequest, WorkflowRunStatus, WorkflowRunStatusList } from '../rest/generated/data-contracts';
 import { RunListenerClient } from '../listeners/run-listener/child-listener-client';
@@ -85,6 +85,7 @@ export declare class AdminClient {
         childKey?: string | undefined;
         additionalMetadata?: Record<string, string> | undefined;
         desiredWorkerId?: string | undefined;
+        priority?: Priority;
     }): WorkflowRunRef<P>;
     /**
      * Run multiple workflows runs with the given input and options. This will create new workflow runs and return their IDs.
@@ -102,6 +103,7 @@ export declare class AdminClient {
             childKey?: string | undefined;
             additionalMetadata?: Record<string, string> | undefined;
             desiredWorkerId?: string | undefined;
+            priority?: Priority;
         };
     }>): Promise<WorkflowRunRef<P>[]>;
     /**

package/clients/admin/admin-client.js

@@ -124,7 +124,7 @@ class AdminClient {
             const inputStr = JSON.stringify(input);
             const resp = this.client.triggerWorkflow(Object.assign(Object.assign({ name: computedName, input: inputStr }, options), { additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
                     ? JSON.stringify(options === null || options === void 0 ? void 0 : options.additionalMetadata)
-                    : undefined }));
+                    : undefined, priority: options === null || options === void 0 ? void 0 : options.priority }));
             return new workflow_run_ref_1.default(resp, this.listenerClient, this.workflows, options === null || options === void 0 ? void 0 : options.parentId);
         }
         catch (e) {

package/clients/hatchet-client/client-config.d.ts

@@ -46,8 +46,6 @@ export declare const ClientConfigSchema: z.ZodObject<{
     log_level: z.ZodOptional<z.ZodEnum<["OFF", "DEBUG", "INFO", "WARN", "ERROR"]>>;
     tenant_id: z.ZodString;
     namespace: z.ZodOptional<z.ZodString>;
-    grpc_max_send_message_length: z.ZodOptional<z.ZodNumber>;
-    grpc_max_recv_message_length: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     token: string;
     tls_config: {
@@ -62,8 +60,6 @@ export declare const ClientConfigSchema: z.ZodObject<{
     tenant_id: string;
     log_level?: "OFF" | "DEBUG" | "INFO" | "WARN" | "ERROR" | undefined;
     namespace?: string | undefined;
-    grpc_max_send_message_length?: number | undefined;
-    grpc_max_recv_message_length?: number | undefined;
 }, {
     token: string;
     tls_config: {
@@ -78,8 +74,6 @@ export declare const ClientConfigSchema: z.ZodObject<{
     tenant_id: string;
     log_level?: "OFF" | "DEBUG" | "INFO" | "WARN" | "ERROR" | undefined;
     namespace?: string | undefined;
-    grpc_max_send_message_length?: number | undefined;
-    grpc_max_recv_message_length?: number | undefined;
 }>;
 export type LogConstructor = (context: string, logLevel?: LogLevel) => Logger;
 export type ClientConfig = z.infer<typeof ClientConfigSchema> & {

package/clients/hatchet-client/client-config.js

@@ -17,6 +17,4 @@ exports.ClientConfigSchema = zod_1.z.object({
     log_level: zod_1.z.enum(['OFF', 'DEBUG', 'INFO', 'WARN', 'ERROR']).optional(),
     tenant_id: zod_1.z.string(),
     namespace: zod_1.z.string().optional(),
-    grpc_max_send_message_length: zod_1.z.number().optional(),
-    grpc_max_recv_message_length: zod_1.z.number().optional(),
 });

package/clients/hatchet-client/features/cron-client.d.ts

@@ -12,15 +12,18 @@ export declare const CreateCronTriggerSchema: z.ZodObject<{
     expression: z.ZodEffects<z.ZodString, string, string>;
     input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     additionalMetadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    priority: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     expression: string;
     additionalMetadata?: Record<string, string> | undefined;
+    priority?: number | undefined;
     input?: Record<string, any> | undefined;
 }, {
     name: string;
     expression: string;
     additionalMetadata?: Record<string, string> | undefined;
+    priority?: number | undefined;
     input?: Record<string, any> | undefined;
 }>;
 /**

package/clients/hatchet-client/features/cron-client.js

@@ -24,6 +24,7 @@ exports.CreateCronTriggerSchema = zod_1.z.object({
     }, 'Invalid cron expression'),
     input: zod_1.z.record(zod_1.z.any()).optional(),
     additionalMetadata: zod_1.z.record(zod_1.z.string()).optional(),
+    priority: zod_1.z.number().optional(),
 });
 /**
  * Client for managing Cron Triggers.
@@ -70,6 +71,7 @@ class CronClient {
                     cronExpression: parsedCron.expression,
                     input: (_a = parsedCron.input) !== null && _a !== void 0 ? _a : {},
                     additionalMetadata: (_b = parsedCron.additionalMetadata) !== null && _b !== void 0 ? _b : {},
+                    priority: parsedCron.priority,
                 });
                 return response.data;
             }

package/clients/hatchet-client/features/schedule-client.d.ts

@@ -11,13 +11,16 @@ export declare const CreateScheduledRunTriggerSchema: z.ZodObject<{
     triggerAt: z.ZodDate;
     input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     additionalMetadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    priority: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     triggerAt: Date;
     additionalMetadata?: Record<string, string> | undefined;
+    priority?: number | undefined;
     input?: Record<string, any> | undefined;
 }, {
     triggerAt: Date;
     additionalMetadata?: Record<string, string> | undefined;
+    priority?: number | undefined;
     input?: Record<string, any> | undefined;
 }>;
 /**

package/clients/hatchet-client/features/schedule-client.js

@@ -19,6 +19,7 @@ exports.CreateScheduledRunTriggerSchema = zod_1.z.object({
     triggerAt: zod_1.z.coerce.date(),
     input: zod_1.z.record(zod_1.z.any()).optional(),
     additionalMetadata: zod_1.z.record(zod_1.z.string()).optional(),
+    priority: zod_1.z.number().optional(),
 });
 /**
  * Client for managing Scheduled Runs.
@@ -64,6 +65,7 @@ class ScheduleClient {
                     input: (_a = parsedCron.input) !== null && _a !== void 0 ? _a : {},
                     additionalMetadata: (_b = parsedCron.additionalMetadata) !== null && _b !== void 0 ? _b : {},
                     triggerAt: parsedCron.triggerAt.toISOString(),
+                    priority: parsedCron.priority,
                 });
                 return response.data;
             }

package/clients/hatchet-client/hatchet-client.js

@@ -53,15 +53,13 @@ const cron_client_1 = require("./features/cron-client");
 const schedule_client_1 = require("./features/schedule-client");
 const durable_listener_client_1 = require("../listeners/durable-listener/durable-listener-client");
 const channelFactory = (config, credentials) => (0, nice_grpc_1.createChannel)(config.host_port, credentials, {
-    'grpc.max_send_message_length': config.grpc_max_send_message_length,
-    'grpc.max_receive_message_length': config.grpc_max_recv_message_length,
     'grpc.ssl_target_name_override': config.tls_config.server_name,
     'grpc.keepalive_timeout_ms': 60 * 1000,
     'grpc.client_idle_timeout_ms': 60 * 1000,
-    'grpc.http2.max_pings_without_data': 0,
-    'grpc.http2.min_recv_ping_interval_without_data_ms': 60 * 1000,
+    // Send keepalive pings every 10 seconds, default is 2 hours.
+    'grpc.keepalive_time_ms': 10 * 1000,
+    // Allow keepalive pings when there are no gRPC calls.
     'grpc.keepalive_permit_without_calls': 1,
-    'grpc-node.max_session_memory': Number.MAX_SAFE_INTEGER,
 });
 exports.channelFactory = channelFactory;
 const addTokenMiddleware = (token) => function _(call, options) {

package/clients/rest/generated/data-contracts.d.ts

@@ -705,6 +705,12 @@ export interface ScheduledWorkflows {
      */
     workflowRunId?: string;
     method: 'DEFAULT' | 'API';
+    /**
+     * @format int32
+     * @min 1
+     * @max 3
+     */
+    priority?: number;
 }
 export interface ScheduledWorkflowsList {
     rows?: ScheduledWorkflows[];
@@ -735,6 +741,12 @@ export interface CronWorkflows {
     additionalMetadata?: Record<string, any>;
     enabled: boolean;
     method: 'DEFAULT' | 'API';
+    /**
+     * @format int32
+     * @min 1
+     * @max 3
+     */
+    priority?: number;
 }
 export interface CronWorkflowsList {
     rows?: CronWorkflows[];
@@ -1091,12 +1103,24 @@ export interface ScheduleWorkflowRunRequest {
     additionalMetadata: object;
     /** @format date-time */
     triggerAt: string;
+    /**
+     * @format int32
+     * @min 1
+     * @max 3
+     */
+    priority?: number;
 }
 export interface CreateCronWorkflowTriggerRequest {
     input: object;
     additionalMetadata: object;
     cronName: string;
     cronExpression: string;
+    /**
+     * @format int32
+     * @min 1
+     * @max 3
+     */
+    priority?: number;
 }
 export interface CreatePullRequestFromStepRun {
     branchName: string;

package/clients/worker/worker.js

@@ -199,6 +199,7 @@ class V0Worker {
                     sticky: workflow.sticky,
                     concurrency,
                     onFailureTask,
+                    defaultPriority: workflow.defaultPriority,
                     tasks: [...workflow._tasks, ...workflow._durableTasks].map((task) => {
                         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
                         return ({

package/package.json

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

package/protoc/dispatcher/dispatcher.d.ts

@@ -158,6 +158,7 @@ export interface AssignedAction {
     childWorkflowKey?: string | undefined;
     /** (optional) the parent workflow run id (if this is a child workflow) */
     parentWorkflowRunId?: string | undefined;
+    priority: number;
 }
 export interface WorkerListenRequest {
     /** the id of the worker */

package/protoc/dispatcher/dispatcher.js

@@ -1093,6 +1093,7 @@ function createBaseAssignedAction() {
         childWorkflowIndex: undefined,
         childWorkflowKey: undefined,
         parentWorkflowRunId: undefined,
+        priority: 0,
     };
 }
 exports.AssignedAction = {
@@ -1148,6 +1149,9 @@ exports.AssignedAction = {
         if (message.parentWorkflowRunId !== undefined) {
             writer.uint32(138).string(message.parentWorkflowRunId);
         }
+        if (message.priority !== 0) {
+            writer.uint32(144).int32(message.priority);
+        }
         return writer;
     },
     decode(input, length) {
@@ -1276,6 +1280,13 @@ exports.AssignedAction = {
                     message.parentWorkflowRunId = reader.string();
                     continue;
                 }
+                case 18: {
+                    if (tag !== 144) {
+                        break;
+                    }
+                    message.priority = reader.int32();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1313,6 +1324,7 @@ exports.AssignedAction = {
             parentWorkflowRunId: isSet(object.parentWorkflowRunId)
                 ? globalThis.String(object.parentWorkflowRunId)
                 : undefined,
+            priority: isSet(object.priority) ? globalThis.Number(object.priority) : 0,
         };
     },
     toJSON(message) {
@@ -1368,13 +1380,16 @@ exports.AssignedAction = {
         if (message.parentWorkflowRunId !== undefined) {
             obj.parentWorkflowRunId = message.parentWorkflowRunId;
         }
+        if (message.priority !== 0) {
+            obj.priority = Math.round(message.priority);
+        }
         return obj;
     },
     create(base) {
         return exports.AssignedAction.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
         const message = createBaseAssignedAction();
         message.tenantId = (_a = object.tenantId) !== null && _a !== void 0 ? _a : '';
         message.workflowRunId = (_b = object.workflowRunId) !== null && _b !== void 0 ? _b : '';
@@ -1393,6 +1408,7 @@ exports.AssignedAction = {
         message.childWorkflowIndex = (_q = object.childWorkflowIndex) !== null && _q !== void 0 ? _q : undefined;
         message.childWorkflowKey = (_r = object.childWorkflowKey) !== null && _r !== void 0 ? _r : undefined;
         message.parentWorkflowRunId = (_s = object.parentWorkflowRunId) !== null && _s !== void 0 ? _s : undefined;
+        message.priority = (_t = object.priority) !== null && _t !== void 0 ? _t : 0;
         return message;
     },
 };

package/protoc/v1/workflows.d.ts

@@ -97,6 +97,8 @@ export interface CreateWorkflowVersionRequest {
     onFailureTask?: CreateTaskOpts | undefined;
     /** (optional) the sticky strategy for assigning steps to workers */
     sticky?: StickyStrategy | undefined;
+    /** (optional) the default priority for the workflow */
+    defaultPriority?: number | undefined;
 }
 export interface Concurrency {
     /** (required) the expression to use for concurrency */

package/protoc/v1/workflows.js

@@ -758,6 +758,7 @@ function createBaseCreateWorkflowVersionRequest() {
         cronInput: undefined,
         onFailureTask: undefined,
         sticky: undefined,
+        defaultPriority: undefined,
     };
 }
 exports.CreateWorkflowVersionRequest = {
@@ -792,6 +793,9 @@ exports.CreateWorkflowVersionRequest = {
         if (message.sticky !== undefined) {
             writer.uint32(80).int32(message.sticky);
         }
+        if (message.defaultPriority !== undefined) {
+            writer.uint32(88).int32(message.defaultPriority);
+        }
         return writer;
     },
     decode(input, length) {
@@ -871,6 +875,13 @@ exports.CreateWorkflowVersionRequest = {
                     message.sticky = reader.int32();
                     continue;
                 }
+                case 11: {
+                    if (tag !== 88) {
+                        break;
+                    }
+                    message.defaultPriority = reader.int32();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -899,6 +910,9 @@ exports.CreateWorkflowVersionRequest = {
                 ? exports.CreateTaskOpts.fromJSON(object.onFailureTask)
                 : undefined,
             sticky: isSet(object.sticky) ? stickyStrategyFromJSON(object.sticky) : undefined,
+            defaultPriority: isSet(object.defaultPriority)
+                ? globalThis.Number(object.defaultPriority)
+                : undefined,
         };
     },
     toJSON(message) {
@@ -934,13 +948,16 @@ exports.CreateWorkflowVersionRequest = {
         if (message.sticky !== undefined) {
             obj.sticky = stickyStrategyToJSON(message.sticky);
         }
+        if (message.defaultPriority !== undefined) {
+            obj.defaultPriority = Math.round(message.defaultPriority);
+        }
         return obj;
     },
     create(base) {
         return exports.CreateWorkflowVersionRequest.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         const message = createBaseCreateWorkflowVersionRequest();
         message.name = (_a = object.name) !== null && _a !== void 0 ? _a : '';
         message.description = (_b = object.description) !== null && _b !== void 0 ? _b : '';
@@ -958,6 +975,7 @@ exports.CreateWorkflowVersionRequest = {
                 ? exports.CreateTaskOpts.fromPartial(object.onFailureTask)
                 : undefined;
         message.sticky = (_h = object.sticky) !== null && _h !== void 0 ? _h : undefined;
+        message.defaultPriority = (_j = object.defaultPriority) !== null && _j !== void 0 ? _j : undefined;
         return message;
     },
 };

package/protoc/workflows/workflows.d.ts

@@ -195,6 +195,8 @@ export interface ScheduleWorkflowRequest {
     childKey?: string | undefined;
     /** (optional) the additional metadata for the workflow */
     additionalMetadata?: string | undefined;
+    /** (optional) the priority of the workflow */
+    priority: number;
 }
 /** ScheduledWorkflow represents a scheduled workflow. */
 export interface ScheduledWorkflow {

package/protoc/workflows/workflows.js

@@ -1409,6 +1409,7 @@ function createBaseScheduleWorkflowRequest() {
         childIndex: undefined,
         childKey: undefined,
         additionalMetadata: undefined,
+        priority: 0,
     };
 }
 exports.ScheduleWorkflowRequest = {
@@ -1437,6 +1438,9 @@ exports.ScheduleWorkflowRequest = {
         if (message.additionalMetadata !== undefined) {
             writer.uint32(66).string(message.additionalMetadata);
         }
+        if (message.priority !== 0) {
+            writer.uint32(72).int32(message.priority);
+        }
         return writer;
     },
     decode(input, length) {
@@ -1502,6 +1506,13 @@ exports.ScheduleWorkflowRequest = {
                     message.additionalMetadata = reader.string();
                     continue;
                 }
+                case 9: {
+                    if (tag !== 72) {
+                        break;
+                    }
+                    message.priority = reader.int32();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1526,6 +1537,7 @@ exports.ScheduleWorkflowRequest = {
             additionalMetadata: isSet(object.additionalMetadata)
                 ? globalThis.String(object.additionalMetadata)
                 : undefined,
+            priority: isSet(object.priority) ? globalThis.Number(object.priority) : 0,
         };
     },
     toJSON(message) {
@@ -1555,13 +1567,16 @@ exports.ScheduleWorkflowRequest = {
         if (message.additionalMetadata !== undefined) {
             obj.additionalMetadata = message.additionalMetadata;
         }
+        if (message.priority !== 0) {
+            obj.priority = Math.round(message.priority);
+        }
         return obj;
     },
     create(base) {
         return exports.ScheduleWorkflowRequest.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         const message = createBaseScheduleWorkflowRequest();
         message.name = (_a = object.name) !== null && _a !== void 0 ? _a : '';
         message.schedules = ((_b = object.schedules) === null || _b === void 0 ? void 0 : _b.map((e) => e)) || [];
@@ -1571,6 +1586,7 @@ exports.ScheduleWorkflowRequest = {
         message.childIndex = (_f = object.childIndex) !== null && _f !== void 0 ? _f : undefined;
         message.childKey = (_g = object.childKey) !== null && _g !== void 0 ? _g : undefined;
         message.additionalMetadata = (_h = object.additionalMetadata) !== null && _h !== void 0 ? _h : undefined;
+        message.priority = (_j = object.priority) !== null && _j !== void 0 ? _j : 0;
         return message;
     },
 };

package/step.d.ts

@@ -8,8 +8,8 @@ import WorkflowRunRef from './util/workflow-run-ref';
 import { V0Worker } from './clients/worker';
 import { WorkerLabels } from './clients/dispatcher/dispatcher-client';
 import { CreateStepRateLimit, RateLimitDuration, WorkerLabelComparator } from './protoc/workflows';
-import { CreateWorkflowTaskOpts } from './v1/task';
-import { TaskWorkflowDeclaration, BaseWorkflowDeclaration as WorkflowV1 } from './v1/declaration';
+import { CreateWorkflowTaskOpts, Priority } from './v1';
+import { RunOpts, TaskWorkflowDeclaration, BaseWorkflowDeclaration as WorkflowV1 } from './v1/declaration';
 import { Conditions } from './v1/conditions';
 import { Duration } from './v1/client/duration';
 import { JsonObject, JsonValue, OutputType } from './v1/types';
@@ -155,6 +155,10 @@ export type NextStep = {
     [key: string]: JsonValue;
 };
 type TriggerData = Record<string, Record<string, any>>;
+type ChildRunOpts = RunOpts & {
+    key?: string;
+    sticky?: boolean;
+};
 interface ContextData<T, K> {
     input: T;
     triggers: TriggerData;
@@ -314,11 +318,7 @@ export declare class Context<T, K = {}> {
     bulkRunNoWaitChildren<Q extends JsonObject = any, P extends JsonObject = any>(children: Array<{
         workflow: string | Workflow | WorkflowV1<Q, P>;
         input: Q;
-        options?: {
-            key?: string;
-            sticky?: boolean;
-            additionalMetadata?: Record<string, string>;
-        };
+        options?: ChildRunOpts;
     }>): Promise<WorkflowRunRef<P>[]>;
     /**
      * Runs multiple children workflows in parallel and waits for all results.
@@ -328,11 +328,7 @@ export declare class Context<T, K = {}> {
     bulkRunChildren<Q extends JsonObject = any, P extends JsonObject = any>(children: Array<{
         workflow: string | Workflow | WorkflowV1<Q, P>;
         input: Q;
-        options?: {
-            key?: string;
-            sticky?: boolean;
-            additionalMetadata?: Record<string, string>;
-        };
+        options?: ChildRunOpts;
     }>): Promise<P[]>;
     /**
      * Spawns multiple workflows.
@@ -344,38 +340,26 @@ export declare class Context<T, K = {}> {
     spawnWorkflows<Q extends JsonObject = any, P extends JsonObject = any>(workflows: Array<{
         workflow: string | Workflow | WorkflowV1<Q, P>;
         input: Q;
-        options?: {
-            key?: string;
-            sticky?: boolean;
-            additionalMetadata?: Record<string, string>;
-        };
+        options?: ChildRunOpts;
     }>): Promise<WorkflowRunRef<P>[]>;
     /**
      * Runs a new workflow and waits for its result.
      *
      * @param workflow - The workflow to run (name, Workflow instance, or WorkflowV1 instance).
      * @param input - The input data for the workflow.
-     * @param optionsOrKey - Either a string key or an options object containing key, sticky, and additionalMetadata.
+     * @param options - An options object containing key, sticky, priority, and additionalMetadata.
      * @returns The result of the workflow.
      */
-    runChild<Q extends JsonObject, P extends JsonObject>(workflow: string | Workflow | WorkflowV1<Q, P> | TaskWorkflowDeclaration<Q, P>, input: Q, optionsOrKey?: string | {
-        key?: string;
-        sticky?: boolean;
-        additionalMetadata?: Record<string, string>;
-    }): Promise<P>;
+    runChild<Q extends JsonObject, P extends JsonObject>(workflow: string | Workflow | WorkflowV1<Q, P> | TaskWorkflowDeclaration<Q, P>, input: Q, options?: ChildRunOpts): Promise<P>;
     /**
      * Enqueues a new workflow without waiting for its result.
      *
      * @param workflow - The workflow to enqueue (name, Workflow instance, or WorkflowV1 instance).
      * @param input - The input data for the workflow.
-     * @param optionsOrKey - Either a string key or an options object containing key, sticky, and additionalMetadata.
+     * @param options - An options object containing key, sticky, priority, and additionalMetadata.
      * @returns A reference to the spawned workflow run.
      */
-    runNoWaitChild<Q extends JsonObject, P extends JsonObject>(workflow: string | Workflow | WorkflowV1<Q, P>, input: Q, optionsOrKey?: string | {
-        key?: string;
-        sticky?: boolean;
-        additionalMetadata?: Record<string, string>;
-    }): WorkflowRunRef<P>;
+    runNoWaitChild<Q extends JsonObject, P extends JsonObject>(workflow: string | Workflow | WorkflowV1<Q, P>, input: Q, options?: ChildRunOpts): WorkflowRunRef<P>;
     /**
      * Spawns a new workflow.
      *
@@ -385,11 +369,7 @@ export declare class Context<T, K = {}> {
      * @returns A reference to the spawned workflow run.
      * @deprecated Use runChild or runNoWaitChild instead.
      */
-    spawnWorkflow<Q extends JsonObject, P extends JsonObject>(workflow: string | Workflow | WorkflowV1<Q, P> | TaskWorkflowDeclaration<Q, P>, input: Q, options?: string | {
-        key?: string;
-        sticky?: boolean;
-        additionalMetadata?: Record<string, string>;
-    }): WorkflowRunRef<P>;
+    spawnWorkflow<Q extends JsonObject, P extends JsonObject>(workflow: string | Workflow | WorkflowV1<Q, P> | TaskWorkflowDeclaration<Q, P>, input: Q, options?: ChildRunOpts): WorkflowRunRef<P>;
     /**
      * Retrieves additional metadata associated with the current workflow run.
      * @returns A record of metadata key-value pairs.
@@ -410,6 +390,7 @@ export declare class Context<T, K = {}> {
      * @returns The parent workflow run ID, or undefined if not a child workflow.
      */
     parentWorkflowRunId(): string | undefined;
+    priority(): Priority | undefined;
 }
 export declare class DurableContext<T, K = {}> extends Context<T, K> {
     waitKey: number;

package/step.js

@@ -53,6 +53,7 @@ const hatchet_error_1 = __importDefault(require("./util/errors/hatchet-error"));
 const z = __importStar(require("zod"));
 const parse_1 = require("./util/parse");
 const workflows_1 = require("./protoc/workflows");
+const v1_1 = require("./v1");
 const declaration_1 = require("./v1/declaration");
 const conditions_1 = require("./v1/conditions");
 const condition_1 = require("./protoc/v1/shared/condition");
@@ -386,28 +387,15 @@ class Context {
                     workflowName = workflow.id;
                 }
                 const name = this.client.config.namespace + workflowName;
-                let key;
-                let sticky = false;
-                let metadata;
-                if (options) {
-                    key = options.key;
-                    sticky = options.sticky;
-                    metadata = options.additionalMetadata;
-                }
+                const opts = options || {};
+                const { sticky } = opts;
                 if (sticky && !this.worker.hasWorkflow(name)) {
                     throw new hatchet_error_1.default(`Cannot run with sticky: workflow ${name} is not registered on the worker`);
                 }
                 const resp = {
                     workflowName: name,
                     input,
-                    options: {
-                        parentId: workflowRunId,
-                        parentStepRunId: stepRunId,
-                        childKey: key,
-                        childIndex: this.spawnIndex,
-                        desiredWorkerId: sticky ? this.worker.id() : undefined,
-                        additionalMetadata: metadata,
-                    },
+                    options: Object.assign(Object.assign({}, opts), { parentId: workflowRunId, parentStepRunId: stepRunId, childIndex: this.spawnIndex, desiredWorkerId: sticky ? this.worker.id() : undefined }),
                 };
                 this.spawnIndex += 1;
                 return resp;
@@ -441,12 +429,12 @@ class Context {
      *
      * @param workflow - The workflow to run (name, Workflow instance, or WorkflowV1 instance).
      * @param input - The input data for the workflow.
-     * @param optionsOrKey - Either a string key or an options object containing key, sticky, and additionalMetadata.
+     * @param options - An options object containing key, sticky, priority, and additionalMetadata.
      * @returns The result of the workflow.
      */
-    runChild(workflow, input, optionsOrKey) {
+    runChild(workflow, input, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const run = yield this.spawnWorkflow(workflow, input, optionsOrKey);
+            const run = yield this.spawnWorkflow(workflow, input, options);
             return run.output;
         });
     }
@@ -455,11 +443,11 @@ class Context {
      *
      * @param workflow - The workflow to enqueue (name, Workflow instance, or WorkflowV1 instance).
      * @param input - The input data for the workflow.
-     * @param optionsOrKey - Either a string key or an options object containing key, sticky, and additionalMetadata.
+     * @param options - An options object containing key, sticky, priority, and additionalMetadata.
      * @returns A reference to the spawned workflow run.
      */
-    runNoWaitChild(workflow, input, optionsOrKey) {
-        return this.spawnWorkflow(workflow, input, optionsOrKey);
+    runNoWaitChild(workflow, input, options) {
+        return this.spawnWorkflow(workflow, input, options);
     }
     /**
      * Spawns a new workflow.
@@ -480,30 +468,13 @@ class Context {
             workflowName = workflow.id;
         }
         const name = this.client.config.namespace + workflowName;
-        let key = '';
-        let sticky = false;
-        let metadata;
-        if (typeof options === 'string') {
-            this.logger.warn('Using key param is deprecated and will be removed in a future release. Use options.key instead.');
-            key = options;
-        }
-        else {
-            key = options === null || options === void 0 ? void 0 : options.key;
-            sticky = options === null || options === void 0 ? void 0 : options.sticky;
-            metadata = options === null || options === void 0 ? void 0 : options.additionalMetadata;
-        }
+        const opts = options || {};
+        const { sticky } = opts;
         if (sticky && !this.worker.hasWorkflow(name)) {
             throw new hatchet_error_1.default(`cannot run with sticky: workflow ${name} is not registered on the worker`);
         }
         try {
-            const resp = this.client.admin.runWorkflow(name, input, {
-                parentId: workflowRunId,
-                parentStepRunId: stepRunId,
-                childKey: key,
-                childIndex: this.spawnIndex,
-                desiredWorkerId: sticky ? this.worker.id() : undefined,
-                additionalMetadata: metadata,
-            });
+            const resp = this.client.admin.runWorkflow(name, input, Object.assign({ parentId: workflowRunId, parentStepRunId: stepRunId, childIndex: this.spawnIndex, desiredWorkerId: sticky ? this.worker.id() : undefined }, opts));
             this.spawnIndex += 1;
             if (workflow instanceof declaration_1.TaskWorkflowDeclaration) {
                 resp._standalone_task_name = workflow._standalone_task_name;
@@ -547,6 +518,18 @@ class Context {
     parentWorkflowRunId() {
         return this.action.parentWorkflowRunId;
     }
+    priority() {
+        switch (this.action.priority) {
+            case 1:
+                return v1_1.Priority.LOW;
+            case 2:
+                return v1_1.Priority.MEDIUM;
+            case 3:
+                return v1_1.Priority.HIGH;
+            default:
+                return undefined;
+        }
+    }
 }
 exports.Context = Context;
 class DurableContext extends Context {

package/util/config-loader/config-loader.js

@@ -44,7 +44,7 @@ const token_1 = require("./token");
 const DEFAULT_CONFIG_FILE = '.hatchet.yaml';
 class ConfigLoader {
     static loadClientConfig(override, config) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6;
         const yaml = this.loadYamlConfig(config === null || config === void 0 ? void 0 : config.path);
         const tlsConfig = (_a = override === null || override === void 0 ? void 0 : override.tls_config) !== null && _a !== void 0 ? _a : {
             tls_strategy: (_d = (_c = (_b = yaml === null || yaml === void 0 ? void 0 : yaml.tls_config) === null || _b === void 0 ? void 0 : _b.tls_strategy) !== null && _c !== void 0 ? _c : this.env('HATCHET_CLIENT_TLS_STRATEGY')) !== null && _d !== void 0 ? _d : 'tls',
@@ -76,18 +76,14 @@ class ConfigLoader {
             apiUrl = (_z = (_y = override === null || override === void 0 ? void 0 : override.api_url) !== null && _y !== void 0 ? _y : yaml === null || yaml === void 0 ? void 0 : yaml.api_url) !== null && _z !== void 0 ? _z : this.env('HATCHET_CLIENT_API_URL');
         }
         const namespace = (_1 = (_0 = override === null || override === void 0 ? void 0 : override.namespace) !== null && _0 !== void 0 ? _0 : yaml === null || yaml === void 0 ? void 0 : yaml.namespace) !== null && _1 !== void 0 ? _1 : this.env('HATCHET_CLIENT_NAMESPACE');
-        const grpcMaxSendMessageLength = (_3 = (_2 = override === null || override === void 0 ? void 0 : override.grpc_max_send_message_length) !== null && _2 !== void 0 ? _2 : yaml === null || yaml === void 0 ? void 0 : yaml.grpc_max_send_message_length) !== null && _3 !== void 0 ? _3 : parseInt((_4 = this.env('HATCHET_CLIENT_GRPC_MAX_SEND_MESSAGE_LENGTH')) !== null && _4 !== void 0 ? _4 : '-1', 10);
-        const grpcMaxRecvMessageLength = (_6 = (_5 = override === null || override === void 0 ? void 0 : override.grpc_max_recv_message_length) !== null && _5 !== void 0 ? _5 : yaml === null || yaml === void 0 ? void 0 : yaml.grpc_max_recv_message_length) !== null && _6 !== void 0 ? _6 : parseInt((_7 = this.env('HATCHET_CLIENT_GRPC_MAX_RECV_MESSAGE_LENGTH')) !== null && _7 !== void 0 ? _7 : '-1', 10);
         return {
-            token: (_9 = (_8 = override === null || override === void 0 ? void 0 : override.token) !== null && _8 !== void 0 ? _8 : yaml === null || yaml === void 0 ? void 0 : yaml.token) !== null && _9 !== void 0 ? _9 : this.env('HATCHET_CLIENT_TOKEN'),
+            token: (_3 = (_2 = override === null || override === void 0 ? void 0 : override.token) !== null && _2 !== void 0 ? _2 : yaml === null || yaml === void 0 ? void 0 : yaml.token) !== null && _3 !== void 0 ? _3 : this.env('HATCHET_CLIENT_TOKEN'),
             host_port: grpcBroadcastAddress,
             api_url: apiUrl,
             tls_config: tlsConfig,
-            log_level: (_12 = (_11 = (_10 = override === null || override === void 0 ? void 0 : override.log_level) !== null && _10 !== void 0 ? _10 : yaml === null || yaml === void 0 ? void 0 : yaml.log_level) !== null && _11 !== void 0 ? _11 : this.env('HATCHET_CLIENT_LOG_LEVEL')) !== null && _12 !== void 0 ? _12 : 'INFO',
+            log_level: (_6 = (_5 = (_4 = override === null || override === void 0 ? void 0 : override.log_level) !== null && _4 !== void 0 ? _4 : yaml === null || yaml === void 0 ? void 0 : yaml.log_level) !== null && _5 !== void 0 ? _5 : this.env('HATCHET_CLIENT_LOG_LEVEL')) !== null && _6 !== void 0 ? _6 : 'INFO',
             tenant_id: tenantId,
             namespace: namespace ? `${namespace}_`.toLowerCase() : '',
-            grpc_max_send_message_length: grpcMaxSendMessageLength > 0 ? grpcMaxSendMessageLength : undefined,
-            grpc_max_recv_message_length: grpcMaxRecvMessageLength > 0 ? grpcMaxRecvMessageLength : undefined,
         };
     }
     static get default_yaml_config_path() {

package/v1/declaration.d.ts

@@ -7,6 +7,11 @@ import { CreateWorkflowTaskOpts, CreateOnFailureTaskOpts, TaskConcurrency, TaskF
 import { Duration } from './client/duration';
 import { MetricsClient } from './client/features/metrics';
 import { InputType, OutputType, UnknownInputType, JsonObject } from './types';
+export declare enum Priority {
+    LOW = 1,
+    MEDIUM = 2,
+    HIGH = 3
+}
 /**
  * Additional metadata that can be attached to a workflow run.
  */
@@ -16,9 +21,15 @@ type AdditionalMetadata = Record<string, string>;
  */
 export type RunOpts = {
     /**
-     * Additional metadata to attach to the workflow run.
+     * (optional) additional metadata to attach to the workflow run.
      */
     additionalMetadata?: AdditionalMetadata;
+    /**
+     * (optional) the priority for the workflow run.
+     *
+     * values: Priority.LOW, Priority.MEDIUM, Priority.HIGH (1, 2, or 3 )
+     */
+    priority?: Priority;
 };
 /**
  * Helper type to safely extract output types from task results
@@ -59,6 +70,11 @@ export type CreateBaseWorkflowOpts = {
      */
     onEvents?: string[];
     concurrency?: TaskConcurrency;
+    /**
+     * (optional) the priority for the workflow.
+     * values: Priority.LOW, Priority.MEDIUM, Priority.HIGH (1, 2, or 3 )
+     */
+    defaultPriority?: Priority;
 };
 export type CreateTaskWorkflowOpts<I extends InputType = UnknownInputType, O extends OutputType = void> = CreateBaseWorkflowOpts & CreateBaseTaskOpts<I, O, TaskFn<I, O>>;
 export type CreateDurableTaskWorkflowOpts<I extends InputType = UnknownInputType, O extends OutputType = void> = CreateBaseWorkflowOpts & CreateBaseTaskOpts<I, O, DurableTaskFn<I, O>>;

package/v1/declaration.js

@@ -9,11 +9,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TaskWorkflowDeclaration = exports.WorkflowDeclaration = exports.BaseWorkflowDeclaration = void 0;
+exports.TaskWorkflowDeclaration = exports.WorkflowDeclaration = exports.BaseWorkflowDeclaration = exports.Priority = void 0;
 exports.CreateTaskWorkflow = CreateTaskWorkflow;
 exports.CreateWorkflow = CreateWorkflow;
 exports.CreateDurableTaskWorkflow = CreateDurableTaskWorkflow;
 const UNBOUND_ERR = new Error('workflow unbound to hatchet client, hint: use client.run instead');
+// eslint-disable-next-line no-shadow
+var Priority;
+(function (Priority) {
+    Priority[Priority["LOW"] = 1] = "LOW";
+    Priority[Priority["MEDIUM"] = 2] = "MEDIUM";
+    Priority[Priority["HIGH"] = 3] = "HIGH";
+})(Priority || (exports.Priority = Priority = {}));
 /**
  * Represents a workflow that can be executed by Hatchet.
  * @template I The input type for the workflow.
@@ -104,11 +111,7 @@ class BaseWorkflowDeclaration {
             if (!this.client) {
                 throw UNBOUND_ERR;
             }
-            const scheduled = this.client._v0.schedule.create(this.definition.name, {
-                triggerAt: enqueueAt,
-                input: input,
-                additionalMetadata: options === null || options === void 0 ? void 0 : options.additionalMetadata,
-            });
+            const scheduled = this.client._v0.schedule.create(this.definition.name, Object.assign({ triggerAt: enqueueAt, input: input }, options));
             return scheduled;
         });
     }
@@ -141,12 +144,7 @@ class BaseWorkflowDeclaration {
             if (!this.client) {
                 throw UNBOUND_ERR;
             }
-            const cronDef = this.client._v0.cron.create(this.definition.name, {
-                expression,
-                input: input,
-                additionalMetadata: options === null || options === void 0 ? void 0 : options.additionalMetadata,
-                name,
-            });
+            const cronDef = this.client._v0.cron.create(this.definition.name, Object.assign(Object.assign({ expression, input: input }, options), { additionalMetadata: options === null || options === void 0 ? void 0 : options.additionalMetadata, name }));
             return cronDef;
         });
     }

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

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

package/v1/examples/priority/run.js

@@ -0,0 +1,41 @@
+"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");
+/* eslint-disable no-console */
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            console.log('running priority workflow');
+            // ❓ Run a Task with a Priority
+            const run = workflow_1.priority.run(new Date(Date.now() + 60 * 60 * 1000), { priority: v1_1.Priority.HIGH });
+            // !!
+            // ❓ Schedule and cron
+            const scheduled = workflow_1.priority.schedule(new Date(Date.now() + 60 * 60 * 1000), {}, { priority: v1_1.Priority.HIGH });
+            const delayed = workflow_1.priority.delay(60 * 60 * 1000, {}, { priority: v1_1.Priority.HIGH });
+            const cron = workflow_1.priority.cron(`daily-cron-${Math.random()}`, '0 0 * * *', {}, { priority: v1_1.Priority.HIGH });
+            // !!
+            const [scheduledResult, delayedResult] = yield Promise.all([scheduled, delayed]);
+            console.log('scheduledResult', scheduledResult);
+            console.log('delayedResult', delayedResult);
+            // !!
+        }
+        catch (e) {
+            console.log('error', e);
+        }
+    });
+}
+if (require.main === module) {
+    main()
+        .catch(console.error)
+        .finally(() => process.exit(0));
+}

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

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

package/v1/examples/priority/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 workflow_1 = require("./workflow");
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const worker = yield hatchet_client_1.hatchet.worker('priority-worker', {
+            workflows: [...workflow_1.priorityTasks],
+        });
+        yield worker.start();
+    });
+}
+if (require.main === module) {
+    main();
+}

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

@@ -0,0 +1,8 @@
+import { Priority } from '../..';
+export declare const priority: import("../..").TaskWorkflowDeclaration<import("../..").UnknownInputType, {
+    priority: Priority | undefined;
+}>;
+export declare const priorityWf: import("../..").WorkflowDeclaration<import("../..").UnknownInputType, {}>;
+export declare const priorityTasks: (import("../..").WorkflowDeclaration<import("../..").UnknownInputType, {}> | import("../..").TaskWorkflowDeclaration<import("../..").UnknownInputType, {
+    priority: Priority | undefined;
+}>)[];

package/v1/examples/priority/workflow.js

@@ -0,0 +1,50 @@
+"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.priorityTasks = exports.priorityWf = exports.priority = void 0;
+/* eslint-disable no-console */
+const v1_1 = require("../..");
+const hatchet_client_1 = require("../hatchet-client");
+// ❓ Simple Task Priority
+exports.priority = hatchet_client_1.hatchet.task({
+    name: 'priority',
+    defaultPriority: v1_1.Priority.MEDIUM,
+    fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        return {
+            priority: ctx.priority(),
+        };
+    }),
+});
+// !!
+// ❓ Task Priority in a Workflow
+exports.priorityWf = hatchet_client_1.hatchet.workflow({
+    name: 'priorityWf',
+    defaultPriority: v1_1.Priority.LOW,
+});
+// !!
+exports.priorityWf.task({
+    name: 'child-medium',
+    fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        return {
+            priority: ctx.priority(),
+        };
+    }),
+});
+exports.priorityWf.task({
+    name: 'child-high',
+    // will inherit the default priority from the workflow
+    fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        return {
+            priority: ctx.priority(),
+        };
+    }),
+});
+exports.priorityTasks = [exports.priority, exports.priorityWf];

package/v1/index.d.ts

@@ -5,3 +5,4 @@ export * from './declaration';
 export * from './conditions';
 export * from './client/duration';
 export * from './types';
+export * from './task';

package/v1/index.js

@@ -21,3 +21,4 @@ __exportStar(require("./declaration"), exports);
 __exportStar(require("./conditions"), exports);
 __exportStar(require("./client/duration"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./task"), exports);

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.1.8-alpha.2";
+export declare const HATCHET_VERSION = "1.2.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.1.8-alpha.2';
+exports.HATCHET_VERSION = '1.2.0';