@resonatehq/sdk 0.3.3 → 0.3.4

package/dist/async.d.ts

@@ -0,0 +1,135 @@
+import { ResonatePromise } from "./core/future";
+import { Invocation } from "./core/invocation";
+import { ResonateOptions, Options, PartialOptions } from "./core/options";
+import { ResonateBase } from "./resonate";
+export type AFunc = (ctx: Context, ...args: any[]) => any;
+export type IFunc = (info: Info, ...args: any[]) => any;
+export type Params<F> = F extends (ctx: any, ...args: infer P) => any ? P : never;
+export type Return<F> = F extends (...args: any[]) => infer T ? Awaited<T> : never;
+export declare class Resonate extends ResonateBase {
+    private scheduler;
+    /**
+     * Creates a Resonate instance. This is the starting point for using Resonate.
+     *
+     * @constructor
+     * @param opts - A partial {@link ResonateOptions} object.
+     */
+    constructor(opts?: Partial<ResonateOptions>);
+    /**
+     * Register a function with Resonate. Registered functions can be invoked by calling {@link run}, or by the returned function.
+     *
+     * @template F The type of the function.
+     * @param name A unique name to identify the function.
+     * @param func The function to register with Resonate.
+     * @param opts Resonate options, can be constructed by calling {@link options}.
+     * @returns Resonate function
+     */
+    register<F extends AFunc>(name: string, func: F, opts?: Partial<Options>): (id: string, ...args: any) => ResonatePromise<Return<F>>;
+    /**
+     * Register a function with Resonate. Registered functions can be invoked by calling {@link run}, or by the returned function.
+     *
+     * @template F The type of the function.
+     * @param name A unique name to identify the function.
+     * @param version Version of the function.
+     * @param func The function to register with Resonate.
+     * @param opts Resonate options, can be constructed by calling {@link options}.
+     * @returns Resonate function
+     */
+    register<F extends AFunc>(name: string, version: number, func: F, opts?: Partial<Options>): (id: string, ...args: any) => ResonatePromise<Return<F>>;
+    /**
+     * Register a module with Resonate. Registered functions can be invoked by calling {@link run}.
+     *
+     * @template F The type of the function.
+     * @param module The module to register with Resonate.
+     * @param opts Resonate options, can be constructed by calling {@link options}.
+     * @returns Resonate function
+     */
+    registerModule<F extends AFunc>(module: Record<string, F>, opts?: Partial<Options>): void;
+    protected execute<F extends AFunc>(name: string, version: number, id: string, func: F, args: Params<F>, opts: Options): ResonatePromise<Return<F>>;
+}
+export declare class Info {
+    private invocation;
+    constructor(invocation: Invocation<any>);
+    /**
+     * The running count of function execution attempts.
+     */
+    get attempt(): number;
+    /**
+     * Uniquely identifies the function invocation.
+     */
+    get id(): string;
+    /**
+     * Deduplicates function invocations with the same id.
+     */
+    get idempotencyKey(): string | undefined;
+    /**
+     * The timestamp in ms, once this time elapses the function invocation will timeout.
+     */
+    get timeout(): number;
+    /**
+     * The resonate function version.
+     */
+    get version(): number;
+}
+export declare class Context {
+    private invocation;
+    constructor(invocation: Invocation<any>);
+    /**
+     * The running count of child function invocations.
+     */
+    get counter(): number;
+    /**
+     * Uniquely identifies the function invocation.
+     */
+    get id(): string;
+    /**
+     * Deduplicates function invocations with the same id.
+     */
+    get idempotencyKey(): string | undefined;
+    /**
+     * The timestamp in ms, once this time elapses the function invocation will timeout.
+     */
+    get timeout(): number;
+    /**
+     * The resonate function version.
+     */
+    get version(): number;
+    /**
+     * Invoke a function.
+     *
+     * @template F The type of the function.
+     * @param func The function to invoke.
+     * @param args The function arguments, optionally followed by {@link options}.
+     * @returns A promise that resolves to the return value of the function.
+     */
+    run<F extends AFunc>(func: F, ...args: [...Params<F>, PartialOptions?]): ResonatePromise<Return<F>>;
+    /**
+     * Invoke a remote function.
+     *
+     * @template T The return type of the remote function.
+     * @param func The id of the remote function.
+     * @param args The arguments to pass to the remote function.
+     * @param opts Optional {@link options}.
+     * @returns A promise that resolves to the resolved value of the remote function.
+     */
+    run<T>(func: string, args?: any, opts?: PartialOptions): ResonatePromise<T>;
+    /**
+     * Invoke an io function.
+     *
+     * @template F The type of the function.
+     * @param func The function to invoke.
+     * @param args The function arguments, optionally followed by {@link options}.
+     * @returns A promise that resolves to the return value of the function.
+     */
+    io<F extends IFunc>(func: F, ...args: [...Params<F>, PartialOptions?]): ResonatePromise<Return<F>>;
+    /**
+     * Construct options.
+     *
+     * @param opts A partial {@link Options} object.
+     * @returns Options with the __resonate flag set.
+     */
+    options(opts?: Partial<Options>): Partial<Options> & {
+        __resonate: true;
+    };
+}
+//# sourceMappingURL=async.d.ts.map

