@hatchet-dev/typescript-sdk 1.6.2 → 1.7.1

package/step.js

@@ -58,6 +58,7 @@ const declaration_1 = require("./v1/declaration");
 const conditions_1 = require("./v1/conditions");
 const condition_1 = require("./protoc/v1/shared/condition");
 const transformer_1 = require("./v1/conditions/transformer");
+const apply_namespace_1 = require("./util/apply-namespace");
 exports.CreateRateLimitSchema = z.object({
     key: z.string().optional(),
     staticKey: z.string().optional(),
@@ -386,7 +387,7 @@ class V0Context {
                 else {
                     workflowName = workflow.id;
                 }
-                const name = this.v0.config.namespace + workflowName;
+                const name = (0, apply_namespace_1.applyNamespace)(workflowName, this.v0.config.namespace);
                 const opts = options || {};
                 const { sticky } = opts;
                 if (sticky && !this.worker.hasWorkflow(name)) {
@@ -470,7 +471,7 @@ class V0Context {
             else {
                 workflowName = workflow.id;
             }
-            const name = this.v0.config.namespace + workflowName;
+            const name = (0, apply_namespace_1.applyNamespace)(workflowName, this.v0.config.namespace);
             const opts = options || {};
             const { sticky } = opts;
             if (sticky && !this.worker.hasWorkflow(name)) {

package/util/apply-namespace.d.ts

@@ -0,0 +1 @@
+export declare function applyNamespace(name: string, namespace?: string): string;

package/util/apply-namespace.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyNamespace = applyNamespace;
+function applyNamespace(name, namespace) {
+    if (namespace && !name.startsWith(namespace)) {
+        return `${namespace}${name}`;
+    }
+    return name;
+}

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

@@ -75,7 +75,10 @@ class ConfigLoader {
                 (_x = (_w = override === null || override === void 0 ? void 0 : override.host_port) !== null && _w !== void 0 ? _w : yaml === null || yaml === void 0 ? void 0 : yaml.host_port) !== null && _x !== void 0 ? _x : this.env('HATCHET_CLIENT_HOST_PORT');
             apiUrl = (_z = (_y = override === null || override === void 0 ? void 0 : override.api_url) !== null && _y !== void 0 ? _y : yaml === null || yaml === void 0 ? void 0 : yaml.api_url) !== null && _z !== void 0 ? _z : this.env('HATCHET_CLIENT_API_URL');
         }
-        const namespace = (_1 = (_0 = override === null || override === void 0 ? void 0 : override.namespace) !== null && _0 !== void 0 ? _0 : yaml === null || yaml === void 0 ? void 0 : yaml.namespace) !== null && _1 !== void 0 ? _1 : this.env('HATCHET_CLIENT_NAMESPACE');
+        let namespace = (_1 = (_0 = override === null || override === void 0 ? void 0 : override.namespace) !== null && _0 !== void 0 ? _0 : yaml === null || yaml === void 0 ? void 0 : yaml.namespace) !== null && _1 !== void 0 ? _1 : this.env('HATCHET_CLIENT_NAMESPACE');
+        if (namespace && !(namespace === null || namespace === void 0 ? void 0 : namespace.endsWith('_'))) {
+            namespace = `${namespace}_`;
+        }
         return {
             token: (_3 = (_2 = override === null || override === void 0 ? void 0 : override.token) !== null && _2 !== void 0 ? _2 : yaml === null || yaml === void 0 ? void 0 : yaml.token) !== null && _3 !== void 0 ? _3 : this.env('HATCHET_CLIENT_TOKEN'),
             host_port: grpcBroadcastAddress,
@@ -83,7 +86,7 @@ class ConfigLoader {
             tls_config: tlsConfig,
             log_level: (_6 = (_5 = (_4 = override === null || override === void 0 ? void 0 : override.log_level) !== null && _4 !== void 0 ? _4 : yaml === null || yaml === void 0 ? void 0 : yaml.log_level) !== null && _5 !== void 0 ? _5 : this.env('HATCHET_CLIENT_LOG_LEVEL')) !== null && _6 !== void 0 ? _6 : 'INFO',
             tenant_id: tenantId,
-            namespace: namespace ? `${namespace}_`.toLowerCase() : '',
+            namespace: namespace ? `${namespace}`.toLowerCase() : '',
         };
     }
     static get default_yaml_config_path() {

package/util/uuid.d.ts

@@ -0,0 +1 @@
+export declare function isValidUUID(uuid: string): boolean;

package/util/uuid.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidUUID = isValidUUID;
+const zod_1 = require("zod");
+function isValidUUID(uuid) {
+    return zod_1.z.string().uuid().safeParse(uuid).success;
+}

package/v1/client/admin.js

@@ -19,6 +19,7 @@ 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 batch_1 = require("../../util/batch");
+const apply_namespace_1 = require("../../util/apply-namespace");
 class AdminClient {
     constructor(config, api, runs) {
         this.config = config;
@@ -38,11 +39,8 @@ class AdminClient {
      */
     runWorkflow(workflowName, input, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            let computedName = workflowName;
             try {
-                if (this.config.namespace && !workflowName.startsWith(this.config.namespace)) {
-                    computedName = this.config.namespace + workflowName;
-                }
+                const computedName = (0, apply_namespace_1.applyNamespace)(workflowName, this.config.namespace);
                 const inputStr = JSON.stringify(input);
                 const resp = yield this.grpc.triggerWorkflow(Object.assign(Object.assign({ name: computedName, input: inputStr }, options), { additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
                         ? JSON.stringify(options === null || options === void 0 ? void 0 : options.additionalMetadata)
@@ -69,10 +67,7 @@ class AdminClient {
         return __awaiter(this, arguments, void 0, function* (workflowRuns, batchSize = 500) {
             // Prepare workflows to be triggered in bulk
             const workflowRequests = workflowRuns.map(({ workflowName, input, options }) => {
-                let computedName = workflowName;
-                if (this.config.namespace && !workflowName.startsWith(this.config.namespace)) {
-                    computedName = this.config.namespace + workflowName;
-                }
+                const computedName = (0, apply_namespace_1.applyNamespace)(workflowName, this.config.namespace);
                 const inputStr = JSON.stringify(input);
                 return Object.assign(Object.assign({ name: computedName, input: inputStr }, options), { additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
                         ? JSON.stringify(options.additionalMetadata)

package/v1/client/client.d.ts

@@ -15,6 +15,9 @@ import { InputType, OutputType, UnknownInputType, StrictWorkflowOutputType } fro
 import { RatelimitsClient } from './features';
 import { AdminClient } from './admin';
 import { FiltersClient } from './features/filters';
+import { ScheduleClient } from './features/schedules';
+import { CronClient } from './features/crons';
+import { TenantClient } from './features/tenant';
 /**
  * HatchetV1 implements the main client interface for interacting with the Hatchet workflow engine.
  * It provides methods for creating and executing workflows, as well as managing workers.
@@ -124,28 +127,34 @@ export declare class HatchetClient implements IHatchetClient {
      * @returns A promise that resolves with the workflow result
      */
     run<I extends InputType = UnknownInputType, O extends OutputType = void>(workflow: BaseWorkflowDeclaration<I, O> | string | V0Workflow, input: I, options?: RunOpts): Promise<O>;
+    private _crons;
     /**
      * Get the cron client for creating and managing cron workflow runs
      * @returns A cron client instance
      */
-    get crons(): import("../../clients/hatchet-client/features/cron-client").CronClient;
+    get crons(): CronClient;
     /**
      * Get the cron client for creating and managing cron workflow runs
      * @returns A cron client instance
      * @deprecated use client.crons instead
      */
-    get cron(): import("../../clients/hatchet-client/features/cron-client").CronClient;
+    get cron(): CronClient;
+    private _scheduled;
     /**
      * Get the schedules client for creating and managing scheduled workflow runs
      * @returns A schedules client instance
      */
-    get schedules(): import("../../clients/hatchet-client/features/schedule-client").ScheduleClient;
+    get scheduled(): ScheduleClient;
     /**
      * Get the schedule client for creating and managing scheduled workflow runs
      * @returns A schedule client instance
-     * @deprecated use client.schedules instead
+     * @deprecated use client.scheduled instead
      */
-    get schedule(): import("../../clients/hatchet-client/features/schedule-client").ScheduleClient;
+    get schedule(): ScheduleClient;
+    /**
+     * @alias scheduled
+     */
+    get schedules(): ScheduleClient;
     /**
      * Get the event client for creating and managing event workflow runs
      * @returns A event client instance
@@ -169,6 +178,12 @@ export declare class HatchetClient implements IHatchetClient {
      * @returns A filters client instance
      */
     get filters(): FiltersClient;
+    private _tenant;
+    /**
+     * Get the tenant client for managing tenants
+     * @returns A tenant client instance
+     */
+    get tenant(): TenantClient;
     private _ratelimits;
     /**
      * Get the rate limits client for creating and managing rate limits

package/v1/client/client.interface.d.ts

@@ -4,11 +4,15 @@ import { RunsClient } from './features/runs';
 import { WorkersClient } from './features/workers';
 import { WorkflowsClient } from './features/workflows';
 import { AdminClient } from './admin';
+import { ScheduleClient } from './features/schedules';
+import { CronClient } from './features/crons';
 export interface IHatchetClient {
     _v0: LegacyHatchetClient;
     metrics: MetricsClient;
     runs: RunsClient;
     workflows: WorkflowsClient;
     workers: WorkersClient;
+    scheduled: ScheduleClient;
+    crons: CronClient;
     admin: AdminClient;
 }

package/v1/client/client.js

@@ -21,6 +21,7 @@ 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 declaration_1 = require("../declaration");
 const worker_1 = require("./worker/worker");
 const metrics_1 = require("./features/metrics");
@@ -30,6 +31,9 @@ const runs_1 = require("./features/runs");
 const features_1 = require("./features");
 const admin_1 = require("./admin");
 const filters_1 = require("./features/filters");
+const schedules_1 = require("./features/schedules");
+const crons_1 = require("./features/crons");
+const tenant_1 = require("./features/tenant");
 /**
  * HatchetV1 implements the main client interface for interacting with the Hatchet workflow engine.
  * It provides methods for creating and executing workflows, as well as managing workers.
@@ -62,12 +66,6 @@ class HatchetClient {
                 logConstructor = hatchet_logger_1.DEFAULT_LOGGER;
             }
             const clientConfig = Object.assign(Object.assign({}, valid), { logger: logConstructor });
-            // FIXME: Remove this once we have a proper namespace validation
-            if (clientConfig.namespace) {
-                clientConfig.namespace = clientConfig.namespace.endsWith('_')
-                    ? clientConfig.namespace.slice(0, -1)
-                    : clientConfig.namespace;
-            }
             this._config = clientConfig;
             this.tenantId = clientConfig.tenant_id;
             this._api = (0, rest_1.default)(clientConfig.api_url, clientConfig.token, axiosConfig);
@@ -79,6 +77,23 @@ class HatchetClient {
             }
             throw e;
         }
+        try {
+            this.tenant
+                .get()
+                .then((tenant) => {
+                if (tenant.version !== 'V1') {
+                    this.config
+                        .logger('client-init', event_client_1.LogLevel.INFO)
+                        .warn('🚨⚠️‼️ YOU ARE USING A V0 ENGINE WITH A V1 SDK, WHICH IS NOT SUPPORTED. PLEASE UPGRADE YOUR ENGINE TO V1.🚨⚠️‼️');
+                }
+            })
+                .catch((error) => {
+                // Do nothing here
+            });
+        }
+        catch (e) {
+            // Do nothing here
+        }
     }
     /**
      * Static factory method to create a new Hatchet client instance.
@@ -175,7 +190,10 @@ class HatchetClient {
      * @returns A cron client instance
      */
     get crons() {
-        return this._v0.cron;
+        if (!this._crons) {
+            this._crons = new crons_1.CronClient(this);
+        }
+        return this._crons;
     }
     /**
      * Get the cron client for creating and managing cron workflow runs
@@ -189,16 +207,25 @@ class HatchetClient {
      * Get the schedules client for creating and managing scheduled workflow runs
      * @returns A schedules client instance
      */
-    get schedules() {
-        return this._v0.schedule;
+    get scheduled() {
+        if (!this._scheduled) {
+            this._scheduled = new schedules_1.ScheduleClient(this);
+        }
+        return this._scheduled;
     }
     /**
      * Get the schedule client for creating and managing scheduled workflow runs
      * @returns A schedule client instance
-     * @deprecated use client.schedules instead
+     * @deprecated use client.scheduled instead
      */
     get schedule() {
-        return this.schedules;
+        return this.scheduled;
+    }
+    /**
+     * @alias scheduled
+     */
+    get schedules() {
+        return this.scheduled;
     }
     /**
      * Get the event client for creating and managing event workflow runs
@@ -235,6 +262,16 @@ class HatchetClient {
         }
         return this._filters;
     }
+    /**
+     * Get the tenant client for managing tenants
+     * @returns A tenant client instance
+     */
+    get tenant() {
+        if (!this._tenant) {
+            this._tenant = new tenant_1.TenantClient(this);
+        }
+        return this._tenant;
+    }
     /**
      * Get the rate limits client for creating and managing rate limits
      * @returns A rate limits client instance

package/{clients/hatchet-client/features/cron-client.d.ts → v1/client/features/crons.d.ts}

@@ -1,9 +1,9 @@
-import { AdminClient } from '../../admin';
-import { Api } from '../../rest';
-import { CronWorkflows, CronWorkflowsList } from '../../rest/generated/data-contracts';
+import { CronWorkflows, CronWorkflowsList } from '../../../clients/rest/generated/data-contracts';
 import { z } from 'zod';
 import { Workflow } from '../../../workflow';
-import { ClientConfig } from '../client-config';
+import { BaseWorkflowDeclaration } from '../..';
+import { HatchetClient } from '../client';
+import { WorkflowsClient } from './workflows';
 /**
  * Schema for creating a Cron Trigger.
  */
@@ -34,19 +34,11 @@ export type CreateCronInput = z.infer<typeof CreateCronTriggerSchema>;
  * Client for managing Cron Triggers.
  */
 export declare class CronClient {
-    private readonly tenantId;
-    private readonly config;
-    private readonly api;
-    private readonly adminClient;
-    private logger;
-    /**
-     * Initializes a new instance of CronClient.
-     * @param tenantId - The tenant identifier.
-     * @param config - Client configuration settings.
-     * @param api - API instance for REST interactions.
-     * @param adminClient - Admin client for administrative operations.
-     */
-    constructor(tenantId: string, config: ClientConfig, api: Api, adminClient: AdminClient);
+    api: HatchetClient['api'];
+    tenantId: string;
+    workflows: WorkflowsClient;
+    namespace: string | undefined;
+    constructor(client: HatchetClient);
     /**
      * Retrieves the Cron ID from a CronWorkflows object or a string.
      * @param cron - The CronWorkflows object or Cron ID as a string.
@@ -60,7 +52,7 @@ export declare class CronClient {
      * @returns A promise that resolves to the created CronWorkflows object.
      * @throws Will throw an error if the input is invalid or the API call fails.
      */
-    create(workflow: string | Workflow, cron: CreateCronInput): Promise<CronWorkflows>;
+    create(workflow: string | Workflow | BaseWorkflowDeclaration<any, any>, cron: CreateCronInput): Promise<CronWorkflows>;
     /**
      * Deletes an existing Cron Trigger.
      * @param cron - The Cron Trigger ID as a string or CronWorkflows object.
@@ -72,7 +64,9 @@ export declare class CronClient {
      * @param query - Query parameters for listing Cron Triggers.
      * @returns A promise that resolves to a CronWorkflowsList object.
      */
-    list(query: Parameters<typeof this.api.cronWorkflowList>[1]): Promise<CronWorkflowsList>;
+    list(query: Parameters<typeof this.api.cronWorkflowList>[1] & {
+        workflow?: string | Workflow | BaseWorkflowDeclaration<any, any>;
+    }): Promise<CronWorkflowsList>;
     /**
      * Retrieves a specific Cron Trigger by its ID.
      * @param cron - The Cron Trigger ID as a string or CronWorkflows object.

package/{clients/hatchet-client/features/cron-client.js → v1/client/features/crons.js}

@@ -8,10 +8,24 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 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 workflows_1 = require("./workflows");
 /**
  * Schema for creating a Cron Trigger.
  */
@@ -26,19 +40,11 @@ exports.CreateCronTriggerSchema = zod_1.z.object({
  * Client for managing Cron Triggers.
  */
 class CronClient {
-    /**
-     * Initializes a new instance of CronClient.
-     * @param tenantId - The tenant identifier.
-     * @param config - Client configuration settings.
-     * @param api - API instance for REST interactions.
-     * @param adminClient - Admin client for administrative operations.
-     */
-    constructor(tenantId, config, api, adminClient) {
-        this.tenantId = tenantId;
-        this.config = config;
-        this.api = api;
-        this.adminClient = adminClient;
-        this.logger = config.logger('Cron', this.config.log_level);
+    constructor(client) {
+        this.api = client.api;
+        this.tenantId = client.tenantId;
+        this.workflows = new workflows_1.WorkflowsClient(client);
+        this.namespace = client.config.namespace;
     }
     /**
      * Retrieves the Cron ID from a CronWorkflows object or a string.
@@ -46,7 +52,11 @@ class CronClient {
      * @returns The Cron ID as a string.
      */
     getCronId(cron) {
-        return typeof cron === 'string' ? cron : cron.metadata.id;
+        const str = typeof cron === 'string' ? cron : cron.metadata.id;
+        if (!(0, uuid_1.isValidUUID)(str)) {
+            throw new Error('Invalid cron ID: must be a valid UUID');
+        }
+        return str;
     }
     /**
      * Creates a new Cron workflow.
@@ -58,7 +68,7 @@ class CronClient {
     create(workflow, cron) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
-            const workflowId = typeof workflow === 'string' ? workflow : workflow.id;
+            const workflowId = (0, apply_namespace_1.applyNamespace)((0, workflows_1.workflowNameString)(workflow), this.namespace);
             // Validate cron input with zod schema
             try {
                 const parsedCron = exports.CreateCronTriggerSchema.parse(cron);
@@ -100,7 +110,12 @@ class CronClient {
      */
     list(query) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.api.cronWorkflowList(this.tenantId, query);
+            const { workflow } = query, rest = __rest(query, ["workflow"]);
+            if (workflow) {
+                const workflowId = yield this.workflows.getWorkflowIdFromName((0, apply_namespace_1.applyNamespace)((0, workflows_1.workflowNameString)(workflow), this.namespace));
+                rest.workflowId = workflowId;
+            }
+            const response = yield this.api.cronWorkflowList(this.tenantId, rest);
             return response.data;
         });
     }

package/v1/client/features/filters.d.ts

@@ -18,4 +18,5 @@ export declare class FiltersClient {
     get(filterId: Parameters<typeof this.api.v1FilterGet>[1]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
     create(opts: Parameters<typeof this.api.v1FilterCreate>[1]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
     delete(filterId: Parameters<typeof this.api.v1FilterDelete>[1]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
+    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/client/features/filters.js

@@ -55,5 +55,11 @@ class FiltersClient {
             return data;
         });
     }
+    update(filterId, updates) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.api.v1FilterUpdate(this.tenantId, filterId, updates);
+            return data;
+        });
+    }
 }
 exports.FiltersClient = FiltersClient;

package/v1/client/features/index.d.ts

@@ -1,5 +1,7 @@
+export * from './crons';
 export * from './metrics';
 export * from './ratelimits';
 export * from './runs';
 export * from './workers';
 export * from './workflows';
+export * from './schedules';

package/v1/client/features/index.js

@@ -14,8 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./crons"), exports);
 __exportStar(require("./metrics"), exports);
 __exportStar(require("./ratelimits"), exports);
 __exportStar(require("./runs"), exports);
 __exportStar(require("./workers"), exports);
 __exportStar(require("./workflows"), exports);
+__exportStar(require("./schedules"), exports);

package/v1/client/features/runs.d.ts

@@ -62,6 +62,7 @@ export declare class RunsClient {
     workflows: WorkflowsClient;
     constructor(client: HatchetClient);
     get<T = any>(run: string | WorkflowRunRef<T>): Promise<import("../../../clients/rest/generated/data-contracts").V1WorkflowRunDetails>;
+    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<void, any>>;
     replay(opts: ReplayRunOpts): Promise<import("axios").AxiosResponse<void, any>>;

package/v1/client/features/runs.js

@@ -26,6 +26,13 @@ class RunsClient {
             return data;
         });
     }
+    get_status(run) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const runId = typeof run === 'string' ? run : yield run.getWorkflowRunId();
+            const { data } = yield this.api.v1WorkflowRunGetStatus(runId);
+            return data;
+        });
+    }
     list(opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.v1WorkflowRunList(this.tenantId, Object.assign({}, (yield this.prepareListFilter(opts || {}))));

package/{clients/hatchet-client/features/schedule-client.d.ts → v1/client/features/schedules.d.ts}

@@ -1,9 +1,9 @@
-import { AdminClient } from '../../admin';
-import { Api } from '../../rest';
-import { ScheduledWorkflows, ScheduledWorkflowsList } from '../../rest/generated/data-contracts';
+import { ScheduledWorkflows, ScheduledWorkflowsList } from '../../../clients/rest/generated/data-contracts';
 import { z } from 'zod';
 import { Workflow } from '../../../workflow';
-import { ClientConfig } from '../client-config';
+import { BaseWorkflowDeclaration, WorkflowDefinition } from '../..';
+import { HatchetClient } from '../client';
+import { WorkflowsClient } from './workflows';
 /**
  * Schema for creating a Scheduled Run Trigger.
  */
@@ -31,19 +31,11 @@ export type CreateScheduledRunInput = z.infer<typeof CreateScheduledRunTriggerSc
  * Client for managing Scheduled Runs.
  */
 export declare class ScheduleClient {
-    private readonly tenantId;
-    private readonly config;
-    private readonly api;
-    private readonly adminClient;
-    private logger;
-    /**
-     * Initializes a new instance of ScheduleClient.
-     * @param tenantId - The tenant identifier.
-     * @param config - Client configuration settings.
-     * @param api - API instance for REST interactions.
-     * @param adminClient - Admin client for administrative operations.
-     */
-    constructor(tenantId: string, config: ClientConfig, api: Api, adminClient: AdminClient);
+    api: HatchetClient['api'];
+    tenantId: string;
+    workflows: WorkflowsClient;
+    namespace: string | undefined;
+    constructor(client: HatchetClient);
     /**
      * Retrieves the Scheduled Run ID from a ScheduledRun object or a string.
      * @param scheduledRun - The ScheduledRun object or Scheduled Run ID as a string.
@@ -69,7 +61,9 @@ export declare class ScheduleClient {
      * @param query - Query parameters for listing Scheduled Runs.
      * @returns A promise that resolves to a ScheduledWorkflowsList object.
      */
-    list(query: Parameters<typeof this.api.workflowScheduledList>[1]): Promise<ScheduledWorkflowsList>;
+    list(query: Parameters<typeof this.api.workflowScheduledList>[1] & {
+        workflow?: string | Workflow | WorkflowDefinition | BaseWorkflowDeclaration<any, any>;
+    }): Promise<ScheduledWorkflowsList>;
     /**
      * Retrieves a specific Scheduled Run by its ID.
      * @param scheduledRun - The Scheduled Run ID as a string or ScheduledWorkflows object.

package/{clients/hatchet-client/features/schedule-client.js → v1/client/features/schedules.js}

@@ -8,10 +8,24 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ScheduleClient = 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 workflows_1 = require("./workflows");
 /**
  * Schema for creating a Scheduled Run Trigger.
  */
@@ -25,19 +39,11 @@ exports.CreateScheduledRunTriggerSchema = zod_1.z.object({
  * Client for managing Scheduled Runs.
  */
 class ScheduleClient {
-    /**
-     * Initializes a new instance of ScheduleClient.
-     * @param tenantId - The tenant identifier.
-     * @param config - Client configuration settings.
-     * @param api - API instance for REST interactions.
-     * @param adminClient - Admin client for administrative operations.
-     */
-    constructor(tenantId, config, api, adminClient) {
-        this.tenantId = tenantId;
-        this.config = config;
-        this.api = api;
-        this.adminClient = adminClient;
-        this.logger = config.logger('Scheduled Run', this.config.log_level);
+    constructor(client) {
+        this.api = client.api;
+        this.tenantId = client.tenantId;
+        this.workflows = new workflows_1.WorkflowsClient(client);
+        this.namespace = client.config.namespace;
     }
     /**
      * Retrieves the Scheduled Run ID from a ScheduledRun object or a string.
@@ -45,7 +51,11 @@ class ScheduleClient {
      * @returns The Scheduled Run ID as a string.
      */
     getScheduledRunId(scheduledRun) {
-        return typeof scheduledRun === 'string' ? scheduledRun : scheduledRun.metadata.id;
+        const str = typeof scheduledRun === 'string' ? scheduledRun : scheduledRun.metadata.id;
+        if (!(0, uuid_1.isValidUUID)(str)) {
+            throw new Error('Invalid scheduled run ID: must be a valid UUID');
+        }
+        return str;
     }
     /**
      * Creates a new Scheduled Run.
@@ -57,7 +67,7 @@ class ScheduleClient {
     create(workflow, cron) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
-            const workflowId = typeof workflow === 'string' ? workflow : workflow.id;
+            const workflowId = (0, apply_namespace_1.applyNamespace)((0, workflows_1.workflowNameString)(workflow), this.namespace);
             // Validate cron input with zod schema
             try {
                 const parsedCron = exports.CreateScheduledRunTriggerSchema.parse(cron);
@@ -98,7 +108,12 @@ class ScheduleClient {
      */
     list(query) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.api.workflowScheduledList(this.tenantId, query);
+            const { workflow } = query, rest = __rest(query, ["workflow"]);
+            if (workflow) {
+                const workflowId = yield this.workflows.getWorkflowIdFromName((0, apply_namespace_1.applyNamespace)((0, workflows_1.workflowNameString)(workflow), this.namespace));
+                rest.workflowId = workflowId;
+            }
+            const response = yield this.api.workflowScheduledList(this.tenantId, rest);
             return response.data;
         });
     }