@hatchet-dev/typescript-sdk 0.13.1 → 0.14.0

package/clients/rest/generated/Api.d.ts

@@ -1,4 +1,4 @@
-import { AcceptInviteRequest, APIErrors, APIMeta, BulkCreateEventRequest, BulkCreateEventResponse, CancelEventRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreateEventRequest, CreateSNSIntegrationRequest, CreateTenantAlertEmailGroupRequest, CreateTenantInviteRequest, CreateTenantRequest, Event, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, ListAPIMetaIntegration, ListAPITokensResponse, ListSlackWebhooks, ListSNSIntegrations, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, RejectInviteRequest, ReplayEventRequest, ReplayWorkflowRunsRequest, ReplayWorkflowRunsResponse, RerunStepRunRequest, SNSIntegration, StepRun, StepRunArchiveList, StepRunEventList, Tenant, TenantAlertEmailGroup, TenantAlertEmailGroupList, TenantAlertingSettings, TenantInvite, TenantInviteList, TenantMember, TenantMemberList, TenantQueueMetrics, TenantResourcePolicy, TriggerWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantRequest, UpdateWorkerRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, WebhookWorkerCreated, WebhookWorkerCreateRequest, WebhookWorkerListResponse, WebhookWorkerRequestListResponse, Worker, WorkerList, Workflow, WorkflowID, WorkflowKindList, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunOrderByDirection, WorkflowRunOrderByField, WorkflowRunsCancelRequest, WorkflowRunShape, WorkflowRunsMetrics, WorkflowRunStatus, WorkflowRunStatusList, WorkflowVersion, WorkflowWorkersCount } from './data-contracts';
+import { AcceptInviteRequest, APIErrors, APIMeta, BulkCreateEventRequest, BulkCreateEventResponse, CancelEventRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreateEventRequest, CreateSNSIntegrationRequest, CreateTenantAlertEmailGroupRequest, CreateTenantInviteRequest, CreateTenantRequest, Event, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, ListAPIMetaIntegration, ListAPITokensResponse, ListSlackWebhooks, ListSNSIntegrations, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, RateLimitList, RateLimitOrderByDirection, RateLimitOrderByField, RejectInviteRequest, ReplayEventRequest, ReplayWorkflowRunsRequest, ReplayWorkflowRunsResponse, RerunStepRunRequest, SNSIntegration, StepRun, StepRunArchiveList, StepRunEventList, Tenant, TenantAlertEmailGroup, TenantAlertEmailGroupList, TenantAlertingSettings, TenantInvite, TenantInviteList, TenantMember, TenantMemberList, TenantQueueMetrics, TenantResourcePolicy, TriggerWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantRequest, UpdateWorkerRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, WebhookWorkerCreated, WebhookWorkerCreateRequest, WebhookWorkerListResponse, WebhookWorkerRequestListResponse, Worker, WorkerList, Workflow, WorkflowID, WorkflowKindList, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunOrderByDirection, WorkflowRunOrderByField, WorkflowRunsCancelRequest, WorkflowRunShape, WorkflowRunsMetrics, WorkflowRunStatus, WorkflowRunStatusList, WorkflowUpdateRequest, WorkflowVersion, WorkflowWorkersCount } from './data-contracts';
 import { HttpClient, RequestParams } from './http-client';
 export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
     /**
@@ -498,6 +498,33 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
     eventUpdateCancel: (tenant: string, data: CancelEventRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<{
         workflowRunIds?: string[];
     }, any>>;
+    /**
+     * @description Lists all rate limits for a tenant.
+     *
+     * @tags Rate Limits
+     * @name RateLimitList
+     * @summary List rate limits
+     * @request GET:/api/v1/tenants/{tenant}/rate-limits
+     * @secure
+     */
+    rateLimitList: (tenant: string, query?: {
+        /**
+         * The number to skip
+         * @format int64
+         */
+        offset?: number;
+        /**
+         * The number to limit by
+         * @format int64
+         */
+        limit?: number;
+        /** The search query to filter for */
+        search?: string;
+        /** What to order by */
+        orderByField?: RateLimitOrderByField;
+        /** The order direction */
+        orderByDirection?: RateLimitOrderByDirection;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<RateLimitList, any>>;
     /**
      * @description Gets a list of tenant members
      *
@@ -590,6 +617,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     workflowDelete: (workflow: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Update a workflow for a tenant
+     *
+     * @tags Workflow
+     * @name WorkflowUpdate
+     * @summary Update workflow
+     * @request PATCH:/api/v1/workflows/{workflow}
+     * @secure
+     */
+    workflowUpdate: (workflow: string, data: WorkflowUpdateRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<Workflow, any>>;
     /**
      * @description Get a workflow version for a tenant
      *
@@ -807,6 +844,18 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          * @example "2021-01-01T00:00:00Z"
          */
         createdBefore?: string;
+        /**
+         * The time after the workflow run was finished
+         * @format date-time
+         * @example "2021-01-01T00:00:00Z"
+         */
+        finishedAfter?: string;
+        /**
+         * The time before the workflow run was finished
+         * @format date-time
+         * @example "2021-01-01T00:00:00Z"
+         */
+        finishedBefore?: string;
         /** The order by field */
         orderByField?: WorkflowRunOrderByField;
         /** The order by direction */

package/clients/rest/generated/Api.js

@@ -472,6 +472,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.eventUpdateCancel = (tenant, data, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/events/cancel`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Lists all rate limits for a tenant.
+         *
+         * @tags Rate Limits
+         * @name RateLimitList
+         * @summary List rate limits
+         * @request GET:/api/v1/tenants/{tenant}/rate-limits
+         * @secure
+         */
+        this.rateLimitList = (tenant, query, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/rate-limits`, method: 'GET', query: query, secure: true, format: 'json' }, params));
         /**
          * @description Gets a list of tenant members
          *
@@ -562,6 +572,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.workflowDelete = (workflow, params = {}) => this.request(Object.assign({ path: `/api/v1/workflows/${workflow}`, method: 'DELETE', secure: true }, params));
+        /**
+         * @description Update a workflow for a tenant
+         *
+         * @tags Workflow
+         * @name WorkflowUpdate
+         * @summary Update workflow
+         * @request PATCH:/api/v1/workflows/{workflow}
+         * @secure
+         */
+        this.workflowUpdate = (workflow, data, params = {}) => this.request(Object.assign({ path: `/api/v1/workflows/${workflow}`, method: 'PATCH', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
         /**
          * @description Get a workflow version for a tenant
          *

package/clients/rest/generated/data-contracts.d.ts

@@ -314,6 +314,7 @@ export interface TenantQueueMetrics {
     /** The total queue metrics. */
     total?: QueueMetrics;
     workflow?: Record<string, QueueMetrics>;
+    queues?: Record<string, number>;
 }
 export interface AcceptInviteRequest {
     /**
@@ -437,6 +438,37 @@ export interface EventList {
     pagination?: PaginationResponse;
     rows?: Event[];
 }
+export interface RateLimit {
+    /** The key for the rate limit. */
+    key: string;
+    /** The ID of the tenant associated with this rate limit. */
+    tenantId: string;
+    /** The maximum number of requests allowed within the window. */
+    limitValue: number;
+    /** The current number of requests made within the window. */
+    value: number;
+    /** The window of time in which the limitValue is enforced. */
+    window: string;
+    /**
+     * The last time the rate limit was refilled.
+     * @format date-time
+     * @example "2022-12-13T20:06:48.888Z"
+     */
+    lastRefill: string;
+}
+export interface RateLimitList {
+    pagination?: PaginationResponse;
+    rows?: RateLimit[];
+}
+export declare enum RateLimitOrderByField {
+    Key = "key",
+    Value = "value",
+    LimitValue = "limitValue"
+}
+export declare enum RateLimitOrderByDirection {
+    Asc = "asc",
+    Desc = "desc"
+}
 export interface ReplayEventRequest {
     eventIds: string[];
 }
@@ -449,12 +481,18 @@ export interface Workflow {
     name: string;
     /** The description of the workflow. */
     description?: string;
+    /** Whether the workflow is paused. */
+    isPaused?: boolean;
     versions?: WorkflowVersionMeta[];
     /** The tags of the workflow. */
     tags?: WorkflowTag[];
     /** The jobs of the workflow. */
     jobs?: Job[];
 }
+export interface WorkflowUpdateRequest {
+    /** Whether the workflow is paused. */
+    isPaused?: boolean;
+}
 export interface WorkflowConcurrency {
     /**
      * The maximum number of concurrent workflow runs.

package/clients/rest/generated/data-contracts.js

@@ -10,7 +10,7 @@
  * ---------------------------------------------------------------
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebhookWorkerRequestMethod = exports.LogLineOrderByDirection = exports.LogLineOrderByField = exports.LogLineLevel = exports.PullRequestState = exports.StepRunEventSeverity = exports.StepRunEventReason = exports.StepRunStatus = exports.JobRunStatus = exports.WorkflowKind = exports.WorkflowRunStatus = exports.WorkflowRunOrderByDirection = exports.WorkflowRunOrderByField = exports.EventOrderByDirection = exports.EventOrderByField = exports.TenantResource = exports.TenantMemberRole = void 0;
+exports.WebhookWorkerRequestMethod = exports.LogLineOrderByDirection = exports.LogLineOrderByField = exports.LogLineLevel = exports.PullRequestState = exports.StepRunEventSeverity = exports.StepRunEventReason = exports.StepRunStatus = exports.JobRunStatus = exports.WorkflowKind = exports.WorkflowRunStatus = exports.WorkflowRunOrderByDirection = exports.WorkflowRunOrderByField = exports.RateLimitOrderByDirection = exports.RateLimitOrderByField = exports.EventOrderByDirection = exports.EventOrderByField = exports.TenantResource = exports.TenantMemberRole = void 0;
 var TenantMemberRole;
 (function (TenantMemberRole) {
     TenantMemberRole["OWNER"] = "OWNER";
@@ -34,6 +34,17 @@ var EventOrderByDirection;
     EventOrderByDirection["Asc"] = "asc";
     EventOrderByDirection["Desc"] = "desc";
 })(EventOrderByDirection || (exports.EventOrderByDirection = EventOrderByDirection = {}));
+var RateLimitOrderByField;
+(function (RateLimitOrderByField) {
+    RateLimitOrderByField["Key"] = "key";
+    RateLimitOrderByField["Value"] = "value";
+    RateLimitOrderByField["LimitValue"] = "limitValue";
+})(RateLimitOrderByField || (exports.RateLimitOrderByField = RateLimitOrderByField = {}));
+var RateLimitOrderByDirection;
+(function (RateLimitOrderByDirection) {
+    RateLimitOrderByDirection["Asc"] = "asc";
+    RateLimitOrderByDirection["Desc"] = "desc";
+})(RateLimitOrderByDirection || (exports.RateLimitOrderByDirection = RateLimitOrderByDirection = {}));
 var WorkflowRunOrderByField;
 (function (WorkflowRunOrderByField) {
     WorkflowRunOrderByField["CreatedAt"] = "createdAt";

package/clients/worker/worker.js

@@ -83,7 +83,7 @@ class Worker {
     }
     registerWorkflow(initWorkflow) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d;
+            var _a, _b, _c;
             const workflow = Object.assign(Object.assign({}, initWorkflow), { id: this.client.config.namespace + initWorkflow.id });
             try {
                 if (((_a = workflow.concurrency) === null || _a === void 0 ? void 0 : _a.key) && workflow.concurrency.expression) {
@@ -112,7 +112,7 @@ class Worker {
                                 parents: [],
                                 userData: '{}',
                                 retries: workflow.onFailure.retries || 0,
-                                rateLimits: (_d = workflow.onFailure.rate_limits) !== null && _d !== void 0 ? _d : [],
+                                rateLimits: (0, step_1.mapRateLimit)(workflow.onFailure.rate_limits),
                                 workerLabels: {}, // no worker labels for on failure steps
                             },
                         ],
@@ -136,7 +136,7 @@ class Worker {
                             name: workflow.id,
                             description: workflow.description,
                             steps: workflow.steps.map((step) => {
-                                var _a, _b;
+                                var _a;
                                 return ({
                                     readableId: step.name,
                                     action: `${workflow.id}:${step.name}`,
@@ -145,7 +145,7 @@ class Worker {
                                     parents: (_a = step.parents) !== null && _a !== void 0 ? _a : [],
                                     userData: '{}',
                                     retries: step.retries || 0,
-                                    rateLimits: (_b = step.rate_limits) !== null && _b !== void 0 ? _b : [], // Add the missing rateLimits property
+                                    rateLimits: (0, step_1.mapRateLimit)(step.rate_limits),
                                     workerLabels: toPbWorkerLabel(step.worker_labels),
                                 });
                             }),

package/examples/rate-limit/worker.js

@@ -23,10 +23,25 @@ const workflow = {
     },
     steps: [
         {
-            name: 'step1',
+            name: 'dynamic',
+            rate_limits: [
+                {
+                    dynamicKey: 'input.group',
+                    units: 1,
+                    limit: 10,
+                    duration: workflows_1.RateLimitDuration.DAY,
+                },
+            ],
+            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+                console.log('starting step1 with the following input and a dynamic rate limit', ctx.workflowInput());
+                return { step1: 'step1 results!' };
+            }),
+        },
+        {
+            name: 'static',
             rate_limits: [{ key: 'test-limit', units: 1 }],
             run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
-                console.log('starting step1 with the following input', ctx.workflowInput());
+                console.log('starting step1 with the following input and a static rate limit', ctx.workflowInput());
                 return { step1: 'step1 results!' };
             }),
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.13.1",
+  "version": "0.14.0",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [

package/protoc/workflows/workflows.d.ts

@@ -153,8 +153,16 @@ export interface CreateWorkflowStepOpts_WorkerLabelsEntry {
 export interface CreateStepRateLimit {
     /** (required) the key for the rate limit */
     key: string;
-    /** (required) the number of units this step consumes */
-    units: number;
+    /** (optional) the number of units this step consumes */
+    units?: number | undefined;
+    /** (optional) a CEL expression for determining the rate limit key */
+    keyExpr?: string | undefined;
+    /** (optional) a CEL expression for determining the number of units consumed */
+    unitsExpr?: string | undefined;
+    /** (optional) a CEL expression for determining the total amount of rate limit units */
+    limitValuesExpr?: string | undefined;
+    /** (optional) the default rate limit window to use for dynamic rate limits */
+    duration?: RateLimitDuration | undefined;
 }
 /** ListWorkflowsRequest is the request for ListWorkflows. */
 export interface ListWorkflowsRequest {

package/protoc/workflows/workflows.js

@@ -1143,16 +1143,35 @@ exports.CreateWorkflowStepOpts_WorkerLabelsEntry = {
     },
 };
 function createBaseCreateStepRateLimit() {
-    return { key: '', units: 0 };
+    return {
+        key: '',
+        units: undefined,
+        keyExpr: undefined,
+        unitsExpr: undefined,
+        limitValuesExpr: undefined,
+        duration: undefined,
+    };
 }
 exports.CreateStepRateLimit = {
     encode(message, writer = new wire_1.BinaryWriter()) {
         if (message.key !== '') {
             writer.uint32(10).string(message.key);
         }
-        if (message.units !== 0) {
+        if (message.units !== undefined) {
             writer.uint32(16).int32(message.units);
         }
+        if (message.keyExpr !== undefined) {
+            writer.uint32(26).string(message.keyExpr);
+        }
+        if (message.unitsExpr !== undefined) {
+            writer.uint32(34).string(message.unitsExpr);
+        }
+        if (message.limitValuesExpr !== undefined) {
+            writer.uint32(42).string(message.limitValuesExpr);
+        }
+        if (message.duration !== undefined) {
+            writer.uint32(48).int32(message.duration);
+        }
         return writer;
     },
     decode(input, length) {
@@ -1174,6 +1193,30 @@ exports.CreateStepRateLimit = {
                     }
                     message.units = reader.int32();
                     continue;
+                case 3:
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.keyExpr = reader.string();
+                    continue;
+                case 4:
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.unitsExpr = reader.string();
+                    continue;
+                case 5:
+                    if (tag !== 42) {
+                        break;
+                    }
+                    message.limitValuesExpr = reader.string();
+                    continue;
+                case 6:
+                    if (tag !== 48) {
+                        break;
+                    }
+                    message.duration = reader.int32();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1185,7 +1228,13 @@ exports.CreateStepRateLimit = {
     fromJSON(object) {
         return {
             key: isSet(object.key) ? globalThis.String(object.key) : '',
-            units: isSet(object.units) ? globalThis.Number(object.units) : 0,
+            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,
+            limitValuesExpr: isSet(object.limitValuesExpr)
+                ? globalThis.String(object.limitValuesExpr)
+                : undefined,
+            duration: isSet(object.duration) ? rateLimitDurationFromJSON(object.duration) : undefined,
         };
     },
     toJSON(message) {
@@ -1193,19 +1242,35 @@ exports.CreateStepRateLimit = {
         if (message.key !== '') {
             obj.key = message.key;
         }
-        if (message.units !== 0) {
+        if (message.units !== undefined) {
             obj.units = Math.round(message.units);
         }
+        if (message.keyExpr !== undefined) {
+            obj.keyExpr = message.keyExpr;
+        }
+        if (message.unitsExpr !== undefined) {
+            obj.unitsExpr = message.unitsExpr;
+        }
+        if (message.limitValuesExpr !== undefined) {
+            obj.limitValuesExpr = message.limitValuesExpr;
+        }
+        if (message.duration !== undefined) {
+            obj.duration = rateLimitDurationToJSON(message.duration);
+        }
         return obj;
     },
     create(base) {
         return exports.CreateStepRateLimit.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b;
+        var _a, _b, _c, _d, _e, _f;
         const message = createBaseCreateStepRateLimit();
         message.key = (_a = object.key) !== null && _a !== void 0 ? _a : '';
-        message.units = (_b = object.units) !== null && _b !== void 0 ? _b : 0;
+        message.units = (_b = object.units) !== null && _b !== void 0 ? _b : undefined;
+        message.keyExpr = (_c = object.keyExpr) !== null && _c !== void 0 ? _c : undefined;
+        message.unitsExpr = (_d = object.unitsExpr) !== null && _d !== void 0 ? _d : undefined;
+        message.limitValuesExpr = (_e = object.limitValuesExpr) !== null && _e !== void 0 ? _e : undefined;
+        message.duration = (_f = object.duration) !== null && _f !== void 0 ? _f : undefined;
         return message;
     },
 };

package/step.d.ts

@@ -7,16 +7,28 @@ import { HatchetClient } from './clients/hatchet-client';
 import WorkflowRunRef from './util/workflow-run-ref';
 import { Worker } from './clients/worker';
 import { WorkerLabels } from './clients/dispatcher/dispatcher-client';
-import { WorkerLabelComparator } from './protoc/workflows';
+import { CreateStepRateLimit, RateLimitDuration, WorkerLabelComparator } from './protoc/workflows';
 export declare const CreateRateLimitSchema: z.ZodObject<{
-    key: z.ZodString;
-    units: z.ZodNumber;
+    key: z.ZodOptional<z.ZodString>;
+    staticKey: z.ZodOptional<z.ZodString>;
+    dynamicKey: z.ZodOptional<z.ZodString>;
+    units: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
+    limit: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodString]>>;
+    duration: z.ZodOptional<z.ZodNativeEnum<typeof RateLimitDuration>>;
 }, "strip", z.ZodTypeAny, {
-    key: string;
-    units: number;
+    units: string | number;
+    key?: string | undefined;
+    duration?: RateLimitDuration | undefined;
+    limit?: string | number | undefined;
+    staticKey?: string | undefined;
+    dynamicKey?: string | undefined;
 }, {
-    key: string;
-    units: number;
+    units: string | number;
+    key?: string | undefined;
+    duration?: RateLimitDuration | undefined;
+    limit?: string | number | undefined;
+    staticKey?: string | undefined;
+    dynamicKey?: string | undefined;
 }>;
 export declare const DesiredWorkerLabelSchema: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodObject<{
     value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
@@ -40,14 +52,26 @@ export declare const CreateStepSchema: z.ZodObject<{
     timeout: z.ZodOptional<z.ZodString>;
     retries: z.ZodOptional<z.ZodNumber>;
     rate_limits: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        key: z.ZodString;
-        units: z.ZodNumber;
+        key: z.ZodOptional<z.ZodString>;
+        staticKey: z.ZodOptional<z.ZodString>;
+        dynamicKey: z.ZodOptional<z.ZodString>;
+        units: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
+        limit: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodString]>>;
+        duration: z.ZodOptional<z.ZodNativeEnum<typeof RateLimitDuration>>;
     }, "strip", z.ZodTypeAny, {
-        key: string;
-        units: number;
+        units: string | number;
+        key?: string | undefined;
+        duration?: RateLimitDuration | undefined;
+        limit?: string | number | undefined;
+        staticKey?: string | undefined;
+        dynamicKey?: string | undefined;
     }, {
-        key: string;
-        units: number;
+        units: string | number;
+        key?: string | undefined;
+        duration?: RateLimitDuration | undefined;
+        limit?: string | number | undefined;
+        staticKey?: string | undefined;
+        dynamicKey?: string | undefined;
     }>, "many">>;
     worker_labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodObject<{
         value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
@@ -71,8 +95,12 @@ export declare const CreateStepSchema: z.ZodObject<{
     parents?: string[] | undefined;
     retries?: number | undefined;
     rate_limits?: {
-        key: string;
-        units: number;
+        units: string | number;
+        key?: string | undefined;
+        duration?: RateLimitDuration | undefined;
+        limit?: string | number | undefined;
+        staticKey?: string | undefined;
+        dynamicKey?: string | undefined;
     }[] | undefined;
     worker_labels?: Record<string, string | number | {
         value: string | number;
@@ -86,8 +114,12 @@ export declare const CreateStepSchema: z.ZodObject<{
     parents?: string[] | undefined;
     retries?: number | undefined;
     rate_limits?: {
-        key: string;
-        units: number;
+        units: string | number;
+        key?: string | undefined;
+        duration?: RateLimitDuration | undefined;
+        limit?: string | number | undefined;
+        staticKey?: string | undefined;
+        dynamicKey?: string | undefined;
     }[] | undefined;
     worker_labels?: Record<string, string | number | {
         value: string | number;
@@ -178,4 +210,5 @@ export type StepRunFunction<T, K> = (ctx: Context<T, K>) => Promise<NextStep | v
 export interface CreateStep<T, K> extends z.infer<typeof CreateStepSchema> {
     run: StepRunFunction<T, K>;
 }
+export declare function mapRateLimit(limits: CreateStep<any, any>['rate_limits']): CreateStepRateLimit[];
 export {};

package/step.js

@@ -36,6 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Context = exports.ContextWorker = exports.CreateStepSchema = exports.DesiredWorkerLabelSchema = exports.CreateRateLimitSchema = void 0;
+exports.mapRateLimit = mapRateLimit;
 /* eslint-disable max-classes-per-file */
 const hatchet_error_1 = __importDefault(require("./util/errors/hatchet-error"));
 const z = __importStar(require("zod"));
@@ -44,8 +45,12 @@ const logger_1 = require("./util/logger");
 const parse_1 = require("./util/parse");
 const workflows_1 = require("./protoc/workflows");
 exports.CreateRateLimitSchema = z.object({
-    key: z.string(),
-    units: z.number().min(1),
+    key: z.string().optional(),
+    staticKey: z.string().optional(),
+    dynamicKey: z.string().optional(),
+    units: z.union([z.number().min(1), z.string()]),
+    limit: z.union([z.number().min(1), z.string()]).optional(),
+    duration: z.nativeEnum(workflows_1.RateLimitDuration).optional(),
 });
 exports.DesiredWorkerLabelSchema = z
     .union([
@@ -273,3 +278,68 @@ class Context {
     }
 }
 exports.Context = Context;
+function mapRateLimit(limits) {
+    if (!limits)
+        return [];
+    return limits.map((l) => {
+        let key = l.staticKey;
+        const keyExpression = l.dynamicKey;
+        if (l.key !== undefined) {
+            // eslint-disable-next-line no-console
+            console.warn('key is deprecated and will be removed in a future release, please use staticKey instead');
+            key = l.key;
+        }
+        if (keyExpression !== undefined) {
+            if (key !== undefined) {
+                throw new Error('Cannot have both static key and dynamic key set');
+            }
+            key = keyExpression;
+            if (!validateCelExpression(keyExpression)) {
+                throw new Error(`Invalid CEL expression: ${keyExpression}`);
+            }
+        }
+        if (key === undefined) {
+            throw new Error(`Invalid key`);
+        }
+        let units;
+        let unitsExpression;
+        if (typeof l.units === 'number') {
+            units = l.units;
+        }
+        else {
+            if (!validateCelExpression(l.units)) {
+                throw new Error(`Invalid CEL expression: ${l.units}`);
+            }
+            unitsExpression = l.units;
+        }
+        let limitExpression;
+        if (l.limit !== undefined) {
+            if (typeof l.limit === 'number') {
+                limitExpression = `${l.limit}`;
+            }
+            else {
+                if (!validateCelExpression(l.limit)) {
+                    throw new Error(`Invalid CEL expression: ${l.limit}`);
+                }
+                limitExpression = l.limit;
+            }
+        }
+        if (keyExpression !== undefined && limitExpression === undefined) {
+            throw new Error('CEL based keys requires limit to be set');
+        }
+        return {
+            key,
+            keyExpr: keyExpression,
+            units,
+            unitsExpr: unitsExpression,
+            limitValuesExpr: limitExpression,
+            duration: l.duration,
+        };
+    });
+}
+// Helper function to validate CEL expressions
+function validateCelExpression(expr) {
+    // This is a placeholder. In a real implementation, you'd need to use a CEL parser or validator.
+    // For now, we'll just return true to mimic the behavior.
+    return true;
+}

package/workflow.d.ts

@@ -7,14 +7,26 @@ declare const StepsSchema: z.ZodArray<z.ZodObject<{
     timeout: z.ZodOptional<z.ZodString>;
     retries: z.ZodOptional<z.ZodNumber>;
     rate_limits: z.ZodOptional<z.ZodArray<z.ZodObject<{
-        key: z.ZodString;
-        units: z.ZodNumber;
+        key: z.ZodOptional<z.ZodString>;
+        staticKey: z.ZodOptional<z.ZodString>;
+        dynamicKey: z.ZodOptional<z.ZodString>;
+        units: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
+        limit: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodString]>>;
+        duration: z.ZodOptional<z.ZodNativeEnum<typeof import("./protoc/workflows").RateLimitDuration>>;
     }, "strip", z.ZodTypeAny, {
-        key: string;
-        units: number;
+        units: string | number;
+        key?: string | undefined;
+        duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+        limit?: string | number | undefined;
+        staticKey?: string | undefined;
+        dynamicKey?: string | undefined;
     }, {
-        key: string;
-        units: number;
+        units: string | number;
+        key?: string | undefined;
+        duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+        limit?: string | number | undefined;
+        staticKey?: string | undefined;
+        dynamicKey?: string | undefined;
     }>, "many">>;
     worker_labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodObject<{
         value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
@@ -38,8 +50,12 @@ declare const StepsSchema: z.ZodArray<z.ZodObject<{
     parents?: string[] | undefined;
     retries?: number | undefined;
     rate_limits?: {
-        key: string;
-        units: number;
+        units: string | number;
+        key?: string | undefined;
+        duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+        limit?: string | number | undefined;
+        staticKey?: string | undefined;
+        dynamicKey?: string | undefined;
     }[] | undefined;
     worker_labels?: Record<string, string | number | {
         value: string | number;
@@ -53,8 +69,12 @@ declare const StepsSchema: z.ZodArray<z.ZodObject<{
     parents?: string[] | undefined;
     retries?: number | undefined;
     rate_limits?: {
-        key: string;
-        units: number;
+        units: string | number;
+        key?: string | undefined;
+        duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+        limit?: string | number | undefined;
+        staticKey?: string | undefined;
+        dynamicKey?: string | undefined;
     }[] | undefined;
     worker_labels?: Record<string, string | number | {
         value: string | number;
@@ -121,14 +141,26 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         timeout: z.ZodOptional<z.ZodString>;
         retries: z.ZodOptional<z.ZodNumber>;
         rate_limits: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            key: z.ZodString;
-            units: z.ZodNumber;
+            key: z.ZodOptional<z.ZodString>;
+            staticKey: z.ZodOptional<z.ZodString>;
+            dynamicKey: z.ZodOptional<z.ZodString>;
+            units: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
+            limit: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodString]>>;
+            duration: z.ZodOptional<z.ZodNativeEnum<typeof import("./protoc/workflows").RateLimitDuration>>;
         }, "strip", z.ZodTypeAny, {
-            key: string;
-            units: number;
+            units: string | number;
+            key?: string | undefined;
+            duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+            limit?: string | number | undefined;
+            staticKey?: string | undefined;
+            dynamicKey?: string | undefined;
         }, {
-            key: string;
-            units: number;
+            units: string | number;
+            key?: string | undefined;
+            duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+            limit?: string | number | undefined;
+            staticKey?: string | undefined;
+            dynamicKey?: string | undefined;
         }>, "many">>;
         worker_labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodObject<{
             value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
@@ -152,8 +184,12 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         parents?: string[] | undefined;
         retries?: number | undefined;
         rate_limits?: {
-            key: string;
-            units: number;
+            units: string | number;
+            key?: string | undefined;
+            duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+            limit?: string | number | undefined;
+            staticKey?: string | undefined;
+            dynamicKey?: string | undefined;
         }[] | undefined;
         worker_labels?: Record<string, string | number | {
             value: string | number;
@@ -167,8 +203,12 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         parents?: string[] | undefined;
         retries?: number | undefined;
         rate_limits?: {
-            key: string;
-            units: number;
+            units: string | number;
+            key?: string | undefined;
+            duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+            limit?: string | number | undefined;
+            staticKey?: string | undefined;
+            dynamicKey?: string | undefined;
         }[] | undefined;
         worker_labels?: Record<string, string | number | {
             value: string | number;
@@ -183,14 +223,26 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         timeout: z.ZodOptional<z.ZodString>;
         retries: z.ZodOptional<z.ZodNumber>;
         rate_limits: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            key: z.ZodString;
-            units: z.ZodNumber;
+            key: z.ZodOptional<z.ZodString>;
+            staticKey: z.ZodOptional<z.ZodString>;
+            dynamicKey: z.ZodOptional<z.ZodString>;
+            units: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
+            limit: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodString]>>;
+            duration: z.ZodOptional<z.ZodNativeEnum<typeof import("./protoc/workflows").RateLimitDuration>>;
         }, "strip", z.ZodTypeAny, {
-            key: string;
-            units: number;
+            units: string | number;
+            key?: string | undefined;
+            duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+            limit?: string | number | undefined;
+            staticKey?: string | undefined;
+            dynamicKey?: string | undefined;
         }, {
-            key: string;
-            units: number;
+            units: string | number;
+            key?: string | undefined;
+            duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+            limit?: string | number | undefined;
+            staticKey?: string | undefined;
+            dynamicKey?: string | undefined;
         }>, "many">>;
         worker_labels: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodLazy<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodObject<{
             value: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
@@ -214,8 +266,12 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         parents?: string[] | undefined;
         retries?: number | undefined;
         rate_limits?: {
-            key: string;
-            units: number;
+            units: string | number;
+            key?: string | undefined;
+            duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+            limit?: string | number | undefined;
+            staticKey?: string | undefined;
+            dynamicKey?: string | undefined;
         }[] | undefined;
         worker_labels?: Record<string, string | number | {
             value: string | number;
@@ -229,8 +285,12 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         parents?: string[] | undefined;
         retries?: number | undefined;
         rate_limits?: {
-            key: string;
-            units: number;
+            units: string | number;
+            key?: string | undefined;
+            duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+            limit?: string | number | undefined;
+            staticKey?: string | undefined;
+            dynamicKey?: string | undefined;
         }[] | undefined;
         worker_labels?: Record<string, string | number | {
             value: string | number;
@@ -247,8 +307,12 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         parents?: string[] | undefined;
         retries?: number | undefined;
         rate_limits?: {
-            key: string;
-            units: number;
+            units: string | number;
+            key?: string | undefined;
+            duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+            limit?: string | number | undefined;
+            staticKey?: string | undefined;
+            dynamicKey?: string | undefined;
         }[] | undefined;
         worker_labels?: Record<string, string | number | {
             value: string | number;
@@ -275,8 +339,12 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         parents?: string[] | undefined;
         retries?: number | undefined;
         rate_limits?: {
-            key: string;
-            units: number;
+            units: string | number;
+            key?: string | undefined;
+            duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+            limit?: string | number | undefined;
+            staticKey?: string | undefined;
+            dynamicKey?: string | undefined;
         }[] | undefined;
         worker_labels?: Record<string, string | number | {
             value: string | number;
@@ -293,8 +361,12 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         parents?: string[] | undefined;
         retries?: number | undefined;
         rate_limits?: {
-            key: string;
-            units: number;
+            units: string | number;
+            key?: string | undefined;
+            duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+            limit?: string | number | undefined;
+            staticKey?: string | undefined;
+            dynamicKey?: string | undefined;
         }[] | undefined;
         worker_labels?: Record<string, string | number | {
             value: string | number;
@@ -321,8 +393,12 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         parents?: string[] | undefined;
         retries?: number | undefined;
         rate_limits?: {
-            key: string;
-            units: number;
+            units: string | number;
+            key?: string | undefined;
+            duration?: import("./protoc/workflows").RateLimitDuration | undefined;
+            limit?: string | number | undefined;
+            staticKey?: string | undefined;
+            dynamicKey?: string | undefined;
         }[] | undefined;
         worker_labels?: Record<string, string | number | {
             value: string | number;