package/dist/async.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"async.d.ts","sourceRoot":"","sources":["../lib/async.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAG1E,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAM1C,MAAM,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAE1D,MAAM,MAAM,KAAK,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAExD,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC;AAElF,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;AAMnF,qBAAa,QAAS,SAAQ,YAAY;IACxC,OAAO,CAAC,SAAS,CAAY;IAE7B;;;;;OAKG;gBACS,IAAI,GAAE,OAAO,CAAC,eAAe,CAAM;IAK/C;;;;;;;;OAQG;IACH,QAAQ,CAAC,CAAC,SAAS,KAAK,EACtB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EACP,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GACtB,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAE3D;;;;;;;;;OASG;IACH,QAAQ,CAAC,CAAC,SAAS,KAAK,EACtB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,CAAC,EACP,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GACtB,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAS3D;;;;;;;OAOG;IACH,cAAc,CAAC,CAAC,SAAS,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,IAAI,GAAE,OAAO,CAAC,OAAO,CAAM;IAItF,SAAS,CAAC,OAAO,CAAC,CAAC,SAAS,KAAK,EAC/B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,EACf,IAAI,EAAE,OAAO,GACZ,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAG9B;AAMD,qBAAa,IAAI;IACH,OAAO,CAAC,UAAU;gBAAV,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC;IAE/C;;OAEG;IACH,IAAI,OAAO,WAEV;IAED;;OAEG;IACH,IAAI,EAAE,WAEL;IAED;;OAEG;IACH,IAAI,cAAc,uBAEjB;IAED;;OAEG;IACH,IAAI,OAAO,WAEV;IAED;;OAEG;IACH,IAAI,OAAO,WAEV;CACF;AAED,qBAAa,OAAO;IACN,OAAO,CAAC,UAAU;gBAAV,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC;IAE/C;;OAEG;IACH,IAAI,OAAO,WAEV;IAED;;OAEG;IACH,IAAI,EAAE,WAEL;IAED;;OAEG;IACH,IAAI,cAAc,uBAEjB;IAED;;OAEG;IACH,IAAI,OAAO,WAEV;IAED;;OAEG;IACH,IAAI,OAAO,WAEV;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAEnG;;;;;;;;OAQG;IACH,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,eAAe,CAAC,CAAC,CAAC;IA4C3E;;;;;;;OAOG;IACH,EAAE,CAAC,CAAC,SAAS,KAAK,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IA0BlG;;;;;OAKG;IACH,OAAO,CAAC,IAAI,GAAE,OAAO,CAAC,OAAO,CAAM,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG;QAAE,UAAU,EAAE,IAAI,CAAA;KAAE;CAG9E"}

package/dist/async.js

