@hatchet-dev/typescript-sdk 1.14.0 → 1.15.0

package/src/v1/client/features/ratelimits.d.ts

@@ -0,0 +1,30 @@
+import { RateLimitDuration } from '../../../../protoc/workflows';
+import { RateLimitOrderByField, RateLimitOrderByDirection } from '../../../../clients/rest/generated/data-contracts';
+import { HatchetClient } from '../client';
+export { RateLimitDuration, RateLimitOrderByField, RateLimitOrderByDirection };
+export type CreateRateLimitOpts = {
+    key: string;
+    limit: number;
+    duration?: RateLimitDuration;
+};
+/**
+ * The rate limits client is a wrapper for Hatchet’s gRPC API that makes it easier to work with rate limits in Hatchet.
+ */
+export declare class RatelimitsClient {
+    api: HatchetClient['api'];
+    admin: HatchetClient['admin'];
+    tenantId: string;
+    constructor(client: HatchetClient);
+    /**
+     * Upserts a rate limit for the current tenant.
+     * @param opts - The options for the upsert operation.
+     * @returns A promise that resolves to the key of the upserted rate limit.
+     */
+    upsert(opts: CreateRateLimitOpts): Promise<string>;
+    /**
+     * Lists all rate limits for the current tenant.
+     * @param opts - The options for the list operation.
+     * @returns A promise that resolves to the list of rate limits.
+     */
+    list(opts: Parameters<typeof this.api.rateLimitList>[1]): Promise<import("../../../../clients/rest/generated/data-contracts").RateLimitList>;
+}

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

@@ -10,13 +10,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RatelimitsClient = exports.RateLimitOrderByDirection = exports.RateLimitOrderByField = exports.RateLimitDuration = void 0;
-const workflows_1 = require("../../../protoc/workflows");
+const workflows_1 = require("../../../../protoc/workflows");
 Object.defineProperty(exports, "RateLimitDuration", { enumerable: true, get: function () { return workflows_1.RateLimitDuration; } });
-const data_contracts_1 = require("../../../clients/rest/generated/data-contracts");
+const data_contracts_1 = require("../../../../clients/rest/generated/data-contracts");
 Object.defineProperty(exports, "RateLimitOrderByField", { enumerable: true, get: function () { return data_contracts_1.RateLimitOrderByField; } });
 Object.defineProperty(exports, "RateLimitOrderByDirection", { enumerable: true, get: function () { return data_contracts_1.RateLimitOrderByDirection; } });
 /**
- * RatelimitsClient is used to manage rate limits for the Hatchet
+ * The rate limits client is a wrapper for Hatchet’s gRPC API that makes it easier to work with rate limits in Hatchet.
  */
 class RatelimitsClient {
     constructor(client) {
@@ -24,12 +24,22 @@ class RatelimitsClient {
         this.admin = client.admin;
         this.tenantId = client.tenantId;
     }
+    /**
+     * Upserts a rate limit for the current tenant.
+     * @param opts - The options for the upsert operation.
+     * @returns A promise that resolves to the key of the upserted rate limit.
+     */
     upsert(opts) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.admin.putRateLimit(opts.key, opts.limit, opts.duration);
             return opts.key;
         });
     }
