@hatchet-dev/typescript-sdk 1.14.0 → 1.15.1

package/protoc/v1/workflows.js

@@ -5,7 +5,7 @@
 //   protoc               v3.19.1
 // source: v1/workflows.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdminServiceDefinition = exports.GetRunDetailsResponse_TaskRunsEntry = exports.GetRunDetailsResponse = exports.TaskRunDetail = exports.GetRunDetailsRequest = exports.CreateWorkflowVersionResponse = exports.CreateTaskRateLimit = exports.CreateTaskOpts_SlotRequestsEntry = exports.CreateTaskOpts_WorkerLabelsEntry = exports.CreateTaskOpts = exports.DesiredWorkerLabels = exports.Concurrency = exports.DefaultFilter = exports.CreateWorkflowVersionRequest = exports.TriggerWorkflowRunResponse = exports.TriggerWorkflowRunRequest = exports.ReplayTasksResponse = exports.CancelTasksResponse = exports.TasksFilter = exports.ReplayTasksRequest = exports.CancelTasksRequest = exports.WorkerLabelComparator = exports.ConcurrencyLimitStrategy = exports.RunStatus = exports.RateLimitDuration = exports.StickyStrategy = exports.protobufPackage = void 0;
+exports.AdminServiceDefinition = exports.GetRunDetailsResponse_TaskRunsEntry = exports.GetRunDetailsResponse = exports.TaskRunDetail = exports.GetRunDetailsRequest = exports.CreateWorkflowVersionResponse = exports.CreateTaskRateLimit = exports.CreateTaskOpts_SlotRequestsEntry = exports.CreateTaskOpts_WorkerLabelsEntry = exports.CreateTaskOpts = exports.DesiredWorkerLabels = exports.Concurrency = exports.DefaultFilter = exports.CreateWorkflowVersionRequest = exports.TriggerWorkflowRunResponse = exports.TriggerWorkflowRunRequest_DesiredWorkerLabelsEntry = exports.TriggerWorkflowRunRequest = exports.ReplayTasksResponse = exports.CancelTasksResponse = exports.TasksFilter = exports.ReplayTasksRequest = exports.CancelTasksRequest = exports.WorkerLabelComparator = exports.ConcurrencyLimitStrategy = exports.RunStatus = exports.RateLimitDuration = exports.StickyStrategy = exports.protobufPackage = void 0;
 exports.stickyStrategyFromJSON = stickyStrategyFromJSON;
 exports.stickyStrategyToJSON = stickyStrategyToJSON;
 exports.rateLimitDurationFromJSON = rateLimitDurationFromJSON;