@@ -0,0 +1,205 @@
+import { OrdinaryExecution, DeferredExecution } from "./core/execution";
+import { Invocation } from "./core/invocation";
+import { Retry } from "./core/retries/retry";
+import * as utils from "./core/utils";
+import { ResonateBase } from "./resonate";
+/////////////////////////////////////////////////////////////////////
+// Resonate
+/////////////////////////////////////////////////////////////////////
+export class Resonate extends ResonateBase {
+    scheduler;
+    /**
+     * Creates a Resonate instance. This is the starting point for using Resonate.
+     *
+     * @constructor
+     * @param opts - A partial {@link ResonateOptions} object.
+     */
+    constructor(opts = {}) {
+        super(opts);
+        this.scheduler = new Scheduler();
+    }
+    register(name, funcOrVersion, funcOrOpts) {
+        return super.register(name, funcOrVersion, funcOrOpts);
+    }
+    /**
+     * Register a module with Resonate. Registered functions can be invoked by calling {@link run}.
+     *
+     * @template F The type of the function.
+     * @param module The module to register with Resonate.
+     * @param opts Resonate options, can be constructed by calling {@link options}.
+     * @returns Resonate function
+     */
+    registerModule(module, opts = {}) {
+        super.registerModule(module, opts);
+    }
+    execute(name, version, id, func, args, opts) {
+        return this.scheduler.add(name, version, id, func, args, opts);
+    }
+}
+/////////////////////////////////////////////////////////////////////
+// Context
+/////////////////////////////////////////////////////////////////////
+export class Info {
+    invocation;
+    constructor(invocation) {
+        this.invocation = invocation;
+    }
+    /**
+     * The running count of function execution attempts.
+     */
+    get attempt() {
+        return this.invocation.attempt;
+    }
+    /**
+     * Uniquely identifies the function invocation.
+     */
+    get id() {
+        return this.invocation.id;
+    }
+    /**
+     * Deduplicates function invocations with the same id.
+     */
+    get idempotencyKey() {
+        return this.invocation.idempotencyKey;
+    }
+    /**
+     * The timestamp in ms, once this time elapses the function invocation will timeout.
+     */
+    get timeout() {
+        return this.invocation.timeout;
+    }
+    /**
+     * The resonate function version.
+     */
+    get version() {
+        return this.invocation.version;
+    }
+}
+export class Context {
+    invocation;
+    constructor(invocation) {
+        this.invocation = invocation;
+    }
+    /**
+     * The running count of child function invocations.
+     */
+    get counter() {
+        return this.invocation.counter;
+    }
+    /**
+     * Uniquely identifies the function invocation.
+     */
+    get id() {
+        return this.invocation.id;
+    }
+    /**
+     * Deduplicates function invocations with the same id.
+     */
+    get idempotencyKey() {
+        return this.invocation.idempotencyKey;
+    }
+    /**
+     * The timestamp in ms, once this time elapses the function invocation will timeout.
+     */
+    get timeout() {
+        return this.invocation.timeout;
+    }
+    /**
+     * The resonate function version.
+     */
+    get version() {
+        return this.invocation.version;
+    }
+    run(func, ...argsWithOpts) {
+        // the parent is the current invocation
+        const parent = this.invocation;
+        // the id is either:
+        // 1. a provided string in the case of a deferred execution
+        // 2. a generated string in the case of an ordinary execution
+        const id = typeof func === "string" ? func : `${parent.id}.${parent.counter}`;
+        // human readable name of the function
+        const name = typeof func === "string" ? func : func.name;
+        // version is inherited from the parent
+        const version = parent.version;
+        // the idempotency key is a hash of the id
+        const idempotencyKey = utils.hash(id);
+        // opts are optional and can be provided as the last arg
+        const { args, opts } = this.invocation.split(argsWithOpts);
+        // create a new invocation
+        const invocation = new Invocation(name, version, id, idempotencyKey, undefined, undefined, opts, parent);
+        let execution;
+        if (typeof func === "string") {
+            // create a deferred execution
+            // this execution will be fulfilled out-of-process
+            execution = new DeferredExecution(invocation);
+        }
+        else {
+            // create an ordinary execution// human readable name of the function
+            // this execution wraps a user-provided function
+            const ctx = new Context(invocation);
+            execution = new OrdinaryExecution(invocation, () => func(ctx, ...args), Retry.never());
+        }
+        // bump the counter
+        parent.counter++;
+        // return a resonate promise
+        return execution.execute();
+    }
+    io(func, ...argsWithOpts) {
+        const parent = this.invocation;
+        const id = `${parent.id}.${parent.counter}`;
+        const idempotencyKey = utils.hash(id);
+        const { args, opts } = this.invocation.split(argsWithOpts);
+        const name = func.name;
+        const version = parent.version;
+        const invocation = new Invocation(name, version, id, idempotencyKey, undefined, undefined, opts, parent);
+        // create an ordinary execution
+        // this execution wraps a user-provided io function
+        // unlike run, an io function can not create child invocations
+        const info = new Info(invocation);
+        const execution = new OrdinaryExecution(invocation, () => func(info, ...args));
+        // bump the counter
+        parent.counter++;
+        // return a resonate promise
+        return execution.execute();
+    }
+    /**
+     * Construct options.
+     *
+     * @param opts A partial {@link Options} object.
+     * @returns Options with the __resonate flag set.
+     */
+    options(opts = {}) {
+        return { ...opts, __resonate: true };
+    }
+}
+/////////////////////////////////////////////////////////////////////
+// Scheduler
+/////////////////////////////////////////////////////////////////////
+class Scheduler {
+    cache = {};
+    add(name, version, id, func, args, opts) {
+        // if the execution is already running, and not killed,
+        // return the promise
+        if (this.cache[id] && !this.cache[id].killed) {
+            // execute is idempotent
+            return this.cache[id].execute();
+        }
+        // the idempotency key is a hash of the id
+        const idempotencyKey = utils.hash(id);
+        // params, used for recovery
+        const param = {
+            func: name,
+            version,
+            args,
+        };
+        // create a new invocation
+        const invocation = new Invocation(name, version, id, idempotencyKey, undefined, param, opts);
+        // create a new execution
+        const ctx = new Context(invocation);
+        const execution = new OrdinaryExecution(invocation, () => func(ctx, ...args));
+        // store the execution,
+        // will be used if run is called again with the same id
+        this.cache[id] = execution;
+        return execution.execute();
+    }
+}

