@resonatehq/sdk 0.6.2 → 0.7.0

package/README.md

@@ -12,61 +12,40 @@
 
 </div>
 
-<div align="center">
-  <a href="https://docs.resonatehq.io">Docs</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://twitter.com/resonatehqio">Twitter</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://resonatehq.io/discord">Discord</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://github.com/resonatehq/resonate-sdk-ts/issues">Issues</a>
-  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://github.com/resonatehq/resonate/issues/131">Roadmap</a>
-  <br /><br />
-</div>
-
-## Distributed Async Await
-
-Resonate's Distributed Async Await is a new programming model that simplifies coding for the cloud. It ensures code completion even if hardware or software failures occur during execution. The programming model does this with just functions and promises, making it trivial to build `coordinated` and `reliable` distributed applications.
-
-## Why Resonate?
+## About this component
 
-- **Cloud Computing Made Dead Simple**: Resonate simplifies coding for the cloud using an intuitive paradigm you already know — async await.
+The Resonate TypeScript SDK enables you to build reliable and scalable applications when paired with at least one [Resonate Server](https://github.com/resonatehq/resonate).
 
-- **Single Binary**: Resonate simplifies your deployment and operations with a single binary.
+**IMPORTANT - A new release is currently in development which will support full [Distributed Async Await](https://distributed-async-await.io) and will be tested using Deterministic Simulations. We do not recommend using the current version as the new release will be a breaking change.**
 
-- **Incremental Adoption and No Vendor Lock-In**: Resonate was designed to allow for incremental adoption without vendor lock-in ever.
+- [Contribute to the Resonate Python SDK](./CONTRIBUTING.md)
+- [License](./LICENSE)
 
-- **Built on an Open Standard**: Resonate's programming model is built on top of [durable promises](https://github.com/resonatehq/durable-promise-specification), an open standard with an intentionally minimal API surface area.
+## Directory
 
-## Getting Started
+- [Get started with Resonate](https://docs.resonatehq.io/get-started)
+  - [Try an example application](https://github.com/resonatehq-examples)
+- [Join the community](https://resonatehq.io/discord)
+  - [Subscribe to Resonate HQ](https://journal.resonatehq.io/subscribe)
+  - [Follow on Twitter / X](https://twitter.com/resonatehqio)
+  - [Follow on LinkedIn](https://www.linkedin.com/company/resonatehqio)
+  - [Subscribe on YouTube](https://www.youtube.com/@resonatehqio)
 
-1. [Start building in just 30 seconds](https://docs.resonatehq.io/getting-started/quickstart) with our quickstart guide!
-2. [Explore in-depth code examples](https://github.com/resonatehq/quickstart-ts/tree/main) and get your hands dirty with our comprehensive repository.
-3. [Dive into the TypeScript SDK docs](https://docs.resonatehq.io/sdks/typescript) and learn how to leverage its full potential with our detailed documentation.
-4. [Explore the API reference](https://resonatehq.github.io/resonate-sdk-ts/index.html) of Resonate's TypeScript SDK.
-5. [Grasp the 4 core concepts](https://docs.resonatehq.io/getting-started/concepts) of distributed async/await applications by delving into our concepts page.
-   
-## Core features
-
-The basic features Resonate offers to simplify the reliability and coordination of distributed processes are the following:
-
-- **Retries**: If a process fails while executing a durable promise due to a transient issue, such as network connectivity problems, it can be transparently retried, minimizing the impact of temporary failures.
-
-- **Recoverability**: If a process crashes while executing a durable promise, it can recover and continue from where it left off, ensuring your application remains resilient.
-
-- **Schedules**: Durable promises can be used to schedule statefule reminders using a simple HTTP/gRPC call.
+## Distributed Async Await
 
-- **Task Framework**: Durable promises allow you to fan out tasks across multiple processes or machines, enabling parallel execution and load balancing, making your application more scalable.
+Resonate implements the Distributed Async Await specification — [Learn more](https://www.distributed-async-await.io/)
 
-- **Notifications**: When a durable promise is created or completed, it can trigger notifications to other processes or services that are interested in the result, enabling efficient communication and coordination.
+## Why Resonate
 
-- **Human in the Loop**: Durable promises can seamlessly integrate human input into your automated workflows, allowing for manual intervention or approval steps when needed.
+**Why Resonate?**
 
-## Contributing
+Because developing distributed applications should be a delightful experience — [Learn more](https://docs.resonatehq.io/evaluate/why-resonate)
 
-See our [contribution guidelines](CONTRIBUTING.md).
+## Available SDKs
 
-## License
+Add reliablity and scalability to the language you love.
 
-The Resonate TypeScript SDK is available under the [Apache 2.0 License](LICENSE).
+|                                                      Language                                                       | Source Code                                   | Package                                              | Developer docs                                        |
+| :-----------------------------------------------------------------------------------------------------------------: | --------------------------------------------- | ---------------------------------------------------- | ----------------------------------------------------- |
+|  <img alt="py sdk" src="https://upload.wikimedia.org/wikipedia/commons/c/c3/Python-logo-notext.svg" width="40px"/>  | https://github.com/resonatehq/resonate-sdk-py | [pypi](https://pypi.org/project/resonate-sdk/)       | [docs](https://docs.resonatehq.io/develop/python)     |
+| <img alt="ts sdk" src="https://upload.wikimedia.org/wikipedia/commons/4/4c/Typescript_logo_2020.svg" width="40px"/> | https://github.com/resonatehq/resonate-sdk-ts | [npm](https://www.npmjs.com/package/@resonatehq/sdk) | [docs](https://docs.resonatehq.io/develop/typescript) |

package/dist/dev/network.d.ts

@@ -0,0 +1,16 @@
+import { Server } from "./server";
+import type { Callback } from "types";
+import type { Message, Network, Request, ResponseFor } from "../src/network/network";
+export declare class LocalNetwork implements Network {
+    private server;
+    private timeoutId;
+    private shouldStop;
+    private subscriptions;
+    constructor(server?: Server);
+    stop(): void;
+    send<T extends Request>(req: Request, callback: Callback<ResponseFor<T>>): void;
+    recv(msg: Message): void;
+    subscribe(callback: (msg: Message) => void): void;
+    private enqueueNext;
+}
+//# sourceMappingURL=network.d.ts.map

package/dist/dev/network.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../../dev/network.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACtC,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAGrF,qBAAa,YAAa,YAAW,OAAO;IAC1C,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAA4C;IAC7D,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,aAAa,CAA8C;gBAEvD,MAAM,GAAE,MAAqB;IAKzC,IAAI;IAMJ,IAAI,CAAC,CAAC,SAAS,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;IAc/E,IAAI,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAMxB,SAAS,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI;IAIjD,OAAO,CAAC,WAAW;CAepB"}

package/dist/dev/network.js

@@ -0,0 +1,89 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalNetwork = void 0;
+const server_1 = require("./server");
+const util = __importStar(require("../src/util"));
+class LocalNetwork {
+    server;
+    timeoutId;
+    shouldStop = false;
+    subscriptions = new Array();
+    constructor(server = new server_1.Server()) {
+        this.server = server;
+        this.timeoutId = undefined;
+    }
+    stop() {
+        clearTimeout(this.timeoutId);
+        this.shouldStop = true;
+        this.timeoutId = undefined;
+    }
+    send(req, callback) {
+        setTimeout(() => {
+            try {
+                const res = this.server.process(req, Date.now());
+                util.assert(res.kind === req.kind, "res kind must match req kind");
+                callback(false, res);
+                this.enqueueNext();
+            }
+            catch (err) {
+                callback(true);
+            }
+        });
+    }
+    recv(msg) {
+        for (const callback of this.subscriptions) {
+            callback(msg);
+        }
+    }
+    subscribe(callback) {
+        this.subscriptions.push(callback);
+    }
+    enqueueNext() {
+        clearTimeout(this.timeoutId);
+        const time = Date.now();
+        const next = this.server.next(time);
+        if (next !== undefined && !this.shouldStop) {
+            this.timeoutId = setTimeout(() => {
+                for (const { msg } of this.server.step(time)) {
+                    this.recv(msg);
+                }
+                this.enqueueNext();
+            }, next);
+        }
+    }
+}
+exports.LocalNetwork = LocalNetwork;
+//# sourceMappingURL=network.js.map

package/dist/dev/network.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"network.js","sourceRoot":"","sources":["../../dev/network.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAkC;AAIlC,kDAAoC;AAEpC,MAAa,YAAY;IACf,MAAM,CAAS;IACf,SAAS,CAA4C;IACrD,UAAU,GAAG,KAAK,CAAC;IACnB,aAAa,GAAkC,IAAI,KAAK,EAAE,CAAC;IAEnE,YAAY,SAAiB,IAAI,eAAM,EAAE;QACvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,IAAI;QACF,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,IAAI,CAAoB,GAAY,EAAE,QAAkC;QACtE,UAAU,CAAC,GAAG,EAAE;YACd,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;gBACjD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,EAAE,8BAA8B,CAAC,CAAC;gBAEnE,QAAQ,CAAC,KAAK,EAAE,GAAqB,CAAC,CAAC;gBACvC,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC,GAAY;QACf,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC1C,QAAQ,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;IACH,CAAC;IAED,SAAS,CAAC,QAAgC;QACxC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAEO,WAAW;QACjB,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE7B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEpC,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YAC3C,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC,GAAS,EAAE;gBACrC,KAAK,MAAM,EAAE,GAAG,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC7C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACjB,CAAC;gBACD,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,CAAC,EAAE,IAAI,CAAC,CAAC;QACX,CAAC;IACH,CAAC;CACF;AAxDD,oCAwDC"}

package/dist/dev/server.d.ts

@@ -0,0 +1,87 @@
+import type { Message, Request, Response } from "../src/network/network";
+interface DurablePromise {
+    id: string;
+    state: "pending" | "resolved" | "rejected" | "rejected_canceled" | "rejected_timedout";
+    timeout: number;
+    param: any;
+    value: any;
+    tags: Record<string, string>;
+    iKeyForCreate?: string;
+    iKeyForComplete?: string;
+    createdOn?: number;
+    completedOn?: number;
+    callbacks?: Map<string, Callback>;
+}
+interface Callback {
+    id: string;
+    type: "resume" | "notify";
+    promiseId: string;
+    rootPromiseId: string;
+    recv: string;
+    timeout: number;
+    createdOn: number;
+}
+interface Task {
+    id: string;
+    counter: number;
+    state: "init" | "enqueued" | "claimed" | "completed";
+    type: "invoke" | "resume" | "notify";
+    recv: string;
+    rootPromiseId: string;
+    leafPromiseId: string;
+    timeout: number;
+    processId?: string;
+    ttl?: number;
+    expiry?: number;
+    createdOn: number;
+    completedOn?: number;
+}
+interface Schedule {
+    id: string;
+    description?: string;
+    cron: string;
+    tags: Record<string, string>;
+    promiseId: string;
+    promiseTimeout: number;
+    promiseParam: any;
+    promiseTags: Record<string, string>;
+    lastRunTime?: number;
+    nextRunTime?: number;
+    iKey?: string;
+    createdOn?: number;
+}
+export declare class Server {
+    readonly promises: Map<string, DurablePromise>;
+    readonly tasks: Map<string, Task>;
+    readonly schedules: Map<string, Schedule>;
+    private routers;
+    private targets;
+    constructor();
+    next(time: number): number | undefined;
+    step(time: number): {
+        msg: Message;
+        recv: string;
+    }[];
+    process(requ: Request, time: number): Response;
+    private createPromise;
+    private createPromiseAndTask;
+    private _createPromise;
+    private readPromise;
+    private completePromise;
+    private createSubscription;
+    private createCallback;
+    private claimTask;
+    private completeTask;
+    private dropTask;
+    private heartbeatTasks;
+    private createSchedule;
+    private readSchedule;
+    private deleteSchedule;
+    private getPromise;
+    private transitionPromise;
+    private _transitionPromise;
+    private transitionTask;
+    private transitionSchedule;
+}
+export {};
+//# sourceMappingURL=server.d.ts.map

package/dist/dev/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../dev/server.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAIV,OAAO,EACP,OAAO,EACP,QAAQ,EAGT,MAAM,wBAAwB,CAAC;AAGhC,UAAU,cAAc;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;IACvF,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,GAAG,CAAC;IACX,KAAK,EAAE,GAAG,CAAC;IACX,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;CACnC;AAED,UAAU,QAAQ;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,UAAU,IAAI;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,WAAW,CAAC;IACrD,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,UAAU,QAAQ;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,GAAG,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AA0BD,qBAAa,MAAM;IACjB,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC/C,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC1C,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,OAAO,CAAyB;;IAUxC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IA4CtC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG;QAAE,GAAG,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE;IAyGpD,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,QAAQ;IA4H9C,OAAO,CAAC,aAAa;IA4BrB,OAAO,CAAC,oBAAoB;IAsC5B,OAAO,CAAC,cAAc;IAqDtB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,eAAe;IA8BvB,OAAO,CAAC,kBAAkB;IA6C1B,OAAO,CAAC,cAAc;IAsCtB,OAAO,CAAC,SAAS;IAmDjB,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,QAAQ;IAMhB,OAAO,CAAC,cAAc;IAqBtB,OAAO,CAAC,cAAc;IAsCtB,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,iBAAiB;IAoFzB,OAAO,CAAC,kBAAkB;IAsK1B,OAAO,CAAC,cAAc;IAoMtB,OAAO,CAAC,kBAAkB;CA6F3B"}