@@ -665,6 +665,7 @@ function createBaseTriggerWorkflowRunRequest() {
         input: new Uint8Array(0),
         additionalMetadata: new Uint8Array(0),
         priority: undefined,
+        desiredWorkerLabels: {},
     };
 }
 exports.TriggerWorkflowRunRequest = {
@@ -681,6 +682,9 @@ exports.TriggerWorkflowRunRequest = {
         if (message.priority !== undefined) {
             writer.uint32(32).int32(message.priority);
         }
+        Object.entries(message.desiredWorkerLabels).forEach(([key, value]) => {
+            exports.TriggerWorkflowRunRequest_DesiredWorkerLabelsEntry.encode({ key: key, value }, writer.uint32(42).fork()).join();
+        });
         return writer;
     },
     decode(input, length) {
@@ -718,6 +722,16 @@ exports.TriggerWorkflowRunRequest = {
                     message.priority = reader.int32();
                     continue;
                 }
+                case 5: {
+                    if (tag !== 42) {
+                        break;
+                    }
+                    const entry5 = exports.TriggerWorkflowRunRequest_DesiredWorkerLabelsEntry.decode(reader, reader.uint32());
+                    if (entry5.value !== undefined) {
+                        message.desiredWorkerLabels[entry5.key] = entry5.value;
+                    }
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -734,6 +748,12 @@ exports.TriggerWorkflowRunRequest = {
                 ? bytesFromBase64(object.additionalMetadata)
                 : new Uint8Array(0),
             priority: isSet(object.priority) ? globalThis.Number(object.priority) : undefined,
+            desiredWorkerLabels: isObject(object.desiredWorkerLabels)
+                ? Object.entries(object.desiredWorkerLabels).reduce((acc, [key, value]) => {
+                    acc[key] = exports.DesiredWorkerLabels.fromJSON(value);
+                    return acc;
+                }, {})
+                : {},
         };
     },
     toJSON(message) {
@@ -750,18 +770,105 @@ exports.TriggerWorkflowRunRequest = {
         if (message.priority !== undefined) {
             obj.priority = Math.round(message.priority);
         }
+        if (message.desiredWorkerLabels) {
+            const entries = Object.entries(message.desiredWorkerLabels);
+            if (entries.length > 0) {
+                obj.desiredWorkerLabels = {};
+                entries.forEach(([k, v]) => {
+                    obj.desiredWorkerLabels[k] = exports.DesiredWorkerLabels.toJSON(v);
+                });
+            }
+        }
         return obj;
     },
     create(base) {
         return exports.TriggerWorkflowRunRequest.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         const message = createBaseTriggerWorkflowRunRequest();
         message.workflowName = (_a = object.workflowName) !== null && _a !== void 0 ? _a : '';
         message.input = (_b = object.input) !== null && _b !== void 0 ? _b : new Uint8Array(0);
         message.additionalMetadata = (_c = object.additionalMetadata) !== null && _c !== void 0 ? _c : new Uint8Array(0);
         message.priority = (_d = object.priority) !== null && _d !== void 0 ? _d : undefined;
+        message.desiredWorkerLabels = Object.entries((_e = object.desiredWorkerLabels) !== null && _e !== void 0 ? _e : {}).reduce((acc, [key, value]) => {
+            if (value !== undefined) {
+                acc[key] = exports.DesiredWorkerLabels.fromPartial(value);
+            }
+            return acc;
+        }, {});
+        return message;
+    },
+};
+function createBaseTriggerWorkflowRunRequest_DesiredWorkerLabelsEntry() {
+    return { key: '', value: undefined };
+}
+exports.TriggerWorkflowRunRequest_DesiredWorkerLabelsEntry = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.key !== '') {
+            writer.uint32(10).string(message.key);
+        }
+        if (message.value !== undefined) {
+            exports.DesiredWorkerLabels.encode(message.value, writer.uint32(18).fork()).join();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseTriggerWorkflowRunRequest_DesiredWorkerLabelsEntry();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.key = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.value = exports.DesiredWorkerLabels.decode(reader, reader.uint32());
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            key: isSet(object.key) ? globalThis.String(object.key) : '',
+            value: isSet(object.value) ? exports.DesiredWorkerLabels.fromJSON(object.value) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.key !== '') {
+            obj.key = message.key;
+        }
+        if (message.value !== undefined) {
+            obj.value = exports.DesiredWorkerLabels.toJSON(message.value);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.TriggerWorkflowRunRequest_DesiredWorkerLabelsEntry.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a;
+        const message = createBaseTriggerWorkflowRunRequest_DesiredWorkerLabelsEntry();
+        message.key = (_a = object.key) !== null && _a !== void 0 ? _a : '';
+        message.value =
+            object.value !== undefined && object.value !== null
+                ? exports.DesiredWorkerLabels.fromPartial(object.value)
+                : undefined;
         return message;
     },
 };

package/protoc/workflows/workflows.d.ts

