@restatedev/restate-sdk-clients 1.9.1 → 1.10.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 (50) hide show
  1. package/LICENSE +21 -0
  2. package/dist/_virtual/rolldown_runtime.cjs +25 -0
  3. package/dist/api.cjs +47 -0
  4. package/dist/api.d.cts +224 -0
  5. package/dist/api.d.cts.map +1 -0
  6. package/dist/api.d.ts +224 -0
  7. package/dist/api.d.ts.map +1 -0
  8. package/dist/api.js +39 -0
  9. package/dist/api.js.map +1 -0
  10. package/dist/index.cjs +22 -0
  11. package/dist/index.d.cts +4 -0
  12. package/dist/index.d.ts +4 -0
  13. package/dist/index.d.ts.map +1 -0
  14. package/dist/index.js +5 -0
  15. package/dist/index.js.map +1 -0
  16. package/dist/ingress.cjs +269 -0
  17. package/dist/ingress.d.cts +20 -0
  18. package/dist/ingress.d.cts.map +1 -0
  19. package/dist/ingress.d.ts +20 -0
  20. package/dist/ingress.d.ts.map +1 -0
  21. package/dist/ingress.js +267 -0
  22. package/dist/ingress.js.map +1 -0
  23. package/package.json +31 -39
  24. package/dist/cjs/package.json +0 -1
  25. package/dist/cjs/src/api.d.ts +0 -225
  26. package/dist/cjs/src/api.d.ts.map +0 -1
  27. package/dist/cjs/src/api.js +0 -45
  28. package/dist/cjs/src/api.js.map +0 -1
  29. package/dist/cjs/src/ingress.d.ts +0 -15
  30. package/dist/cjs/src/ingress.d.ts.map +0 -1
  31. package/dist/cjs/src/ingress.js +0 -392
  32. package/dist/cjs/src/ingress.js.map +0 -1
  33. package/dist/cjs/src/public_api.d.ts +0 -7
  34. package/dist/cjs/src/public_api.d.ts.map +0 -1
  35. package/dist/cjs/src/public_api.js +0 -24
  36. package/dist/cjs/src/public_api.js.map +0 -1
  37. package/dist/cjs/tsconfig.tsbuildinfo +0 -1
  38. package/dist/esm/src/api.d.ts +0 -225
  39. package/dist/esm/src/api.d.ts.map +0 -1
  40. package/dist/esm/src/api.js +0 -40
  41. package/dist/esm/src/api.js.map +0 -1
  42. package/dist/esm/src/ingress.d.ts +0 -15
  43. package/dist/esm/src/ingress.d.ts.map +0 -1
  44. package/dist/esm/src/ingress.js +0 -387
  45. package/dist/esm/src/ingress.js.map +0 -1
  46. package/dist/esm/src/public_api.d.ts +0 -7
  47. package/dist/esm/src/public_api.d.ts.map +0 -1
  48. package/dist/esm/src/public_api.js +0 -15
  49. package/dist/esm/src/public_api.js.map +0 -1
  50. package/dist/esm/tsconfig.tsbuildinfo +0 -1
