@restatedev/restate-sdk 0.7.2-worker → 0.8.0

package/LICENSE

@@ -1,6 +1,6 @@
     MIT License
 
-    Copyright (c) 2023 - Restate Software, Inc., Restate GmbH
+    Copyright (c) 2023-2024 - Restate Software, Inc., Restate GmbH
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -37,35 +37,17 @@ restate
   .listen(9080);
 ```
 
-Restate takes care of:
-  - **reliable execution:** handlers will always run to completion. Intermediate failures result in re-tries
-    that use the *durable execution* mechanism to recover partial progress and not duplicate already executed
-    steps.
-  - **suspending handlers:** long-running handlers suspend when awaiting on a promise (or when explicitly
-    sleeping) and resume when that promise is resolved. Lambdas finish, services may scale down.
-  - **reliable communication:** handlers communicate with *exactly-once semantics*. Restate reliably delivers
-    messages and anchors both sender and receiver in the durable execution to ensure no losses or duplicates
-    can happen.
-  - **durable timers:** handlers can sleep (and suspend) or schedule calls for later.
-  - **isolation:** handlers can be keyed, which makes Restate scheduled them to obey single-writer-per-key
-    semantics.
-  - **state:** keyed handlers can attach key/value state, which is eagerly pushed into handlers during
-    invocation, and written back upon completion. This is particularly efficient for FaaS deployments
-    (stateful serverless, yay!).
-  - **observability & introspection:** Restate automatically generates Open Telemetry traces for the
-    interactions between handlers and gives you a SQL shell to query the distributed state of the application.
-  - **gRPC support:** Handlers may optionally be defined as gRPC services, and Restate will act as the transport
-    layer for the services/clients in that case.
-
-📖 Check out our [docs](https://docs.restate.dev) to get quickly started!
-
-🗣️ Join our [discord channel](https://discord.gg/skW3AZ6uGd) to talk to the community.
-
-🏠 Visit our [GitHub org](https://github.com/restatedev) for more details.
-
-# Using the SDK
-
-To use this SDK, simply add the dependency to your project:
+## Community
+
+* 🤗️ [Join our online community](https://discord.gg/skW3AZ6uGd) for help, sharing feedback and talking to the community.
+* 📖 [Check out our documentation](https://docs.restate.dev) to get quickly started!
+* 📣 [Follow us on Twitter](https://twitter.com/restatedev) for staying up to date.
+* 🙋 [Create a GitHub issue](https://github.com/restatedev/sdk-typescript/issues) for requesting a new feature or reporting a problem.
+* 🏠 [Visit our GitHub org](https://github.com/restatedev) for exploring other repositories.
+
+## Using the SDK
+
+To use this SDK, add the dependency to your project:
 ```shell
 npm install @restatedev/restate-sdk
 ```
@@ -75,13 +57,17 @@ For brand-new projects, we recommend using the [Restate Node Template](https://g
 npx -y @restatedev/create-app@latest
 ```
 
-# Contributing to the SDK
+## Contributing
 
