@restatedev/restate-sdk-cloudflare-workers 0.0.0-SNAPSHOT-20241001101403

package/dist/esm/src/common_api.d.ts

@@ -0,0 +1,12 @@
+export type { Context, ObjectContext, ObjectSharedContext, WorkflowContext, WorkflowSharedContext, Rand, GenericCall, GenericSend, } from "./context.js";
+export { CombineablePromise } from "./context.js";
+export type { Serde } from "@restatedev/restate-sdk-core";
+export { serde } from "@restatedev/restate-sdk-core";
+export type { Client, SendClient, ClientCallOptions, ClientSendOptions, } from "./types/rpc.js";
+export { service, object, workflow, handlers, Opts, SendOpts, } from "./types/rpc.js";
+export { rpc } from "./types/rpc.js";
+export type { ServiceDefinition, VirtualObjectDefinition, WorkflowDefinition, } from "@restatedev/restate-sdk-core";
+export type { ServiceBundle, RestateEndpoint } from "./endpoint.js";
+export { RestateError, TerminalError, TimeoutError } from "./types/errors.js";
+export type { Logger, LogParams, RestateLogLevel, LoggerContext, LogSource, } from "./logger.js";
+//# sourceMappingURL=common_api.d.ts.map

package/dist/esm/src/common_api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common_api.d.ts","sourceRoot":"","sources":["../../../src/common_api.ts"],"names":[],"mappings":"AAWA,YAAY,EACV,OAAO,EACP,aAAa,EACb,mBAAmB,EACnB,eAAe,EACf,qBAAqB,EACrB,IAAI,EACJ,WAAW,EACX,WAAW,GACZ,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAElD,YAAY,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAErD,YAAY,EACV,MAAM,EACN,UAAU,EACV,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,OAAO,EACP,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,IAAI,EACJ,QAAQ,GACT,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAErC,YAAY,EACV,iBAAiB,EACjB,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,8BAA8B,CAAC;AAEtC,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC9E,YAAY,EACV,MAAM,EACN,SAAS,EACT,eAAe,EACf,aAAa,EACb,SAAS,GACV,MAAM,aAAa,CAAC"}

package/dist/esm/src/common_api.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2023-2024 - Restate Software, Inc., Restate GmbH
+ *
+ * This file is part of the Restate SDK for Node.js/TypeScript,
+ * which is released under the MIT license.
+ *
+ * You can find a copy of the license in file LICENSE in the root
+ * directory of this repository or package, or at
+ * https://github.com/restatedev/sdk-typescript/blob/main/LICENSE
+ */
+export { CombineablePromise } from "./context.js";
+export { serde } from "@restatedev/restate-sdk-core";
+export { service, object, workflow, handlers, Opts, SendOpts, } from "./types/rpc.js";
+export { rpc } from "./types/rpc.js";
+export { RestateError, TerminalError, TimeoutError } from "./types/errors.js";
+//# sourceMappingURL=common_api.js.map

package/dist/esm/src/common_api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common_api.js","sourceRoot":"","sources":["../../../src/common_api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAYH,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGlD,OAAO,EAAE,KAAK,EAAE,MAAM,8BAA8B,CAAC;AAQrD,OAAO,EACL,OAAO,EACP,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,IAAI,EACJ,QAAQ,GACT,MAAM,gBAAgB,CAAC;AAExB,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AASrC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/esm/src/context.d.ts