@@ -258,6 +258,14 @@ export interface TriggerWorkflowRequest {
     desiredWorkerId?: string | undefined;
     /** (optional) override for the priority of the workflow tasks, will set all tasks to this priority */
     priority?: number | undefined;
+    /** (optional) override for the desired worker labels for the workflow tasks, used for routing to specific workers (or worker pools) */
+    desiredWorkerLabels: {
+        [key: string]: DesiredWorkerLabels;
+    };
+}
+export interface TriggerWorkflowRequest_DesiredWorkerLabelsEntry {
+    key: string;
+    value: DesiredWorkerLabels | undefined;
 }
 export interface TriggerWorkflowResponse {
     workflowRunId: string;
@@ -289,6 +297,7 @@ export declare const WorkflowTriggerCronRef: MessageFns<WorkflowTriggerCronRef>;
 export declare const BulkTriggerWorkflowRequest: MessageFns<BulkTriggerWorkflowRequest>;
 export declare const BulkTriggerWorkflowResponse: MessageFns<BulkTriggerWorkflowResponse>;
 export declare const TriggerWorkflowRequest: MessageFns<TriggerWorkflowRequest>;
+export declare const TriggerWorkflowRequest_DesiredWorkerLabelsEntry: MessageFns<TriggerWorkflowRequest_DesiredWorkerLabelsEntry>;
 export declare const TriggerWorkflowResponse: MessageFns<TriggerWorkflowResponse>;
 export declare const PutRateLimitRequest: MessageFns<PutRateLimitRequest>;
 export declare const PutRateLimitResponse: MessageFns<PutRateLimitResponse>;

package/protoc/workflows/workflows.js

@@ -5,7 +5,7 @@
 //   protoc               v3.19.1
 // source: workflows/workflows.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowServiceDefinition = exports.PutRateLimitResponse = exports.PutRateLimitRequest = exports.TriggerWorkflowResponse = exports.TriggerWorkflowRequest = exports.BulkTriggerWorkflowResponse = exports.BulkTriggerWorkflowRequest = exports.WorkflowTriggerCronRef = exports.WorkflowTriggerEventRef = exports.WorkflowVersion = exports.ScheduledWorkflow = exports.ScheduleWorkflowRequest = exports.ListWorkflowsRequest = exports.CreateStepRateLimit = exports.CreateWorkflowStepOpts_WorkerLabelsEntry = exports.CreateWorkflowStepOpts = exports.DesiredWorkerLabels = exports.CreateWorkflowJobOpts = exports.WorkflowConcurrencyOpts = exports.CreateWorkflowVersionOpts = exports.PutWorkflowRequest = exports.RateLimitDuration = exports.WorkerLabelComparator = exports.ConcurrencyLimitStrategy = exports.WorkflowKind = exports.StickyStrategy = exports.protobufPackage = void 0;
+exports.WorkflowServiceDefinition = exports.PutRateLimitResponse = exports.PutRateLimitRequest = exports.TriggerWorkflowResponse = exports.TriggerWorkflowRequest_DesiredWorkerLabelsEntry = exports.TriggerWorkflowRequest = exports.BulkTriggerWorkflowResponse = exports.BulkTriggerWorkflowRequest = exports.WorkflowTriggerCronRef = exports.WorkflowTriggerEventRef = exports.WorkflowVersion = exports.ScheduledWorkflow = exports.ScheduleWorkflowRequest = exports.ListWorkflowsRequest = exports.CreateStepRateLimit = exports.CreateWorkflowStepOpts_WorkerLabelsEntry = exports.CreateWorkflowStepOpts = exports.DesiredWorkerLabels = exports.CreateWorkflowJobOpts = exports.WorkflowConcurrencyOpts = exports.CreateWorkflowVersionOpts = exports.PutWorkflowRequest = exports.RateLimitDuration = exports.WorkerLabelComparator = exports.ConcurrencyLimitStrategy = exports.WorkflowKind = exports.StickyStrategy = exports.protobufPackage = void 0;
 exports.stickyStrategyFromJSON = stickyStrategyFromJSON;
 exports.stickyStrategyToJSON = stickyStrategyToJSON;
 exports.workflowKindFromJSON = workflowKindFromJSON;
@@ -2078,6 +2078,7 @@ function createBaseTriggerWorkflowRequest() {
         additionalMetadata: undefined,
         desiredWorkerId: undefined,
         priority: undefined,
+        desiredWorkerLabels: {},
     };
 }
 exports.TriggerWorkflowRequest = {
@@ -2109,6 +2110,9 @@ exports.TriggerWorkflowRequest = {
         if (message.priority !== undefined) {
             writer.uint32(72).int32(message.priority);
         }
+        Object.entries(message.desiredWorkerLabels).forEach(([key, value]) => {
+            exports.TriggerWorkflowRequest_DesiredWorkerLabelsEntry.encode({ key: key, value }, writer.uint32(82).fork()).join();
+        });
         return writer;
     },
     decode(input, length) {
@@ -2181,6 +2185,16 @@ exports.TriggerWorkflowRequest = {
                     message.priority = reader.int32();
                     continue;
                 }
+                case 10: {
+                    if (tag !== 82) {
+                        break;
+                    }
+                    const entry10 = exports.TriggerWorkflowRequest_DesiredWorkerLabelsEntry.decode(reader, reader.uint32());
+                    if (entry10.value !== undefined) {
+                        message.desiredWorkerLabels[entry10.key] = entry10.value;
+                    }
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -2206,6 +2220,12 @@ exports.TriggerWorkflowRequest = {
                 ? globalThis.String(object.desiredWorkerId)
                 : undefined,
             priority: isSet(object.priority) ? globalThis.Number(object.priority) : undefined,
+            desiredWorkerLabels: isObject(object.desiredWorkerLabels)
+                ? Object.entries(object.desiredWorkerLabels).reduce((acc, [key, value]) => {
+                    acc[key] = exports.DesiredWorkerLabels.fromJSON(value);
+                    return acc;
+                }, {})
+                : {},
         };
     },
     toJSON(message) {
@@ -2237,13 +2257,22 @@ exports.TriggerWorkflowRequest = {
         if (message.priority !== undefined) {
             obj.priority = Math.round(message.priority);
         }
+        if (message.desiredWorkerLabels) {
+            const entries = Object.entries(message.desiredWorkerLabels);
+            if (entries.length > 0) {
+                obj.desiredWorkerLabels = {};
+                entries.forEach(([k, v]) => {
+                    obj.desiredWorkerLabels[k] = exports.DesiredWorkerLabels.toJSON(v);
+                });
+            }
+        }
         return obj;
     },
     create(base) {
         return exports.TriggerWorkflowRequest.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         const message = createBaseTriggerWorkflowRequest();
         message.name = (_a = object.name) !== null && _a !== void 0 ? _a : '';
         message.input = (_b = object.input) !== null && _b !== void 0 ? _b : '';
@@ -2254,6 +2283,84 @@ exports.TriggerWorkflowRequest = {
         message.additionalMetadata = (_g = object.additionalMetadata) !== null && _g !== void 0 ? _g : undefined;
         message.desiredWorkerId = (_h = object.desiredWorkerId) !== null && _h !== void 0 ? _h : undefined;
         message.priority = (_j = object.priority) !== null && _j !== void 0 ? _j : undefined;
+        message.desiredWorkerLabels = Object.entries((_k = object.desiredWorkerLabels) !== null && _k !== void 0 ? _k : {}).reduce((acc, [key, value]) => {
+            if (value !== undefined) {
+                acc[key] = exports.DesiredWorkerLabels.fromPartial(value);
+            }
+            return acc;
+        }, {});
+        return message;
+    },
+};
+function createBaseTriggerWorkflowRequest_DesiredWorkerLabelsEntry() {
+    return { key: '', value: undefined };
+}
+exports.TriggerWorkflowRequest_DesiredWorkerLabelsEntry = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.key !== '') {
+            writer.uint32(10).string(message.key);
+        }
+        if (message.value !== undefined) {
+            exports.DesiredWorkerLabels.encode(message.value, writer.uint32(18).fork()).join();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseTriggerWorkflowRequest_DesiredWorkerLabelsEntry();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.key = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.value = exports.DesiredWorkerLabels.decode(reader, reader.uint32());
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            key: isSet(object.key) ? globalThis.String(object.key) : '',
+            value: isSet(object.value) ? exports.DesiredWorkerLabels.fromJSON(object.value) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.key !== '') {
+            obj.key = message.key;
+        }
+        if (message.value !== undefined) {
+            obj.value = exports.DesiredWorkerLabels.toJSON(message.value);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.TriggerWorkflowRequest_DesiredWorkerLabelsEntry.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a;
+        const message = createBaseTriggerWorkflowRequest_DesiredWorkerLabelsEntry();
+        message.key = (_a = object.key) !== null && _a !== void 0 ? _a : '';
+        message.value =
+            object.value !== undefined && object.value !== null
+                ? exports.DesiredWorkerLabels.fromPartial(object.value)
+                : undefined;
         return message;
     },
 };

package/v1/client/admin.d.ts

@@ -3,9 +3,15 @@ import WorkflowRunRef from '../../util/workflow-run-ref';
 import { Priority, RateLimitDuration, RunsClient } from './..';
 import { RunListenerClient } from '../../clients/listeners/run-listener/child-listener-client';
 import { Api } from '../../clients/rest/generated/Api';
-import { WorkflowServiceClient } from '../../protoc/workflows';
+import { WorkerLabelComparator, WorkflowServiceClient } from '../../protoc/workflows';
 import { AdminServiceClient, CreateWorkflowVersionRequest } from '../../protoc/v1/workflows';
 import { Logger } from '../../util/logger';
+type DesiredWorkerLabelOpt = {
+    value: string | number;
+    required?: boolean;
+    weight?: number;
+    comparator?: WorkerLabelComparator;
+};
 export type WorkflowRun<T = object> = {
     workflowName: string;
     input: T;
@@ -66,6 +72,7 @@ export declare class AdminClient {
         additionalMetadata?: Record<string, string> | undefined;
         desiredWorkerId?: string | undefined;
         priority?: Priority;
+        desiredWorkerLabels?: Record<string, DesiredWorkerLabelOpt>;
         _standaloneTaskName?: string | undefined;
     }): Promise<WorkflowRunRef<P>>;
     /**
@@ -95,8 +102,10 @@ export declare class AdminClient {
             additionalMetadata?: Record<string, string> | undefined;
             desiredWorkerId?: string | undefined;
             priority?: Priority;
+            desiredWorkerLabels?: Record<string, DesiredWorkerLabelOpt>;
             _standaloneTaskName?: string | undefined;
         };
     }>, batchSize?: number): Promise<WorkflowRunRef<P>[]>;
     putRateLimit(key: string, limit: number, duration?: RateLimitDuration): Promise<void>;
 }
+export {};

package/v1/client/admin.js

@@ -33,6 +33,18 @@ const workflows_2 = require("../../protoc/v1/workflows");
 const retrier_1 = require("../../util/retrier");
 const batch_1 = require("../../util/batch");
 const apply_namespace_1 = require("../../util/apply-namespace");
+function convertDesiredWorkerLabels(labels) {
+    return Object.fromEntries(Object.entries(labels).map(([key, label]) => [
+        key,
+        {
+            strValue: typeof label.value === 'string' ? label.value : undefined,
+            intValue: typeof label.value === 'number' ? label.value : undefined,
+            required: label.required,
+            weight: label.weight,
+            comparator: label.comparator,
+        },
+    ]));
+}
 class AdminClient {
     constructor(config, api, runs) {
         this.config = config;
@@ -71,10 +83,12 @@ class AdminClient {
                 const computedName = (0, apply_namespace_1.applyNamespace)(workflowName, this.config.namespace).toLowerCase();
                 const inputStr = JSON.stringify(input);
                 const opts = options !== null && options !== void 0 ? options : {};
-                const { additionalMetadata, parentStepRunId, parentTaskRunExternalId } = opts, rest = __rest(opts, ["additionalMetadata", "parentStepRunId", "parentTaskRunExternalId"]);
+                const { additionalMetadata, parentStepRunId, parentTaskRunExternalId, desiredWorkerLabels } = opts, rest = __rest(opts, ["additionalMetadata", "parentStepRunId", "parentTaskRunExternalId", "desiredWorkerLabels"]);
                 const request = Object.assign(Object.assign({ name: computedName, input: inputStr }, rest), { 
                     // API expects `parentTaskRunExternalId`; accept old names as aliases.
-                    parentTaskRunExternalId: parentTaskRunExternalId !== null && parentTaskRunExternalId !== void 0 ? parentTaskRunExternalId : parentStepRunId, additionalMetadata: additionalMetadata ? JSON.stringify(additionalMetadata) : undefined, priority: opts.priority });
+                    parentTaskRunExternalId: parentTaskRunExternalId !== null && parentTaskRunExternalId !== void 0 ? parentTaskRunExternalId : parentStepRunId, additionalMetadata: additionalMetadata ? JSON.stringify(additionalMetadata) : undefined, priority: opts.priority, desiredWorkerLabels: desiredWorkerLabels
+                        ? convertDesiredWorkerLabels(desiredWorkerLabels)
+                        : {} });
                 const resp = yield (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () { return this.workflowsGrpc.triggerWorkflow(request); }), this.logger);
                 const id = resp.workflowRunId;
                 const ref = new workflow_run_ref_1.default(id, this.listenerClient, this.runs, options === null || options === void 0 ? void 0 : options.parentId, 
@@ -101,10 +115,12 @@ class AdminClient {
                 const computedName = (0, apply_namespace_1.applyNamespace)(workflowName, this.config.namespace).toLowerCase();
                 const inputStr = JSON.stringify(input);
                 const opts = options !== null && options !== void 0 ? options : {};
-                const { additionalMetadata, parentStepRunId, parentTaskRunExternalId } = opts, rest = __rest(opts, ["additionalMetadata", "parentStepRunId", "parentTaskRunExternalId"]);
+                const { additionalMetadata, parentStepRunId, parentTaskRunExternalId, desiredWorkerLabels } = opts, rest = __rest(opts, ["additionalMetadata", "parentStepRunId", "parentTaskRunExternalId", "desiredWorkerLabels"]);
                 return Object.assign(Object.assign({ name: computedName, input: inputStr }, rest), { 
                     // API expects `parentTaskRunExternalId`; accept old names as aliases.
-                    parentTaskRunExternalId: parentTaskRunExternalId !== null && parentTaskRunExternalId !== void 0 ? parentTaskRunExternalId : parentStepRunId, additionalMetadata: additionalMetadata ? JSON.stringify(additionalMetadata) : undefined });
+                    parentTaskRunExternalId: parentTaskRunExternalId !== null && parentTaskRunExternalId !== void 0 ? parentTaskRunExternalId : parentStepRunId, additionalMetadata: additionalMetadata ? JSON.stringify(additionalMetadata) : undefined, desiredWorkerLabels: desiredWorkerLabels
+                        ? convertDesiredWorkerLabels(desiredWorkerLabels)
+                        : {} });
             });
             const limit = 4 * 1024 * 1024; // FIXME configurable GRPC limit
             const batches = (0, batch_1.batch)(workflowRequests, batchSize, limit);

package/v1/client/client.d.ts

@@ -1,3 +1,9 @@
+/**
+ * This is the TypeScript SDK reference, documenting methods available for interacting with Hatchet resources.
+ * Check out the [user guide](https://docs.hatchet.run/home/) for an introduction to getting your first tasks running.
+ *
+ * @module Hatchet TypeScript SDK Reference
+ */
 import { ClientConfig, HatchetClientOptions, LegacyHatchetClient, TaskMiddleware, InferMiddlewareBefore, InferMiddlewareAfter } from '../../clients/hatchet-client';
 import { AxiosRequestConfig } from 'axios';
 import WorkflowRunRef from '../../util/workflow-run-ref';
@@ -44,6 +50,7 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
     private _credentials;
     /**
      * @deprecated v0 client will be removed in a future release, please upgrade to v1
+     * @hidden
      */
     get v0(): LegacyHatchetClient;
     /** The tenant ID for the Hatchet client */
@@ -56,6 +63,7 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
      * @param config - Optional configuration for the client
      * @param options - Optional client options
      * @param axiosConfig - Optional Axios configuration for HTTP requests
+     * @internal
      */
     constructor(config?: Partial<ClientConfig>, options?: HatchetClientOptions, axiosConfig?: AxiosRequestConfig);
     /**
@@ -66,6 +74,7 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
      * @param options - Optional client options.
      * @param axiosConfig - Optional Axios configuration for HTTP requests.
      * @returns A new Hatchet client instance. Chain `.withMiddleware()` to attach typed middleware.
+     * @internal
      */
     static init<T extends Record<string, any> = {}, U extends Record<string, any> = {}>(config?: Omit<Partial<ClientConfig>, 'middleware'>, options?: HatchetClientOptions, axiosConfig?: AxiosRequestConfig): HatchetClient<T, U>;
     /**
@@ -74,6 +83,7 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
      *
      * Use this after `init<T, U>()` to get full middleware return-type inference
      * that TypeScript can't provide when global types are explicitly set on `init`.
+     * @internal
      */
     withMiddleware<const M extends TaskMiddleware<Resolved<GlobalInput, MiddlewareBefore>, Resolved<GlobalOutput, MiddlewareAfter>>>(middleware: M): HatchetClient<GlobalInput, GlobalOutput, MiddlewareBefore & InferMiddlewareBefore<M>, MiddlewareAfter & InferMiddlewareAfter<M>>;
     private _config;
@@ -134,12 +144,12 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
      */
     runNoWait<I extends InputType = UnknownInputType, O extends OutputType = void>(workflow: BaseWorkflowDeclaration<I, O> | LegacyWorkflow | string, input: I, options: RunOpts): Promise<WorkflowRunRef<O>>;
     /**
-     * @alias run
      * Triggers a workflow run and waits for the result.
      * @template I - The input type for the workflow
      * @template O - The return type of the workflow
      * @param workflow - The workflow to run, either as a Workflow instance or workflow name
      * @param input - The input data for the workflow
+     * @alias run
      * @param options - Configuration options for the workflow run
      * @returns A promise that resolves with the workflow result
      */
@@ -158,6 +168,7 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
     /**
      * Get the CEL client for debugging CEL expressions
      * @returns A CEL client instance
+     * @internal
      */
     get cel(): CELClient;
     private _crons;
@@ -170,6 +181,7 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
      * Get the cron client for creating and managing cron workflow runs
      * @returns A cron client instance
      * @deprecated use client.crons instead
+     * @hidden
      */
     get cron(): CronClient;
     private _scheduled;
@@ -182,6 +194,7 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
      * Get the schedule client for creating and managing scheduled workflow runs
      * @returns A schedule client instance
      * @deprecated use client.scheduled instead
+     * @hidden
      */
     get schedule(): ScheduleClient;
     /**
@@ -192,6 +205,7 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
     /**
      * Get the dispatcher client for sending action events and managing worker registration
      * @returns A dispatcher client instance
+     * @internal
      */
     get dispatcher(): DispatcherClient;
     private _event;
@@ -204,15 +218,18 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
     /**
      * Get the durable listener client for managing durable event subscriptions
      * @returns A durable listener client instance
+     * @internal
      */
     get durableListener(): DurableListenerClient;
     /**
      * Get the run listener client for streaming workflow run results
      * @returns A run listener client instance
+     * @internal
      */
     get listener(): RunListenerClient;
     /**
      * @deprecated use client.events instead
+     * @hidden
      */
     get event(): EventClient;
     private _metrics;
@@ -278,6 +295,7 @@ export declare class HatchetClient<GlobalInput extends Record<string, any> = {},
     /**
      * Get the admin client for creating and managing workflows
      * @returns A admin client instance
+     * @internal
      */
     get admin(): AdminClient;
     /**

package/v1/client/client.js

@@ -13,6 +13,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HatchetClient = void 0;
+/**
+ * This is the TypeScript SDK reference, documenting methods available for interacting with Hatchet resources.
+ * Check out the [user guide](https://docs.hatchet.run/home/) for an introduction to getting your first tasks running.
+ *
+ * @module Hatchet TypeScript SDK Reference
+ */
 /* eslint-disable no-dupe-class-members */
 /* eslint-disable no-underscore-dangle */
 const hatchet_client_1 = require("../../clients/hatchet-client");
@@ -52,6 +58,7 @@ const webhooks_1 = require("./features/webhooks");
 class HatchetClient {
     /**
      * @deprecated v0 client will be removed in a future release, please upgrade to v1
+     * @hidden
      */
     get v0() {
         if (!this._v0) {
@@ -67,6 +74,7 @@ class HatchetClient {
      * @param config - Optional configuration for the client
      * @param options - Optional client options
      * @param axiosConfig - Optional Axios configuration for HTTP requests
+     * @internal
      */
     constructor(config, options, axiosConfig) {
         var _a;
@@ -124,6 +132,7 @@ class HatchetClient {
      * @param options - Optional client options.
      * @param axiosConfig - Optional Axios configuration for HTTP requests.
      * @returns A new Hatchet client instance. Chain `.withMiddleware()` to attach typed middleware.
+     * @internal
      */
     static init(config, options, axiosConfig) {
         return new HatchetClient(config, options, axiosConfig);
@@ -134,6 +143,7 @@ class HatchetClient {
      *
      * Use this after `init<T, U>()` to get full middleware return-type inference
      * that TypeScript can't provide when global types are explicitly set on `init`.
+     * @internal
      */
     withMiddleware(middleware) {
         const existing = this._config.middleware || {};
@@ -192,12 +202,12 @@ class HatchetClient {
         });
     }
     /**
-     * @alias run
      * Triggers a workflow run and waits for the result.
      * @template I - The input type for the workflow
      * @template O - The return type of the workflow
      * @param workflow - The workflow to run, either as a Workflow instance or workflow name
      * @param input - The input data for the workflow
+     * @alias run
      * @param options - Configuration options for the workflow run
      * @returns A promise that resolves with the workflow result
      */
@@ -224,6 +234,7 @@ class HatchetClient {
     /**
      * Get the CEL client for debugging CEL expressions
      * @returns A CEL client instance
+     * @internal
      */
     get cel() {
         if (!this._cel) {
@@ -245,6 +256,7 @@ class HatchetClient {
      * Get the cron client for creating and managing cron workflow runs
      * @returns A cron client instance
      * @deprecated use client.crons instead
+     * @hidden
      */
     get cron() {
         return this.crons;
@@ -263,6 +275,7 @@ class HatchetClient {
      * Get the schedule client for creating and managing scheduled workflow runs
      * @returns A schedule client instance
      * @deprecated use client.scheduled instead
+     * @hidden
      */
     get schedule() {
         return this.scheduled;
@@ -276,6 +289,7 @@ class HatchetClient {
     /**
      * Get the dispatcher client for sending action events and managing worker registration
      * @returns A dispatcher client instance
+     * @internal
      */
     get dispatcher() {
         if (!this._dispatcher) {
@@ -296,6 +310,7 @@ class HatchetClient {
     /**
      * Get the durable listener client for managing durable event subscriptions
      * @returns A durable listener client instance
+     * @internal
      */
     get durableListener() {
         if (!this._durableListener) {
@@ -306,12 +321,14 @@ class HatchetClient {
     /**
      * Get the run listener client for streaming workflow run results
      * @returns A run listener client instance
+     * @internal
      */
     get listener() {
         return this._listener;
     }
     /**
      * @deprecated use client.events instead
+     * @hidden
      */
     get event() {
         return this.events;
@@ -414,6 +431,7 @@ class HatchetClient {
     /**
      * Get the admin client for creating and managing workflows
      * @returns A admin client instance
+     * @internal
      */
     get admin() {
         if (!this._admin) {