package/dist/core/encoder.d.ts

@@ -0,0 +1,5 @@
+export interface IEncoder<I, O> {
+    encode(data: I): O;
+    decode(data: O): I;
+}
+//# sourceMappingURL=encoder.d.ts.map

package/dist/core/encoder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encoder.d.ts","sourceRoot":"","sources":["../../lib/core/encoder.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ,CAAC,CAAC,EAAE,CAAC;IAC5B,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC;IACnB,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC;CACpB"}

package/dist/core/encoder.js

@@ -0,0 +1 @@
+export {};

package/dist/core/encoders/base64.d.ts

@@ -0,0 +1,6 @@
+import { IEncoder } from "../encoder";
+export declare class Base64Encoder implements IEncoder<string, string> {
+    encode(data: string): string;
+    decode(data: string): string;
+}
+//# sourceMappingURL=base64.d.ts.map

package/dist/core/encoders/base64.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base64.d.ts","sourceRoot":"","sources":["../../../lib/core/encoders/base64.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,qBAAa,aAAc,YAAW,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAC5D,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAI5B,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAG7B"}

package/dist/core/encoders/base64.js

@@ -0,0 +1,8 @@
+export class Base64Encoder {
+    encode(data) {
+        return btoa(data);
+    }
+    decode(data) {
+        return atob(data);
+    }
+}

package/dist/core/encoders/json.d.ts

@@ -0,0 +1,6 @@
+import { IEncoder } from "../encoder";
+export declare class JSONEncoder implements IEncoder<unknown, string | undefined> {
+    encode(data: unknown): string | undefined;
+    decode(data: string | undefined): unknown;
+}
+//# sourceMappingURL=json.d.ts.map

package/dist/core/encoders/json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../../lib/core/encoders/json.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,qBAAa,WAAY,YAAW,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IACvE,MAAM,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IA2CzC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO;CAuB1C"}

package/dist/core/encoders/json.js