-### Prerequisites
-- [NodeJS (and npm)](https://nodejs.org) installed
+We’re excited if you join the Restate community and start contributing!
+Whether it is feature requests, bug reports, ideas & feedback or PRs, we appreciate any and all contributions.
+We know that your time is precious and, therefore, deeply value any effort to contribute!
 
 ### Building the SDK
 
+#### Prerequisites
+- [NodeJS (and npm)](https://nodejs.org) installed
+
 Install the dependencies, build the Restate protocol types (from ProtoBuf), and transpile the TypeScript code:
 ```shell
 npm install
@@ -115,37 +101,29 @@ npm run example
 npm run proto
 ```
 
-### Testing end-to-end with Restate Runtime
-
-This requires the [Docker Engine](https://docs.docker.com/engine/install/) to launch the Restate runtime for testing.
-
-Start the runtime in a Docker container and tell Restate about the example service. This requires the example to be running, to make the discovery succeed!
- - On Linux:
-    ```shell
-    docker run --name restate_dev --rm --network=host docker.io/restatedev/restate:latest
+### Testing end-to-end with Restate Server
 
-    curl -X POST http://localhost:9070/deployments -H 'content-type: application/json' -d '{"uri": "http://localhost:9080"}'
-    ```
-- On macOS:
-    ```shell
-    docker run --name restate_dev --rm -p 9070:9070 -p 8080:8080 docker.io/restatedev/restate:latest
+[Launch the Restate Server](https://github.com/restatedev/restate?tab=readme-ov-file#install-the-server) for testing your SDK changes.
 
-    curl -X POST http://localhost:9070/deployments -H 'content-type: application/json' -d '{"uri": "http://host.docker.internal:9080"}'
-    ```
+Register a service with the server via the Restate CLI. 
+This requires that the service is running to make the discovery succeed!
 
+```shell
+npx @restatedev/restate deployment register http://localhost:9080
+```
 
 Invoke the example service from the command line:
 ```shell
 curl -X POST http://localhost:8080/greeter/greet -H 'content-type: application/json' -d '{"name": "Pete"}'
 ```
 
-# Releasing the package
+## Releasing the package
 
-## Pre-release
+### Pre-release
 
 Before release, make sure the `buf.lock` of the proto descriptors is updated. See [Update the proto descriptors](#update-the-proto-descriptors).
 
-## Releasing via release-it
+### Releasing via release-it
 
 Releasing a new npm package from this repo requires:
 
@@ -160,7 +138,7 @@ npm run release
 
 The actual `npm publish` is run by GitHub actions once a GitHub release is created.
 
-## Releasing manually
+### Releasing manually
 
 1. Bump the version field in package.json to `X.Y.Z`
 2. Create and push a tag of the form `vX.Y.Z` to the upstream repository

package/dist/clients/workflow_client.d.ts

@@ -0,0 +1,77 @@
+import * as restate from "../public_api";
+/**
+ * A client to interact with running workflows.
+ */
+export interface WorkflowClient<R, U> {
+    /**
+     * Gets the ID of the workflow that this client talks to.
+     */
+    workflowId(): string;
+    /**
+     * Gets the status of the workflow, as a {@link restate.workflow.LifecycleStatus}.
+     * This will take on the values "NOT_STARTED", "RUNNING", "FINISHED", "FAILED".
+     */
+    status(): Promise<restate.workflow.LifecycleStatus>;
+    /**
+     * Returns a promise completed with the result. This will resolve successfully on successful
+     * termination of the workflow, and will be rejected if the workflow throws an Error.
+     */
+    result(): Promise<R>;
+    /**
+     * Gets the interface to the workflow through which all the workflow's additional methods
+     * can be called.
+     *
+     * To get the proper typed client, use the {@link WorkflowConnection.submitWorkflow} or
+     * {@link WorkflowConnection.connectToWorkflow} functions that accpet a typed ServiceApi
+     * object, as in the example below.
+     *
+     * @example
+     * In the workflow definition:
+     * ```
+     * const myWorkflow = restate.workflow.workflow("acme.myworkflow", { ... });
+     * export const myWorkflowApi = myworkflow.api;
+     * ```
+     * In the client code:
+     * ```
+     * import { myWorkflowApi } from "../server/myWorkflow"
+     * ...
+     * const restate = connectWorkflows("https://restatehost:8080");
+     * restate.submitWorkflow(myWorkflowApi, workflowId, args);
+     * restate.connectToWorkflow(myWorkflowApi, workflowId);
+     * ```
+     */
+    workflowInterface(): restate.Client<restate.workflow.WorkflowClientApi<U>>;
+}
+/**
+ * A connection to Restate that let's you submit workflows or connect to workflows.
+ * This is a typed client that internally makes HTTP calls to Restate to launch trigger
+ * an execution of a workflow service, or to connect to an existing execution.
+ */
+export interface RestateClient {
+    submitWorkflow<R, T>(path: string, workflowId: string, params: T): Promise<{
+        status: restate.workflow.WorkflowStartResult;
+        client: WorkflowClient<R, unknown>;
+    }>;
+    submitWorkflow<R, T, U>(workflowApi: restate.ServiceApi<restate.workflow.WorkflowRestateRpcApi<R, T, U>>, workflowId: string, params: T): Promise<{
+        status: restate.workflow.WorkflowStartResult;
+        client: WorkflowClient<R, U>;
+    }>;
+    connectToWorkflow<R = unknown>(path: string, workflowId: string): Promise<{
+        status: restate.workflow.LifecycleStatus;
+        client: WorkflowClient<R, unknown>;
+    }>;
+    connectToWorkflow<R, T, U>(workflowApi: restate.ServiceApi<restate.workflow.WorkflowRestateRpcApi<R, T, U>>, workflowId: string): Promise<{
+        status: restate.workflow.LifecycleStatus;
+        client: WorkflowClient<R, U>;
+    }>;
+}
+/**
+ * Creates a typed client to start and interact with workflow executions.
+ * The specifiec URI must point to the Restate request endpoint (ingress).
+ *
+ * This function doesn't immediately verify the connection, it will not fail
+ * if Restate is unreachable. Connection failures will only manifest when
+ * attempting to submit or connect a specific workflow.
+ */
+export declare function connect(restateUri: string): RestateClient;
+//# sourceMappingURL=workflow_client.d.ts.map

package/dist/clients/workflow_client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow_client.d.ts","sourceRoot":"","sources":["../../src/clients/workflow_client.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,OAAO,MAAM,eAAe,CAAC;AAGzC;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,EAAE,CAAC;IAClC;;OAEG;IACH,UAAU,IAAI,MAAM,CAAC;IAErB;;;OAGG;IACH,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAEpD;;;OAGG;IACH,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IAErB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5E;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,cAAc,CAAC,CAAC,EAAE,CAAC,EACjB,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,CAAC,GACR,OAAO,CAAC;QACT,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC;QAC7C,MAAM,EAAE,cAAc,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;KACpC,CAAC,CAAC;IAEH,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACpB,WAAW,EAAE,OAAO,CAAC,UAAU,CAC7B,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAChD,EACD,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,CAAC,GACR,OAAO,CAAC;QACT,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC;QAC7C,MAAM,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KAC9B,CAAC,CAAC;IAEH,iBAAiB,CAAC,CAAC,GAAG,OAAO,EAC3B,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC;QACT,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;QACzC,MAAM,EAAE,cAAc,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;KACpC,CAAC,CAAC;IAEH,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACvB,WAAW,EAAE,OAAO,CAAC,UAAU,CAC7B,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAChD,EACD,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC;QACT,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC;QACzC,MAAM,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;KAC9B,CAAC,CAAC;CACJ;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa,CAyDzD"}

package/dist/clients/workflow_client.js

@@ -0,0 +1,172 @@
+"use strict";
+/*
+ * 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
+ */
+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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.connect = void 0;
+const restate = __importStar(require("../public_api"));
+const errors_1 = require("../types/errors");
+/**
+ * Creates a typed client to start and interact with workflow executions.
+ * The specifiec URI must point to the Restate request endpoint (ingress).
+ *
+ * This function doesn't immediately verify the connection, it will not fail
+ * if Restate is unreachable. Connection failures will only manifest when
+ * attempting to submit or connect a specific workflow.
+ */
+function connect(restateUri) {
+    return {
+        submitWorkflow: async (pathOrApi, workflowId, params) => {
+            const path = typeof pathOrApi === "string" ? pathOrApi : pathOrApi.path;
+            let result;
+            try {
+                result = await makeCall(restateUri, path, "submit", workflowId, params);
+            }
+            catch (err) {
+                const error = (0, errors_1.ensureError)(err);
+                throw new Error("Cannot start workflow: " + error.message, {
+                    cause: error,
+                });
+            }
+            return {
+                status: result,
+                client: new WorkflowClientImpl(restateUri, path, workflowId),
+            };
+        },
+        async connectToWorkflow(pathOrApi, workflowId) {
+            const path = typeof pathOrApi === "string" ? pathOrApi : pathOrApi.path;
+            const client = new WorkflowClientImpl(restateUri, path, workflowId);
+            const status = await client.status();
+            if (status === restate.workflow.LifecycleStatus.NOT_STARTED) {
+                throw new Error("No workflow running/finished/failed with ID " + workflowId);
+            }
+            return {
+                status,
+                client: new WorkflowClientImpl(restateUri, path, workflowId),
+            };
+        },
+    };
+}
+exports.connect = connect;
+class WorkflowClientImpl {
+    restateUri;
+    serviceName;
+    wfId;
+    constructor(restateUri, serviceName, wfId) {
+        this.restateUri = restateUri;
+        this.serviceName = serviceName;
+        this.wfId = wfId;
+    }
+    workflowId() {
+        return this.wfId;
+    }
+    status() {
+        return this.makeCall("status", {});
+    }
+    result() {
+        return this.makeCall("waitForResult", {});
+    }
+    workflowInterface() {
+        const clientProxy = new Proxy({}, {
+            get: (_target, prop) => {
+                const method = prop;
+                return async (args) => {
+                    return this.makeCall(method, args);
+                };
+            },
+        });
+        return clientProxy;
+    }
+    async makeCall(method, args) {
+        return await makeCall(this.restateUri, this.serviceName, method, this.wfId, args);
+    }
+}
+// ----------------------------------------------------------------------------
+//                                 Utils
+// ----------------------------------------------------------------------------
+async function makeCall(restateUri, serviceName, method, workflowId, params) {
+    if (!workflowId || typeof workflowId !== "string") {
+        throw new Error("missing workflowId");
+    }
+    if (params === undefined) {
+        params = {};
+    }
+    if (typeof params !== "object") {
+        throw new Error("invalid parameters: must be an object");
+    }
+    const url = `${restateUri}/${serviceName}/${method}`;
+    const data = {
+        request: {
+            workflowId,
+            ...params,
+        },
+    };
+    let body;
+    try {
+        body = JSON.stringify(data);
+    }
+    catch (err) {
+        throw new Error("Cannot encode request: " + err, { cause: err });
+    }
+    // eslint-disable-next-line no-console
+    console.debug(`Making call to Restate at ${url}`);
+    const httpResponse = await fetch(url, {
+        method: "POST",
+        headers: {
+            "Content-Type": "application/json",
+        },
+        body,
+    });
+    const responseText = await httpResponse.text();
+    if (!httpResponse.ok) {
+        throw new Error(`Request failed: ${httpResponse.status}\n${responseText}`);
+    }
+    let response;
+    try {
+        response = JSON.parse(responseText);
+    }
+    catch (err) {
+        throw new Error("Cannot parse response JSON: " + err, { cause: err });
+    }
+    if (response.error) {
+        throw new Error(response.error);
+    }
+    if (response.response) {
+        return response.response;
+    }
+    if (Object.keys(response).length === 0) {
+        return undefined;
+    }
+    throw new Error("Unrecognized response object: " + responseText);
+}
+//# sourceMappingURL=workflow_client.js.map

package/dist/clients/workflow_client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow_client.js","sourceRoot":"","sources":["../../src/clients/workflow_client.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,uDAAyC;AACzC,4CAA8C;AA8F9C;;;;;;;GAOG;AACH,SAAgB,OAAO,CAAC,UAAkB;IACxC,OAAO;QACL,cAAc,EAAE,KAAK,EACnB,SAEuE,EACvE,UAAkB,EAClB,MAAS,EAIR,EAAE;YACH,MAAM,IAAI,GAAG,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC;YAExE,IAAI,MAA4C,CAAC;YACjD,IAAI;gBACF,MAAM,GAAG,MAAM,QAAQ,CAAC,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;aACzE;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,KAAK,GAAG,IAAA,oBAAW,EAAC,GAAG,CAAC,CAAC;gBAC/B,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,KAAK,CAAC,OAAO,EAAE;oBACzD,KAAK,EAAE,KAAK;iBACb,CAAC,CAAC;aACJ;YAED,OAAO;gBACL,MAAM,EAAE,MAAM;gBACd,MAAM,EAAE,IAAI,kBAAkB,CAAC,UAAU,EAAE,IAAI,EAAE,UAAU,CAAC;aAC7D,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,iBAAiB,CACrB,SAEuE,EACvE,UAAkB;YAKlB,MAAM,IAAI,GAAG,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC;YACxE,MAAM,MAAM,GAAyB,IAAI,kBAAkB,CACzD,UAAU,EACV,IAAI,EACJ,UAAU,CACX,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC;YACrC,IAAI,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,WAAW,EAAE;gBAC3D,MAAM,IAAI,KAAK,CACb,8CAA8C,GAAG,UAAU,CAC5D,CAAC;aACH;YACD,OAAO;gBACL,MAAM;gBACN,MAAM,EAAE,IAAI,kBAAkB,CAAC,UAAU,EAAE,IAAI,EAAE,UAAU,CAAC;aAC7D,CAAC;QACJ,CAAC;KACsB,CAAC;AAC5B,CAAC;AAzDD,0BAyDC;AAED,MAAM,kBAAkB;IAEH;IACA;IACA;IAHnB,YACmB,UAAkB,EAClB,WAAmB,EACnB,IAAY;QAFZ,eAAU,GAAV,UAAU,CAAQ;QAClB,gBAAW,GAAX,WAAW,CAAQ;QACnB,SAAI,GAAJ,IAAI,CAAQ;IAC5B,CAAC;IAEJ,UAAU;QACR,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACrC,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,iBAAiB;QACf,MAAM,WAAW,GAAG,IAAI,KAAK,CAC3B,EAAE,EACF;YACE,GAAG,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;gBACrB,MAAM,MAAM,GAAG,IAAc,CAAC;gBAC9B,OAAO,KAAK,EAAE,IAAa,EAAE,EAAE;oBAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBACrC,CAAC,CAAC;YACJ,CAAC;SACF,CACF,CAAC;QAEF,OAAO,WAAoE,CAAC;IAC9E,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAS,MAAc,EAAE,IAAQ;QACrD,OAAO,MAAM,QAAQ,CACnB,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,WAAW,EAChB,MAAM,EACN,IAAI,CAAC,IAAI,EACT,IAAI,CACL,CAAC;IACJ,CAAC;CACF;AAED,+EAA+E;AAC/E,wCAAwC;AACxC,+EAA+E;AAE/E,KAAK,UAAU,QAAQ,CACrB,UAAkB,EAClB,WAAmB,EACnB,MAAc,EACd,UAAkB,EAClB,MAAS;IAET,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;QACjD,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;KACvC;IACD,IAAI,MAAM,KAAK,SAAS,EAAE;QACxB,MAAM,GAAG,EAAO,CAAC;KAClB;IACD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;KAC1D;IAED,MAAM,GAAG,GAAG,GAAG,UAAU,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;IACrD,MAAM,IAAI,GAAG;QACX,OAAO,EAAE;YACP,UAAU;YACV,GAAG,MAAM;SACoC;KAChD,CAAC;IAEF,IAAI,IAAY,CAAC;IACjB,IAAI;QACF,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;KAC7B;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;KAClE;IAED,sCAAsC;IACtC,OAAO,CAAC,KAAK,CAAC,6BAA6B,GAAG,EAAE,CAAC,CAAC;IAElD,MAAM,YAAY,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QACpC,MAAM,EAAE,MAAM;QACd,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;SACnC;QACD,IAAI;KACL,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,MAAM,YAAY,CAAC,IAAI,EAAE,CAAC;IAC/C,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE;QACpB,MAAM,IAAI,KAAK,CAAC,mBAAmB,YAAY,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC,CAAC;KAC5E;IAED,IAAI,QAAQ,CAAC;IACb,IAAI;QACF,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;KACrC;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;KACvE;IAED,IAAI,QAAQ,CAAC,KAAK,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;KACjC;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE;QACrB,OAAO,QAAQ,CAAC,QAAa,CAAC;KAC/B;IACD,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;QACtC,OAAO,SAAc,CAAC;KACvB;IAED,MAAM,IAAI,KAAK,CAAC,gCAAgC,GAAG,YAAY,CAAC,CAAC;AACnE,CAAC"}

package/dist/connection/buffered_connection.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BufferedConnection = void 0;
+const encoder_1 = require("../io/encoder");
+class BufferedConnection {
+    flushFn;
+    queue = [];
+    flushing = Promise.resolve();
+    constructor(flushFn) {
+        this.flushFn = flushFn;
+    }
+    send(msg) {
+        const len = this.queue.push(msg);
+        if (len === 1) {
+            // we are the first in line, therefore we schedule a flush,
+            // BUT we must wait for the previous flush to end.
+            this.flushing = this.flushing.then(() => this.scheduleFlush());
+        }
+        // we don't need to reschedule the `flush` here,
+        // because the flush happens anyway at the end of the current event loop iteration.
+        // tag along to the previously scheduled flush.
+        return this.flushing;
+    }
+    end() {
+        this.flushing = this.flushing.then(() => this.flush());
+        return this.flushing;
+    }
+    scheduleFlush() {
+        // schedule a flush at the end of the current event loop iteration.
+        return new Promise((resolve, reject) => setImmediate(() => {
+            this.flush().then(resolve).catch(reject);
+        }));
+    }
+    async flush() {
+        if (this.queue.length === 0) {
+            return Promise.resolve();
+        }
+        const buffer = (0, encoder_1.encodeMessages)(this.queue);
+        this.queue = [];
+        return this.flushFn(buffer);
+    }
+}
+exports.BufferedConnection = BufferedConnection;
+//# sourceMappingURL=buffered_connection.js.map

package/dist/connection/buffered_connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buffered_connection.js","sourceRoot":"","sources":["../../src/connection/buffered_connection.ts"],"names":[],"mappings":";;;AAAA,2CAA+C;AAI/C,MAAa,kBAAkB;IAIA;IAHrB,KAAK,GAAc,EAAE,CAAC;IACtB,QAAQ,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAC;IAEpD,YAA6B,OAA0C;QAA1C,YAAO,GAAP,OAAO,CAAmC;IAAG,CAAC;IAE3E,IAAI,CAAC,GAAY;QACf,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,GAAG,KAAK,CAAC,EAAE;YACb,2DAA2D;YAC3D,kDAAkD;YAClD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;SAChE;QACD,gDAAgD;QAChD,mFAAmF;QACnF,+CAA+C;QAC/C,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,GAAG;QACD,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QACvD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEO,aAAa;QACnB,mEAAmE;QACnE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CACrC,YAAY,CAAC,GAAG,EAAE;YAChB,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3C,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,KAAK;QACjB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC1B;QACD,MAAM,MAAM,GAAG,IAAA,wBAAc,EAAC,IAAI,CAAC,KAAK,CAAW,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAEhB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,CAAC;CACF;AA1CD,gDA0CC"}

package/dist/connection/connection.js

@@ -0,0 +1,13 @@
+"use strict";
+/*
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=connection.js.map

package/dist/connection/connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection.js","sourceRoot":"","sources":["../../src/connection/connection.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG"}

package/dist/connection/embedded_connection.js

@@ -0,0 +1,59 @@
+"use strict";
+/*
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmbeddedConnection = exports.InvocationAlreadyCompletedError = exports.FencedOffError = void 0;
+const buffered_connection_1 = require("./buffered_connection");
+class FencedOffError extends Error {
+    constructor() {
+        super("FencedOff");
+    }
+}
+exports.FencedOffError = FencedOffError;
+class InvocationAlreadyCompletedError extends Error {
+    constructor() {
+        super("Completed");
+    }
+}
+exports.InvocationAlreadyCompletedError = InvocationAlreadyCompletedError;
+class EmbeddedConnection {
+    operationId;
+    streamId;
+    remote;
+    buffered;
+    constructor(operationId, streamId, remote) {
+        this.operationId = operationId;
+        this.streamId = streamId;
+        this.remote = remote;
+        this.buffered = new buffered_connection_1.BufferedConnection((buffer) => this.sendBuffer(buffer));
+    }
+    send(msg) {
+        return this.buffered.send(msg);
+    }
+    end() {
+        return this.buffered.end();
+    }
+    async sendBuffer(buffer) {
+        const res = await this.remote.send({
+            operationId: this.operationId,
+            streamId: this.streamId,
+            messages: buffer,
+        });
+        if (res.invalidStream !== undefined) {
+            throw new FencedOffError();
+        }
+        if (res.invocationCompleted !== undefined) {
+            throw new InvocationAlreadyCompletedError();
+        }
+    }
+}
+exports.EmbeddedConnection = EmbeddedConnection;
+//# sourceMappingURL=embedded_connection.js.map

package/dist/connection/embedded_connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"embedded_connection.js","sourceRoot":"","sources":["../../src/connection/embedded_connection.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAIH,+DAA2D;AAG3D,MAAa,cAAe,SAAQ,KAAK;IACvC;QACE,KAAK,CAAC,WAAW,CAAC,CAAC;IACrB,CAAC;CACF;AAJD,wCAIC;AAED,MAAa,+BAAgC,SAAQ,KAAK;IACxD;QACE,KAAK,CAAC,WAAW,CAAC,CAAC;IACrB,CAAC;CACF;AAJD,0EAIC;AAED,MAAa,kBAAkB;IAIV;IACA;IACA;IALX,QAAQ,CAAqB;IAErC,YACmB,WAAmB,EACnB,QAAgB,EAChB,MAAqB;QAFrB,gBAAW,GAAX,WAAW,CAAQ;QACnB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,WAAM,GAAN,MAAM,CAAe;QAEtC,IAAI,CAAC,QAAQ,GAAG,IAAI,wCAAkB,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,CAAC,GAAY;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IAED,GAAG;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;IAC7B,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,MAAc;QACrC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACjC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,MAAM;SACjB,CAAC,CAAC;QAEH,IAAI,GAAG,CAAC,aAAa,KAAK,SAAS,EAAE;YACnC,MAAM,IAAI,cAAc,EAAE,CAAC;SAC5B;QACD,IAAI,GAAG,CAAC,mBAAmB,KAAK,SAAS,EAAE;YACzC,MAAM,IAAI,+BAA+B,EAAE,CAAC;SAC7C;IACH,CAAC;CACF;AAjCD,gDAiCC"}