@hatchet-dev/typescript-sdk 0.10.1 → 0.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/clients/admin/admin-client.d.ts +1 -0
  2. package/clients/dispatcher/dispatcher-client.d.ts +3 -0
  3. package/clients/dispatcher/dispatcher-client.js +20 -1
  4. package/clients/hatchet-client/hatchet-client.d.ts +2 -2
  5. package/clients/hatchet-client/hatchet-client.js +11 -4
  6. package/clients/listener/listener-client.d.ts +10 -4
  7. package/clients/listener/listener-client.js +45 -13
  8. package/clients/worker/handler.d.ts +4 -12
  9. package/clients/worker/handler.js +21 -12
  10. package/clients/worker/worker.d.ts +12 -0
  11. package/clients/worker/worker.js +54 -2
  12. package/examples/affinity-workers.d.ts +1 -0
  13. package/examples/affinity-workers.js +93 -0
  14. package/examples/api.d.ts +1 -0
  15. package/examples/api.js +61 -0
  16. package/examples/concurrency/cancel-in-progress/concurrency-event.d.ts +1 -0
  17. package/examples/concurrency/cancel-in-progress/concurrency-event.js +37 -0
  18. package/examples/concurrency/cancel-in-progress/concurrency-worker.d.ts +1 -0
  19. package/examples/concurrency/cancel-in-progress/concurrency-worker.js +66 -0
  20. package/examples/concurrency/group-round-robin/concurrency-event.d.ts +1 -0
  21. package/examples/concurrency/group-round-robin/concurrency-event.js +35 -0
  22. package/examples/concurrency/group-round-robin/concurrency-worker.d.ts +1 -0
  23. package/examples/concurrency/group-round-robin/concurrency-worker.js +61 -0
  24. package/examples/dag-worker.d.ts +1 -0
  25. package/examples/dag-worker.js +76 -0
  26. package/examples/example-event-with-results.d.ts +1 -0
  27. package/examples/example-event-with-results.js +50 -0
  28. package/examples/example-event.d.ts +1 -0
  29. package/examples/example-event.js +10 -0
  30. package/examples/fanout-worker.d.ts +1 -0
  31. package/examples/fanout-worker.js +69 -0
  32. package/examples/logger.d.ts +1 -0
  33. package/examples/logger.js +50 -0
  34. package/examples/manual-trigger.d.ts +1 -0
  35. package/examples/manual-trigger.js +46 -0
  36. package/examples/multi-workflow.d.ts +1 -0
  37. package/examples/multi-workflow.js +55 -0
  38. package/examples/namespaced-worker.d.ts +1 -0
  39. package/examples/namespaced-worker.js +56 -0
  40. package/examples/on-failure.d.ts +1 -0
  41. package/examples/on-failure.js +53 -0
  42. package/examples/playground.d.ts +1 -0
  43. package/examples/playground.js +39 -0
  44. package/examples/rate-limit/events.d.ts +1 -0
  45. package/examples/rate-limit/events.js +16 -0
  46. package/examples/rate-limit/worker.d.ts +1 -0
  47. package/examples/rate-limit/worker.js +43 -0
  48. package/examples/retries-worker.d.ts +1 -0
  49. package/examples/retries-worker.js +60 -0
  50. package/examples/simple-worker.d.ts +1 -0
  51. package/examples/simple-worker.js +55 -0
  52. package/examples/sticky-worker.d.ts +1 -0
  53. package/examples/sticky-worker.js +73 -0
  54. package/examples/stream-by-additional-meta.d.ts +1 -0
  55. package/examples/stream-by-additional-meta.js +55 -0
  56. package/package.json +25 -22
  57. package/protoc/dispatcher/dispatcher.d.ts +109 -2
  58. package/protoc/dispatcher/dispatcher.js +518 -17
  59. package/protoc/events/events.d.ts +1 -1
  60. package/protoc/events/events.js +0 -5
  61. package/protoc/google/protobuf/timestamp.js +0 -8
  62. package/protoc/workflows/workflows.d.ts +82 -1
  63. package/protoc/workflows/workflows.js +404 -9
  64. package/step.d.ts +79 -2
  65. package/step.js +90 -3
  66. package/util/workflow-run-ref.d.ts +3 -0
  67. package/util/workflow-run-ref.js +21 -4
  68. package/workflow.d.ts +116 -1
  69. package/workflow.js +6 -1