@@ -0,0 +1,587 @@
+/// <reference types="node" resolution-mode="require"/>
+import type { Client, SendClient } from "./types/rpc.js";
+import type { RestateContext, RestateObjectContext, RestateObjectSharedContext, RestateWorkflowContext, RestateWorkflowSharedContext, Service, ServiceDefinitionFrom, VirtualObject, VirtualObjectDefinitionFrom, Workflow, WorkflowDefinitionFrom, Serde } from "@restatedev/restate-sdk-core";
+/**
+ * Represents the original request as sent to this handler.
+ *
+ * A request object includes the request headers, and the raw unparsed
+ * request body.
+ */
+export interface Request {
+    /**
+     * The unique id that identifies the current function invocation. This id is guaranteed to be
+     * unique across invocations, but constant across reties and suspensions.
+     */
+    readonly id: string;
+    /**
+     * Request headers - the following headers capture the original invocation headers, as provided to
+     * the ingress.
+     */
+    readonly headers: ReadonlyMap<string, string>;
+    /**
+     * Attempt headers - the following headers are sent by the restate runtime.
+     * These headers are attempt specific, generated by the restate runtime uniquely for each attempt.
+     * These headers might contain information such as the W3C trace context, and attempt specific information.
+     */
+    readonly attemptHeaders: ReadonlyMap<string, string | string[] | undefined>;
+    /**
+     * Raw unparsed request body
+     */
+    readonly body: Uint8Array;
+    /**
+     * Extra arguments provided to the request handler:
+     * Lambda: [Context]
+     * Cloudflare workers: [Env, ExecutionContext]
+     * Deno: [ConnInfo]
+     * Bun: [Server]
+     * These arguments can contain request-specific values that could change after a suspension.
+     * Care should be taken to use them deterministically.
+     */
+    readonly extraArgs: unknown[];
+}
+export type TypedState = Record<string, any>;
+export type UntypedState = {
+    _: never;
+};
+/**
+ * Key value store operations. Only keyed services have an attached key-value store.
+ */
+export interface KeyValueStore<TState extends TypedState> {
+    /**
+     * Get/retrieve state from the Restate runtime.
+     * Note that state objects are serialized with `Buffer.from(JSON.stringify(theObject))`
+     * and deserialized with `JSON.parse(value.toString()) as T`.
+     *
+     * @param name key of the state to retrieve
+     * @returns a Promise that is resolved with the value of the state key
+     *
+     * @example
+     * const state = await ctx.get<string>("STATE");
+     */
+    get<TValue, TKey extends keyof TState = string>(name: TState extends UntypedState ? string : TKey, serde?: Serde<TState extends UntypedState ? TValue : TState[TKey]>): Promise<(TState extends UntypedState ? TValue : TState[TKey]) | null>;
+    stateKeys(): Promise<Array<string>>;
+    /**
+     * Set/store state in the Restate runtime.
+     * Note that state objects are serialized with `Buffer.from(JSON.stringify(theObject))`
+     * and deserialized with `JSON.parse(value.toString()) as T`.
+     *
+     * @param name key of the state to set
+     * @param value value to set
+     *
+     * @example
+     * ctx.set("STATE", "Hello");
+     */
+    set<TValue, TKey extends keyof TState = string>(name: TState extends UntypedState ? string : TKey, value: TState extends UntypedState ? TValue : TState[TKey], serde?: Serde<TState extends UntypedState ? TValue : TState[TKey]>): void;
+    /**
+     * Clear/delete state in the Restate runtime.
+     * @param name key of the state to delete
+     *
+     * @example
+     * ctx.clear("STATE");
+     */
+    clear<TKey extends keyof TState>(name: TState extends UntypedState ? string : TKey): void;
+    /**
+     * Clear/delete all the state entries in the Restate runtime.
+     *
+     * @example
+     * ctx.clearAll();
+     */
+    clearAll(): void;
+}
+export interface SendOptions {
+    /**
+     * Makes a type-safe one-way RPC to the specified target service, after a delay specified by the
+     * milliseconds' argument.
+     * This method is like setting up a fault-tolerant cron job that enqueues the message in a
+     * message queue.
+     * The handler calling this function does not have to stay active for the delay time.
+     *
+     * Both the delay timer and the message are durably stored in Restate and guaranteed to be reliably
+     * delivered. The delivery happens no earlier than specified through the delay, but may happen
+     * later, if the target service is down, or backpressuring the system.
+     *
+     * The delay message is journaled for durable execution and will thus not be duplicated when the
+     * handler is re-invoked for retries or after suspending.
+     *
+     * This call will return immediately; the message sending happens asynchronously in the background.
+     * Despite that, the message is guaranteed to be sent, because the completion of the invocation that
+     * triggers the send (calls this function) happens logically after the sending. That means that any
+     * failure where the message does not reach Restate also cannot complete this invocation, and will
+     * hence recover this handler and (through the durable execution) recover the message to be sent.
+     *
+     * @example
+     * ```ts
+     * ctx.serviceSendClient(Service, {delay: 60_000}).anotherAction(1337);
+     * ```
+     */
+    delay?: number;
+}
+export interface ContextDate {
+    /** Returns the number of milliseconds elapsed since midnight, January 1, 1970 Universal Coordinated Time (UTC).
+     *  This is equivalent to Date.now()
+     */
+    now(): Promise<number>;
+    /** Returns the JSON representation of the current date.
+     * This is equivalent to new Date().toJSON()
+     **/
+    toJSON(): Promise<string>;
+}
+/**
+ * A function that can be run and its result durably persisted by Restate.
+ */
+export type RunAction<T> = (() => Promise<T>) | (() => T);
+export type RunOptions<T> = {
+    serde?: Serde<T>;
+};
+/**
+ * Call a handler directly avoiding restate's type safety checks.
+ * This is a generic machnisim to invoke handlers directly by only knowing
+ * the service and handler name, (or key in the case of objects or workflows)
+ */
+export type GenericCall<REQ, RES> = {
+    service: string;
+    method: string;
+    parameter: REQ;
+    key?: string;
+    inputSerde?: Serde<REQ>;
+    outputSerde?: Serde<RES>;
+};
+/**
+ * Send a message to an handler directly avoiding restate's type safety checks.
+ * This is a generic machnisim to invoke handlers directly by only knowing
+ * the service and handler name, (or key in the case of objects or workflows)
+ */
+export type GenericSend<REQ> = {
+    service: string;
+    method: string;
+    parameter: REQ;
+    key?: string;
+    inputSerde?: Serde<REQ>;
+    delay?: number;
+};
+/**
+ * The context that gives access to all Restate-backed operations, for example
+ *   - sending reliable messages / RPC through Restate
+ *   - execute non-deterministic closures and memoize their result
+ *   - sleeps and delayed calls
+ *   - awakeables
+ *   - ...
+ *
+ * Virtual objects can also access their key-value store using the {@link ObjectContext}.
+ *
+ */
+export interface Context extends RestateContext {
+    /**
+     * Deterministic random methods; these are inherently predictable (seeded on the invocation ID, which is not secret)
+     * and so should not be used for any cryptographic purposes. They are useful for identifiers, idempotency keys,
+     * and for uniform sampling from a set of options. If a cryptographically secure value is needed, please generate that
+     * externally and capture the result with a side effect.
+     *
+     * Calls to these methods from inside `ctx.run` are disallowed and will fail - side effects must be idempotent, and
+     * these calls are not.
+     */
+    rand: Rand;
+    /**
+     * Console to use for logging. It attaches to each log message some contextual information,
+     * such as invoked service method and invocation id, and automatically excludes logs during replay.
+     */
+    console: Console;
+    /**
+     * Deterministic date.
+     */
+    date: ContextDate;
+    /**
+     * Run an operation and store the result in Restate. The operation will thus not
+     * be re-run during a later replay, but take the durable result from Restate.
+     *
+     * This let you capture potentially non-deterministic computation and interaction
+     * with external systems in a safe way.
+     *
+     * Failure semantics are:
+     *   - If an operation has run and persisted before, the result (value or Error) will be
+     *     taken from the Restate journal.
+     *   - There is a small window where an action may be re-run, if a failure
+     *     occurred between a successful run and persisting the result.
+     *   - No second action will be run while a previous run's result is not
+     *     yet durable. That way, effects that build on top of each other can assume
+     *     deterministic results from previous runs, and at most one run will be
+     *     re-executed on replay (the latest, if the failure happened in the small windows
+     *     described above).
+     *
+     * @example
+     * ```ts
+     * const result = await ctx.run(someExternalAction)
+     *```
+  
+     * @example
+     * ```ts
+     *    await ctx.run("payment action", async () => {
+     *        const result = await paymentProvider.charge(txId, paymentInfo);
+     *        if (result.paymentRejected) {
+     *            // this action will not be retried anymore
+     *            throw new TerminalError("Payment failed");
+     *        } else if (result.paymentGatewayBusy) {
+     *            // restate will retry automatically
+     *            throw new Exception("Payment gateway busy");
+     *        } else {
+     *            // success!
+     *        }
+     *   });
+     *
+     * ```
+     *
+     * @param action The function to run.
+     */
+    run<T>(action: RunAction<T>): Promise<T>;
+    /**
+     * Run an operation and store the result in Restate. The operation will thus not
+     * be re-run during a later replay, but take the durable result from Restate.
+     *
+     * @param name the action's name
+     * @param action the action to run.
+     */
+    run<T>(name: string, action: RunAction<T>): Promise<T>;
+    run<T>(name: string, action: RunAction<T>, options: RunOptions<T>): Promise<T>;
+    /**
+     * Register an awakeable and pause the processing until the awakeable ID (and optional payload) have been returned to the service
+     * (via ctx.completeAwakeable(...)). The SDK deserializes the payload with `JSON.parse(result.toString()) as T`.
+     * @returns
+     * - id: the string ID that has to be used to complete the awakaeble by some external service
+     * - promise: the Promise that needs to be awaited and that is resolved with the payload that was supplied by the service which completed the awakeable
+     *
+     * @example
+     * const awakeable = ctx.awakeable<string>();
+     *
+     * // send the awakeable ID to some external service that will wake this one back up
+     * // The ID can be retrieved by:
+     * const id = awakeable.id;
+     *
+     * // ... send to external service ...
+     *
+     * // Wait for the external service to wake this service back up
+     * const result = await awakeable.promise;
+     */
+    awakeable<T>(serde?: Serde<T>): {
+        id: string;
+        promise: CombineablePromise<T>;
+    };
+    /**
+     * Resolve an awakeable.
+     * @param id the string ID of the awakeable.
+     * This is supplied by the service that needs to be woken up.
+     * @param payload the payload to pass to the service that is woken up.
+     * The SDK serializes the payload with `Buffer.from(JSON.stringify(payload))`
+     * and deserializes it in the receiving service with `JSON.parse(result.toString()) as T`.
+     *
+     * @example
+     * // The sleeping service should have sent the awakeableIdentifier string to this service.
+     * ctx.resolveAwakeable(awakeableIdentifier, "hello");
+     */
+    resolveAwakeable<T>(id: string, payload?: T, serde?: Serde<T>): void;
+    /**
+     * Reject an awakeable. When rejecting, the service waiting on this awakeable will be woken up with a terminal error with the provided reason.
+     * @param id the string ID of the awakeable.
+     * This is supplied by the service that needs to be woken up.
+     * @param reason the reason of the rejection.
+     *
+     * @example
+     * // The sleeping service should have sent the awakeableIdentifier string to this service.
+     * ctx.rejectAwakeable(awakeableIdentifier, "super bad error");
+     */
+    rejectAwakeable(id: string, reason: string): void;
+    /**
+     * Sleep until a timeout has passed.
+     * @param millis duration of the sleep in millis.
+     * This is a lower-bound.
+     *
+     * @example
+     * await ctx.sleep(1000);
+     */
+    sleep(millis: number): CombineablePromise<void>;
+    /**
+     * Makes a type-safe request/response RPC to the specified target service.
+     *
+     * The RPC goes through Restate and is guaranteed to be reliably delivered. The RPC is also
+     * journaled for durable execution and will thus not be duplicated when the handler is re-invoked
+     * for retries or after suspending.
+     *
+     * This call will return the result produced by the target handler, or the Error, if the target
+     * handler finishes with a Terminal Error.
+     *
+     * This call is a suspension point: The handler might suspend while awaiting the response and
+     * resume once the response is available.
+     *
+     * @example
+     * *Service Side:*
+     * ```ts
+     * const service = restate.service(
+     *   name: "myservice",
+     *   handlers: {
+     *    someAction:    async(ctx: restate.Context, req: string) => { ... },
+     *    anotherAction: async(ctx: restate.Context, count: number) => { ... }
+     * });
+     *
+     * // option 1: export only the type signature
+     * export type Service = typeof service;
+     *
+     *
+     * restate.endpoint().bind(service).listen(9080);
+     * ```
+     * **Client side:**
+     * ```ts
+     * // option 1: use only types and supply service name separately
+     * const result1 = await ctx.serviceClient<Service>({name: "myservice"}).someAction("hello!");
+     *
+     * // option 2: use full API spec
+     * type MyService: Service = { name: "myservice" };
+     * const result2 = await ctx.serviceClient(Service).anotherAction(1337);
+     * ```
+     */
+    serviceClient<D>(opts: ServiceDefinitionFrom<D>): Client<Service<D>>;
+    /**
+     * Same as {@link serviceClient} but for virtual objects.
+     *
+     * @param opts
+     * @param key the virtual object key
+     */
+    objectClient<D>(opts: VirtualObjectDefinitionFrom<D>, key: string): Client<VirtualObject<D>>;
+    /**
+     * Same as {@link serviceClient} but for workflows.
+     *
+     * @param opts
+     * @param key the workflow key
+     */
+    workflowClient<D>(opts: WorkflowDefinitionFrom<D>, key: string): Client<Workflow<D>>;
+    /**
+     * Same as {@link objectSendClient} but for workflows.
+     *
+     * @param opts
+     * @param key the workflow key
+     */
+    workflowSendClient<D>(opts: WorkflowDefinitionFrom<D>, key: string): SendClient<Workflow<D>>;
+    /**
+     * Makes a type-safe one-way RPC to the specified target service. This method effectively behaves
+     * like enqueuing the message in a message queue.
+     *
+     * The message goes through Restate and is guaranteed to be reliably delivered. The RPC is also
+     * journaled for durable execution and will thus not be duplicated when the handler is re-invoked
+     * for retries or after suspending.
+     *
+     * This call will return immediately; the message sending happens asynchronously in the background.
+     * Despite that, the message is guaranteed to be sent, because the completion of the invocation that
+     * triggers the send (calls this function) happens logically after the sending. That means that any
+     * failure where the message does not reach Restate also cannot complete this invocation, and will
+     * hence recover this handler and (through the durable execution) recover the message to be sent.
+     *
+     * @example
+     * *Service Side:*
+     * ```ts
+     * const service = restate.service(
+     *   name: "myservice",
+     *   handlers: {
+     *    someAction:    async(ctx: restate.Context, req: string) => { ... },
+     *    anotherAction: async(ctx: restate.Context, count: number) => { ... }
+     * });
+     *
+     * // option 1: export only the type signature of the router
+     * export type MyApi = typeof service;
+     *
+     * // option 2: export the API definition with type and name (name)
+     * const MyService: MyApi = { name: "myservice" };
+     *
+     * restate.endpoint().bind(service).listen(9080);
+     * ```
+     * **Client side:**
+     * ```ts
+     * // option 1: use only types and supply service name separately
+     * ctx.serviceSendClient<MyApi>({name: "myservice"}).someAction("hello!");
+     *
+     * // option 2: use full API spec
+     * ctx.serviceSendClient(MyService).anotherAction(1337);
+     * ```
+     */
+    serviceSendClient<D>(service: ServiceDefinitionFrom<D>, opts?: SendOptions): SendClient<Service<D>>;
+    /**
+     * Same as {@link serviceSendClient} but for virtual objects.
+     *
+     * @param obj
+     * @param key the virtual object key
+     * @param opts Send options
+     */
+    objectSendClient<D>(obj: VirtualObjectDefinitionFrom<D>, key: string, opts?: SendOptions): SendClient<VirtualObject<D>>;
+    genericCall<REQ = Uint8Array, RES = Uint8Array>(call: GenericCall<REQ, RES>): Promise<RES>;
+    genericSend<REQ = Uint8Array>(call: GenericSend<REQ>): void;
+    /**
+     * Returns the raw request that triggered that handler.
+     * Use that object to inspect the original request headers
+     */
+    request(): Request;
+}
+/**
+ * The context that gives access to all Restate-backed operations, for example
+ *   - sending reliable messages / RPC through Restate
+ *   - access/update state
+ *   - execute non-deterministic closures and memoize their result
+ *   - sleeps and delayed calls
+ *   - awakeables
+ *   - ...
+ *
+ * This context can be used only within virtual objects.
+ *
+ */
+export interface ObjectContext<TState extends TypedState = UntypedState> extends Context, KeyValueStore<TState>, RestateObjectContext {
+    key: string;
+}
+/**
+ * The context that gives access to all Restate-backed operations, for example
+ *   - sending reliable messages / RPC through Restate
+ *   - execute non-deterministic closures and memoize their result
+ *   - sleeps and delayed calls
+ *   - awakeables
+ *   - ...
+ *
+ * This context can be used only within a shared virtual objects.
+ *
+ */
+export interface ObjectSharedContext<TState extends TypedState = UntypedState> extends Context, RestateObjectSharedContext {
+    key: string;
+    /**
+     * Get/retrieve state from the Restate runtime.
+     * Note that state objects are serialized with `Buffer.from(JSON.stringify(theObject))`
+     * and deserialized with `JSON.parse(value.toString()) as T`.
+     *
+     * @param name key of the state to retrieve
+     * @returns a Promise that is resolved with the value of the state key
+     *
+     * @example
+     * const state = await ctx.get<string>("STATE");
+     */
+    get<TValue, TKey extends keyof TState = string>(name: TState extends UntypedState ? string : TKey, serde?: Serde<TState extends UntypedState ? TValue : TState[TKey]>): Promise<(TState extends UntypedState ? TValue : TState[TKey]) | null>;
+    /**
+     * Retrieve all the state keys for this object.
+     */
+    stateKeys(): Promise<Array<string>>;
+}
+export interface Rand {
+    /**
+     * Equivalent of JS `Math.random()` but deterministic; seeded by the invocation ID of the current invocation,
+     * each call will return a new pseudorandom float within the range [0,1)
+     */
+    random(): number;
+    /**
+     * Using the same random source and seed as random(), produce a UUID version 4 string. This is inherently predictable
+     * based on the invocation ID and should not be used in cryptographic contexts
+     */
+    uuidv4(): string;
+}
+/**
+ * A promise that can be combined using Promise combinators in RestateContext.
+ */
+export type CombineablePromise<T> = Promise<T> & {
+    /**
+     * Creates a promise that awaits for the current promise up to the specified timeout duration.
+     * If the timeout is fired, this Promise will be rejected with a {@link TimeoutError}.
+     *
+     * @param millis duration of the sleep in millis.
+     * This is a lower-bound.
+     */
+    orTimeout(millis: number): Promise<T>;
+};
+export declare const CombineablePromise: {
+    /**
+     * Creates a Promise that is resolved with an array of results when all of the provided Promises
+     * resolve, or rejected when any Promise is rejected.
+     *
+     * See {@link Promise.all} for more details.
+     *
+     * @param values An iterable of Promises.
+     * @returns A new Promise.
+     */
+    all<T extends [] | readonly CombineablePromise<unknown>[]>(values: T): Promise<{ -readonly [P in keyof T]: Awaited<T[P]>; }>;
+    /**
+     * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
+     * or rejected.
+     *
+     * See {@link Promise.race} for more details.
+     *
+     * @param values An iterable of Promises.
+     * @returns A new Promise.
+     */
+    race<T_1 extends [] | readonly CombineablePromise<unknown>[]>(values: T_1): Promise<Awaited<T_1[number]>>;
+    /**
+     * Creates a promise that fulfills when any of the input's promises fulfills, with this first fulfillment value.
+     * It rejects when all the input's promises reject (including when an empty iterable is passed),
+     * with an AggregateError containing an array of rejection reasons.
+     *
+     * See {@link Promise.any} for more details.
+     *
+     * @param values An iterable of Promises.
+     * @returns A new Promise.
+     */
+    any<T_2 extends [] | readonly CombineablePromise<unknown>[]>(values: T_2): Promise<Awaited<T_2[number]>>;
+    /**
+     * Creates a promise that fulfills when all the input's promises settle (including when an empty iterable is passed),
+     * with an array of objects that describe the outcome of each promise.
+     *
+     * See {@link Promise.allSettled} for more details.
+     *
+     * @param values An iterable of Promises.
+     * @returns A new Promise.
+     */
+    allSettled<T_3 extends [] | readonly CombineablePromise<unknown>[]>(values: T_3): Promise<{ -readonly [P_1 in keyof T_3]: PromiseSettledResult<Awaited<T_3[P_1]>>; }>;
+};
+/**
+ * Workflow bound durable promise
+ *
+ * See {@link WorkflowSharedContext} promise..
+ */
+export type DurablePromise<T> = Promise<T> & {
+    /**
+     * Returns the value of the promise, if it has been resolved.
+     */
+    peek(): Promise<T | undefined>;
+    /**
+     * Resolve the promise with the given value.
+     * @param value the value to resolve the promise with
+     */
+    resolve(value?: T): Promise<void>;
+    /**
+     * Reject the promise with the given error message.
+     * @param errorMsg the error message to use for rejection.
+     */
+    reject(errorMsg: string): Promise<void>;
+    /**
+     * Obtain a {@link CombineablePromise} variant of this promise.
+     */
+    get(): CombineablePromise<T>;
+};
+export interface WorkflowSharedContext<TState extends TypedState = UntypedState> extends ObjectSharedContext<TState>, RestateWorkflowSharedContext {
+    /**
+     * Create a durable promise that can be resolved or rejected during the workflow execution.
+     * The promise is bound to the workflow and will be persisted across suspensions and retries.
+     *
+     * @example
+     * ```ts
+     *        const wf = restate.workflow({
+     *              name: "myWorkflow",
+     *              handlers: {
+     *                 run: async (ctx: restate.WorkflowContext) => {
+     *                        // ... do some work ...
+     *                        const payment = await ctx.promise<Payment>("payment.succeeded");
+     *                         // ... do some more work ...
+     *                },
+     *
+     *                onPaymentSucceeded: async (ctx: restate.WorkflowContext, payment) => {
+     *                       // ... handle payment succeeded ...
+     *                        await ctx.promise("payment.succeeded").resolve(payment);
+     *                }
+     *      });
+     *  ```
+     *
+     * @param name the name of the durable promise
+     */
+    promise<T>(name: string, serde?: Serde<T>): DurablePromise<T>;
+}
+export interface WorkflowContext<TState extends TypedState = UntypedState> extends WorkflowSharedContext<TState>, ObjectContext<TState>, RestateWorkflowContext {
+}
+//# sourceMappingURL=context.d.ts.map