@@ -1,225 +0,0 @@
1
- import type { Service, VirtualObjectDefinitionFrom, Workflow, VirtualObject, ServiceDefinitionFrom, WorkflowDefinitionFrom, Serde, Duration, JournalValueCodec } from "@restatedev/restate-sdk-core";
2
- /**
3
- * A remote client for a Restate service.
4
- *
5
- * Use the following client to interact with services defined
6
- * - `serviceClient` to create a client for a service.
7
- * - `workflowClient` to create a client for a workflow.
8
- * - `objectClient` to create a client for a virtual object.
9
- *
10
- */
11
- export interface Ingress {
12
- /**
13
- * Create a client from a {@link ServiceDefinition}.
14
- */
15
- serviceClient<D>(opts: ServiceDefinitionFrom<D>): IngressClient<Service<D>>;
16
- /**
17
- * Create a client from a {@link WorkflowDefinition}.
18
- *
19
- * @param key the key of the workflow.
20
- */
21
- workflowClient<D>(opts: WorkflowDefinitionFrom<D>, key: string): IngressWorkflowClient<Workflow<D>>;
22
- /**
23
- * Create a client from a {@link VirtualObjectDefinition}.
24
- * @param key the key of the virtual object.
25
- */
26
- objectClient<D>(opts: VirtualObjectDefinitionFrom<D>, key: string): IngressClient<VirtualObject<D>>;
27
- /**
28
- * Create a client from a {@link ServiceDefinition}.
29
- */
30
- serviceSendClient<D>(opts: ServiceDefinitionFrom<D>): IngressSendClient<Service<D>>;
31
- /**
32
- * Create a client from a {@link VirtualObjectDefinition}.
33
- */
34
- objectSendClient<D>(opts: VirtualObjectDefinitionFrom<D>, key: string): IngressSendClient<VirtualObject<D>>;
35
- /**
36
- * Resolve an awakeable from the ingress client.
37
- */
38
- resolveAwakeable<T>(id: string, payload?: T): Promise<void>;
39
- /**
40
- * Reject an awakeable from the ingress client.
41
- */
42
- rejectAwakeable(id: string, reason: string): Promise<void>;
43
- /**
44
- * Obtain the result of a service that was asynchronously submitted (via a sendClient).
45
- *
46
- * @param send either the send response or the workflow submission as obtained by the respective clients.
47
- */
48
- result<T>(send: Send<T> | WorkflowSubmission<T>): Promise<T>;
49
- }
50
- export interface IngressCallOptions<I = unknown, O = unknown> {
51
- /**
52
- * Key to use for idempotency key.
53
- *
54
- * See https://docs.restate.dev/operate/invocation#invoke-a-handler-idempotently for more details.
55
- */
56
- idempotencyKey?: string;
57
- /**
58
- * Headers to attach to the request.
59
- */
60
- headers?: Record<string, string>;
61
- input?: Serde<I>;
62
- output?: Serde<O>;
63
- /**
64
- * Timeout to be used when executing the request. In milliseconds.
65
- *
66
- * Same as {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal#aborting_a_fetch_with_timeout_or_explicit_abort | AbortSignal.timeout()}.
67
- *
68
- * This field is exclusive with `signal`, and using both of them will result in a runtime failure.
69
- */
70
- timeout?: number;
71
- /**
72
- * Signal to abort the underlying `fetch` operation. See {@link https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal}.
73
- *
74
- * This field is exclusive with `timeout`, and using both of them will result in a runtime failure.
75
- */
76
- signal?: AbortSignal;
77
- }
78
- export interface IngressSendOptions<I> extends IngressCallOptions<I, void> {
79
- /**
80
- * If set, the invocation will be enqueued now to be executed after the provided delay. In milliseconds.
81
- */
82
- delay?: number | Duration;
83
- }
84
- export declare class Opts<I, O> {
85
- readonly opts: IngressCallOptions<I, O>;
86
- /**
87
- * Create a call configuration from the provided options.
88
- *
89
- * @param opts the call configuration
90
- */
91
- static from<I = unknown, O = unknown>(opts: IngressCallOptions<I, O>): Opts<I, O>;
92
- constructor(opts: IngressCallOptions<I, O>);
93
- }
94
- export declare class SendOpts<I = unknown> {
95
- readonly opts: IngressSendOptions<I>;
96
- /**
97
- * @param opts Create send options
98
- */
99
- static from<I = unknown>(opts: IngressSendOptions<I>): SendOpts<I>;
100
- delay(): number | undefined;
101
- constructor(opts: IngressSendOptions<I>);
102
- }
103
- export type InferArgType<P> = P extends [infer A, ...any[]] ? A : unknown;
104
- export type IngressClient<M> = {
105
- [K in keyof M as M[K] extends never ? never : K]: M[K] extends (arg: any, ...args: infer P) => PromiseLike<infer O> ? (...args: [...P, ...[opts?: Opts<InferArgType<P>, O>]]) => PromiseLike<O> : never;
106
- };
107
- export declare namespace rpc {
108
- const opts: <I, O>(opts: IngressCallOptions<I, O>) => Opts<I, O>;
109
- const sendOpts: <I>(opts: IngressSendOptions<I>) => SendOpts<I>;
110
- }
111
- /**
112
- * Represents the output of a workflow.
113
- */
114
- export interface Output<O> {
115
- /**
116
- * Whether the output is ready.
117
- */
118
- ready: boolean;
119
- /**
120
- * The output of the workflow.
121
- */
122
- result: O;
123
- }
124
- /**
125
- * Represents a successful workflow submission.
126
- *
127
- */
128
- export type WorkflowSubmission<T> = {
129
- /**
130
- * The invocation id of the workflow. You can use that id to
131
- * with the introspection tools (restate cli, logging, metrics)
132
- *
133
- */
134
- readonly invocationId: string;
135
- readonly status: "Accepted" | "PreviouslyAccepted";
136
- readonly attachable: true;
137
- };
138
- /**
139
- * A client for a workflow.
140
- *
141
- * This client represents the workflow definition, with the following additional methods:
142
- * - `workflowSubmit` to submit the workflow.
143
- * - `workflowAttach` to attach to the workflow and wait for its completion
144
- * - `workflowOutput` to check if the workflow's output is ready/available.
145
- *
146
- * Once a workflow is submitted, it can be attached to, and the output can be retrieved.
147
- *
148
- * @typeParam M the type of the workflow.
149
- */
150
- export type IngressWorkflowClient<M> = Omit<{
151
- [K in keyof M as M[K] extends never ? never : K]: M[K] extends (arg: any, ...args: infer P) => PromiseLike<infer O> ? (...args: [...P, ...[opts?: Opts<InferArgType<P>, O>]]) => PromiseLike<O> : never;
152
- } & {
153
- /**
154
- * Submit this workflow.
155
- *
156
- * This instructs restate to execute the 'run' handler of the workflow, idempotently.
157
- * The workflow will be executed asynchronously, and the promise will resolve when the workflow has been accepted.
158
- * Please note that submitting a workflow does not wait for it to completion, and it is safe to retry the submission,
159
- * in case of failure.
160
- *
161
- * @param argument the same argument type as defined by the 'run' handler.
162
- */
163
- workflowSubmit: M extends Record<string, unknown> ? M["run"] extends (arg: any, ...args: infer I) => Promise<infer O> ? (...args: [...I, ...[opts?: SendOpts<InferArgType<I>>]]) => Promise<WorkflowSubmission<O>> : never : never;
164
- /**
165
- * Attach to this workflow.
166
- *
167
- * This instructs restate to attach to the workflow and wait for it to complete.
168
- * It is only possible to 'attach' to a workflow that has been previously submitted.
169
- * The promise will resolve when the workflow has completed either successfully with a result,
170
- * or be rejected with an error.
171
- * This operation is safe to retry many times, and it will always return the same result.
172
- *
173
- * @returns a promise that resolves when the workflow has completed.
174
- */
175
- workflowAttach: M extends Record<string, unknown> ? M["run"] extends (...args: any) => Promise<infer O> ? (opts?: Opts<void, O>) => Promise<O> : never : never;
176
- /**
177
- * Try retrieving the output of this workflow.
178
- *
179
- * This instructs restate to check if the workflow's output is ready/available.
180
- * The returned Output object will have a 'ready' field set to true if the output is ready.
181
- * If the output is ready, the 'result' field will contain the output.
182
- * note: that this operation will not wait for the workflow to complete, to do so use 'workflowAttach'.
183
- *
184
- * @returns a promise that resolves if the workflow's output is ready/available.
185
- */
186
- workflowOutput: M extends Record<string, unknown> ? M["run"] extends (...args: any) => Promise<infer O> ? (opts?: Opts<void, O>) => Promise<Output<O>> : never : never;
187
- }, "run">;
188
- /**
189
- * A send response.
190
- *
191
- * @typeParam T the type of the response.
192
- */
193
- export type Send<T = unknown> = {
194
- /**
195
- * The invocation id of the send.
196
- */
197
- invocationId: string;
198
- /**
199
- * The status of the send.
200
- */
201
- status: "Accepted" | "PreviouslyAccepted";
202
- attachable: boolean;
203
- };
204
- export type IngressSendClient<M> = {
205
- [K in keyof M as M[K] extends never ? never : K]: M[K] extends (arg: any, ...args: infer P) => infer O ? (...args: [...P, ...[opts?: SendOpts<InferArgType<P>>]]) => Promise<Send<O>> : never;
206
- };
207
- export type ConnectionOpts = {
208
- /**
209
- * Restate ingress URL.
210
- * For example: http://localhost:8080
211
- */
212
- url: string;
213
- /**
214
- * Headers to attach on every request.
215
- * Use this to attach authentication headers.
216
- */
217
- headers?: Record<string, string>;
218
- /**
219
- * Codec to use for input/outputs. Check {@link JournalValueCodec} for more details
220
- *
221
- * @experimental
222
- */
223
- journalValueCodec?: JournalValueCodec;
224
- };
225
- //# sourceMappingURL=api.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,2BAA2B,EAC3B,QAAQ,EACR,aAAa,EACb,qBAAqB,EACrB,sBAAsB,EACtB,KAAK,EACL,QAAQ,EACR,iBAAiB,EAClB,MAAM,8BAA8B,CAAC;AAKtC;;;;;;;;GAQG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5E;;;;OAIG;IACH,cAAc,CAAC,CAAC,EACd,IAAI,EAAE,sBAAsB,CAAC,CAAC,CAAC,EAC/B,GAAG,EAAE,MAAM,GACV,qBAAqB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAEtC;;;OAGG;IACH,YAAY,CAAC,CAAC,EACZ,IAAI,EAAE,2BAA2B,CAAC,CAAC,CAAC,EACpC,GAAG,EAAE,MAAM,GACV,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAEnC;;OAEG;IACH,iBAAiB,CAAC,CAAC,EACjB,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAC7B,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAEjC;;OAEG;IACH,gBAAgB,CAAC,CAAC,EAChB,IAAI,EAAE,2BAA2B,CAAC,CAAC,CAAC,EACpC,GAAG,EAAE,MAAM,GACV,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvC;;OAEG;IACH,gBAAgB,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5D;;OAEG;IACH,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3D;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CAC9D;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO;IAC1D;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAEjB,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAElB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC,CAAE,SAAQ,kBAAkB,CAAC,CAAC,EAAE,IAAI,CAAC;IACxE;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;CAC3B;AAED,qBAAa,IAAI,CAAC,CAAC,EAAE,CAAC;IAYR,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC;IAXnD;;;;OAIG;WACW,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,EACzC,IAAI,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GAC7B,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBAIQ,IAAI,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC;CACpD;AAED,qBAAa,QAAQ,CAAC,CAAC,GAAG,OAAO;IAenB,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;IAdhD;;OAEG;WACW,IAAI,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;IAIzE,KAAK,IAAI,MAAM,GAAG,SAAS;gBAON,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;CACjD;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC;AAE1E,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI;KAC5B,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAC7D,GAAG,EAAE,GAAG,EACR,GAAG,IAAI,EAAE,MAAM,CAAC,KACb,WAAW,CAAC,MAAM,CAAC,CAAC,GACrB,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,CAAC,CAAC,GACzE,KAAK;CACV,CAAC;AAGF,yBAAiB,GAAG,CAAC;IACZ,MAAM,IAAI,GAAI,CAAC,EAAE,CAAC,EAAE,MAAM,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,eAAoB,CAAC;IAEvE,MAAM,QAAQ,GAAI,CAAC,EAAE,MAAM,kBAAkB,CAAC,CAAC,CAAC,gBAClC,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC;IACvB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,CAAC,CAAC;CACX;AAED;;;GAGG;AAEH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI;IAClC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,oBAAoB,CAAC;IACnD,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,qBAAqB,CAAC,CAAC,IAAI,IAAI,CACzC;KACG,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAC7D,GAAG,EAAE,GAAG,EACR,GAAG,IAAI,EAAE,MAAM,CAAC,KACb,WAAW,CAAC,MAAM,CAAC,CAAC,GACrB,CACE,GAAG,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAClD,WAAW,CAAC,CAAC,CAAC,GACnB,KAAK;CACV,GAAG;IACF;;;;;;;;;OASG;IACH,cAAc,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7C,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAC/D,CACE,GAAG,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KACnD,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,GACnC,KAAK,GACP,KAAK,CAAC;IAEV;;;;;;;;;;OAUG;IACH,cAAc,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7C,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GACjD,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GACpC,KAAK,GACP,KAAK,CAAC;IAEV;;;;;;;;;OASG;IACH,cAAc,EAAE,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC7C,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GACjD,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAC5C,KAAK,GACP,KAAK,CAAC;CACX,EACD,KAAK,CACN,CAAC;AAEF;;;;GAIG;AAEH,MAAM,MAAM,IAAI,CAAC,CAAC,GAAG,OAAO,IAAI;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,UAAU,GAAG,oBAAoB,CAAC;IAE1C,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;KAChC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAC7D,GAAG,EAAE,GAAG,EACR,GAAG,IAAI,EAAE,MAAM,CAAC,KACb,MAAM,CAAC,GACR,CACE,GAAG,IAAI,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KACnD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GACrB,KAAK;CACV,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;CACvC,CAAC"}
@@ -1,40 +0,0 @@
1
- import { millisOrDurationToMillis } from "@restatedev/restate-sdk-core";
2
- export class Opts {
3
- opts;
4
- /**
5
- * Create a call configuration from the provided options.
6
- *
7
- * @param opts the call configuration
8
- */
9
- static from(opts) {
10
- return new Opts(opts);
11
- }
12
- constructor(opts) {
13
- this.opts = opts;
14
- }
15
- }
16
- export class SendOpts {
17
- opts;
18
- /**
19
- * @param opts Create send options
20
- */
21
- static from(opts) {
22
- return new SendOpts(opts);
23
- }
24
- delay() {
25
- if (this.opts.delay !== undefined) {
26
- return millisOrDurationToMillis(this.opts.delay);
27
- }
28
- return undefined;
29
- }
30
- constructor(opts) {
31
- this.opts = opts;
32
- }
33
- }
34
- // eslint-disable-next-line @typescript-eslint/no-namespace
35
- export var rpc;
36
- (function (rpc) {
37
- rpc.opts = (opts) => Opts.from(opts);
38
- rpc.sendOpts = (opts) => SendOpts.from(opts);
39
- })(rpc || (rpc = {}));
40
- //# sourceMappingURL=api.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/api.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAgHxE,MAAM,OAAO,IAAI;IAYM;IAXrB;;;;OAIG;IACI,MAAM,CAAC,IAAI,CAChB,IAA8B;QAE9B,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,YAAqB,IAA8B;QAA9B,SAAI,GAAJ,IAAI,CAA0B;IAAG,CAAC;CACxD;AAED,MAAM,OAAO,QAAQ;IAeE;IAdrB;;OAEG;IACI,MAAM,CAAC,IAAI,CAAc,IAA2B;QACzD,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,KAAK;QACH,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,YAAqB,IAA2B;QAA3B,SAAI,GAAJ,IAAI,CAAuB;IAAG,CAAC;CACrD;AAaD,2DAA2D;AAC3D,MAAM,KAAW,GAAG,CAKnB;AALD,WAAiB,GAAG;IACL,QAAI,GAAG,CAAO,IAA8B,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEjE,YAAQ,GAAG,CAAI,IAA2B,EAAE,EAAE,CACzD,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC,EALgB,GAAG,KAAH,GAAG,QAKnB"}
@@ -1,15 +0,0 @@
1
- import type { ConnectionOpts, Ingress } from "./api.js";
2
- /**
3
- * Connect to the restate Ingress
4
- *
5
- * @param opts connection options
6
- * @returns a connection the the restate ingress
7
- */
8
- export declare function connect(opts: ConnectionOpts): Ingress;
9
- export declare class HttpCallError extends Error {
10
- readonly status: number;
11
- readonly responseText: string;
12
- readonly message: string;
13
- constructor(status: number, responseText: string, message: string);
14
- }
15
- //# sourceMappingURL=ingress.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ingress.d.ts","sourceRoot":"","sources":["../../../src/ingress.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EACV,cAAc,EACd,OAAO,EAOR,MAAM,UAAU,CAAC;AAIlB;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAErD;AAED,qBAAa,aAAc,SAAQ,KAAK;aAEpB,MAAM,EAAE,MAAM;aACd,YAAY,EAAE,MAAM;aACpB,OAAO,EAAE,MAAM;gBAFf,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM;CAIlC"}
@@ -1,387 +0,0 @@
1
- /*
2
- * Copyright (c) 2023-2024 - Restate Software, Inc., Restate GmbH
3
- *
4
- * This file is part of the Restate SDK for Node.js/TypeScript,
5
- * which is released under the MIT license.
6
- *
7
- * You can find a copy of the license in file LICENSE in the root
8
- * directory of this repository or package, or at
9
- * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
10
- */
11
- import { serde, } from "@restatedev/restate-sdk-core";
12
- import { Opts, SendOpts } from "./api.js";
13
- /**
14
- * Connect to the restate Ingress
15
- *
16
- * @param opts connection options
17
- * @returns a connection the the restate ingress
18
- */
19
- export function connect(opts) {
20
- return new HttpIngress(opts);
21
- }
22
- export class HttpCallError extends Error {
23
- status;
24
- responseText;
25
- message;
26
- constructor(status, responseText, message) {
27
- super(message);
28
- this.status = status;
29
- this.responseText = responseText;
30
- this.message = message;
31
- }
32
- }
33
- function optsFromArgs(args) {
34
- let parameter;
35
- let opts;
36
- switch (args.length) {
37
- case 0: {
38
- break;
39
- }
40
- case 1: {
41
- if (args[0] instanceof Opts) {
42
- opts = args[0];
43
- }
44
- else if (args[0] instanceof SendOpts) {
45
- opts = args[0];
46
- }
47
- else {
48
- parameter = args[0];
49
- }
50
- break;
51
- }
52
- case 2: {
53
- parameter = args[0];
54
- if (args[1] instanceof Opts) {
55
- opts = args[1];
56
- }
57
- else if (args[1] instanceof SendOpts) {
58
- opts = args[1];
59
- }
60
- else {
61
- throw new TypeError("The second argument must be either Opts or SendOpts");
62
- }
63
- break;
64
- }
65
- default: {
66
- throw new TypeError("unexpected number of arguments");
67
- }
68
- }
69
- return {
70
- parameter,
71
- opts,
72
- };
73
- }
74
- const IDEMPOTENCY_KEY_HEADER = "idempotency-key";
75
- const doComponentInvocation = async (opts, params) => {
76
- let attachable = false;
77
- const fragments = [];
78
- //
79
- // ingress URL
80
- //
81
- fragments.push(opts.url);
82
- //
83
- // component
84
- //
85
- fragments.push(params.component);
86
- //
87
- // has key?
88
- //
89
- if (params.key) {
90
- const key = encodeURIComponent(params.key);
91
- fragments.push(key);
92
- }
93
- //
94
- // handler
95
- //
96
- fragments.push(params.handler);
97
- if (params.send ?? false) {
98
- if (params.opts instanceof SendOpts) {
99
- const sendString = computeDelayAsIso(params.opts);
100
- fragments.push(sendString);
101
- }
102
- else {
103
- fragments.push("send");
104
- }
105
- }
106
- //
107
- // request body
108
- //
109
- const inputSerde = params.opts?.opts.input ?? serde.json;
110
- const { body, contentType } = serializeBodyWithContentType(params.parameter, inputSerde, opts.journalValueCodec);
111
- //
112
- // headers
113
- //
114
- const headers = {
115
- ...(opts.headers ?? {}),
116
- ...(params.opts?.opts?.headers ?? {}),
117
- };
118
- if (contentType) {
119
- headers["Content-Type"] = contentType;
120
- }
121
- //
122
- //idempotency
123
- //
124
- const idempotencyKey = params.opts?.opts.idempotencyKey;
125
- if (idempotencyKey) {
126
- headers[IDEMPOTENCY_KEY_HEADER] = idempotencyKey;
127
- attachable = true;
128
- }
129
- // Abort signal, if any
130
- let signal;
131
- if (params.opts?.opts.signal !== undefined &&
132
- params.opts?.opts.timeout !== undefined) {
133
- throw new Error("You can't specify both signal and timeout options at the same time");
134
- }
135
- else if (params.opts?.opts.signal !== undefined) {
136
- signal = params.opts?.opts.signal;
137
- }
138
- else if (params.opts?.opts.timeout !== undefined) {
139
- signal = AbortSignal.timeout(params.opts?.opts.timeout);
140
- }
141
- //
142
- // make the call
143
- //
144
- const url = fragments.join("/");
145
- const httpResponse = await fetch(url, {
146
- method: params.method ?? "POST",
147
- headers,
148
- body,
149
- signal,
150
- });
151
- if (!httpResponse.ok) {
152
- const body = await httpResponse.text();
153
- throw new HttpCallError(httpResponse.status, body, `Request failed: ${httpResponse.status}\n${body}`);
154
- }
155
- const responseBuf = new Uint8Array(await httpResponse.arrayBuffer());
156
- if (!params.send) {
157
- const decodedBuf = opts.journalValueCodec
158
- ? await opts.journalValueCodec.decode(responseBuf)
159
- : responseBuf;
160
- const outputSerde = params.opts?.opts.output ?? serde.json;
161
- return outputSerde.deserialize(decodedBuf);
162
- }
163
- const json = serde.json.deserialize(responseBuf);
164
- return { ...json, attachable };
165
- };
166
- const doWorkflowHandleCall = async (opts, wfName, wfKey, op, callOpts) => {
167
- const outputSerde = callOpts?.opts.output ?? serde.json;
168
- //
169
- // headers
170
- //
171
- const headers = {
172
- ...(opts.headers ?? {}),
173
- };
174
- //
175
- // make the call
176
- //
177
- const url = `${opts.url}/restate/workflow/${wfName}/${encodeURIComponent(wfKey)}/${op}`;
178
- // Abort signal, if any
179
- let signal;
180
- if (callOpts?.opts?.signal !== undefined &&
181
- callOpts?.opts?.timeout !== undefined) {
182
- throw new Error("You can't specify both signal and timeout options at the same time");
183
- }
184
- else if (callOpts?.opts?.signal !== undefined) {
185
- signal = callOpts?.opts?.signal;
186
- }
187
- else if (callOpts?.opts?.timeout !== undefined) {
188
- signal = AbortSignal.timeout(callOpts?.opts?.timeout);
189
- }
190
- const httpResponse = await fetch(url, {
191
- method: "GET",
192
- headers,
193
- signal,
194
- });
195
- if (httpResponse.ok) {
196
- const responseBuf = new Uint8Array(await httpResponse.arrayBuffer());
197
- const decodedBuf = opts.journalValueCodec
198
- ? await opts.journalValueCodec.decode(responseBuf)
199
- : responseBuf;
200
- return outputSerde.deserialize(decodedBuf);
201
- }
202
- const body = await httpResponse.text();
203
- throw new HttpCallError(httpResponse.status, body, `Request failed: ${httpResponse.status}\n${body}`);
204
- };
205
- class HttpIngress {
206
- opts;
207
- constructor(opts) {
208
- this.opts = opts;
209
- }
210
- proxy(component, key, send) {
211
- return new Proxy({}, {
212
- get: (_target, prop) => {
213
- const handler = prop;
214
- return (...args) => {
215
- const { parameter, opts } = optsFromArgs(args);
216
- return doComponentInvocation(this.opts, {
217
- component,
218
- handler,
219
- key,
220
- parameter,
221
- opts,
222
- send,
223
- });
224
- };
225
- },
226
- });
227
- }
228
- serviceClient(opts) {
229
- return this.proxy(opts.name);
230
- }
231
- objectClient(opts, key) {
232
- return this.proxy(opts.name, key);
233
- }
234
- workflowClient(opts, key) {
235
- const component = opts.name;
236
- const conn = this.opts;
237
- const workflowSubmit = async (parameter, opts) => {
238
- const res = await doComponentInvocation(conn, {
239
- component,
240
- handler: "run",
241
- key,
242
- send: true,
243
- parameter,
244
- opts,
245
- });
246
- return {
247
- invocationId: res.invocationId,
248
- status: res.status,
249
- attachable: true,
250
- };
251
- };
252
- const workflowAttach = (opts) => doWorkflowHandleCall(conn, component, key, "attach", opts);
253
- const workflowOutput = async (opts) => {
254
- try {
255
- const result = await doWorkflowHandleCall(conn, component, key, "output", opts);
256
- return {
257
- ready: true,
258
- result,
259
- };
260
- }
261
- catch (e) {
262
- if (!(e instanceof HttpCallError) || e.status !== 470) {
263
- throw e;
264
- }
265
- return {
266
- ready: false,
267
- get result() {
268
- throw new Error("Calling result() on a non ready workflow");
269
- },
270
- };
271
- }
272
- };
273
- return new Proxy({}, {
274
- get: (_target, prop) => {
275
- const handler = prop;
276
- if (handler === "workflowSubmit") {
277
- return workflowSubmit;
278
- }
279
- else if (handler === "workflowAttach") {
280
- return workflowAttach;
281
- }
282
- else if (handler === "workflowOutput") {
283
- return workflowOutput;
284
- }
285
- // shared handlers pass trough via the ingress's normal invocation form
286
- // i.e. POST /<svc>/<key>/<handler>
287
- return (...args) => {
288
- const { parameter, opts } = optsFromArgs(args);
289
- return doComponentInvocation(conn, {
290
- component,
291
- handler,
292
- key,
293
- parameter,
294
- opts,
295
- });
296
- };
297
- },
298
- });
299
- }
300
- objectSendClient(opts, key) {
301
- return this.proxy(opts.name, key, true);
302
- }
303
- serviceSendClient(opts) {
304
- return this.proxy(opts.name, undefined, true);
305
- }
306
- async resolveAwakeable(id, payload, payloadSerde) {
307
- const url = `${this.opts.url}/restate/a/${id}/resolve`;
308
- const { body, contentType } = serializeBodyWithContentType(payload, payloadSerde ?? serde.json, this.opts.journalValueCodec);
309
- const headers = {
310
- ...(this.opts.headers ?? {}),
311
- };
312
- if (contentType) {
313
- headers["Content-Type"] = contentType;
314
- }
315
- const httpResponse = await fetch(url, {
316
- method: "POST",
317
- headers,
318
- body,
319
- });
320
- if (!httpResponse.ok) {
321
- const body = await httpResponse.text();
322
- throw new HttpCallError(httpResponse.status, body, `Request failed: ${httpResponse.status}\n${body}`);
323
- }
324
- }
325
- async rejectAwakeable(id, reason) {
326
- const url = `${this.opts.url}/restate/a/${id}/reject`;
327
- const headers = {
328
- "Content-Type": "text/plain",
329
- ...(this.opts.headers ?? {}),
330
- };
331
- const httpResponse = await fetch(url, {
332
- method: "POST",
333
- headers,
334
- body: reason,
335
- });
336
- if (!httpResponse.ok) {
337
- const body = await httpResponse.text();
338
- throw new HttpCallError(httpResponse.status, body, `Request failed: ${httpResponse.status}\n${body}`);
339
- }
340
- }
341
- async result(send, resultSerde) {
342
- if (!send.attachable) {
343
- throw new Error(`Unable to fetch the result for ${send.invocationId}.
344
- A service's result is stored only with an idempotencyKey is supplied when invocating the service.`);
345
- }
346
- //
347
- // headers
348
- //
349
- const headers = {
350
- ...(this.opts.headers ?? {}),
351
- };
352
- //
353
- // make the call
354
- const url = `${this.opts.url}/restate/invocation/${send.invocationId}/attach`;
355
- const httpResponse = await fetch(url, {
356
- method: "GET",
357
- headers,
358
- });
359
- if (httpResponse.ok) {
360
- const responseBuf = new Uint8Array(await httpResponse.arrayBuffer());
361
- const decodedBuf = this.opts.journalValueCodec
362
- ? await this.opts.journalValueCodec.decode(responseBuf)
363
- : responseBuf;
364
- return (resultSerde ?? serde.json).deserialize(decodedBuf);
365
- }
366
- const body = await httpResponse.text();
367
- throw new HttpCallError(httpResponse.status, body, `Request failed: ${httpResponse.status}\n${body}`);
368
- }
369
- }
370
- function computeDelayAsIso(opts) {
371
- const delay = opts.delay();
372
- if (!delay) {
373
- return "send";
374
- }
375
- return `send?delay=${delay}ms`;
376
- }
377
- function serializeBodyWithContentType(body, serde, journalValueCodec) {
378
- let buffer = serde.serialize(body);
379
- if (journalValueCodec) {
380
- buffer = journalValueCodec.encode(buffer);
381
- }
382
- return {
383
- body: buffer,
384
- contentType: serde.contentType,
385
- };
386
- }
387
- //# sourceMappingURL=ingress.js.map