@@ -1,4 +1,4 @@
1
- import { type CallContext, type CallOptions } from 'nice-grpc-common';
1
+ import type { CallContext, CallOptions } from 'nice-grpc-common';
2
2
  import * as _m0 from 'protobufjs/minimal';
3
3
  export declare const protobufPackage = "";
4
4
  export declare enum ActionType {
@@ -53,6 +53,11 @@ export declare enum WorkflowRunEventType {
53
53
  }
54
54
  export declare function workflowRunEventTypeFromJSON(object: any): WorkflowRunEventType;
55
55
  export declare function workflowRunEventTypeToJSON(object: WorkflowRunEventType): string;
56
+ export interface WorkerLabels {
57
+ /** value of the label */
58
+ strValue?: string | undefined;
59
+ intValue?: number | undefined;
60
+ }
56
61
  export interface WorkerRegisterRequest {
57
62
  /** the name of the worker */
58
63
  workerName: string;
@@ -62,6 +67,14 @@ export interface WorkerRegisterRequest {
62
67
  services: string[];
63
68
  /** (optional) the max number of runs this worker can handle */
64
69
  maxRuns?: number | undefined;
70
+ /** (optional) worker labels (i.e. state or other metadata) */
71
+ labels: {
72
+ [key: string]: WorkerLabels;
73
+ };
74
+ }
75
+ export interface WorkerRegisterRequest_LabelsEntry {
76
+ key: string;
77
+ value: WorkerLabels | undefined;
65
78
  }
66
79
  export interface WorkerRegisterResponse {
67
80
  /** the tenant id */
@@ -71,6 +84,24 @@ export interface WorkerRegisterResponse {
71
84
  /** the name of the worker */
72
85
  workerName: string;
73
86
  }
87
+ export interface UpsertWorkerLabelsRequest {
88
+ /** the name of the worker */
89
+ workerId: string;
90
+ /** (optional) the worker labels */
91
+ labels: {
92
+ [key: string]: WorkerLabels;
93
+ };
94
+ }
95
+ export interface UpsertWorkerLabelsRequest_LabelsEntry {
96
+ key: string;
97
+ value: WorkerLabels | undefined;
98
+ }
99
+ export interface UpsertWorkerLabelsResponse {
100
+ /** the tenant id */
101
+ tenantId: string;
102
+ /** the id of the worker */
103
+ workerId: string;
104
+ }
74
105
  export interface AssignedAction {
75
106
  /** the tenant id */
76
107
  tenantId: string;
@@ -98,6 +129,14 @@ export interface AssignedAction {
98
129
  stepName: string;
99
130
  /** the count number of the retry attempt */
100
131
  retryCount: number;
132
+ /** (optional) additional metadata set on the workflow */
133
+ additionalMetadata?: string | undefined;
134
+ /** (optional) the child workflow index (if this is a child workflow) */
135
+ childWorkflowIndex?: number | undefined;
136
+ /** (optional) the child workflow key (if this is a child workflow) */
137
+ childWorkflowKey?: string | undefined;
138
+ /** (optional) the parent workflow run id (if this is a child workflow) */
139
+ parentWorkflowRunId?: string | undefined;
101
140
  }
102
141
  export interface WorkerListenRequest {
103
142
  /** the id of the worker */
@@ -154,7 +193,11 @@ export interface ActionEventResponse {
154
193
  }
155
194
  export interface SubscribeToWorkflowEventsRequest {
156
195
  /** the id of the workflow run */
157
- workflowRunId: string;
196
+ workflowRunId?: string | undefined;
197
+ /** the key of the additional meta field to subscribe to */
198
+ additionalMetaKey?: string | undefined;
199
+ /** the value of the additional meta field to subscribe to */
200
+ additionalMetaValue?: string | undefined;
158
201
  }
159
202
  export interface SubscribeToWorkflowRunsRequest {
160
203
  /** the id of the workflow run */
@@ -227,6 +270,14 @@ export interface ReleaseSlotRequest {
227
270
  }
228
271
  export interface ReleaseSlotResponse {
229
272
  }
273
+ export declare const WorkerLabels: {
274
+ encode(message: WorkerLabels, writer?: _m0.Writer): _m0.Writer;
275
+ decode(input: _m0.Reader | Uint8Array, length?: number): WorkerLabels;
276
+ fromJSON(object: any): WorkerLabels;
277
+ toJSON(message: WorkerLabels): unknown;
278
+ create(base?: DeepPartial<WorkerLabels>): WorkerLabels;
279
+ fromPartial(object: DeepPartial<WorkerLabels>): WorkerLabels;
280
+ };
230
281
  export declare const WorkerRegisterRequest: {
231
282
  encode(message: WorkerRegisterRequest, writer?: _m0.Writer): _m0.Writer;
232
283
  decode(input: _m0.Reader | Uint8Array, length?: number): WorkerRegisterRequest;
@@ -235,6 +286,14 @@ export declare const WorkerRegisterRequest: {
235
286
  create(base?: DeepPartial<WorkerRegisterRequest>): WorkerRegisterRequest;
236
287
  fromPartial(object: DeepPartial<WorkerRegisterRequest>): WorkerRegisterRequest;
237
288
  };
289
+ export declare const WorkerRegisterRequest_LabelsEntry: {
290
+ encode(message: WorkerRegisterRequest_LabelsEntry, writer?: _m0.Writer): _m0.Writer;
291
+ decode(input: _m0.Reader | Uint8Array, length?: number): WorkerRegisterRequest_LabelsEntry;
292
+ fromJSON(object: any): WorkerRegisterRequest_LabelsEntry;
293
+ toJSON(message: WorkerRegisterRequest_LabelsEntry): unknown;
294
+ create(base?: DeepPartial<WorkerRegisterRequest_LabelsEntry>): WorkerRegisterRequest_LabelsEntry;
295
+ fromPartial(object: DeepPartial<WorkerRegisterRequest_LabelsEntry>): WorkerRegisterRequest_LabelsEntry;
296
+ };
238
297
  export declare const WorkerRegisterResponse: {
239
298
  encode(message: WorkerRegisterResponse, writer?: _m0.Writer): _m0.Writer;
240
299
  decode(input: _m0.Reader | Uint8Array, length?: number): WorkerRegisterResponse;
@@ -243,6 +302,30 @@ export declare const WorkerRegisterResponse: {
243
302
  create(base?: DeepPartial<WorkerRegisterResponse>): WorkerRegisterResponse;
244
303
  fromPartial(object: DeepPartial<WorkerRegisterResponse>): WorkerRegisterResponse;
245
304
  };
305
+ export declare const UpsertWorkerLabelsRequest: {
306
+ encode(message: UpsertWorkerLabelsRequest, writer?: _m0.Writer): _m0.Writer;
307
+ decode(input: _m0.Reader | Uint8Array, length?: number): UpsertWorkerLabelsRequest;
308
+ fromJSON(object: any): UpsertWorkerLabelsRequest;
309
+ toJSON(message: UpsertWorkerLabelsRequest): unknown;
310
+ create(base?: DeepPartial<UpsertWorkerLabelsRequest>): UpsertWorkerLabelsRequest;
311
+ fromPartial(object: DeepPartial<UpsertWorkerLabelsRequest>): UpsertWorkerLabelsRequest;
312
+ };
313
+ export declare const UpsertWorkerLabelsRequest_LabelsEntry: {
314
+ encode(message: UpsertWorkerLabelsRequest_LabelsEntry, writer?: _m0.Writer): _m0.Writer;
315
+ decode(input: _m0.Reader | Uint8Array, length?: number): UpsertWorkerLabelsRequest_LabelsEntry;
316
+ fromJSON(object: any): UpsertWorkerLabelsRequest_LabelsEntry;
317
+ toJSON(message: UpsertWorkerLabelsRequest_LabelsEntry): unknown;
318
+ create(base?: DeepPartial<UpsertWorkerLabelsRequest_LabelsEntry>): UpsertWorkerLabelsRequest_LabelsEntry;
319
+ fromPartial(object: DeepPartial<UpsertWorkerLabelsRequest_LabelsEntry>): UpsertWorkerLabelsRequest_LabelsEntry;
320
+ };
321
+ export declare const UpsertWorkerLabelsResponse: {
322
+ encode(message: UpsertWorkerLabelsResponse, writer?: _m0.Writer): _m0.Writer;
323
+ decode(input: _m0.Reader | Uint8Array, length?: number): UpsertWorkerLabelsResponse;
324
+ fromJSON(object: any): UpsertWorkerLabelsResponse;
325
+ toJSON(message: UpsertWorkerLabelsResponse): unknown;
326
+ create(base?: DeepPartial<UpsertWorkerLabelsResponse>): UpsertWorkerLabelsResponse;
327
+ fromPartial(object: DeepPartial<UpsertWorkerLabelsResponse>): UpsertWorkerLabelsResponse;
328
+ };
246
329
  export declare const AssignedAction: {
247
330
  encode(message: AssignedAction, writer?: _m0.Writer): _m0.Writer;
248
331
  decode(input: _m0.Reader | Uint8Array, length?: number): AssignedAction;
@@ -677,6 +760,28 @@ export declare const DispatcherDefinition: {
677
760
  readonly responseStream: false;
678
761
  readonly options: {};
679
762
  };
763
+ readonly upsertWorkerLabels: {
764
+ readonly name: "UpsertWorkerLabels";
765
+ readonly requestType: {
766
+ encode(message: UpsertWorkerLabelsRequest, writer?: _m0.Writer): _m0.Writer;
767
+ decode(input: _m0.Reader | Uint8Array, length?: number): UpsertWorkerLabelsRequest;
768
+ fromJSON(object: any): UpsertWorkerLabelsRequest;
769
+ toJSON(message: UpsertWorkerLabelsRequest): unknown;
770
+ create(base?: DeepPartial<UpsertWorkerLabelsRequest>): UpsertWorkerLabelsRequest;
771
+ fromPartial(object: DeepPartial<UpsertWorkerLabelsRequest>): UpsertWorkerLabelsRequest;
772
+ };
773
+ readonly requestStream: false;
774
+ readonly responseType: {
775
+ encode(message: UpsertWorkerLabelsResponse, writer?: _m0.Writer): _m0.Writer;
776
+ decode(input: _m0.Reader | Uint8Array, length?: number): UpsertWorkerLabelsResponse;
777
+ fromJSON(object: any): UpsertWorkerLabelsResponse;
778
+ toJSON(message: UpsertWorkerLabelsResponse): unknown;
779
+ create(base?: DeepPartial<UpsertWorkerLabelsResponse>): UpsertWorkerLabelsResponse;
780
+ fromPartial(object: DeepPartial<UpsertWorkerLabelsResponse>): UpsertWorkerLabelsResponse;
781
+ };
782
+ readonly responseStream: false;
783
+ readonly options: {};
784
+ };
680
785
  };
681
786
  };
682
787
  export interface DispatcherServiceImplementation<CallContextExt = {}> {
@@ -697,6 +802,7 @@ export interface DispatcherServiceImplementation<CallContextExt = {}> {
697
802
  unsubscribe(request: WorkerUnsubscribeRequest, context: CallContext & CallContextExt): Promise<DeepPartial<WorkerUnsubscribeResponse>>;
698
803
  refreshTimeout(request: RefreshTimeoutRequest, context: CallContext & CallContextExt): Promise<DeepPartial<RefreshTimeoutResponse>>;
699
804
  releaseSlot(request: ReleaseSlotRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ReleaseSlotResponse>>;
805
+ upsertWorkerLabels(request: UpsertWorkerLabelsRequest, context: CallContext & CallContextExt): Promise<DeepPartial<UpsertWorkerLabelsResponse>>;
700
806
  }
701
807
  export interface DispatcherClient<CallOptionsExt = {}> {
702
808
  register(request: DeepPartial<WorkerRegisterRequest>, options?: CallOptions & CallOptionsExt): Promise<WorkerRegisterResponse>;
@@ -716,6 +822,7 @@ export interface DispatcherClient<CallOptionsExt = {}> {
716
822
  unsubscribe(request: DeepPartial<WorkerUnsubscribeRequest>, options?: CallOptions & CallOptionsExt): Promise<WorkerUnsubscribeResponse>;
717
823
  refreshTimeout(request: DeepPartial<RefreshTimeoutRequest>, options?: CallOptions & CallOptionsExt): Promise<RefreshTimeoutResponse>;
718
824
  releaseSlot(request: DeepPartial<ReleaseSlotRequest>, options?: CallOptions & CallOptionsExt): Promise<ReleaseSlotResponse>;
825
+ upsertWorkerLabels(request: DeepPartial<UpsertWorkerLabelsRequest>, options?: CallOptions & CallOptionsExt): Promise<UpsertWorkerLabelsResponse>;
719
826
  }
720
827
  type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
721
828
  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 {} ? {