@@ -0,0 +1,60 @@
+import { ResonateError } from "../errors";
+export class JSONEncoder {
+    encode(data) {
+        // note about undefined:
+        // undefined is not json serializable, so immediately return undefined
+        if (data === undefined) {
+            return undefined;
+        }
+        return JSON.stringify(data, (_, value) => {
+            if (value instanceof AggregateError) {
+                return {
+                    __type: "aggregate_error",
+                    message: value.message,
+                    stack: value.stack,
+                    name: value.name,
+                    errors: value.errors,
+                };
+            }
+            if (value instanceof ResonateError) {
+                return {
+                    __type: "resonate_error",
+                    message: value.message,
+                    stack: value.stack,
+                    name: value.name,
+                    code: value.code,
+                    cause: value.cause,
+                    retriable: value.retriable,
+                };
+            }
+            if (value instanceof Error) {
+                return {
+                    __type: "error",
+                    message: value.message,
+                    stack: value.stack,
+                    name: value.name,
+                };
+            }
+            return value;
+        });
+    }
+    decode(data) {
+        // note about undefined:
+        // undefined causes JSON.parse to throw, so immediately return undefined
+        if (data === undefined) {
+            return undefined;
+        }
+        return JSON.parse(data, (_, value) => {
+            if (value?.__type === "aggregate_error") {
+                return Object.assign(new AggregateError(value.errors, value.message), value);
+            }
+            if (value?.__type === "resonate_error") {
+                return Object.assign(new ResonateError(value.message, value.code, value.cause, value.retriable), value);
+            }
+            if (value?.__type === "error") {
+                return Object.assign(new Error(value.message), value);
+            }
+            return value;
+        });
+    }
+}

package/dist/core/errors.d.ts

