@resonatehq/sdk 0.8.2 → 0.8.3

package/dist/src/resonate.d.ts

@@ -45,11 +45,61 @@ export declare class Resonate {
         };
     });
     /**
-     * Create a local Resonate instance
+     * Initializes a Resonate client instance for local development.
+     *
+     * Creates and returns a Resonate client configured for **local-only execution**
+     * with zero external dependencies. All state is stored in local memory — no
+     * network or external persistence is required. This mode is ideal for rapid
+     * testing, debugging, and experimentation before connecting to a Resonate server.
+     *
+     * The client runs with a `"default"` worker group, a `"default"` process ID,
+     * and an effectively infinite TTL (`Number.MAX_SAFE_INTEGER`) for tasks.
+     *
+     * @returns A {@link Resonate} client instance configured for local development.
+     *
+     * @example
+     * ```ts
+     * const resonate = Resonate.local();
+     * resonate.register(foo);
+     * const result = await resonate.run("foo.1", foo, { data: "test" });
+     * console.log(result);
+     * ```
      */
     static local(): Resonate;
     /**
-     * Create a remote Resonate instance
+     * Initializes a Resonate client instance with remote configuration.
+     *
+     * Creates and returns a Resonate client that connects to a **Resonate Server**
+     * and optional remote message sources. This configuration enables distributed,
+     * durable workers to cooperate and execute functions via **durable RPCs**.
+     *
+     * By default, the client connects to a Resonate Server running locally
+     * (`http://localhost:8001`) and joins the `"default"` worker group.
+     *
+     * The client is identified by a unique process ID (`pid`) and maintains
+     * claimed task leases for the duration specified by `ttl`.
+     *
+     * @param options - Configuration options for the remote client.
+     * @param options.url - The base URL of the remote Resonate Server. Defaults to `"http://localhost:8001"`.
+     * @param options.group - The worker group name. Defaults to `"default"`.
+     * @param options.pid - Optional process identifier for the client. Defaults to a randomly generated UUID.
+     * @param options.ttl - Time-to-live (in seconds) for claimed tasks. Defaults to `1 * util.MIN`.
+     * @param options.auth - Optional authentication credentials for connecting to the remote server.
+     *
+     * @returns A {@link Resonate} client instance configured for remote operation.
+     *
+     * @example
+     * ```ts
+     * const resonate = Resonate.remote({
+     *   url: "https://resonate.example.com",
+     *   group: "analytics",
+     *   ttl: 30,
+     *   auth: { username: "user", password: "secret" },
+     * });
+     *
+     * const result = await resonate.run("task-42", "processData", { input: "dataset.csv" });
+     * console.log(result);
+     * ```
      */
     static remote({ url, group, pid, ttl, auth, }?: {
         url?: string;
@@ -66,7 +116,34 @@ export declare class Resonate {
         };
     }): Resonate;
     /**
-     * Register a function and returns a registered function
+     * Registers a function with Resonate for execution and version control.
+     *
+     * This method makes a function available for distributed or top-level execution
+     * under a specific name and version.
+     *
+     * Providing explicit `name` or `version` options allows precise control over
+     * function identification and versioning, enabling repeatable, distributed
+     * invocation and backward-compatible deployments.
+     *
+     * @param nameOrFunc - Either the function name (string) or the function itself.
+     *   When passing a name, provide the function and optional options as additional parameters.
+     * @param funcOrOptions - The function to register, or an optional configuration object
+     *   with versioning information when the first argument is a name.
+     * @param maybeOptions - Optional configuration object when both name and function are provided.
+     *   Supports a `version` field to specify the registered function version.
+     *
+     * @returns A {@link ResonateFunc} wrapper for the registered function.
+     *   When used as a decorator, returns a decorator that registers the target function
+     *   upon definition.
+     *
+     * @example
+     * ```ts
+     * function greet(ctx: Context, name: string): string {
+     *   return `Hello, ${name}!`;
+     * }
+     *
+     * resonate.register("greet_user", greet, { version: 2 });
+     * ```
      */
     register<F extends Func>(name: string, func: F, options?: {
         version?: number;
@@ -75,25 +152,131 @@ export declare class Resonate {
         version?: number;
     }): ResonateFunc<F>;
     /**
-     * Invoke a function and return a value
+     * Runs a registered function with Resonate and waits for the result.
+     *
+     * This method executes the specified function under a **durable promise**
+     * identified by the provided `id`. If a promise with the same `id` already exists,
+     * Resonate subscribes to its result or returns it immediately if it has already completed.
+     *
+     * Duplicate executions for the same `id` are automatically prevented, ensuring
+     * idempotent and consistent behavior across distributed runs.
+     *
+     * This is a **blocking operation** — execution will not continue until the
+     * function result is available.
+     *
+     * @param id - The unique identifier of the durable promise. Reusing an ID ensures
+     *   idempotent execution.
+     * @param funcOrName - Either the registered function reference or its string name
+     *   to execute.
+     * @param args - Positional arguments passed to the function.
+     *
+     * @returns A promise resolving to the final result returned from the function execution.
+     *
+     * @example
+     * ```ts
+     * const result = await client.run("job-123", "processData", { input: "records.csv" });
+     * console.log("Result:", result);
+     * ```
      */
     run<F extends Func>(id: string, func: F, ...args: ParamsWithOptions<F>): Promise<Return<F>>;
     run<T>(id: string, name: string, ...args: any[]): Promise<T>;
     run<T>(id: string, funcOrName: Func | string, ...args: any[]): Promise<T>;
     /**
-     * Invoke a function and return a promise
+     * Runs a registered function asynchronously with Resonate.
+     *
+     * This method schedules the specified function for execution under a **durable promise**
+     * identified by the provided `id`. If a promise with the same `id` already exists,
+     * Resonate subscribes to its result or returns it immediately if it has already completed.
+     *
+     * Unlike {@link run}, this method is **non-blocking** and immediately returns a
+     * {@link ResonateHandle} that can be awaited or queried later to retrieve the final result
+     * once execution completes.
+     *
+     * Duplicate executions for the same `id` are automatically prevented, ensuring idempotent
+     * and consistent behavior across distributed runs.
+     *
+     * @param id - The unique identifier of the durable promise. Reusing an ID ensures
+     *   idempotent execution.
+     * @param funcOrName - Either the registered function reference or its string name
+     *   to execute.
+     * @param argsWithOpts - Positional arguments and optional configuration parameters
+     *   passed to the function.
+     *
+     * @returns A {@link ResonateHandle} representing the asynchronous execution.
+     *   The handle can be awaited or inspected for status and results.
+     *
+     * @example
+     * ```ts
+     * const handle = await client.beginRun("run-001", "generateReport", { period: "Q3" });
+     * const result = await handle.getResult();
+     * console.log(result);
+     * ```
      */
     beginRun<F extends Func>(id: string, func: F, ...args: ParamsWithOptions<F>): Promise<ResonateHandle<Return<F>>>;
     beginRun<T>(id: string, func: string, ...args: any[]): Promise<ResonateHandle<T>>;
     beginRun(id: string, funcOrName: Func | string, ...args: any[]): Promise<ResonateHandle<any>>;
     /**
-     * Invoke a remote function and return a value
+     * Executes a registered function remotely with Resonate and waits for the result.
+     *
+     * This method runs the specified function on a remote worker or process under a
+     * **durable promise** identified by the provided `id`. If a promise with the same
+     * `id` already exists, Resonate subscribes to its result or returns it immediately
+     * if it has already completed.
+     *
+     * Unlike {@link beginRpc}, this method is **blocking** — it waits for the remote
+     * function to complete and returns the final result before continuing execution.
+     *
+     * Duplicate executions for the same `id` are automatically prevented, ensuring
+     * idempotent and consistent behavior across distributed runs.
+     *
+     * @param id - The unique identifier of the durable promise. Reusing an ID ensures
+     *   idempotent remote execution.
+     * @param funcOrName - Either the registered function reference or its string name
+     *   to execute remotely.
+     * @param args - Positional arguments passed to the remote function.
+     *
+     * @returns A promise resolving to the final result returned from the remote
+     *   function execution.
+     *
+     * @example
+     * ```ts
+     * const result = await client.rpc("job-42", "analyzeData", { file: "input.csv" });
+     * console.log("Remote result:", result);
+     * ```
      */
     rpc<F extends Func>(id: string, func: F, ...args: ParamsWithOptions<F>): Promise<Return<F>>;
     rpc<T>(id: string, name: string, ...args: any[]): Promise<T>;
     rpc<T>(id: string, funcOrName: Func | string, ...args: any[]): Promise<T>;
     /**
-     * Invoke a remote function and return a promise
+     * Initiates a remote procedure call (RPC) with Resonate and returns a handle to the execution.
+     *
+     * This method schedules a registered function for **remote execution** under a durable promise
+     * identified by the provided `id`. The function runs on a remote worker or process as part of
+     * Resonate’s distributed execution environment.
+     *
+     * Unlike {@link rpc}, this method is **non-blocking** and immediately returns a
+     * {@link ResonateHandle} that can be awaited or queried later to retrieve the final result once
+     * remote execution completes.
+     *
+     * If a durable promise with the same `id` already exists, Resonate subscribes to its result or
+     * returns it immediately if it has already completed. Duplicate executions for the same `id`
+     * are automatically prevented, ensuring idempotent and consistent behavior.
+     *
+     * @param id - The unique identifier of the durable promise. Reusing an ID ensures
+     *   idempotent remote execution.
+     * @param funcOrName - Either the registered function reference or its string name to execute remotely.
+     * @param argsWithOpts - Positional arguments and optional configuration parameters
+     *   passed to the remote function.
+     *
+     * @returns A {@link ResonateHandle} representing the asynchronous remote execution.
+     *   The handle can be awaited or inspected for completion and results.
+     *
+     * @example
+     * ```ts
+     * const handle = await client.beginRpc("task-123", "processData", { input: "hello" });
+     * const result = await handle.getResult();
+     * console.log(result);
+     * ```
      */
     beginRpc<F extends Func>(id: string, func: F, ...args: ParamsWithOptions<F>): Promise<ResonateHandle<Return<F>>>;
     beginRpc<T>(id: string, func: string, ...args: any[]): Promise<ResonateHandle<T>>;
@@ -101,16 +284,26 @@ export declare class Resonate {
     schedule<F extends Func>(name: string, cron: string, func: F, ...args: ParamsWithOptions<F>): Promise<ResonateSchedule>;
     schedule(name: string, cron: string, func: string, ...args: any[]): Promise<ResonateSchedule>;
     /**
-     * Get a promise and return a value
+     * Retrieves or subscribes to an existing execution by its unique ID.
+     *
+     * This method attaches to an existing **durable promise** identified by `id`.
+     * If the associated execution is still in progress, it returns a {@link ResonateHandle}
+     * that can be awaited or observed until completion. If the execution has already
+     * finished, the handle is immediately resolved with the stored result.
+     *
+     * Notes:
+     * - A durable promise with the given `id` must already exist.
+     * - This operation is **non-blocking**; awaiting the returned handle will block
+     *   only if the execution is still running.
+     *
+     * @param id - Unique identifier of the target execution or durable promise.
+     *
+     * @returns A {@link ResonateHandle} representing the existing execution.
+     *   The handle can be awaited or queried to retrieve the final result.
      */
     get<T = any>(id: string): Promise<ResonateHandle<T>>;
     options(opts?: Partial<Options>): Options;
-    /** Store a named dependency for use with `Context`.
-     *  The dependency is made available to all functions via
-     *  their execution `Context`.
-     *  Setting a dependency for a name that already exists will
-     *  overwrite the previously set dependency.
-     */
+    private getArgsAndOpts;
     setDependency(name: string, obj: any): void;
     stop(): void;
     private createPromiseAndTask;

package/dist/src/resonate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resonate.d.ts","sourceRoot":"","sources":["../../src/resonate.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAG/D,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IACrB,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,IAAI;IAC1C,GAAG,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,GAAG,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5F,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5F,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC;CAC/C;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED,qBAAa,QAAQ;IACnB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,GAAG,CAAS;IAEpB,OAAO,CAAC,KAAK,CAAgB;IAC7B,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,YAAY,CAAmB;IACvC,OAAO,CAAC,aAAa,CAA2E;IAEhG,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,SAAgB,SAAS,EAAE,SAAS,CAAC;gBAEzB,EACV,GAAe,EACf,KAAiB,EACjB,GAA2C,EAC3C,GAAkB,EAClB,IAAgB,GACjB,GAAE;QACD,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAC;KAC1C;IA6CN;;OAEG;IACH,MAAM,CAAC,KAAK,IAAI,QAAQ;IAQxB;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,EACZ,GAA6B,EAC7B,KAAiB,EACjB,GAA2C,EAC3C,GAAkB,EAClB,IAAgB,GACjB,GAAE;QACD,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAC;QAC9C,iBAAiB,CAAC,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAC;KACvD,GAAG,QAAQ;IAIjB;;OAEG;IACI,QAAQ,CAAC,CAAC,SAAS,IAAI,EAC5B,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EACP,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GACA,YAAY,CAAC,CAAC,CAAC;IACX,QAAQ,CAAC,CAAC,SAAS,IAAI,EAC5B,IAAI,EAAE,CAAC,EACP,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GACA,YAAY,CAAC,CAAC,CAAC;IA+BlB;;OAEG;IACU,GAAG,CAAC,CAAC,SAAS,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3F,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAC5D,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAKtF;;OAEG;IACU,QAAQ,CAAC,CAAC,SAAS,IAAI,EAClC,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,CAAC,EACP,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC5B,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACxB,QAAQ,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IACjF,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IAsC1G;;OAEG;IACU,GAAG,CAAC,CAAC,SAAS,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3F,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAC5D,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAKtF;;OAEG;IACU,QAAQ,CAAC,CAAC,SAAS,IAAI,EAClC,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,CAAC,EACP,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC5B,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACxB,QAAQ,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IACjF,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IA8B7F,QAAQ,CAAC,CAAC,SAAS,IAAI,EAClC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EACP,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC5B,OAAO,CAAC,gBAAgB,CAAC;IACf,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA+B1G;;OAEG;IACU,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAS1D,OAAO,CAAC,IAAI,GAAE,OAAO,CAAC,OAAO,CAAM,GAAG,OAAO;IAKpD;;;;;OAKG;IACI,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,IAAI;IAI3C,IAAI;IAMX,OAAO,CAAC,oBAAoB;IAmB5B,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,kBAAkB;IAiB1B,OAAO,CAAC,WAAW;IAanB,OAAO,CAAC,YAAY;IAgBpB,OAAO,CAAC,SAAS;YA8BH,SAAS;IA4BvB,OAAO,CAAC,MAAM;CAcf"}
+{"version":3,"file":"resonate.d.ts","sourceRoot":"","sources":["../../src/resonate.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAG/D,MAAM,WAAW,cAAc,CAAC,CAAC;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IACrB,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,IAAI;IAC1C,GAAG,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,GAAG,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACvE,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5F,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5F,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,OAAO,CAAC;CAC/C;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED,qBAAa,QAAQ;IACnB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,GAAG,CAAS;IAEpB,OAAO,CAAC,KAAK,CAAgB;IAC7B,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,SAAS,CAAY;IAC7B,OAAO,CAAC,YAAY,CAAmB;IACvC,OAAO,CAAC,aAAa,CAA2E;IAEhG,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IACnC,SAAgB,SAAS,EAAE,SAAS,CAAC;gBAEzB,EACV,GAAe,EACf,KAAiB,EACjB,GAA2C,EAC3C,GAAkB,EAClB,IAAgB,GACjB,GAAE;QACD,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAC;KAC1C;IAwEN;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,MAAM,CAAC,KAAK,IAAI,QAAQ;IAQxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,MAAM,CAAC,EACZ,GAA6B,EAC7B,KAAiB,EACjB,GAA2C,EAC3C,GAAkB,EAClB,IAAgB,GACjB,GAAE;QACD,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAC;QAC9C,iBAAiB,CAAC,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAC;KACvD,GAAG,QAAQ;IAIjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACI,QAAQ,CAAC,CAAC,SAAS,IAAI,EAC5B,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EACP,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GACA,YAAY,CAAC,CAAC,CAAC;IACX,QAAQ,CAAC,CAAC,SAAS,IAAI,EAC5B,IAAI,EAAE,CAAC,EACP,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GACA,YAAY,CAAC,CAAC,CAAC;IA+BlB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,GAAG,CAAC,CAAC,SAAS,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3F,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAC5D,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAKtF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,QAAQ,CAAC,CAAC,SAAS,IAAI,EAClC,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,CAAC,EACP,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC5B,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACxB,QAAQ,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IACjF,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IAgD1G;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACU,GAAG,CAAC,CAAC,SAAS,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3F,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAC5D,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IAKtF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,QAAQ,CAAC,CAAC,SAAS,IAAI,EAClC,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,CAAC,EACP,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC5B,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACxB,QAAQ,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IACjF,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IA6B7F,QAAQ,CAAC,CAAC,SAAS,IAAI,EAClC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EACP,GAAG,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC5B,OAAO,CAAC,gBAAgB,CAAC;IACf,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkC1G;;;;;;;;;;;;;;;;;OAiBG;IACU,GAAG,CAAC,CAAC,GAAG,GAAG,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAS1D,OAAO,CAAC,IAAI,GAAE,OAAO,CAAC,OAAO,CAAM,GAAG,OAAO;IAKpD,OAAO,CAAC,cAAc;IAIf,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,IAAI;IAI3C,IAAI;IAMX,OAAO,CAAC,oBAAoB;IAmB5B,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,kBAAkB;IAgB1B,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,YAAY;IAgBpB,OAAO,CAAC,SAAS;YA8BH,SAAS;IA4BvB,OAAO,CAAC,MAAM;CAcf"}

package/dist/src/resonate.js

@@ -32,6 +32,9 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Resonate = void 0;
 const network_1 = require("../dev/network");
@@ -39,6 +42,7 @@ const handler_1 = require("../src/handler");
 const registry_1 = require("../src/registry");
 const clock_1 = require("./clock");
 const encoder_1 = require("./encoder");
+const exceptions_1 = __importDefault(require("./exceptions"));
 const heartbeat_1 = require("./heartbeat");
 const remote_1 = require("./network/remote");
 const options_1 = require("./options");
@@ -70,15 +74,39 @@ class Resonate {
         this.pid = pid;
         this.ttl = ttl;
         this.encoder = new encoder_1.JsonEncoder();
-        if (!url) {
+        // Determine the URL based on priority: url arg > RESONATE_URL > RESONATE_HOST+PORT
+        let resolvedUrl = url;
+        if (!resolvedUrl) {
+            if (process.env.RESONATE_URL) {
+                resolvedUrl = process.env.RESONATE_URL;
+            }
+            else {
+                const resonateScheme = process.env.RESONATE_SCHEME ?? "http";
+                const resonateHost = process.env.RESONATE_HOST;
+                const resonatePort = process.env.RESONATE_PORT ?? "8001";
+                if (resonateHost) {
+                    resolvedUrl = `${resonateScheme}://${resonateHost}:${resonatePort}`;
+                }
+            }
+        }
+        // Determine the auth based on priority: auth arg > RESONATE_USERNAME+RESONATE_PASSWORD
+        let resolvedAuth = auth;
+        if (!resolvedAuth) {
+            const resonateUsername = process.env.RESONATE_USERNAME;
+            const resonatePassword = process.env.RESONATE_PASSWORD ?? "";
+            if (resonateUsername) {
+                resolvedAuth = { username: resonateUsername, password: resonatePassword };
+            }
+        }
+        if (!resolvedUrl) {
             const localNetwork = new network_1.LocalNetwork();
             this.network = localNetwork;
             this.messageSource = localNetwork.getMessageSource();
             this.heartbeat = new heartbeat_1.NoopHeartbeat();
         }
         else {
-            this.network = new remote_1.HttpNetwork({ url, auth, timeout: 1 * util.MIN, headers: {} });
-            this.messageSource = new remote_1.HttpMessageSource({ url, pid, group, auth });
+            this.network = new remote_1.HttpNetwork({ url: resolvedUrl, auth: resolvedAuth, timeout: 1 * util.MIN, headers: {} });
+            this.messageSource = new remote_1.HttpMessageSource({ url: resolvedUrl, pid, group, auth: resolvedAuth });
             this.heartbeat = new heartbeat_1.AsyncHeartbeat(pid, ttl / 2, this.network);
         }
         this.handler = new handler_1.Handler(this.network, this.encoder);
@@ -104,7 +132,25 @@ class Resonate {
         this.messageSource.subscribe("notify", this.onMessage.bind(this));
     }
     /**
-     * Create a local Resonate instance
+     * Initializes a Resonate client instance for local development.
+     *
+     * Creates and returns a Resonate client configured for **local-only execution**
+     * with zero external dependencies. All state is stored in local memory — no
+     * network or external persistence is required. This mode is ideal for rapid
+     * testing, debugging, and experimentation before connecting to a Resonate server.
+     *
+     * The client runs with a `"default"` worker group, a `"default"` process ID,
+     * and an effectively infinite TTL (`Number.MAX_SAFE_INTEGER`) for tasks.
+     *
+     * @returns A {@link Resonate} client instance configured for local development.
+     *
+     * @example
+     * ```ts
+     * const resonate = Resonate.local();
+     * resonate.register(foo);
+     * const result = await resonate.run("foo.1", foo, { data: "test" });
+     * console.log(result);
+     * ```
      */
     static local() {
         return new Resonate({
@@ -114,7 +160,39 @@ class Resonate {
         });
     }
     /**
-     * Create a remote Resonate instance
+     * Initializes a Resonate client instance with remote configuration.
+     *
+     * Creates and returns a Resonate client that connects to a **Resonate Server**
+     * and optional remote message sources. This configuration enables distributed,
+     * durable workers to cooperate and execute functions via **durable RPCs**.
+     *
+     * By default, the client connects to a Resonate Server running locally
+     * (`http://localhost:8001`) and joins the `"default"` worker group.
+     *
+     * The client is identified by a unique process ID (`pid`) and maintains
+     * claimed task leases for the duration specified by `ttl`.
+     *
+     * @param options - Configuration options for the remote client.
+     * @param options.url - The base URL of the remote Resonate Server. Defaults to `"http://localhost:8001"`.
+     * @param options.group - The worker group name. Defaults to `"default"`.
+     * @param options.pid - Optional process identifier for the client. Defaults to a randomly generated UUID.
+     * @param options.ttl - Time-to-live (in seconds) for claimed tasks. Defaults to `1 * util.MIN`.
+     * @param options.auth - Optional authentication credentials for connecting to the remote server.
+     *
+     * @returns A {@link Resonate} client instance configured for remote operation.
+     *
+     * @example
+     * ```ts
+     * const resonate = Resonate.remote({
+     *   url: "https://resonate.example.com",
+     *   group: "analytics",
+     *   ttl: 30,
+     *   auth: { username: "user", password: "secret" },
+     * });
+     *
+     * const result = await resonate.run("task-42", "processData", { input: "dataset.csv" });
+     * console.log(result);
+     * ```
      */
     static remote({ url = "http://localhost:8001", group = "default", pid = crypto.randomUUID().replace(/-/g, ""), ttl = 1 * util.MIN, auth = undefined, } = {}) {
         return new Resonate({ url, group, pid, ttl, auth });
@@ -122,13 +200,13 @@ class Resonate {
     register(nameOrFunc, funcOrOptions, maybeOptions = {}) {
         const { version = 1 } = (typeof funcOrOptions === "object" ? funcOrOptions : maybeOptions) ?? {};
         const func = typeof nameOrFunc === "function" ? nameOrFunc : funcOrOptions;
-        const name = typeof nameOrFunc === "string" ? nameOrFunc : (func.name ?? "anonymous");
+        const name = typeof nameOrFunc === "string" ? nameOrFunc : func.name;
         this.registry.add(func, name, version);
         return {
-            run: (id, ...args) => this.run(id, func, ...util.splitArgsAndOpts(args, this.options({ version: version }))),
-            rpc: (id, ...args) => this.rpc(id, func, ...util.splitArgsAndOpts(args, this.options({ version: version }))),
-            beginRun: (id, ...args) => this.beginRun(id, func, ...util.splitArgsAndOpts(args, this.options({ version: version }))),
-            beginRpc: (id, ...args) => this.beginRpc(id, func, ...util.splitArgsAndOpts(args, this.options({ version: version }))),
+            run: (id, ...args) => this.run(id, func, ...this.getArgsAndOpts(args, version)),
+            rpc: (id, ...args) => this.rpc(id, func, ...this.getArgsAndOpts(args, version)),
+            beginRun: (id, ...args) => this.beginRun(id, func, ...this.getArgsAndOpts(args, version)),
+            beginRpc: (id, ...args) => this.beginRpc(id, func, ...this.getArgsAndOpts(args, version)),
             options: this.options,
         };
     }
@@ -136,8 +214,13 @@ class Resonate {
         return (await this.beginRun(id, funcOrName, ...args)).result();
     }
     async beginRun(id, funcOrName, ...argsWithOpts) {
-        const [args, opts] = util.splitArgsAndOpts(argsWithOpts, this.options());
+        const [args, opts] = this.getArgsAndOpts(argsWithOpts);
         const registered = this.registry.get(funcOrName, opts.version);
+        // function must be registered
+        if (!registered) {
+            throw exceptions_1.default.REGISTRY_FUNCTION_NOT_REGISTERED(typeof funcOrName === "string" ? funcOrName : funcOrName.name, opts.version);
+        }
+        util.assert(registered.version > 0, "function version must be greater than zero");
         const { promise, task } = await this.createPromiseAndTask({
             kind: "createPromiseAndTask",
             promise: {
@@ -147,7 +230,7 @@ class Resonate {
                     data: {
                         func: registered.name,
                         args: args,
-                        version: opts.version,
+                        version: registered.version,
                     },
                 },
                 tags: {
@@ -172,13 +255,11 @@ class Resonate {
         return (await this.beginRpc(id, funcOrName, ...args)).result();
     }
     async beginRpc(id, funcOrName, ...argsWithOpts) {
-        const [args, opts] = util.splitArgsAndOpts(argsWithOpts, this.options());
-        let name;
-        if (typeof funcOrName === "string") {
-            name = funcOrName;
-        }
-        else {
-            name = this.registry.get(funcOrName, opts.version).name;
+        const [args, opts] = this.getArgsAndOpts(argsWithOpts);
+        const registered = this.registry.get(funcOrName, opts.version);
+        // function must be registered if function pointer is provided
+        if (typeof funcOrName === "function" && !registered) {
+            throw exceptions_1.default.REGISTRY_FUNCTION_NOT_REGISTERED(funcOrName.name, opts.version);
         }
         const promise = await this.createPromise({
             kind: "createPromise",
@@ -186,9 +267,9 @@ class Resonate {
             timeout: Date.now() + opts.timeout,
             param: {
                 data: {
-                    func: name,
+                    func: registered ? registered.name : funcOrName,
                     args: args,
-                    version: opts.version,
+                    version: registered ? registered.version : opts.version || 1,
                 },
             },
             tags: { ...opts.tags, "resonate:invoke": opts.target, "resonate:scope": "global" },
@@ -197,17 +278,19 @@ class Resonate {
         });
         return this.createHandle(promise);
     }
-    async schedule(name, cron, func, ...argsWithOpts) {
-        const [args, opts] = util.splitArgsAndOpts(argsWithOpts, this.options());
-        let funcName;
-        if (typeof func === "string") {
-            funcName = func;
-        }
-        else {
-            funcName = this.registry.get(func, opts.version).name;
+    async schedule(name, cron, funcOrName, ...argsWithOpts) {
+        const [args, opts] = this.getArgsAndOpts(argsWithOpts);
+        const registered = this.registry.get(funcOrName, opts.version);
+        // function must be registered if function pointer is provided
+        if (typeof funcOrName === "function" && !registered) {
+            throw exceptions_1.default.REGISTRY_FUNCTION_NOT_REGISTERED(funcOrName.name, opts.version);
         }
         // TODO: move this into the handler?
-        const { headers, data } = this.encoder.encode({ func: funcName, args, version: opts.version });
+        const { headers, data } = this.encoder.encode({
+            func: registered ? registered.name : funcOrName,
+            args: args,
+            version: registered ? registered.version : opts.version || 1,
+        });
         await this.schedules.create(name, cron, "{{.id}}.{{.timestamp}}", opts.timeout, {
             ikey: name,
             promiseHeaders: headers,
@@ -219,7 +302,22 @@ class Resonate {
         };
     }
     /**
-     * Get a promise and return a value
+     * Retrieves or subscribes to an existing execution by its unique ID.
+     *
+     * This method attaches to an existing **durable promise** identified by `id`.
+     * If the associated execution is still in progress, it returns a {@link ResonateHandle}
+     * that can be awaited or observed until completion. If the execution has already
+     * finished, the handle is immediately resolved with the stored result.
+     *
+     * Notes:
+     * - A durable promise with the given `id` must already exist.
+     * - This operation is **non-blocking**; awaiting the returned handle will block
+     *   only if the execution is still running.
+     *
+     * @param id - Unique identifier of the target execution or durable promise.
+     *
+     * @returns A {@link ResonateHandle} representing the existing execution.
+     *   The handle can be awaited or queried to retrieve the final result.
      */
     async get(id) {
         const promise = await this.readPromise({
@@ -232,12 +330,9 @@ class Resonate {
         const target = opts.target ?? this.anycastNoPreference;
         return new options_1.Options({ target, ...opts });
     }
-    /** Store a named dependency for use with `Context`.
-     *  The dependency is made available to all functions via
-     *  their execution `Context`.
-     *  Setting a dependency for a name that already exists will
-     *  overwrite the previously set dependency.
-     */
+    getArgsAndOpts(args, version) {
+        return util.splitArgsAndOpts(args, this.options({ version }));
+    }
     setDependency(name, obj) {
         this.dependencies.set(name, obj);
     }
@@ -249,30 +344,27 @@ class Resonate {
     createPromiseAndTask(req) {
         return new Promise((resolve, reject) => this.handler.createPromiseAndTask(req, (err, res) => {
             if (err) {
-                // TODO: improve this message
-                reject(new Error(`Promise '${req.promise.id}' could not be created`));
+                reject(err);
             }
             else {
                 resolve({ promise: res.promise, task: res.task });
             }
-        }, true));
+        }, undefined, true));
     }
     createPromise(req) {
         return new Promise((resolve, reject) => this.handler.createPromise(req, (err, res) => {
             if (err) {
-                // TODO: improve this message
-                reject(new Error(`Promise '${req.id}' could not be created`));
+                reject(err);
             }
             else {
                 resolve(res);
             }
-        }, true));
+        }, undefined, true));
     }
     createSubscription(req) {
         return new Promise((resolve, reject) => this.handler.createSubscription(req, (err, res) => {
             if (err) {
-                // TODO: improve this message
-                reject(new Error(`Subscription for promise '${req.promiseId}' could not be created`));
+                reject(err);
             }
             else {
                 resolve(res);
@@ -282,8 +374,7 @@ class Resonate {
     readPromise(req) {
         return new Promise((resolve, reject) => this.handler.readPromise(req, (err, res) => {
             if (err) {
-                // TODO: improve this message
-                reject(new Error(`Promise '${req.id}' not found`));
+                reject(err);
             }
             else {
                 resolve(res);