Integrate a TypeScript client

Author: hpnkv

examples/005-echo-server/CMakeLists.txt

@@ -0,0 +1,13 @@
+add_executable(
+        005-echo-server
+        main.cc
+)
+
+target_link_libraries(
+        005-echo-server PRIVATE
+        eglt::actions
+        eglt::data
+        eglt::nodes
+        eglt::service
+        eglt::sdk::serving::websockets
+)

examples/005-echo-server/main.cc

@@ -0,0 +1,86 @@
+#include <cstdint>
+#include <iostream>
+#include <memory>
+#include <optional>
+#include <ostream>
+#include <sstream>
+#include <string>
+#include <string_view>
+
+#include <eglt/absl_headers.h>
+#include <eglt/actions/action.h>
+#include <eglt/data/eg_structs.h>
+#include <eglt/nodes/async_node.h>
+#include <eglt/sdk/serving/websockets.h>
+#include <eglt/service/service.h>
+
+ABSL_FLAG(uint16_t, port, 20000, "Port to bind to.");
+
+// Simply some type aliases to make the code more readable.
+using Action = eglt::Action;
+using ActionRegistry = eglt::ActionRegistry;
+using Chunk = eglt::Chunk;
+using Service = eglt::Service;
+
+absl::Status RunEcho(const std::shared_ptr<Action>& action) {
+  auto input_text = action->GetNode("text");
+  input_text->SetReaderOptions(/*ordered=*/true,
+                               /*remove_chunks=*/true);
+  std::optional<Chunk> chunk;
+  while (true) {
+    *input_text >> chunk;
+
+    if (!chunk.has_value()) {
+      break;
+    }
+
+    if (auto status = input_text->GetReaderStatus(); !status.ok()) {
+      LOG(ERROR) << "Failed to read input: " << status;
+      return status;
+    }
+
+    action->GetNode("response") << *chunk;
+  }
+
+  // This is necessary and indicates the end of stream.
+  action->GetNode("response") << eglt::EndOfStream();
+
+  return absl::OkStatus();
+}
+
+ActionRegistry MakeActionRegistry() {
+  ActionRegistry registry;
+
+  registry.Register(/*name=*/"echo",
+                    /*schema=*/
+                    {
+                        .name = "echo",
+                        .inputs = {{"text", "text/plain"}},
+                        .outputs = {{"response", "text/plain"}},
+                    },
+                    /*handler=*/RunEcho);
+  return registry;
+}
+
+int main(int argc, char** argv) {
+  absl::InstallFailureSignalHandler({});
+  absl::ParseCommandLine(argc, argv);
+
+  eglt::SessionMessage message{
+      .node_fragments = {eglt::NodeFragment{.id = "test",
+                                            .chunk = eglt::EndOfStream()}},
+  };
+  for (const auto bytes = cppack::Pack(message); const auto& byte : bytes) {
+    std::cout << std::hex << static_cast<int>(byte) << " ";
+  }
+  std::cout << std::endl;
+
+  const uint16_t port = absl::GetFlag(FLAGS_port);
+  ActionRegistry action_registry = MakeActionRegistry();
+  eglt::Service service(&action_registry);
+  eglt::sdk::WebsocketEvergreenServer server(&service, "0.0.0.0", port);
+  server.Run();
+  server.Join().IgnoreError();
+
+  return 0;
+}

examples/CMakeLists.txt

@@ -1,4 +1,5 @@
 add_subdirectory(000-actions)
 add_subdirectory(001-bidi-actions)
 add_subdirectory(002-chunks-from-custom-types)
-add_subdirectory(004-connections-through-nodes)
+add_subdirectory(004-connections-through-nodes)
+add_subdirectory(005-echo-server)

js/.editorconfig

@@ -5,6 +5,7 @@ charset = utf-8
 end_of_line = lf
 trim_trailing_whitespace = true
 insert_final_newline = true
+max_line_length = 80
 
 [*.md]
 insert_final_newline = false

js/.prettierrc

@@ -2,5 +2,6 @@
   "parser": "typescript",
   "semi": true,
   "singleQuote": true,
-  "trailingComma": "all"
+  "trailingComma": "all",
+  "maxLineLength": 80
 }

js/__tests__/unit/main.test.ts

@@ -23,7 +23,7 @@ export default tseslint.config(
     },
 
     rules: {
-      '@typescript-eslint/explicit-function-return-type': 'warn',
+      '@typescript-eslint/explicit-function-return-type': 'off',
     },
 
     languageOptions: {

js/eslint.config.mjs

@@ -0,0 +1,10 @@
+export { Action, ActionRegistry } from './src/action.js';
+export { AsyncNode, NodeMap } from './src/asyncNode.js';
+export { ChunkStore, LocalChunkStore } from './src/chunkStore.js';
+export { ChunkStoreReader } from './src/chunkStoreReader.js';
+export { ChunkStoreWriter } from './src/chunkStoreWriter.js';
+export { endOfStream, isEndOfStream, isNullChunk } from './src/data.js';
+export { Session } from './src/session.js';
+export * from './src/msgpack.js';
+export { EvergreenStream } from './src/stream.js';
+export { Lock, Event, Channel, Deque } from './src/utils.js';

js/index.ts

@@ -1,8 +1,14 @@
 {
-  "name": "actionengine-ts",
+  "name": "actionengine",
   "version": "0.1.0",
+  "author": "Google DeepMind <[email protected]>",
+  "license": "Apache-2.0",
   "description": "A TypeScript client library for Action Engine.",
   "type": "module",
+  "exports": {
+    ".": "./build/actionengine.js"
+  },
+  "types": "index.ts",
   "engines": {
     "node": ">= 23.0 < 24"
   },
@@ -13,34 +19,35 @@
     "@typescript-eslint/parser": "~8.19",
     "@vitest/coverage-v8": "~2.1",
     "@vitest/eslint-plugin": "~1.1",
-    "eslint-config-prettier": "~9.1",
     "eslint": "~9.17",
+    "eslint-config-prettier": "~9.1",
     "globals": "~15.14",
     "prettier": "~3.4",
     "rimraf": "~6.0",
     "ts-api-utils": "~2.0",
-    "typescript-eslint": "~8.19",
     "typescript": "~5.7",
+    "typescript-eslint": "~8.19",
     "vitest": "~2.1"
   },
   "scripts": {
-    "start": "node build/src/main.js",
     "clean": "rimraf coverage build tmp",
     "prebuild": "npm run lint",
     "build": "tsc -p tsconfig.json",
+    "build:bundle": "esbuild --bundle index.ts --format=esm --outfile=build/actionengine.js",
     "build:watch": "tsc -w -p tsconfig.json",
     "build:release": "npm run clean && tsc -p tsconfig.release.json",
+    "build:typings": "tsc --declaration --emitDeclarationOnly --outDir build",
     "lint": "eslint .",
     "test": "vitest run unit --config __tests__/vitest.config.ts",
     "test:coverage": "vitest run unit --config __tests__/vitest.config.ts --coverage.enabled --coverage.all",
     "prettier": "prettier \"{src,__{tests}__}/**/*.{ts,mts}\" --config .prettierrc --write",
     "prettier:check": "prettier \"{src,__{tests}__}/**/*.{ts,mts}\" --config .prettierrc --check",
     "test:watch": "vitest unit"
   },
-  "author": "Jakub Synowiec <[email protected]>",
-  "license": "Apache-2.0",
   "dependencies": {
-    "tslib": "~2.8"
+    "@msgpack/msgpack": "^3.1.1",
+    "tslib": "~2.8",
+    "uuid": "^11.1.0"
   },
   "volta": {
     "node": "22.12.0"