@hatchet-dev/typescript-sdk 0.3.0 → 0.4.0

package/clients/admin/admin-client.d.ts

@@ -1,5 +1,5 @@
 import { Channel, ClientFactory } from 'nice-grpc';
-import { CreateWorkflowVersionOpts, WorkflowServiceClient } from '../../protoc/workflows';
+import { CreateWorkflowVersionOpts, RateLimitDuration, WorkflowServiceClient } from '../../protoc/workflows';
 import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
 import { Api } from '../rest';
@@ -32,6 +32,7 @@ export declare class AdminClient {
      * @param workflow a workflow definition to create
      */
     put_workflow(workflow: CreateWorkflowVersionOpts): Promise<void>;
+    put_rate_limit(key: string, limit: number, duration?: RateLimitDuration): Promise<void>;
     /**
      * Run a new instance of a workflow with the given input. This will create a new workflow run and return the ID of the
      * new run.

package/clients/admin/admin-client.js

@@ -56,6 +56,22 @@ class AdminClient {
             }
         });
     }
+    put_rate_limit(key, limit, duration = workflows_1.RateLimitDuration.SECOND) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                yield (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () {
+                    return this.client.putRateLimit({
+                        key,
+                        limit,
+                        duration,
+                    });
+                }), this.logger);
+            }
+            catch (e) {
+                throw new hatchet_error_1.default(e.message);
+            }
+        });
+    }
     /**
      * Run a new instance of a workflow with the given input. This will create a new workflow run and return the ID of the
      * new run.

package/clients/worker/worker.d.ts

@@ -24,6 +24,7 @@ export declare class Worker {
         maxRuns?: number;
     });
     registerWorkflow(initWorkflow: Workflow): Promise<void>;
+    register_workflow(initWorkflow: Workflow): Promise<void>;
     registerAction<T, K>(actionId: string, action: StepRunFunction<T, K>): void;
     handleStartStepRun(action: Action): void;
     handleStartGroupKeyRun(action: Action): void;

package/clients/worker/worker.js

@@ -42,7 +42,13 @@ class Worker {
         this.handle_kill = options.handleKill === undefined ? true : options.handleKill;
         this.logger = new logger_1.Logger(`Worker/${this.name}`, this.client.config.log_level);
     }
+    // @deprecated
     registerWorkflow(initWorkflow) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.register_workflow(initWorkflow);
+        });
+    }
+    register_workflow(initWorkflow) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const workflow = Object.assign(Object.assign({}, initWorkflow), { id: this.client.config.namespace + initWorkflow.id });
@@ -69,7 +75,7 @@ class Worker {
                             timeout: workflow.timeout || '60s',
                             description: workflow.description,
                             steps: workflow.steps.map((step) => {
-                                var _a;
+                                var _a, _b;
                                 return ({
                                     readableId: step.name,
                                     action: `${workflow.id}:${step.name}`,
@@ -78,6 +84,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
                                 });
                             }),
                         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -34,6 +34,10 @@
     "example:event": "npm run exec -- ./examples/example-event.ts",
     "example:event-listen": "npm run exec -- ./examples/example-event-with-results.ts",
     "worker:namespaced": "npm run exec -- ./examples/namespaced-worker.ts",
+
+    "worker:rate": "npm run exec -- ./examples/rate-limit/worker.ts",
+    "example:rate": "npm run exec -- ./examples/rate-limit/events.ts",
+
     "worker:fanout": "npm run exec -- ./examples/fanout-worker.ts",
     "worker:simple": "npm run exec -- ./examples/simple-worker.ts",
     "manual:trigger": "npm run exec -- ./examples/manual-trigger.ts",

package/protoc/workflows/workflows.d.ts

@@ -10,6 +10,14 @@ export declare enum ConcurrencyLimitStrategy {
 }
 export declare function concurrencyLimitStrategyFromJSON(object: any): ConcurrencyLimitStrategy;
 export declare function concurrencyLimitStrategyToJSON(object: ConcurrencyLimitStrategy): string;
+export declare enum RateLimitDuration {
+    SECOND = 0,
+    MINUTE = 1,
+    HOUR = 2,
+    UNRECOGNIZED = -1
+}
+export declare function rateLimitDurationFromJSON(object: any): RateLimitDuration;
+export declare function rateLimitDurationToJSON(object: RateLimitDuration): string;
 export interface PutWorkflowRequest {
     opts: CreateWorkflowVersionOpts | undefined;
 }
@@ -69,6 +77,14 @@ export interface CreateWorkflowStepOpts {
     userData: string;
     /** (optional) the number of retries for the step, default 0 */
     retries: number;
+    /** (optional) the rate limits for the step */
+    rateLimits: CreateStepRateLimit[];
+}
+export interface CreateStepRateLimit {
+    /** (required) the key for the rate limit */
+    key: string;
+    /** (required) the number of units this step consumes */
+    units: number;
 }
 /** ListWorkflowsRequest is the request for ListWorkflows. */
 export interface ListWorkflowsRequest {
@@ -136,6 +152,16 @@ export interface TriggerWorkflowRequest {
 export interface TriggerWorkflowResponse {
     workflowRunId: string;
 }
+export interface PutRateLimitRequest {
+    /** (required) the global key for the rate limit */
+    key: string;
+    /** (required) the max limit for the rate limit (per unit of time) */
+    limit: number;
+    /** (required) the duration of time for the rate limit (second|minute|hour) */
+    duration: RateLimitDuration;
+}
+export interface PutRateLimitResponse {
+}
 export declare const PutWorkflowRequest: {
     encode(message: PutWorkflowRequest, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): PutWorkflowRequest;
@@ -176,6 +202,14 @@ export declare const CreateWorkflowStepOpts: {
     create(base?: DeepPartial<CreateWorkflowStepOpts>): CreateWorkflowStepOpts;
     fromPartial(object: DeepPartial<CreateWorkflowStepOpts>): CreateWorkflowStepOpts;
 };
+export declare const CreateStepRateLimit: {
+    encode(message: CreateStepRateLimit, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): CreateStepRateLimit;
+    fromJSON(object: any): CreateStepRateLimit;
+    toJSON(message: CreateStepRateLimit): unknown;
+    create(base?: DeepPartial<CreateStepRateLimit>): CreateStepRateLimit;
+    fromPartial(object: DeepPartial<CreateStepRateLimit>): CreateStepRateLimit;
+};
 export declare const ListWorkflowsRequest: {
     encode(_: ListWorkflowsRequest, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): ListWorkflowsRequest;
@@ -232,6 +266,22 @@ export declare const TriggerWorkflowResponse: {
     create(base?: DeepPartial<TriggerWorkflowResponse>): TriggerWorkflowResponse;
     fromPartial(object: DeepPartial<TriggerWorkflowResponse>): TriggerWorkflowResponse;
 };
+export declare const PutRateLimitRequest: {
+    encode(message: PutRateLimitRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PutRateLimitRequest;
+    fromJSON(object: any): PutRateLimitRequest;
+    toJSON(message: PutRateLimitRequest): unknown;
+    create(base?: DeepPartial<PutRateLimitRequest>): PutRateLimitRequest;
+    fromPartial(object: DeepPartial<PutRateLimitRequest>): PutRateLimitRequest;
+};
+export declare const PutRateLimitResponse: {
+    encode(_: PutRateLimitResponse, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): PutRateLimitResponse;
+    fromJSON(_: any): PutRateLimitResponse;
+    toJSON(_: PutRateLimitResponse): unknown;
+    create(base?: DeepPartial<PutRateLimitResponse>): PutRateLimitResponse;
+    fromPartial(_: DeepPartial<PutRateLimitResponse>): PutRateLimitResponse;
+};
 /** WorkflowService represents a set of RPCs for managing workflows. */
 export type WorkflowServiceDefinition = typeof WorkflowServiceDefinition;
 export declare const WorkflowServiceDefinition: {
@@ -304,17 +354,41 @@ export declare const WorkflowServiceDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly putRateLimit: {
+            readonly name: "PutRateLimit";
+            readonly requestType: {
+                encode(message: PutRateLimitRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): PutRateLimitRequest;
+                fromJSON(object: any): PutRateLimitRequest;
+                toJSON(message: PutRateLimitRequest): unknown;
+                create(base?: DeepPartial<PutRateLimitRequest>): PutRateLimitRequest;
+                fromPartial(object: DeepPartial<PutRateLimitRequest>): PutRateLimitRequest;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                encode(_: PutRateLimitResponse, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): PutRateLimitResponse;
+                fromJSON(_: any): PutRateLimitResponse;
+                toJSON(_: PutRateLimitResponse): unknown;
+                create(base?: DeepPartial<PutRateLimitResponse>): PutRateLimitResponse;
+                fromPartial(_: DeepPartial<PutRateLimitResponse>): PutRateLimitResponse;
+            };
+            readonly responseStream: false;
+            readonly options: {};
+        };
     };
 };
 export interface WorkflowServiceImplementation<CallContextExt = {}> {
     putWorkflow(request: PutWorkflowRequest, context: CallContext & CallContextExt): Promise<DeepPartial<WorkflowVersion>>;
     scheduleWorkflow(request: ScheduleWorkflowRequest, context: CallContext & CallContextExt): Promise<DeepPartial<WorkflowVersion>>;
     triggerWorkflow(request: TriggerWorkflowRequest, context: CallContext & CallContextExt): Promise<DeepPartial<TriggerWorkflowResponse>>;
+    putRateLimit(request: PutRateLimitRequest, context: CallContext & CallContextExt): Promise<DeepPartial<PutRateLimitResponse>>;
 }
 export interface WorkflowServiceClient<CallOptionsExt = {}> {
     putWorkflow(request: DeepPartial<PutWorkflowRequest>, options?: CallOptions & CallOptionsExt): Promise<WorkflowVersion>;
     scheduleWorkflow(request: DeepPartial<ScheduleWorkflowRequest>, options?: CallOptions & CallOptionsExt): Promise<WorkflowVersion>;
     triggerWorkflow(request: DeepPartial<TriggerWorkflowRequest>, options?: CallOptions & CallOptionsExt): Promise<TriggerWorkflowResponse>;
+    putRateLimit(request: DeepPartial<PutRateLimitRequest>, options?: CallOptions & CallOptionsExt): Promise<PutRateLimitResponse>;
 }
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
 export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {

package/protoc/workflows/workflows.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowServiceDefinition = exports.TriggerWorkflowResponse = exports.TriggerWorkflowRequest = exports.WorkflowTriggerCronRef = exports.WorkflowTriggerEventRef = exports.WorkflowVersion = exports.ScheduleWorkflowRequest = exports.ListWorkflowsRequest = exports.CreateWorkflowStepOpts = exports.CreateWorkflowJobOpts = exports.WorkflowConcurrencyOpts = exports.CreateWorkflowVersionOpts = exports.PutWorkflowRequest = exports.concurrencyLimitStrategyToJSON = exports.concurrencyLimitStrategyFromJSON = exports.ConcurrencyLimitStrategy = exports.protobufPackage = void 0;
+exports.WorkflowServiceDefinition = exports.PutRateLimitResponse = exports.PutRateLimitRequest = exports.TriggerWorkflowResponse = exports.TriggerWorkflowRequest = exports.WorkflowTriggerCronRef = exports.WorkflowTriggerEventRef = exports.WorkflowVersion = exports.ScheduleWorkflowRequest = exports.ListWorkflowsRequest = exports.CreateStepRateLimit = exports.CreateWorkflowStepOpts = exports.CreateWorkflowJobOpts = exports.WorkflowConcurrencyOpts = exports.CreateWorkflowVersionOpts = exports.PutWorkflowRequest = exports.rateLimitDurationToJSON = exports.rateLimitDurationFromJSON = exports.RateLimitDuration = exports.concurrencyLimitStrategyToJSON = exports.concurrencyLimitStrategyFromJSON = exports.ConcurrencyLimitStrategy = exports.protobufPackage = void 0;
 const _m0 = __importStar(require("protobufjs/minimal"));
 const timestamp_1 = require("../google/protobuf/timestamp");
 exports.protobufPackage = '';
@@ -72,6 +72,45 @@ function concurrencyLimitStrategyToJSON(object) {
     }
 }
 exports.concurrencyLimitStrategyToJSON = concurrencyLimitStrategyToJSON;
+var RateLimitDuration;
+(function (RateLimitDuration) {
+    RateLimitDuration[RateLimitDuration["SECOND"] = 0] = "SECOND";
+    RateLimitDuration[RateLimitDuration["MINUTE"] = 1] = "MINUTE";
+    RateLimitDuration[RateLimitDuration["HOUR"] = 2] = "HOUR";
+    RateLimitDuration[RateLimitDuration["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(RateLimitDuration || (exports.RateLimitDuration = RateLimitDuration = {}));
+function rateLimitDurationFromJSON(object) {
+    switch (object) {
+        case 0:
+        case 'SECOND':
+            return RateLimitDuration.SECOND;
+        case 1:
+        case 'MINUTE':
+            return RateLimitDuration.MINUTE;
+        case 2:
+        case 'HOUR':
+            return RateLimitDuration.HOUR;
+        case -1:
+        case 'UNRECOGNIZED':
+        default:
+            return RateLimitDuration.UNRECOGNIZED;
+    }
+}
+exports.rateLimitDurationFromJSON = rateLimitDurationFromJSON;
+function rateLimitDurationToJSON(object) {
+    switch (object) {
+        case RateLimitDuration.SECOND:
+            return 'SECOND';
+        case RateLimitDuration.MINUTE:
+            return 'MINUTE';
+        case RateLimitDuration.HOUR:
+            return 'HOUR';
+        case RateLimitDuration.UNRECOGNIZED:
+        default:
+            return 'UNRECOGNIZED';
+    }
+}
+exports.rateLimitDurationToJSON = rateLimitDurationToJSON;
 function createBasePutWorkflowRequest() {
     return { opts: undefined };
 }
@@ -508,6 +547,7 @@ function createBaseCreateWorkflowStepOpts() {
         parents: [],
         userData: '',
         retries: 0,
+        rateLimits: [],
     };
 }
 exports.CreateWorkflowStepOpts = {
@@ -533,6 +573,9 @@ exports.CreateWorkflowStepOpts = {
         if (message.retries !== 0) {
             writer.uint32(56).int32(message.retries);
         }
+        for (const v of message.rateLimits) {
+            exports.CreateStepRateLimit.encode(v, writer.uint32(66).fork()).ldelim();
+        }
         return writer;
     },
     decode(input, length) {
@@ -584,6 +627,12 @@ exports.CreateWorkflowStepOpts = {
                     }
                     message.retries = reader.int32();
                     continue;
+                case 8:
+                    if (tag !== 66) {
+                        break;
+                    }
+                    message.rateLimits.push(exports.CreateStepRateLimit.decode(reader, reader.uint32()));
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -603,10 +652,13 @@ exports.CreateWorkflowStepOpts = {
                 : [],
             userData: isSet(object.userData) ? globalThis.String(object.userData) : '',
             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))
+                : [],
         };
     },
     toJSON(message) {
-        var _a;
+        var _a, _b;
         const obj = {};
         if (message.readableId !== '') {
             obj.readableId = message.readableId;
@@ -629,13 +681,16 @@ exports.CreateWorkflowStepOpts = {
         if (message.retries !== 0) {
             obj.retries = Math.round(message.retries);
         }
+        if ((_b = message.rateLimits) === null || _b === void 0 ? void 0 : _b.length) {
+            obj.rateLimits = message.rateLimits.map((e) => exports.CreateStepRateLimit.toJSON(e));
+        }
         return obj;
     },
     create(base) {
         return exports.CreateWorkflowStepOpts.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
         const message = createBaseCreateWorkflowStepOpts();
         message.readableId = (_a = object.readableId) !== null && _a !== void 0 ? _a : '';
         message.action = (_b = object.action) !== null && _b !== void 0 ? _b : '';
@@ -644,6 +699,74 @@ exports.CreateWorkflowStepOpts = {
         message.parents = ((_e = object.parents) === null || _e === void 0 ? void 0 : _e.map((e) => e)) || [];
         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))) || [];
+        return message;
+    },
+};
+function createBaseCreateStepRateLimit() {
+    return { key: '', units: 0 };
+}
+exports.CreateStepRateLimit = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.key !== '') {
+            writer.uint32(10).string(message.key);
+        }
+        if (message.units !== 0) {
+            writer.uint32(16).int32(message.units);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseCreateStepRateLimit();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.key = reader.string();
+                    continue;
+                case 2:
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.units = reader.int32();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            key: isSet(object.key) ? globalThis.String(object.key) : '',
+            units: isSet(object.units) ? globalThis.Number(object.units) : 0,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.key !== '') {
+            obj.key = message.key;
+        }
+        if (message.units !== 0) {
+            obj.units = Math.round(message.units);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.CreateStepRateLimit.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b;
+        const message = createBaseCreateStepRateLimit();
+        message.key = (_a = object.key) !== null && _a !== void 0 ? _a : '';
+        message.units = (_b = object.units) !== null && _b !== void 0 ? _b : 0;
         return message;
     },
 };
@@ -1283,6 +1406,124 @@ exports.TriggerWorkflowResponse = {
         return message;
     },
 };
+function createBasePutRateLimitRequest() {
+    return { key: '', limit: 0, duration: 0 };
+}
+exports.PutRateLimitRequest = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.key !== '') {
+            writer.uint32(10).string(message.key);
+        }
+        if (message.limit !== 0) {
+            writer.uint32(16).int32(message.limit);
+        }
+        if (message.duration !== 0) {
+            writer.uint32(24).int32(message.duration);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBasePutRateLimitRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.key = reader.string();
+                    continue;
+                case 2:
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.limit = reader.int32();
+                    continue;
+                case 3:
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.duration = reader.int32();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            key: isSet(object.key) ? globalThis.String(object.key) : '',
+            limit: isSet(object.limit) ? globalThis.Number(object.limit) : 0,
+            duration: isSet(object.duration) ? rateLimitDurationFromJSON(object.duration) : 0,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.key !== '') {
+            obj.key = message.key;
+        }
+        if (message.limit !== 0) {
+            obj.limit = Math.round(message.limit);
+        }
+        if (message.duration !== 0) {
+            obj.duration = rateLimitDurationToJSON(message.duration);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.PutRateLimitRequest.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b, _c;
+        const message = createBasePutRateLimitRequest();
+        message.key = (_a = object.key) !== null && _a !== void 0 ? _a : '';
+        message.limit = (_b = object.limit) !== null && _b !== void 0 ? _b : 0;
+        message.duration = (_c = object.duration) !== null && _c !== void 0 ? _c : 0;
+        return message;
+    },
+};
+function createBasePutRateLimitResponse() {
+    return {};
+}
+exports.PutRateLimitResponse = {
+    encode(_, writer = _m0.Writer.create()) {
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBasePutRateLimitResponse();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(_) {
+        return {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.PutRateLimitResponse.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(_) {
+        const message = createBasePutRateLimitResponse();
+        return message;
+    },
+};
 exports.WorkflowServiceDefinition = {
     name: 'WorkflowService',
     fullName: 'WorkflowService',
@@ -1311,6 +1552,14 @@ exports.WorkflowServiceDefinition = {
             responseStream: false,
             options: {},
         },
+        putRateLimit: {
+            name: 'PutRateLimit',
+            requestType: exports.PutRateLimitRequest,
+            requestStream: false,
+            responseType: exports.PutRateLimitResponse,
+            responseStream: false,
+            options: {},
+        },
     },
 };
 function toTimestamp(date) {

package/step.d.ts

@@ -4,21 +4,49 @@ import { LogLevel } from './clients/event/event-client';
 import { Logger } from './util/logger';
 import { HatchetClient } from './clients/hatchet-client';
 import { RunEventType } from './clients/listener/listener-client';
+export declare const CreateRateLimitSchema: z.ZodObject<{
+    key: z.ZodString;
+    units: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    key: string;
+    units: number;
+}, {
+    key: string;
+    units: number;
+}>;
 export declare const CreateStepSchema: z.ZodObject<{
     name: z.ZodString;
     parents: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     timeout: z.ZodOptional<z.ZodString>;
     retries: z.ZodOptional<z.ZodNumber>;
+    rate_limits: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        units: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        key: string;
+        units: number;
+    }, {
+        key: string;
+        units: number;
+    }>, "many">>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     parents?: string[] | undefined;
     timeout?: string | undefined;
     retries?: number | undefined;
+    rate_limits?: {
+        key: string;
+        units: number;
+    }[] | undefined;
 }, {
     name: string;
     parents?: string[] | undefined;
     timeout?: string | undefined;
     retries?: number | undefined;
+    rate_limits?: {
+        key: string;
+        units: number;
+    }[] | undefined;
 }>;
 type JSONPrimitive = string | number | boolean | null | Array<JSONPrimitive>;
 export type NextStep = {

package/step.js

@@ -42,7 +42,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Context = exports.CreateStepSchema = void 0;
+exports.Context = exports.CreateStepSchema = exports.CreateRateLimitSchema = void 0;
 /* eslint-disable max-classes-per-file */
 const hatchet_error_1 = __importDefault(require("./util/errors/hatchet-error"));
 const z = __importStar(require("zod"));
@@ -50,11 +50,16 @@ const workflow_1 = require("./workflow");
 const logger_1 = require("./util/logger");
 const parse_1 = require("./util/parse");
 const listener_client_1 = require("./clients/listener/listener-client");
+exports.CreateRateLimitSchema = z.object({
+    key: z.string(),
+    units: z.number().min(1),
+});
 exports.CreateStepSchema = z.object({
     name: z.string(),
     parents: z.array(z.string()).optional(),
     timeout: workflow_1.HatchetTimeoutSchema.optional(),
     retries: z.number().optional(),
+    rate_limits: z.array(exports.CreateRateLimitSchema).optional(),
 });
 class ChildWorkflowRef {
     constructor(workflowRunId, client) {

package/workflow.d.ts

@@ -6,16 +6,34 @@ declare const StepsSchema: z.ZodArray<z.ZodObject<{
     parents: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     timeout: z.ZodOptional<z.ZodString>;
     retries: z.ZodOptional<z.ZodNumber>;
+    rate_limits: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        units: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        key: string;
+        units: number;
+    }, {
+        key: string;
+        units: number;
+    }>, "many">>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     parents?: string[] | undefined;
     timeout?: string | undefined;
     retries?: number | undefined;
+    rate_limits?: {
+        key: string;
+        units: number;
+    }[] | undefined;
 }, {
     name: string;
     parents?: string[] | undefined;
     timeout?: string | undefined;
     retries?: number | undefined;
+    rate_limits?: {
+        key: string;
+        units: number;
+    }[] | undefined;
 }>, "many">;
 export type Steps = z.infer<typeof StepsSchema>;
 export declare const ConcurrencyLimitStrategy: typeof PbConcurrencyLimitStrategy;
@@ -63,16 +81,34 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         parents: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
         timeout: z.ZodOptional<z.ZodString>;
         retries: z.ZodOptional<z.ZodNumber>;
+        rate_limits: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            units: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            key: string;
+            units: number;
+        }, {
+            key: string;
+            units: number;
+        }>, "many">>;
     }, "strip", z.ZodTypeAny, {
         name: string;
         parents?: string[] | undefined;
         timeout?: string | undefined;
         retries?: number | undefined;
+        rate_limits?: {
+            key: string;
+            units: number;
+        }[] | undefined;
     }, {
         name: string;
         parents?: string[] | undefined;
         timeout?: string | undefined;
         retries?: number | undefined;
+        rate_limits?: {
+            key: string;
+            units: number;
+        }[] | undefined;
     }>, "many">;
 }, "strip", z.ZodTypeAny, {
     description: string;
@@ -81,6 +117,10 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         parents?: string[] | undefined;
         timeout?: string | undefined;
         retries?: number | undefined;
+        rate_limits?: {
+            key: string;
+            units: number;
+        }[] | undefined;
     }[];
     id: string;
     on: {
@@ -100,6 +140,10 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         parents?: string[] | undefined;
         timeout?: string | undefined;
         retries?: number | undefined;
+        rate_limits?: {
+            key: string;
+            units: number;
+        }[] | undefined;
     }[];
     id: string;
     on: {