@hatchet-dev/typescript-sdk 1.17.0 → 1.17.2

package/protoc/workflows/workflows.js

@@ -1,7 +1,7 @@
 "use strict";
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.7.7
+//   protoc-gen-ts_proto  v2.11.4
 //   protoc               v3.19.1
 // source: workflows/workflows.proto
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -439,13 +439,19 @@ exports.CreateWorkflowVersionOpts = {
             version: isSet(object.version) ? globalThis.String(object.version) : '',
             eventTriggers: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.eventTriggers)
                 ? object.eventTriggers.map((e) => globalThis.String(e))
-                : [],
+                : globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.event_triggers)
+                    ? object.event_triggers.map((e) => globalThis.String(e))
+                    : [],
             cronTriggers: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.cronTriggers)
                 ? object.cronTriggers.map((e) => globalThis.String(e))
-                : [],
+                : globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.cron_triggers)
+                    ? object.cron_triggers.map((e) => globalThis.String(e))
+                    : [],
             scheduledTriggers: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.scheduledTriggers)
                 ? object.scheduledTriggers.map((e) => fromJsonTimestamp(e))
-                : [],
+                : globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.scheduled_triggers)
+                    ? object.scheduled_triggers.map((e) => fromJsonTimestamp(e))
+                    : [],
             jobs: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.jobs)
                 ? object.jobs.map((e) => exports.CreateWorkflowJobOpts.fromJSON(e))
                 : [],