+    /**
+     * Lists all rate limits for the current tenant.
+     * @param opts - The options for the list operation.
+     * @returns A promise that resolves to the list of rate limits.
+     */
     list(opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.rateLimitList(this.tenantId, opts);

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

@@ -1,6 +1,6 @@
-import WorkflowRunRef from '../../../util/workflow-run-ref';
-import { V1TaskStatus } from '../../../clients/rest/generated/data-contracts';
-import { RunListenerClient } from '../../../clients/listeners/run-listener/child-listener-client';
+import WorkflowRunRef from '../../../../util/workflow-run-ref';
+import { V1TaskStatus } from '../../../../clients/rest/generated/data-contracts';
+import { RunListenerClient } from '../../../../clients/listeners/run-listener/child-listener-client';
 import { WorkflowsClient } from './workflows';
 import { HatchetClient } from '../client';
 export type RunFilter = {
@@ -65,7 +65,7 @@ export interface ListRunsOpts extends RunFilter {
     includePayloads?: boolean;
 }
 /**
- * RunsClient is used to list and manage runs
+ * The runs client is a client for interacting with task and workflow runs within Hatchet.
  */
 export declare class RunsClient {
     api: HatchetClient['api'];
@@ -73,13 +73,48 @@ export declare class RunsClient {
     workflows: WorkflowsClient;
     listener: RunListenerClient;
     constructor(client: HatchetClient);
-    get<T = any>(run: string | WorkflowRunRef<T>): Promise<import("../../../clients/rest/generated/data-contracts").V1WorkflowRunDetails>;
+    /**
+     * Gets a task or workflow run by its ID.
+     * @param run - The ID of the run to get.
+     * @returns A promise that resolves to the run.
+     */
+    get<T = any>(run: string | WorkflowRunRef<T>): Promise<import("../../../../clients/rest/generated/data-contracts").V1WorkflowRunDetails>;
+    /**
+     * Gets the status of a task or workflow run by its ID.
+     * @param run - The ID of the run to get the status of.
+     * @returns A promise that resolves to the status of the run.
+     */
     get_status<T = any>(run: string | WorkflowRunRef<T>): Promise<V1TaskStatus>;
-    list(opts?: Partial<ListRunsOpts>): Promise<import("../../../clients/rest/generated/data-contracts").V1TaskSummaryList>;
-    cancel(opts: CancelRunOpts): Promise<import("axios").AxiosResponse<import("../../../clients/rest/generated/data-contracts").V1CancelledTasks, any, {}>>;
-    replay(opts: ReplayRunOpts): Promise<import("axios").AxiosResponse<import("../../../clients/rest/generated/data-contracts").V1ReplayedTasks, any, {}>>;
+    /**
+     * Lists all task and workflow runs for the current tenant.
+     * @param opts - The options for the list operation.
+     * @returns A promise that resolves to the list of runs.
+     */
+    list(opts?: Partial<ListRunsOpts>): Promise<import("../../../../clients/rest/generated/data-contracts").V1TaskSummaryList>;
+    /**
+     * Cancels a task or workflow run by its ID.
+     * @param opts - The options for the cancel operation.
+     * @returns A promise that resolves to the cancelled run.
+     */
+    cancel(opts: CancelRunOpts): Promise<import("axios").AxiosResponse<import("../../../../clients/rest/generated/data-contracts").V1CancelledTasks, any, {}>>;
+    /**
+     * Replays a task or workflow run by its ID.
+     * @param opts - The options for the replay operation.
+     * @returns A promise that resolves to the replayed run.
+     */
+    replay(opts: ReplayRunOpts): Promise<import("axios").AxiosResponse<import("../../../../clients/rest/generated/data-contracts").V1ReplayedTasks, any, {}>>;
     private prepareFilter;
     private prepareListFilter;
+    /**
+     * Creates a run reference for a task or workflow run by its ID.
+     * @param id - The ID of the run to create a reference for.
+     * @returns A promise that resolves to the run reference.
+     */
     runRef<T extends Record<string, any> = any>(id: string): WorkflowRunRef<T>;
+    /**
+     * Subscribes to a stream of events for a task or workflow run by its ID.
+     * @param workflowRunId - The ID of the run to subscribe to.
+     * @returns A promise that resolves to the stream of events.
+     */
     subscribeToStream(workflowRunId: string): AsyncIterableIterator<string>;
 }

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

@@ -33,10 +33,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RunsClient = void 0;
-const workflow_run_ref_1 = __importDefault(require("../../../util/workflow-run-ref"));
-const child_listener_client_1 = require("../../../clients/listeners/run-listener/child-listener-client");
+const workflow_run_ref_1 = __importDefault(require("../../../../util/workflow-run-ref"));
+const child_listener_client_1 = require("../../../../clients/listeners/run-listener/child-listener-client");
 /**
- * RunsClient is used to list and manage runs
+ * The runs client is a client for interacting with task and workflow runs within Hatchet.
  */
 class RunsClient {
     constructor(client) {
@@ -46,6 +46,11 @@ class RunsClient {
         // eslint-disable-next-line no-underscore-dangle
         this.listener = client._listener;
     }
+    /**
+     * Gets a task or workflow run by its ID.
+     * @param run - The ID of the run to get.
+     * @returns A promise that resolves to the run.
+     */
     get(run) {
         return __awaiter(this, void 0, void 0, function* () {
             const runId = typeof run === 'string' ? run : yield run.getWorkflowRunId();
@@ -53,6 +58,11 @@ class RunsClient {
             return data;
         });
     }
+    /**
+     * Gets the status of a task or workflow run by its ID.
+     * @param run - The ID of the run to get the status of.
+     * @returns A promise that resolves to the status of the run.
+     */
     get_status(run) {
         return __awaiter(this, void 0, void 0, function* () {
             const runId = typeof run === 'string' ? run : yield run.getWorkflowRunId();
@@ -60,6 +70,11 @@ class RunsClient {
             return data;
         });
     }
+    /**
+     * Lists all task and workflow runs for the current tenant.
+     * @param opts - The options for the list operation.
+     * @returns A promise that resolves to the list of runs.
+     */
     list(opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const normalizedOpts = (opts === null || opts === void 0 ? void 0 : opts.parentTaskExternalId) && !(opts === null || opts === void 0 ? void 0 : opts.parentTaskRunExternalId)
@@ -68,6 +83,11 @@ class RunsClient {
             return data;
         });
     }
+    /**
+     * Cancels a task or workflow run by its ID.
+     * @param opts - The options for the cancel operation.
+     * @returns A promise that resolves to the cancelled run.
+     */
     cancel(opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const filter = yield this.prepareFilter(opts.filters || {});
@@ -77,6 +97,11 @@ class RunsClient {
             });
         });
     }
+    /**
+     * Replays a task or workflow run by its ID.
+     * @param opts - The options for the replay operation.
+     * @returns A promise that resolves to the replayed run.
+     */
     replay(opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const filter = yield this.prepareFilter(opts.filters || {});
@@ -122,9 +147,19 @@ class RunsClient {
             };
         });
     }
+    /**
+     * Creates a run reference for a task or workflow run by its ID.
+     * @param id - The ID of the run to create a reference for.
+     * @returns A promise that resolves to the run reference.
+     */
     runRef(id) {
         return new workflow_run_ref_1.default(id, this.listener, this);
     }
+    /**
+     * Subscribes to a stream of events for a task or workflow run by its ID.
+     * @param workflowRunId - The ID of the run to subscribe to.
+     * @returns A promise that resolves to the stream of events.
+     */
     subscribeToStream(workflowRunId) {
         return __asyncGenerator(this, arguments, function* subscribeToStream_1() {
             var _a, e_1, _b, _c;

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

@@ -1,11 +1,12 @@
-import { ScheduledWorkflows, ScheduledWorkflowsBulkDeleteFilter, ScheduledWorkflowsBulkDeleteResponse, ScheduledWorkflowsBulkUpdateResponse, ScheduledWorkflowsList } from '../../../clients/rest/generated/data-contracts';
+import { ScheduledWorkflows, ScheduledWorkflowsBulkDeleteFilter, ScheduledWorkflowsBulkDeleteResponse, ScheduledWorkflowsBulkUpdateResponse, ScheduledWorkflowsList } from '../../../../clients/rest/generated/data-contracts';
 import { z } from 'zod';
-import { Workflow } from '../../../workflow';
-import { BaseWorkflowDeclaration, WorkflowDefinition } from '../..';
+import { Workflow } from '../../../../workflow';
+import { BaseWorkflowDeclaration, WorkflowDefinition } from '../../../../v1';
 import { HatchetClient } from '../client';
 import { WorkflowsClient } from './workflows';
 /**
  * Schema for creating a Scheduled Run Trigger.
+ * @internal
  */
 export declare const CreateScheduledRunTriggerSchema: z.ZodObject<{
     triggerAt: z.ZodDate;
@@ -25,10 +26,12 @@ export declare const CreateScheduledRunTriggerSchema: z.ZodObject<{
 }>;
 /**
  * Type representing the input for creating a Cron.
+ * @internal
  */
 export type CreateScheduledRunInput = z.infer<typeof CreateScheduledRunTriggerSchema>;
 /**
  * Schema for updating (rescheduling) a Scheduled Run Trigger.
+ * @internal
  */
 export declare const UpdateScheduledRunTriggerSchema: z.ZodObject<{
     triggerAt: z.ZodDate;
@@ -39,7 +42,7 @@ export declare const UpdateScheduledRunTriggerSchema: z.ZodObject<{
 }>;
 export type UpdateScheduledRunInput = z.infer<typeof UpdateScheduledRunTriggerSchema>;
 /**
- * Client for managing Scheduled Runs.
+ * The scheduled client is a client for managing scheduled workflows within Hatchet
  */
 export declare class ScheduleClient {
     api: HatchetClient['api'];

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

@@ -23,11 +23,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ScheduleClient = exports.UpdateScheduledRunTriggerSchema = exports.CreateScheduledRunTriggerSchema = 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 Scheduled Run Trigger.
+ * @internal
  */
 exports.CreateScheduledRunTriggerSchema = zod_1.z.object({
     triggerAt: zod_1.z.coerce.date(),
@@ -37,12 +38,13 @@ exports.CreateScheduledRunTriggerSchema = zod_1.z.object({
 });
 /**
  * Schema for updating (rescheduling) a Scheduled Run Trigger.
+ * @internal
  */
 exports.UpdateScheduledRunTriggerSchema = zod_1.z.object({
     triggerAt: zod_1.z.coerce.date(),
 });
 /**
- * Client for managing Scheduled Runs.
+ * The scheduled client is a client for managing scheduled workflows within Hatchet
  */
 class ScheduleClient {
     constructor(client) {

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

@@ -1,4 +1,7 @@
-import { Tenant } from '../../../clients/rest/generated/data-contracts';
+/**
+ * @module Tenant Client
+ */
+import { Tenant } from '../../../../clients/rest/generated/data-contracts';
 import { HatchetClient } from '../client';
 /**
  * Client for managing Tenants

package/src/v1/client/features/webhooks.d.ts

@@ -0,0 +1,54 @@
+import { V1CreateWebhookRequestBase, V1UpdateWebhookRequest, V1Webhook, V1WebhookList, V1WebhookSourceName, V1WebhookAPIKeyAuth, V1WebhookBasicAuth, V1WebhookHMACAuth } from '../../../../clients/rest/generated/data-contracts';
+import { HatchetClient } from '../client';
+export type CreateWebhookOptions = V1CreateWebhookRequestBase & {
+    auth: V1WebhookBasicAuth | V1WebhookAPIKeyAuth | V1WebhookHMACAuth;
+};
+/**
+ * Client for managing incoming webhooks in Hatchet.
+ *
+ * Webhooks allow external systems to trigger Hatchet workflows by sending
+ * HTTP requests to dedicated endpoints. This enables real-time integration
+ * with third-party services like GitHub, Stripe, Slack, or any system that
+ * can send webhook events.
+ */
+export declare class WebhooksClient {
+    api: HatchetClient['api'];
+    tenantId: string;
+    constructor(client: HatchetClient);
+    /**
+     * Lists all webhooks for the current tenant.
+     * @param options - The options for the list operation.
+     * @returns A promise that resolves to the list of webhooks.
+     */
+    list(options?: {
+        limit?: number;
+        offset?: number;
+        webhookNames?: string[];
+        sourceNames?: V1WebhookSourceName[];
+    }): Promise<V1WebhookList>;
+    /**
+     * Gets a webhook by its name.
+     * @param webhookName - The name of the webhook to get.
+     * @returns A promise that resolves to the webhook.
+     */
+    get(webhookName: string): Promise<V1Webhook>;
+    /**
+     * Creates a new webhook.
+     * @param request - The request options for the create operation.
+     * @returns A promise that resolves to the created webhook.
+     */
+    create(request: CreateWebhookOptions): Promise<V1Webhook>;
+    /**
+     * Updates a webhook by its name.
+     * @param webhookName - The name of the webhook to update.
+     * @param options - The options for the update operation.
+     * @returns A promise that resolves to the updated webhook.
+     */
+    update(webhookName: string, options?: Partial<V1UpdateWebhookRequest>): Promise<V1Webhook>;
+    /**
+     * Deletes a webhook by its name.
+     * @param webhookName - The name of the webhook to delete.
+     * @returns A promise that resolves to the deleted webhook.
+     */
+    delete(webhookName: string): Promise<V1Webhook>;
+}

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

@@ -21,7 +21,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhooksClient = void 0;
-const data_contracts_1 = require("../../../clients/rest/generated/data-contracts");
+const data_contracts_1 = require("../../../../clients/rest/generated/data-contracts");
 function getAuthType(auth) {
     if ('username' in auth && 'password' in auth)
         return data_contracts_1.V1WebhookAuthType.BASIC;
@@ -43,16 +43,21 @@ function toCreateWebhookRequest(options) {
 /**
  * Client for managing incoming webhooks in Hatchet.
  *
- * Webhooks allow external systems to trigger Hatchet workflows by sending HTTP
- * requests to dedicated endpoints. This enables real-time integration with
- * third-party services like GitHub, Stripe, Slack, or any system that can send
- * webhook events.
+ * Webhooks allow external systems to trigger Hatchet workflows by sending
+ * HTTP requests to dedicated endpoints. This enables real-time integration
+ * with third-party services like GitHub, Stripe, Slack, or any system that
+ * can send webhook events.
  */
 class WebhooksClient {
     constructor(client) {
         this.api = client.api;
         this.tenantId = client.tenantId;
     }
+    /**
+     * Lists all webhooks for the current tenant.
+     * @param options - The options for the list operation.
+     * @returns A promise that resolves to the list of webhooks.
+     */
     list(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.api.v1WebhookList(this.tenantId, {
@@ -64,12 +69,22 @@ class WebhooksClient {
             return response.data;
         });
     }
+    /**
+     * Gets a webhook by its name.
+     * @param webhookName - The name of the webhook to get.
+     * @returns A promise that resolves to the webhook.
+     */
     get(webhookName) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.api.v1WebhookGet(this.tenantId, webhookName);
             return response.data;
         });
     }
+    /**
+     * Creates a new webhook.
+     * @param request - The request options for the create operation.
+     * @returns A promise that resolves to the created webhook.
+     */
     create(request) {
         return __awaiter(this, void 0, void 0, function* () {
             const payload = toCreateWebhookRequest(request);
@@ -77,6 +92,12 @@ class WebhooksClient {
             return response.data;
         });
     }
+    /**
+     * Updates a webhook by its name.
+     * @param webhookName - The name of the webhook to update.
+     * @param options - The options for the update operation.
+     * @returns A promise that resolves to the updated webhook.
+     */
     update(webhookName_1) {
         return __awaiter(this, arguments, void 0, function* (webhookName, options = {}) {
             const response = yield this.api.v1WebhookUpdate(this.tenantId, webhookName, {
@@ -87,6 +108,11 @@ class WebhooksClient {
             return response.data;
         });
     }
+    /**
+     * Deletes a webhook by its name.
+     * @param webhookName - The name of the webhook to delete.
+     * @returns A promise that resolves to the deleted webhook.
+     */
     delete(webhookName) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.api.v1WebhookDelete(this.tenantId, webhookName);

package/src/v1/client/features/workers.d.ts

@@ -0,0 +1,38 @@
+import { HatchetClient } from '../client';
+/**
+ * The workers client is a client for managing workers programmatically within Hatchet.
+ */
+export declare class WorkersClient {
+    api: HatchetClient['api'];
+    tenantId: string;
+    constructor(client: HatchetClient);
+    /**
+     * Get a worker by its ID.
+     * @param workerId - The ID of the worker to get.
+     * @returns A promise that resolves to the worker.
+     */
+    get(workerId: string): Promise<import("../../../clients/rest/generated/data-contracts").Worker>;
+    /**
+     * List all workers in the tenant.
+     * @returns A promise that resolves to the list of workers.
+     */
+    list(): Promise<import("../../../clients/rest/generated/data-contracts").WorkerList>;
+    /**
+     * Check if a worker is paused.
+     * @param workerId - The ID of the worker to check.
+     * @returns A promise that resolves to true if the worker is paused, false otherwise.
+     */
+    isPaused(workerId: string): Promise<boolean>;
+    /**
+     * Pause a worker.
+     * @param workerId - The ID of the worker to pause.
+     * @returns A promise that resolves to the paused worker.
+     */
+    pause(workerId: string): Promise<import("../../../clients/rest/generated/data-contracts").Worker>;
+    /**
+     * Unpause a worker.
+     * @param workerId - The ID of the worker to unpause.
+     * @returns A promise that resolves to the unpaused worker.
+     */
+    unpause(workerId: string): Promise<import("../../../clients/rest/generated/data-contracts").Worker>;
+}

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

@@ -11,31 +11,50 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkersClient = void 0;
 /**
- * WorkersClient is used to list and manage workers
+ * The workers client is a client for managing workers programmatically within Hatchet.
  */
 class WorkersClient {
     constructor(client) {
         this.api = client.api;
         this.tenantId = client.tenantId;
     }
+    /**
+     * Get a worker by its ID.
+     * @param workerId - The ID of the worker to get.
+     * @returns A promise that resolves to the worker.
+     */
     get(workerId) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.workerGet(workerId);
             return data;
         });
     }
+    /**
+     * List all workers in the tenant.
+     * @returns A promise that resolves to the list of workers.
+     */
     list() {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.workerList(this.tenantId);
             return data;
         });
     }
+    /**
+     * Check if a worker is paused.
+     * @param workerId - The ID of the worker to check.
+     * @returns A promise that resolves to true if the worker is paused, false otherwise.
+     */
     isPaused(workerId) {
         return __awaiter(this, void 0, void 0, function* () {
             const wf = yield this.get(workerId);
             return wf.status === 'PAUSED';
         });
     }
+    /**
+     * Pause a worker.
+     * @param workerId - The ID of the worker to pause.
+     * @returns A promise that resolves to the paused worker.
+     */
     pause(workerId) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.workerUpdate(workerId, {
@@ -44,6 +63,11 @@ class WorkersClient {
             return data;
         });
     }
+    /**
+     * Unpause a worker.
+     * @param workerId - The ID of the worker to unpause.
+     * @returns A promise that resolves to the unpaused worker.
+     */
     unpause(workerId) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.workerUpdate(workerId, {

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

@@ -1,9 +1,12 @@
-import { BaseWorkflowDeclaration, WorkflowDefinition } from '../..';
-import type { LegacyWorkflow } from '../../../legacy/legacy-transformer';
+import { BaseWorkflowDeclaration, WorkflowDefinition } from '../../../../v1';
+import type { LegacyWorkflow } from '../../../../legacy/legacy-transformer';
 import { HatchetClient } from '../client';
 export declare const workflowNameString: (workflow: string | WorkflowDefinition | BaseWorkflowDeclaration<any, any> | LegacyWorkflow) => string;
 /**
- * WorkflowsClient is used to list and manage workflows
+ * The workflows client is a client for managing workflows programmatically within Hatchet.
+ *
+ * NOTE: that workflows are the declaration, not the individual runs. If you're looking for runs, use the RunsClient instead.
+ *
  */
 export declare class WorkflowsClient {
     api: HatchetClient['api'];
@@ -18,7 +21,22 @@ export declare class WorkflowsClient {
      * @returns The workflow ID as a string.
      */
     getWorkflowIdFromName(workflow: string | WorkflowDefinition | BaseWorkflowDeclaration<any, any> | LegacyWorkflow): Promise<string>;
+    /**
+     * Get a workflow by its name, ID, or object.
+     * @param workflow - The workflow name, ID, or object.
+     * @returns A promise that resolves to the workflow.
+     */
     get(workflow: string | BaseWorkflowDeclaration<any, any> | LegacyWorkflow): Promise<import("../../../clients/rest/generated/data-contracts").Workflow>;
+    /**
+     * List all workflows in the tenant.
+     * @param opts - The options for the list operation.
+     * @returns A promise that resolves to the list of workflows.
+     */
     list(opts?: Parameters<typeof this.api.workflowList>[1]): Promise<import("../../../clients/rest/generated/data-contracts").WorkflowList>;
+    /**
+     * Delete a workflow by its name, ID, or object.
+     * @param workflow - The workflow name, ID, or object.
+     * @returns A promise that resolves to the deleted workflow.
+     */
     delete(workflow: string | BaseWorkflowDeclaration<any, any> | LegacyWorkflow): Promise<void>;
 }

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

@@ -10,8 +10,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkflowsClient = exports.workflowNameString = void 0;
-const legacy_transformer_1 = require("../../../legacy/legacy-transformer");
-const uuid_1 = require("../../../util/uuid");
+const legacy_transformer_1 = require("../../../../legacy/legacy-transformer");
+const uuid_1 = require("../../../../util/uuid");
 const workflowNameString = (workflow) => {
     if (typeof workflow === 'string') {
         return workflow;
@@ -27,7 +27,10 @@ const workflowNameString = (workflow) => {
 };
 exports.workflowNameString = workflowNameString;
 /**
- * WorkflowsClient is used to list and manage workflows
+ * The workflows client is a client for managing workflows programmatically within Hatchet.
+ *
+ * NOTE: that workflows are the declaration, not the individual runs. If you're looking for runs, use the RunsClient instead.
+ *
  */
 class WorkflowsClient {
     constructor(client, cacheTTL) {
@@ -69,6 +72,11 @@ class WorkflowsClient {
             return str;
         });
     }
+    /**
+     * Get a workflow by its name, ID, or object.
+     * @param workflow - The workflow name, ID, or object.
+     * @returns A promise that resolves to the workflow.
+     */
     get(workflow) {
         return __awaiter(this, void 0, void 0, function* () {
             // Get workflow name string
@@ -103,12 +111,22 @@ class WorkflowsClient {
             }
         });
     }
+    /**
+     * List all workflows in the tenant.
+     * @param opts - The options for the list operation.
+     * @returns A promise that resolves to the list of workflows.
+     */
     list(opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.workflowList(this.tenantId, opts);
             return data;
         });
     }
+    /**
+     * Delete a workflow by its name, ID, or object.
+     * @param workflow - The workflow name, ID, or object.
+     * @returns A promise that resolves to the deleted workflow.
+     */
     delete(workflow) {
         return __awaiter(this, void 0, void 0, function* () {
             const name = (0, exports.workflowNameString)(workflow);