package/dist/esm/src/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/context.ts"],"names":[],"mappings":";AAWA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACpB,0BAA0B,EAC1B,sBAAsB,EACtB,4BAA4B,EAC5B,OAAO,EACP,qBAAqB,EACrB,aAAa,EACb,2BAA2B,EAC3B,QAAQ,EACR,sBAAsB,EACtB,KAAK,EACN,MAAM,8BAA8B,CAAC;AAGtC;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE9C;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IAE5E;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAE1B;;;;;;;;OAQG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,EAAE,CAAC;CAC/B;AAGD,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC7C,MAAM,MAAM,YAAY,GAAG;IAAE,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,SAAS,UAAU;IACtD;;;;;;;;;;OAUG;IACH,GAAG,CAAC,MAAM,EAAE,IAAI,SAAS,MAAM,MAAM,GAAG,MAAM,EAC5C,IAAI,EAAE,MAAM,SAAS,YAAY,GAAG,MAAM,GAAG,IAAI,EACjD,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,SAAS,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,GACjE,OAAO,CAAC,CAAC,MAAM,SAAS,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAEzE,SAAS,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAEpC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,MAAM,EAAE,IAAI,SAAS,MAAM,MAAM,GAAG,MAAM,EAC5C,IAAI,EAAE,MAAM,SAAS,YAAY,GAAG,MAAM,GAAG,IAAI,EACjD,KAAK,EAAE,MAAM,SAAS,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,EAC1D,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,SAAS,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,GACjE,IAAI,CAAC;IAER;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,SAAS,MAAM,MAAM,EAC7B,IAAI,EAAE,MAAM,SAAS,YAAY,GAAG,MAAM,GAAG,IAAI,GAChD,IAAI,CAAC;IAER;;;;;OAKG;IACH,QAAQ,IAAI,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACvB;;QAEI;IACJ,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;AAE1D,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;CAClB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,GAAG,EAAE,GAAG,IAAI;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,GAAG,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IACxB,WAAW,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,GAAG,IAAI;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,GAAG,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,WAAW,OAAQ,SAAQ,cAAc;IAC7C;;;;;;;;OAQG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEvD,GAAG,CAAC,CAAC,EACH,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EACpB,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,GACrB,OAAO,CAAC,CAAC,CAAC,CAAC;IAEd;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG;QAC9B,EAAE,EAAE,MAAM,CAAC;QACX,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC;KAChC,CAAC;IAEF;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAErE;;;;;;;;;OASG;IACH,eAAe,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAElD;;;;;;;OAOG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAErE;;;;;OAKG;IACH,YAAY,CAAC,CAAC,EACZ,IAAI,EAAE,2BAA2B,CAAC,CAAC,CAAC,EACpC,GAAG,EAAE,MAAM,GACV,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5B;;;;;OAKG;IACH,cAAc,CAAC,CAAC,EACd,IAAI,EAAE,sBAAsB,CAAC,CAAC,CAAC,EAC/B,GAAG,EAAE,MAAM,GACV,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvB;;;;;OAKG;IACH,kBAAkB,CAAC,CAAC,EAClB,IAAI,EAAE,sBAAsB,CAAC,CAAC,CAAC,EAC/B,GAAG,EAAE,MAAM,GACV,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,iBAAiB,CAAC,CAAC,EACjB,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,EACjC,IAAI,CAAC,EAAE,WAAW,GACjB,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1B;;;;;;OAMG;IACH,gBAAgB,CAAC,CAAC,EAChB,GAAG,EAAE,2BAA2B,CAAC,CAAC,CAAC,EACnC,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,WAAW,GACjB,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhC,WAAW,CAAC,GAAG,GAAG,UAAU,EAAE,GAAG,GAAG,UAAU,EAC5C,IAAI,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,GAC1B,OAAO,CAAC,GAAG,CAAC,CAAC;IAEhB,WAAW,CAAC,GAAG,GAAG,UAAU,EAAE,IAAI,EAAE,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAE5D;;;OAGG;IACH,OAAO,IAAI,OAAO,CAAC;CACpB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa,CAAC,MAAM,SAAS,UAAU,GAAG,YAAY,CACrE,SAAQ,OAAO,EACb,aAAa,CAAC,MAAM,CAAC,EACrB,oBAAoB;IACtB,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,mBAAmB,CAAC,MAAM,SAAS,UAAU,GAAG,YAAY,CAC3E,SAAQ,OAAO,EACb,0BAA0B;IAC5B,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;OAUG;IACH,GAAG,CAAC,MAAM,EAAE,IAAI,SAAS,MAAM,MAAM,GAAG,MAAM,EAC5C,IAAI,EAAE,MAAM,SAAS,YAAY,GAAG,MAAM,GAAG,IAAI,EACjD,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,SAAS,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,GACjE,OAAO,CAAC,CAAC,MAAM,SAAS,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAEzE;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,MAAM,IAAI,MAAM,CAAC;IAEjB;;;OAGG;IACH,MAAM,IAAI,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG;IAC/C;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACvC,CAAC;AAEF,eAAO,MAAM,kBAAkB;IAC7B;;;;;;;;OAQG;uEAEO,CAAC;IAUX;;;;;;;;OAQG;;IAYH;;;;;;;;;OASG;;IAYH;;;;;;;;OAQG;;CAaJ,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG;IAC3C;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAE/B;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElC;;;OAGG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;OAEG;IACH,GAAG,IAAI,kBAAkB,CAAC,CAAC,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,qBAAqB,CAAC,MAAM,SAAS,UAAU,GAAG,YAAY,CAC7E,SAAQ,mBAAmB,CAAC,MAAM,CAAC,EACjC,4BAA4B;IAC9B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;CAC/D;AAED,MAAM,WAAW,eAAe,CAAC,MAAM,SAAS,UAAU,GAAG,YAAY,CACvE,SAAQ,qBAAqB,CAAC,MAAM,CAAC,EACnC,aAAa,CAAC,MAAM,CAAC,EACrB,sBAAsB;CAAG"}