@hatchet-dev/typescript-sdk 1.14.0 → 1.15.0

package/{v1 → src/v1}/client/admin.d.ts

@@ -1,11 +1,17 @@
-import { ClientConfig } from '../../clients/hatchet-client/client-config';
-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 { AdminServiceClient, CreateWorkflowVersionRequest } from '../../protoc/v1/workflows';
-import { Logger } from '../../util/logger';
+import { ClientConfig } from '../../../clients/hatchet-client/client-config';
+import WorkflowRunRef from '../../../util/workflow-run-ref';
+import { Priority, RateLimitDuration, RunsClient } from '../../../v1';
+import { RunListenerClient } from '../../../clients/listeners/run-listener/child-listener-client';
+import { Api } from '../../../clients/rest/generated/Api';
+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;
@@ -39,7 +45,7 @@ export declare class AdminClient {
      * Creates a new workflow or updates an existing workflow via the v1 admin service.
      * @param workflow a workflow definition to create
      */
-    putWorkflow(workflow: CreateWorkflowVersionRequest): Promise<import("../../protoc/v1/workflows").CreateWorkflowVersionResponse>;
+    putWorkflow(workflow: CreateWorkflowVersionRequest): Promise<import("../../../protoc/v1/workflows").CreateWorkflowVersionResponse>;
     /**
      * Run a new instance of a workflow with the given input. This will create a new workflow run and return the ID of the
      * new run.
@@ -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 → src/v1}/client/admin.js

@@ -24,15 +24,27 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AdminClient = void 0;
-const hatchet_error_1 = __importDefault(require("../../util/errors/hatchet-error"));
-const workflow_run_ref_1 = __importDefault(require("../../util/workflow-run-ref"));
-const grpc_helpers_1 = require("../../util/grpc-helpers");
-const child_listener_client_1 = require("../../clients/listeners/run-listener/child-listener-client");
-const workflows_1 = require("../../protoc/workflows");
-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");
+const hatchet_error_1 = __importDefault(require("../../../util/errors/hatchet-error"));
+const workflow_run_ref_1 = __importDefault(require("../../../util/workflow-run-ref"));
+const grpc_helpers_1 = require("../../../util/grpc-helpers");
+const child_listener_client_1 = require("../../../clients/listeners/run-listener/child-listener-client");
+const workflows_1 = require("../../../protoc/workflows");
+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 → src/v1}/client/client.d.ts

@@ -1,12 +1,18 @@
-import { ClientConfig, HatchetClientOptions, LegacyHatchetClient, TaskMiddleware, InferMiddlewareBefore, InferMiddlewareAfter } from '../../clients/hatchet-client';
+/**
+ * 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';
-import { Api } from '../../clients/rest';
-import { EventClient } from '../../clients/event/event-client';
-import { DispatcherClient } from '../../clients/dispatcher/dispatcher-client';
-import { Logger } from '../../util/logger';
-import { RunListenerClient } from '../../clients/listeners/run-listener/child-listener-client';
-import { DurableListenerClient } from '../../clients/listeners/durable-listener/durable-listener-client';
+import WorkflowRunRef from '../../../util/workflow-run-ref';
+import { Api } from '../../../clients/rest';
+import { EventClient } from '../../../clients/event/event-client';
+import { DispatcherClient } from '../../../clients/dispatcher/dispatcher-client';
+import { Logger } from '../../../util/logger';
+import { RunListenerClient } from '../../../clients/listeners/run-listener/child-listener-client';
+import { DurableListenerClient } from '../../../clients/listeners/durable-listener/durable-listener-client';
 import { CreateTaskWorkflowOpts, CreateWorkflowOpts, RunOpts, BaseWorkflowDeclaration, WorkflowDeclaration, TaskWorkflowDeclaration, CreateDurableTaskWorkflowOpts } from '../declaration';
 import type { LegacyWorkflow } from '../../legacy/legacy-transformer';
 import { IHatchetClient } from './client.interface';
@@ -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 → src/v1}/client/client.interface.d.ts

@@ -1,6 +1,6 @@
-import { EventClient } from '../../clients/event/event-client';
-import { DispatcherClient } from '../../clients/dispatcher/dispatcher-client';
-import { Logger } from '../../util/logger';
+import { EventClient } from '../../../clients/event/event-client';
+import { DispatcherClient } from '../../../clients/dispatcher/dispatcher-client';
+import { Logger } from '../../../util/logger';
 import { LegacyHatchetClient } from '../../legacy/legacy-client';
 import { MetricsClient } from './features/metrics';
 import { RunsClient } from './features/runs';

package/{v1 → src/v1}/client/client.js

@@ -13,18 +13,24 @@ 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");
-const rest_1 = __importDefault(require("../../clients/rest"));
-const config_loader_1 = require("../../util/config-loader");
-const hatchet_logger_1 = require("../../clients/hatchet-client/hatchet-logger");
+const hatchet_client_1 = require("../../../clients/hatchet-client");
+const rest_1 = __importDefault(require("../../../clients/rest"));
+const config_loader_1 = require("../../../util/config-loader");
+const hatchet_logger_1 = require("../../../clients/hatchet-client/hatchet-logger");
 const zod_1 = require("zod");
-const event_client_1 = require("../../clients/event/event-client");
-const dispatcher_client_1 = require("../../clients/dispatcher/dispatcher-client");
-const child_listener_client_1 = require("../../clients/listeners/run-listener/child-listener-client");
-const durable_listener_client_1 = require("../../clients/listeners/durable-listener/durable-listener-client");
-const grpc_helpers_1 = require("../../util/grpc-helpers");
+const event_client_1 = require("../../../clients/event/event-client");
+const dispatcher_client_1 = require("../../../clients/dispatcher/dispatcher-client");
+const child_listener_client_1 = require("../../../clients/listeners/run-listener/child-listener-client");
+const durable_listener_client_1 = require("../../../clients/listeners/durable-listener/durable-listener-client");
+const grpc_helpers_1 = require("../../../util/grpc-helpers");
 const nice_grpc_1 = require("nice-grpc");
 const declaration_1 = require("../declaration");
 const legacy_transformer_1 = require("../../legacy/legacy-transformer");
@@ -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) {

package/{v1 → src/v1}/client/features/cel.d.ts

@@ -1,4 +1,4 @@
-import { V1CELDebugResponseStatus } from '../../../clients/rest/generated/data-contracts';
+import { V1CELDebugResponseStatus } from '../../../../clients/rest/generated/data-contracts';
 import { HatchetClient } from '../client';
 export type DebugCELInput = {
     expression: string;

package/{v1 → src/v1}/client/features/cel.js

@@ -11,7 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CELClient = void 0;
 const axios_1 = require("axios");
-const data_contracts_1 = require("../../../clients/rest/generated/data-contracts");
+const data_contracts_1 = require("../../../../clients/rest/generated/data-contracts");
 /**
  * Client for debugging CEL expressions.
  */

package/{v1 → src/v1}/client/features/crons.d.ts

@@ -1,11 +1,12 @@
-import { CronWorkflows, CronWorkflowsList } from '../../../clients/rest/generated/data-contracts';
+import { CronWorkflows, CronWorkflowsList } from '../../../../clients/rest/generated/data-contracts';
 import { z } from 'zod';
-import { BaseWorkflowDeclaration } from '../..';
-import type { LegacyWorkflow } from '../../../legacy/legacy-transformer';
+import { BaseWorkflowDeclaration } from '../../../../v1';
+import type { LegacyWorkflow } from '../../../../legacy/legacy-transformer';
 import { HatchetClient } from '../client';
 import { WorkflowsClient } from './workflows';
 /**
  * Schema for creating a Cron Trigger.
+ * @internal
  */
 export declare const CreateCronTriggerSchema: z.ZodObject<{
     name: z.ZodString;
@@ -28,10 +29,11 @@ export declare const CreateCronTriggerSchema: z.ZodObject<{
 }>;
 /**
  * Type representing the input for creating a Cron.
+ * @internal
  */
 export type CreateCronInput = z.infer<typeof CreateCronTriggerSchema>;
 /**
- * Client for managing Cron Triggers.
+ * The cron client is a client for managing cron workflows within Hatchet.
  */
 export declare class CronClient {
     api: HatchetClient['api'];

package/{v1 → src/v1}/client/features/crons.js

@@ -23,11 +23,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CronClient = exports.CreateCronTriggerSchema = void 0;
 const zod_1 = require("zod");
 const axios_1 = require("axios");
-const uuid_1 = require("../../../util/uuid");
-const apply_namespace_1 = require("../../../util/apply-namespace");
+const uuid_1 = require("../../../../util/uuid");
+const apply_namespace_1 = require("../../../../util/apply-namespace");
 const workflows_1 = require("./workflows");
 /**
  * Schema for creating a Cron Trigger.
+ * @internal
  */
 exports.CreateCronTriggerSchema = zod_1.z.object({
     name: zod_1.z.string(),
@@ -37,7 +38,7 @@ exports.CreateCronTriggerSchema = zod_1.z.object({
     priority: zod_1.z.number().optional(),
 });
 /**
- * Client for managing Cron Triggers.
+ * The cron client is a client for managing cron workflows within Hatchet.
  */
 class CronClient {
     constructor(client) {

package/{v1 → src/v1}/client/features/filters.d.ts

@@ -10,14 +10,44 @@ export declare class FiltersClient {
     tenantId: string;
     api: HatchetClient['api'];
     constructor(client: HatchetClient);
+    /**
+     * Lists all filters.
+     * @param opts - The options for the list operation.
+     * @param opts.limit - The number of filters to return.
+     * @param opts.offset - The number of filters to skip before returning the result set.
+     * @param opts.workflowIds - A list of workflow IDs to filter by.
+     * @param opts.scopes - A list of scopes to filter by.
+     * @returns A promise that resolves to the list of filters.
+     */
     list(opts?: {
         limit?: number;
         offset?: number;
         workflowIds?: string[];
         scopes?: string[];
     }): Promise<import("../../../clients/rest/generated/data-contracts").V1FilterList>;
+    /**
+     * Gets a filter by its ID.
+     * @param filterId - The ID of the filter to get.
+     * @returns A promise that resolves to the filter.
+     */
     get(filterId: Parameters<typeof this.api.v1FilterGet>[1]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
+    /**
+     * Creates a new filter.
+     * @param opts - The options for the create operation.
+     * @returns A promise that resolves to the created filter.
+     */
     create(opts: Parameters<typeof this.api.v1FilterCreate>[1]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
+    /**
+     * Deletes a filter by its ID.
+     * @param filterId - The ID of the filter to delete.
+     * @returns A promise that resolves to the deleted filter.
+     */
     delete(filterId: Parameters<typeof this.api.v1FilterDelete>[1]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
+    /**
+     * Updates a filter by its ID.
+     * @param filterId - The ID of the filter to update.
+     * @param updates - The updates to apply to the filter.
+     * @returns A promise that resolves to the updated filter.
+     */
     update(filterId: Parameters<typeof this.api.v1FilterDelete>[1], updates: Parameters<typeof this.api.v1FilterUpdate>[2]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
 }

package/{v1 → src/v1}/client/features/filters.js

@@ -18,6 +18,15 @@ class FiltersClient {
         this.tenantId = client.tenantId;
         this.api = client.api;
     }
+    /**
+     * Lists all filters.
+     * @param opts - The options for the list operation.
+     * @param opts.limit - The number of filters to return.
+     * @param opts.offset - The number of filters to skip before returning the result set.
+     * @param opts.workflowIds - A list of workflow IDs to filter by.
+     * @param opts.scopes - A list of scopes to filter by.
+     * @returns A promise that resolves to the list of filters.
+     */
     list(opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.v1FilterList(this.tenantId, {
@@ -29,24 +38,45 @@ class FiltersClient {
             return data;
         });
     }
+    /**
+     * Gets a filter by its ID.
+     * @param filterId - The ID of the filter to get.
+     * @returns A promise that resolves to the filter.
+     */
     get(filterId) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.v1FilterGet(this.tenantId, filterId);
             return data;
         });
     }
+    /**
+     * Creates a new filter.
+     * @param opts - The options for the create operation.
+     * @returns A promise that resolves to the created filter.
+     */
     create(opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.v1FilterCreate(this.tenantId, opts);
             return data;
         });
     }
+    /**
+     * Deletes a filter by its ID.
+     * @param filterId - The ID of the filter to delete.
+     * @returns A promise that resolves to the deleted filter.
+     */
     delete(filterId) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.v1FilterDelete(this.tenantId, filterId);
             return data;
         });
     }
+    /**
+     * Updates a filter by its ID.
+     * @param filterId - The ID of the filter to update.
+     * @param updates - The updates to apply to the filter.
+     * @returns A promise that resolves to the updated filter.
+     */
     update(filterId, updates) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.v1FilterUpdate(this.tenantId, filterId, updates);

package/{v1 → src/v1}/client/features/metrics.d.ts

@@ -7,19 +7,23 @@ export type TaskStatusMetrics = {
     running: number;
 };
 /**
- * MetricsClient is used to get metrics for workflows
+ * The metrics client is a client for reading metrics out of Hatchet’s metrics API.
  */
 export declare class MetricsClient {
     tenantId: string;
     api: HatchetClient['api'];
     constructor(client: HatchetClient);
     /**
-     * Get task/run status metrics for a tenant.
-     *
-     * This backs the dashboard "runs list" status count badges.
-     *
-     * Endpoint: GET /api/v1/stable/tenants/{tenant}/task-metrics
+     * Returns aggregate task run counts grouped by status (queued, running, completed, failed, cancelled)
+     * @param query - Filters for the metrics query (e.g. `since`, `until`, `workflow_ids`).
+     * @param requestParams - Optional request-level overrides (headers, signal, etc.).
+     * @returns Counts per status for the matched task runs.
      */
     getTaskStatusMetrics(query: Parameters<typeof this.api.v1TaskListStatusMetrics>[1], requestParams?: Parameters<typeof this.api.v1TaskListStatusMetrics>[2]): Promise<TaskStatusMetrics>;
+    /**
+     * Returns the queue metrics for the current tenant.
+     * @param opts - The options for the request.
+     * @returns The queue metrics for the current tenant.
+     */
     getQueueMetrics(opts?: Parameters<typeof this.api.tenantGetStepRunQueueMetrics>[1]): Promise<import("../../../clients/rest/generated/data-contracts").TenantStepRunQueueMetrics>;
 }

package/{v1 → src/v1}/client/features/metrics.js

@@ -11,7 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MetricsClient = void 0;
 /**
- * MetricsClient is used to get metrics for workflows
+ * The metrics client is a client for reading metrics out of Hatchet’s metrics API.
  */
 class MetricsClient {
     constructor(client) {
@@ -19,11 +19,10 @@ class MetricsClient {
         this.api = client.api;
     }
     /**
-     * Get task/run status metrics for a tenant.
-     *
-     * This backs the dashboard "runs list" status count badges.
-     *
-     * Endpoint: GET /api/v1/stable/tenants/{tenant}/task-metrics
+     * Returns aggregate task run counts grouped by status (queued, running, completed, failed, cancelled)
+     * @param query - Filters for the metrics query (e.g. `since`, `until`, `workflow_ids`).
+     * @param requestParams - Optional request-level overrides (headers, signal, etc.).
+     * @returns Counts per status for the matched task runs.
      */
     getTaskStatusMetrics(query, requestParams) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -34,6 +33,11 @@ class MetricsClient {
             }, {});
         });
     }
+    /**
+     * Returns the queue metrics for the current tenant.
+     * @param opts - The options for the request.
+     * @returns The queue metrics for the current tenant.
+     */
     getQueueMetrics(opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.tenantGetStepRunQueueMetrics(this.tenantId, opts);