@@ -454,16 +460,26 @@ exports.CreateWorkflowVersionOpts = {
                 : undefined,
             scheduleTimeout: isSet(object.scheduleTimeout)
                 ? globalThis.String(object.scheduleTimeout)
-                : undefined,
-            cronInput: isSet(object.cronInput) ? globalThis.String(object.cronInput) : undefined,
+                : isSet(object.schedule_timeout)
+                    ? globalThis.String(object.schedule_timeout)
+                    : undefined,
+            cronInput: isSet(object.cronInput)
+                ? globalThis.String(object.cronInput)
+                : isSet(object.cron_input)
+                    ? globalThis.String(object.cron_input)
+                    : undefined,
             onFailureJob: isSet(object.onFailureJob)
                 ? exports.CreateWorkflowJobOpts.fromJSON(object.onFailureJob)
-                : undefined,
+                : isSet(object.on_failure_job)
+                    ? exports.CreateWorkflowJobOpts.fromJSON(object.on_failure_job)
+                    : undefined,
             sticky: isSet(object.sticky) ? stickyStrategyFromJSON(object.sticky) : undefined,
             kind: isSet(object.kind) ? workflowKindFromJSON(object.kind) : undefined,
             defaultPriority: isSet(object.defaultPriority)
                 ? globalThis.Number(object.defaultPriority)
-                : undefined,
+                : isSet(object.default_priority)
+                    ? globalThis.Number(object.default_priority)
+                    : undefined,
         };
     },
     toJSON(message) {
@@ -607,10 +623,16 @@ exports.WorkflowConcurrencyOpts = {
     fromJSON(object) {
         return {
             action: isSet(object.action) ? globalThis.String(object.action) : undefined,
-            maxRuns: isSet(object.maxRuns) ? globalThis.Number(object.maxRuns) : undefined,
+            maxRuns: isSet(object.maxRuns)
+                ? globalThis.Number(object.maxRuns)
+                : isSet(object.max_runs)
+                    ? globalThis.Number(object.max_runs)
+                    : undefined,
             limitStrategy: isSet(object.limitStrategy)
                 ? concurrencyLimitStrategyFromJSON(object.limitStrategy)
-                : undefined,
+                : isSet(object.limit_strategy)
+                    ? concurrencyLimitStrategyFromJSON(object.limit_strategy)
+                    : undefined,
             expression: isSet(object.expression) ? globalThis.String(object.expression) : undefined,
         };
     },
@@ -771,7 +793,7 @@ exports.CreateWorkflowStepOpts = {
         for (const v of message.rateLimits) {
             exports.CreateStepRateLimit.encode(v, writer.uint32(66).fork()).join();
         }
-        Object.entries(message.workerLabels).forEach(([key, value]) => {
+        globalThis.Object.entries(message.workerLabels).forEach(([key, value]) => {
             exports.CreateWorkflowStepOpts_WorkerLabelsEntry.encode({ key: key, value }, writer.uint32(74).fork()).join();
         });
         if (message.backoffFactor !== undefined) {
@@ -879,30 +901,49 @@ exports.CreateWorkflowStepOpts = {
     },
     fromJSON(object) {
         return {
-            readableId: isSet(object.readableId) ? globalThis.String(object.readableId) : '',
+            readableId: isSet(object.readableId)
+                ? globalThis.String(object.readableId)
+                : isSet(object.readable_id)
+                    ? globalThis.String(object.readable_id)
+                    : '',
             action: isSet(object.action) ? globalThis.String(object.action) : '',
             timeout: isSet(object.timeout) ? globalThis.String(object.timeout) : '',
             inputs: isSet(object.inputs) ? globalThis.String(object.inputs) : '',
             parents: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.parents)
                 ? object.parents.map((e) => globalThis.String(e))
                 : [],
-            userData: isSet(object.userData) ? globalThis.String(object.userData) : '',
+            userData: isSet(object.userData)
+                ? globalThis.String(object.userData)
+                : isSet(object.user_data)
+                    ? globalThis.String(object.user_data)
+                    : '',
             retries: isSet(object.retries) ? globalThis.Number(object.retries) : 0,
             rateLimits: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.rateLimits)
                 ? object.rateLimits.map((e) => exports.CreateStepRateLimit.fromJSON(e))
-                : [],
+                : globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.rate_limits)
+                    ? object.rate_limits.map((e) => exports.CreateStepRateLimit.fromJSON(e))
+                    : [],
             workerLabels: isObject(object.workerLabels)
-                ? Object.entries(object.workerLabels).reduce((acc, [key, value]) => {
+                ? globalThis.Object.entries(object.workerLabels).reduce((acc, [key, value]) => {
                     acc[key] = trigger_1.DesiredWorkerLabels.fromJSON(value);
                     return acc;
                 }, {})
-                : {},
+                : isObject(object.worker_labels)
+                    ? globalThis.Object.entries(object.worker_labels).reduce((acc, [key, value]) => {
+                        acc[key] = trigger_1.DesiredWorkerLabels.fromJSON(value);
+                        return acc;
+                    }, {})
+                    : {},
             backoffFactor: isSet(object.backoffFactor)
                 ? globalThis.Number(object.backoffFactor)
-                : undefined,
+                : isSet(object.backoff_factor)
+                    ? globalThis.Number(object.backoff_factor)
+                    : undefined,
             backoffMaxSeconds: isSet(object.backoffMaxSeconds)
                 ? globalThis.Number(object.backoffMaxSeconds)
-                : undefined,
+                : isSet(object.backoff_max_seconds)
+                    ? globalThis.Number(object.backoff_max_seconds)
+                    : undefined,
         };
     },
     toJSON(message) {
@@ -933,7 +974,7 @@ exports.CreateWorkflowStepOpts = {
             obj.rateLimits = message.rateLimits.map((e) => exports.CreateStepRateLimit.toJSON(e));
         }
         if (message.workerLabels) {
-            const entries = Object.entries(message.workerLabels);
+            const entries = globalThis.Object.entries(message.workerLabels);
             if (entries.length > 0) {
                 obj.workerLabels = {};
                 entries.forEach(([k, v]) => {
@@ -963,7 +1004,7 @@ exports.CreateWorkflowStepOpts = {
         message.userData = (_f = object.userData) !== null && _f !== void 0 ? _f : '';
         message.retries = (_g = object.retries) !== null && _g !== void 0 ? _g : 0;
         message.rateLimits = ((_h = object.rateLimits) === null || _h === void 0 ? void 0 : _h.map((e) => exports.CreateStepRateLimit.fromPartial(e))) || [];
-        message.workerLabels = Object.entries((_j = object.workerLabels) !== null && _j !== void 0 ? _j : {}).reduce((acc, [key, value]) => {
+        message.workerLabels = globalThis.Object.entries((_j = object.workerLabels) !== null && _j !== void 0 ? _j : {}).reduce((acc, [key, value]) => {
             if (value !== undefined) {
                 acc[key] = trigger_1.DesiredWorkerLabels.fromPartial(value);
             }
@@ -1139,11 +1180,21 @@ exports.CreateStepRateLimit = {
         return {
             key: isSet(object.key) ? globalThis.String(object.key) : '',
             units: isSet(object.units) ? globalThis.Number(object.units) : undefined,
-            keyExpr: isSet(object.keyExpr) ? globalThis.String(object.keyExpr) : undefined,
-            unitsExpr: isSet(object.unitsExpr) ? globalThis.String(object.unitsExpr) : undefined,
+            keyExpr: isSet(object.keyExpr)
+                ? globalThis.String(object.keyExpr)
+                : isSet(object.key_expr)
+                    ? globalThis.String(object.key_expr)
+                    : undefined,
+            unitsExpr: isSet(object.unitsExpr)
+                ? globalThis.String(object.unitsExpr)
+                : isSet(object.units_expr)
+                    ? globalThis.String(object.units_expr)
+                    : undefined,
             limitValuesExpr: isSet(object.limitValuesExpr)
                 ? globalThis.String(object.limitValuesExpr)
-                : undefined,
+                : isSet(object.limit_values_expr)
+                    ? globalThis.String(object.limit_values_expr)
+                    : undefined,
             duration: isSet(object.duration) ? rateLimitDurationFromJSON(object.duration) : undefined,
         };
     },
@@ -1350,15 +1401,31 @@ exports.ScheduleWorkflowRequest = {
                 ? object.schedules.map((e) => fromJsonTimestamp(e))
                 : [],
             input: isSet(object.input) ? globalThis.String(object.input) : '',
-            parentId: isSet(object.parentId) ? globalThis.String(object.parentId) : undefined,
+            parentId: isSet(object.parentId)
+                ? globalThis.String(object.parentId)
+                : isSet(object.parent_id)
+                    ? globalThis.String(object.parent_id)
+                    : undefined,
             parentTaskRunExternalId: isSet(object.parentTaskRunExternalId)
                 ? globalThis.String(object.parentTaskRunExternalId)
-                : undefined,
-            childIndex: isSet(object.childIndex) ? globalThis.Number(object.childIndex) : undefined,
-            childKey: isSet(object.childKey) ? globalThis.String(object.childKey) : undefined,
+                : isSet(object.parent_task_run_external_id)
+                    ? globalThis.String(object.parent_task_run_external_id)
+                    : undefined,
+            childIndex: isSet(object.childIndex)
+                ? globalThis.Number(object.childIndex)
+                : isSet(object.child_index)
+                    ? globalThis.Number(object.child_index)
+                    : undefined,
+            childKey: isSet(object.childKey)
+                ? globalThis.String(object.childKey)
+                : isSet(object.child_key)
+                    ? globalThis.String(object.child_key)
+                    : undefined,
             additionalMetadata: isSet(object.additionalMetadata)
                 ? globalThis.String(object.additionalMetadata)
-                : undefined,
+                : isSet(object.additional_metadata)
+                    ? globalThis.String(object.additional_metadata)
+                    : undefined,
             priority: isSet(object.priority) ? globalThis.Number(object.priority) : undefined,
         };
     },
@@ -1457,7 +1524,11 @@ exports.ScheduledWorkflow = {
     fromJSON(object) {
         return {
             id: isSet(object.id) ? globalThis.String(object.id) : '',
-            triggerAt: isSet(object.triggerAt) ? fromJsonTimestamp(object.triggerAt) : undefined,
+            triggerAt: isSet(object.triggerAt)
+                ? fromJsonTimestamp(object.triggerAt)
+                : isSet(object.trigger_at)
+                    ? fromJsonTimestamp(object.trigger_at)
+                    : undefined,
         };
     },
     toJSON(message) {
@@ -1584,14 +1655,28 @@ exports.WorkflowVersion = {
     fromJSON(object) {
         return {
             id: isSet(object.id) ? globalThis.String(object.id) : '',
-            createdAt: isSet(object.createdAt) ? fromJsonTimestamp(object.createdAt) : undefined,
-            updatedAt: isSet(object.updatedAt) ? fromJsonTimestamp(object.updatedAt) : undefined,
+            createdAt: isSet(object.createdAt)
+                ? fromJsonTimestamp(object.createdAt)
+                : isSet(object.created_at)
+                    ? fromJsonTimestamp(object.created_at)
+                    : undefined,
+            updatedAt: isSet(object.updatedAt)
+                ? fromJsonTimestamp(object.updatedAt)
+                : isSet(object.updated_at)
+                    ? fromJsonTimestamp(object.updated_at)
+                    : undefined,
             version: isSet(object.version) ? globalThis.String(object.version) : '',
             order: isSet(object.order) ? globalThis.Number(object.order) : 0,
-            workflowId: isSet(object.workflowId) ? globalThis.String(object.workflowId) : '',
+            workflowId: isSet(object.workflowId)
+                ? globalThis.String(object.workflowId)
+                : isSet(object.workflow_id)
+                    ? globalThis.String(object.workflow_id)
+                    : '',
             scheduledWorkflows: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.scheduledWorkflows)
                 ? object.scheduledWorkflows.map((e) => exports.ScheduledWorkflow.fromJSON(e))
-                : [],
+                : globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.scheduled_workflows)
+                    ? object.scheduled_workflows.map((e) => exports.ScheduledWorkflow.fromJSON(e))
+                    : [],
         };
     },
     toJSON(message) {
@@ -1681,8 +1766,16 @@ exports.WorkflowTriggerEventRef = {
     },
     fromJSON(object) {
         return {
-            parentId: isSet(object.parentId) ? globalThis.String(object.parentId) : '',
-            eventKey: isSet(object.eventKey) ? globalThis.String(object.eventKey) : '',
+            parentId: isSet(object.parentId)
+                ? globalThis.String(object.parentId)
+                : isSet(object.parent_id)
+                    ? globalThis.String(object.parent_id)
+                    : '',
+            eventKey: isSet(object.eventKey)
+                ? globalThis.String(object.eventKey)
+                : isSet(object.event_key)
+                    ? globalThis.String(object.event_key)
+                    : '',
         };
     },
     toJSON(message) {
@@ -1750,7 +1843,11 @@ exports.WorkflowTriggerCronRef = {
     },
     fromJSON(object) {
         return {
-            parentId: isSet(object.parentId) ? globalThis.String(object.parentId) : '',
+            parentId: isSet(object.parentId)
+                ? globalThis.String(object.parentId)
+                : isSet(object.parent_id)
+                    ? globalThis.String(object.parent_id)
+                    : '',
             cron: isSet(object.cron) ? globalThis.String(object.cron) : '',
         };
     },
@@ -1868,7 +1965,9 @@ exports.BulkTriggerWorkflowResponse = {
         return {
             workflowRunIds: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.workflowRunIds)
                 ? object.workflowRunIds.map((e) => globalThis.String(e))
-                : [],
+                : globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.workflow_run_ids)
+                    ? object.workflow_run_ids.map((e) => globalThis.String(e))
+                    : [],
         };
     },
     toJSON(message) {
@@ -1923,7 +2022,11 @@ exports.TriggerWorkflowResponse = {
     },
     fromJSON(object) {
         return {
-            workflowRunId: isSet(object.workflowRunId) ? globalThis.String(object.workflowRunId) : '',
+            workflowRunId: isSet(object.workflowRunId)
+                ? globalThis.String(object.workflowRunId)
+                : isSet(object.workflow_run_id)
+                    ? globalThis.String(object.workflow_run_id)
+                    : '',
         };
     },
     toJSON(message) {

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

@@ -1,3 +1,4 @@
+import { TaskStats } from '../../../clients/rest/generated/data-contracts';
 import { HatchetClient } from '../client';
 export type TaskStatusMetrics = {
     cancelled: number;
@@ -26,4 +27,14 @@ export declare class MetricsClient {
      * @returns The queue metrics for the current tenant.
      */
     getQueueMetrics(opts?: Parameters<typeof this.api.tenantGetStepRunQueueMetrics>[1]): Promise<import("../../../clients/rest/generated/data-contracts").TenantStepRunQueueMetrics>;
+    /**
+     * Scrape Prometheus metrics for the tenant.
+     * @returns The metrics in Prometheus text format.
+     */
+    scrapePrometheusMetrics(): Promise<string>;
+    /**
+     * Get task statistics for the tenant.
+     * @returns A record mapping task names to their statistics.
+     */
+    getTaskStats(): Promise<TaskStats>;
 }

package/v1/client/features/metrics.js

@@ -44,5 +44,25 @@ class MetricsClient {
             return data;
         });
     }
+    /**
+     * Scrape Prometheus metrics for the tenant.
+     * @returns The metrics in Prometheus text format.
+     */
+    scrapePrometheusMetrics() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.api.tenantGetPrometheusMetrics(this.tenantId);
+            return data;
+        });
+    }
+    /**
+     * Get task statistics for the tenant.
+     * @returns A record mapping task names to their statistics.
+     */
+    getTaskStats() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.api.tenantGetTaskStats(this.tenantId);
+            return data;
+        });
+    }
 }
 exports.MetricsClient = MetricsClient;

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.17.0";
+export declare const HATCHET_VERSION = "1.17.2";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HATCHET_VERSION = void 0;
-exports.HATCHET_VERSION = '1.17.0';
+exports.HATCHET_VERSION = '1.17.2';