@@ -0,0 +1,21 @@
+export declare enum ErrorCodes {
+    UNKNOWN = 0,
+    CANCELED = 10,
+    TIMEDOUT = 20,
+    KILLED = 30,
+    STORE = 40,
+    STORE_PAYLOAD = 41,
+    STORE_FORBIDDEN = 42,
+    STORE_NOT_FOUND = 43,
+    STORE_ALREADY_EXISTS = 44,
+    STORE_INVALID_STATE = 45,
+    STORE_ENCODER = 46
+}
+export declare class ResonateError extends Error {
+    readonly code: ErrorCodes;
+    readonly cause?: any;
+    readonly retriable: boolean;
+    constructor(message: string, code: ErrorCodes, cause?: any, retriable?: boolean);
+    static fromError(e: unknown): ResonateError;
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/core/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../lib/core/errors.ts"],"names":[],"mappings":"AAAA,oBAAY,UAAU;IAEpB,OAAO,IAAI;IAGX,QAAQ,KAAK;IAGb,QAAQ,KAAK;IAGb,MAAM,KAAK;IAGX,KAAK,KAAK;IACV,aAAa,KAAK;IAClB,eAAe,KAAK;IACpB,eAAe,KAAK;IACpB,oBAAoB,KAAK;IACzB,mBAAmB,KAAK;IACxB,aAAa,KAAK;CACnB;AAED,qBAAa,aAAc,SAAQ,KAAK;aAGpB,IAAI,EAAE,UAAU;aAChB,KAAK,CAAC;aACN,SAAS,EAAE,OAAO;gBAHlC,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,UAAU,EAChB,KAAK,CAAC,KAAK,EACX,SAAS,GAAE,OAAe;WAK9B,SAAS,CAAC,CAAC,EAAE,OAAO,GAAG,aAAa;CAGnD"}

package/dist/core/errors.js

@@ -0,0 +1,33 @@
+export var ErrorCodes;
+(function (ErrorCodes) {
+    // unknown
+    ErrorCodes[ErrorCodes["UNKNOWN"] = 0] = "UNKNOWN";
+    // canceled
+    ErrorCodes[ErrorCodes["CANCELED"] = 10] = "CANCELED";
+    // timedout
+    ErrorCodes[ErrorCodes["TIMEDOUT"] = 20] = "TIMEDOUT";
+    // killed
+    ErrorCodes[ErrorCodes["KILLED"] = 30] = "KILLED";
+    // store
+    ErrorCodes[ErrorCodes["STORE"] = 40] = "STORE";
+    ErrorCodes[ErrorCodes["STORE_PAYLOAD"] = 41] = "STORE_PAYLOAD";
+    ErrorCodes[ErrorCodes["STORE_FORBIDDEN"] = 42] = "STORE_FORBIDDEN";
+    ErrorCodes[ErrorCodes["STORE_NOT_FOUND"] = 43] = "STORE_NOT_FOUND";
+    ErrorCodes[ErrorCodes["STORE_ALREADY_EXISTS"] = 44] = "STORE_ALREADY_EXISTS";
+    ErrorCodes[ErrorCodes["STORE_INVALID_STATE"] = 45] = "STORE_INVALID_STATE";
+    ErrorCodes[ErrorCodes["STORE_ENCODER"] = 46] = "STORE_ENCODER";
+})(ErrorCodes || (ErrorCodes = {}));
+export class ResonateError extends Error {
+    code;
+    cause;
+    retriable;
+    constructor(message, code, cause, retriable = false) {
+        super(message);
+        this.code = code;
+        this.cause = cause;
+        this.retriable = retriable;
+    }
+    static fromError(e) {
+        return e instanceof ResonateError ? e : new ResonateError("Unknown error", ErrorCodes.UNKNOWN, e, true);
+    }
+}

package/dist/core/execution.d.ts

@@ -0,0 +1,44 @@
+import { Future, ResonatePromise } from "./future";
+import { Invocation } from "./invocation";
+import { DurablePromise } from "./promises/promises";
+import { IRetry } from "./retry";
+export declare abstract class Execution<T> {
+    invocation: Invocation<T>;
+    private promise;
+    /**
+     * Represents an execution of a Resonate function invocation.
+     *
+     * @constructor
+     * @param invocation - An invocation correpsonding to the Resonate function.
+     */
+    constructor(invocation: Invocation<T>);
+    execute(): ResonatePromise<T>;
+    protected abstract fork(): Promise<Future<T>>;
+    protected abstract join(future: Future<T>): Promise<T>;
+    get killed(): boolean;
+    kill(error: unknown): void;
+    protected tags(): Record<string, string>;
+}
+export declare class OrdinaryExecution<T> extends Execution<T> {
+    private func;
+    private retry;
+    constructor(invocation: Invocation<T>, func: () => T, retry?: IRetry);
+    protected fork(): Promise<Future<T>>;
+    protected join(future: Future<T>): Promise<T>;
+    private run;
+}
+export declare class DeferredExecution<T> extends Execution<T> {
+    constructor(invocation: Invocation<T>);
+    protected fork(): Promise<Future<T>>;
+    protected join(future: Future<T>): Promise<T>;
+}
+export declare class GeneratorExecution<T> extends Execution<T> {
+    generator: Generator<any, T>;
+    constructor(invocation: Invocation<T>, generator: Generator<any, T>);
+    create(): Promise<DurablePromise<T> | undefined>;
+    resolve(promise: DurablePromise<T>, value: T): Promise<DurablePromise<T>>;
+    reject(promise: DurablePromise<T>, error: any): Promise<DurablePromise<T>>;
+    protected fork(): Promise<Future<T>>;
+    protected join(future: Future<T>): Promise<T>;
+}
+//# sourceMappingURL=execution.d.ts.map

package/dist/core/execution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execution.d.ts","sourceRoot":"","sources":["../../lib/core/execution.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAMjC,8BAAsB,SAAS,CAAC,CAAC;IASZ,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;IAR5C,OAAO,CAAC,OAAO,CAAmC;IAElD;;;;;OAKG;gBACgB,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;IAE5C,OAAO,IAAI,eAAe,CAAC,CAAC,CAAC;IAY7B,SAAS,CAAC,QAAQ,CAAC,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7C,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAEtD,IAAI,MAAM,YAET;IAED,IAAI,CAAC,KAAK,EAAE,OAAO;IAQnB,SAAS,CAAC,IAAI;CAOf;AAED,qBAAa,iBAAiB,CAAC,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,CAAC;IAGlD,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,KAAK;gBAFb,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EACjB,IAAI,EAAE,MAAM,CAAC,EACb,KAAK,GAAE,MAA8B;cAK/B,IAAI;cAsCJ,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;YAIxB,GAAG;CAmBlB;AAED,qBAAa,iBAAiB,CAAC,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,CAAC;gBACxC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;cAIrB,IAAI;cA6BJ,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAGvC;AAED,qBAAa,kBAAkB,CAAC,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,CAAC;IAG5C,SAAS,EAAE,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC;gBADnC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EAClB,SAAS,EAAE,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC;IAK/B,MAAM;IA6BN,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;IAmB5C,MAAM,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG;cAmBnC,IAAI;cAIJ,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;CAGvC"}