@tui-sandbox/library 1.2.0 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [2.0.0](https://github.com/mikavilpas/tui-sandbox/compare/library-v1.3.0...library-v2.0.0) (2024-09-24)
+
+
+### ⚠ BREAKING CHANGES
+
+* add public client and server APIs ([#46](https://github.com/mikavilpas/tui-sandbox/issues/46))
+
+### Features
+
+* add public client and server APIs ([#46](https://github.com/mikavilpas/tui-sandbox/issues/46)) ([3f13f53](https://github.com/mikavilpas/tui-sandbox/commit/3f13f5386f31de9bb5bf6fc099e2e404261d31b0))
+
+## [1.3.0](https://github.com/mikavilpas/tui-sandbox/compare/library-v1.2.0...library-v1.3.0) (2024-09-23)
+
+
+### Features
+
+* add license (MIT) to library package ([#42](https://github.com/mikavilpas/tui-sandbox/issues/42)) ([8c72eb1](https://github.com/mikavilpas/tui-sandbox/commit/8c72eb13e17c5e6838220a5a16da0d44a6aba792))
+* allow test dirs that have no contents ([#40](https://github.com/mikavilpas/tui-sandbox/issues/40)) ([863e9f0](https://github.com/mikavilpas/tui-sandbox/commit/863e9f0731b1565bf5f9afdb6834275598196f22))
+
 ## [1.2.0](https://github.com/mikavilpas/tui-sandbox/compare/library-v1.1.0...library-v1.2.0) (2024-09-22)
 
 

package/dist/src/client/index.d.ts

@@ -0,0 +1 @@
+export { NeovimClient } from "./neovim-client";

package/dist/src/client/index.js

@@ -0,0 +1,2 @@
+// This is the public client api. Semantic versioning will be applied to this.
+export { NeovimClient } from "./neovim-client";

package/dist/src/client/neovim-client.d.ts

@@ -0,0 +1,12 @@
+import "@xterm/xterm/css/xterm.css";
+import type { StartNeovimGenericArguments } from "../server/neovim/NeovimApplication.ts";
+import type { TestDirectory } from "../server/types.ts";
+import "./style.css";
+export declare class NeovimClient {
+    private readonly ready;
+    private readonly tabId;
+    private readonly terminal;
+    private readonly trpc;
+    constructor(app: HTMLElement);
+    startNeovim(args: StartNeovimGenericArguments): Promise<TestDirectory>;
+}

package/dist/src/client/neovim-client.js

@@ -0,0 +1,58 @@
+import { createTRPCClient, createWSClient, wsLink } from "@trpc/client";
+import "@xterm/xterm/css/xterm.css";
+import "./style.css";
+import { getTabId, startTerminal } from "./websocket-client.js";
+export class NeovimClient {
+    ready;
+    tabId;
+    terminal;
+    trpc;
+    constructor(app) {
+        const wsClient = createWSClient({ url: `ws://localhost:3000`, WebSocket });
+        const trpc = createTRPCClient({
+            links: [wsLink({ client: wsClient })],
+        });
+        this.trpc = trpc;
+        this.tabId = getTabId();
+        const tabId = this.tabId;
+        const terminal = startTerminal(app, {
+            onMouseEvent(data) {
+                void trpc.neovim.sendStdin.mutate({ tabId, data }).catch((error) => {
+                    console.error(`Error sending mouse event`, error);
+                });
+            },
+            onKeyPress(event) {
+                void trpc.neovim.sendStdin.mutate({ tabId, data: event.key });
+            },
+        });
+        this.terminal = terminal;
+        // start listening to Neovim stdout - this will take some (short) amount of
+        // time to complete
+        this.ready = new Promise(resolve => {
+            console.log("Subscribing to Neovim stdout");
+            trpc.neovim.onStdout.subscribe({ client: tabId }, {
+                onStarted() {
+                    resolve();
+                },
+                onData(data) {
+                    terminal.write(data);
+                },
+                onError(err) {
+                    console.error(`Error from Neovim`, err);
+                },
+            });
+        });
+    }
+    async startNeovim(args) {
+        await this.ready;
+        const neovim = await this.trpc.neovim.start.mutate({
+            startNeovimArguments: args,
+            tabId: this.tabId,
+            terminalDimensions: {
+                cols: this.terminal.cols,
+                rows: this.terminal.rows,
+            },
+        });
+        return neovim;
+    }
+}

package/dist/src/client/websocket-client.d.ts

@@ -1,7 +1,5 @@
 import { Terminal } from "@xterm/xterm";
 import "@xterm/xterm/css/xterm.css";
-import type { StartNeovimGenericArguments } from "../server/neovim/NeovimApplication.ts";
-import type { TestDirectory } from "../server/types.ts";
 import type { TabId } from "../server/utilities/tabId.ts";
 import "./style.css";
 export type StartTerminalOptions = {
@@ -15,11 +13,3 @@ export declare function startTerminal(app: HTMLElement, options: StartTerminalOp
 /** An identifier unique to a browser tab, so that each tab can have its own
  * unique session that persists across page reloads. */
 export declare function getTabId(): TabId;
-export declare class NeovimClient {
-    private readonly ready;
-    private readonly tabId;
-    private readonly terminal;
-    private readonly trpc;
-    constructor(app: HTMLElement);
-    startNeovim(args: StartNeovimGenericArguments): Promise<TestDirectory>;
-}

package/dist/src/client/websocket-client.js

@@ -1,5 +1,4 @@
 import { flavors } from "@catppuccin/palette";
-import { createTRPCClient, createWSClient, wsLink } from "@trpc/client";
 import { FitAddon } from "@xterm/addon-fit";
 import { Terminal } from "@xterm/xterm";
 import "@xterm/xterm/css/xterm.css";
@@ -71,57 +70,3 @@ export function getTabId() {
     }
     return { tabId };
 }
-export class NeovimClient {
-    ready;
-    tabId;
-    terminal;
-    trpc;
-    constructor(app) {
-        const wsClient = createWSClient({ url: `ws://localhost:3000`, WebSocket });
-        const trpc = createTRPCClient({
-            links: [wsLink({ client: wsClient })],
-        });
-        this.trpc = trpc;
-        this.tabId = getTabId();
-        const tabId = this.tabId;
-        const terminal = startTerminal(app, {
-            onMouseEvent(data) {
-                void trpc.neovim.sendStdin.mutate({ tabId, data }).catch((error) => {
-                    console.error(`Error sending mouse event`, error);
-                });
-            },
-            onKeyPress(event) {
-                void trpc.neovim.sendStdin.mutate({ tabId, data: event.key });
-            },
-        });
-        this.terminal = terminal;
-        // start listening to Neovim stdout - this will take some (short) amount of
-        // time to complete
-        this.ready = new Promise(resolve => {
-            console.log("Subscribing to Neovim stdout");
-            trpc.neovim.onStdout.subscribe({ client: tabId }, {
-                onStarted() {
-                    resolve();
-                },
-                onData(data) {
-                    terminal.write(data);
-                },
-                onError(err) {
-                    console.error(`Error from Neovim`, err);
-                },
-            });
-        });
-    }
-    async startNeovim(args) {
-        await this.ready;
-        const neovim = await this.trpc.neovim.start.mutate({
-            startNeovimArguments: args,
-            tabId: this.tabId,
-            terminalDimensions: {
-                cols: this.terminal.cols,
-                rows: this.terminal.rows,
-            },
-        });
-        return neovim;
-    }
-}

package/dist/src/server/TestServer.d.ts

@@ -0,0 +1,8 @@
+import type { AnyTRPCRouter } from "@trpc/server";
+import "core-js/proposals/async-explicit-resource-management";
+import type { TestServerConfig } from "./updateTestdirectorySchemaFile";
+export declare class TestServer {
+    private readonly port;
+    constructor(port: number);
+    startAndRun<TRouter extends AnyTRPCRouter>(appRouter: TRouter, config: TestServerConfig): Promise<void>;
+}

package/dist/src/server/TestServer.js

@@ -0,0 +1,49 @@
+import { applyWSSHandler } from "@trpc/server/adapters/ws";
+import "core-js/proposals/async-explicit-resource-management";
+import { once } from "events";
+import { WebSocketServer } from "ws";
+import { createContext } from "./connection/trpc";
+import { updateTestdirectorySchemaFile } from "./updateTestdirectorySchemaFile";
+export class TestServer {
+    port;
+    constructor(port) {
+        this.port = port;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
+    async startAndRun(appRouter, config) {
+        console.log("🚀 Server starting");
+        await updateTestdirectorySchemaFile(config);
+        const wss = new WebSocketServer({ port: this.port });
+        const handler = applyWSSHandler({
+            wss,
+            router: appRouter,
+            createContext,
+            // Enable heartbeat messages to keep connection open (disabled by default)
+            keepAlive: {
+                enabled: true,
+                // server ping message interval in milliseconds
+                pingMs: 30_000,
+                // connection is terminated if pong message is not received in this many milliseconds
+                pongWaitMs: 5000,
+            },
+        });
+        wss.on("connection", socket => {
+            console.log(`➕➕ Connection (${wss.clients.size})`);
+            socket.once("close", () => {
+                console.log(`➖➖ Connection (${wss.clients.size})`);
+            });
+        });
+        console.log(`✅ WebSocket Server listening on ws://localhost:${this.port}`);
+        await Promise.race([once(process, "SIGTERM"), once(process, "SIGINT")]);
+        console.log("Shutting down...");
+        handler.broadcastReconnectNotification();
+        wss.close(error => {
+            if (error) {
+                console.error("Error closing WebSocket server", error);
+                process.exit(1);
+            }
+            console.log("WebSocket server closed");
+            process.exit(0);
+        });
+    }
+}

package/dist/src/server/dirtree/index.js

@@ -28,13 +28,12 @@ export function convertDree(root) {
             stem: root.extension ? root.name.slice(0, -root.extension.length) : root.name,
         };
     }
-    assert(root.children, `Expected children for directory node ${root.name}`);
     const node = {
         name: root.name,
         type: root.type,
         contents: {},
     };
-    for (const child of root.children) {
+    for (const child of root.children || []) {
         node.contents[child.name] = convertDree(child);
     }
     return node;

package/dist/src/server/index.d.ts

@@ -1,8 +1,4 @@
-import type { AnyRouter } from "@trpc/server";
 import "core-js/proposals/async-explicit-resource-management";
-import type { TestServerConfig } from "./updateTestdirectorySchemaFile";
-export declare class TestServer {
-    private readonly port;
-    constructor(port: number);
-    startAndRun<TRouter extends AnyRouter>(appRouter: TRouter, config: TestServerConfig): Promise<void>;
-}
+export { startTestServer } from "./server";
+export { updateTestdirectorySchemaFile } from "./updateTestdirectorySchemaFile";
+export type { TestServerConfig } from "./updateTestdirectorySchemaFile";

package/dist/src/server/index.js

@@ -1,49 +1,4 @@
-import { applyWSSHandler } from "@trpc/server/adapters/ws";
 import "core-js/proposals/async-explicit-resource-management";
-import { once } from "events";
-import { WebSocketServer } from "ws";
-import { createContext } from "./connection/trpc";
-import { updateTestdirectorySchemaFile } from "./updateTestdirectorySchemaFile";
-export class TestServer {
-    port;
-    constructor(port) {
-        this.port = port;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
-    async startAndRun(appRouter, config) {
-        console.log("🚀 Server starting");
-        await updateTestdirectorySchemaFile(config);
-        const wss = new WebSocketServer({ port: this.port });
-        const handler = applyWSSHandler({
-            wss,
-            router: appRouter,
-            createContext,
-            // Enable heartbeat messages to keep connection open (disabled by default)
-            keepAlive: {
-                enabled: true,
-                // server ping message interval in milliseconds
-                pingMs: 30_000,
-                // connection is terminated if pong message is not received in this many milliseconds
-                pongWaitMs: 5000,
-            },
-        });
-        wss.on("connection", socket => {
-            console.log(`➕➕ Connection (${wss.clients.size})`);
-            socket.once("close", () => {
-                console.log(`➖➖ Connection (${wss.clients.size})`);
-            });
-        });
-        console.log(`✅ WebSocket Server listening on ws://localhost:${this.port}`);
-        await Promise.race([once(process, "SIGTERM"), once(process, "SIGINT")]);
-        console.log("Shutting down...");
-        handler.broadcastReconnectNotification();
-        wss.close(error => {
-            if (error) {
-                console.error("Error closing WebSocket server", error);
-                process.exit(1);
-            }
-            console.log("WebSocket server closed");
-            process.exit(0);
-        });
-    }
-}
+// This is the public server api. Semantic versioning will be applied to this.
+export { startTestServer } from "./server";
+export { updateTestdirectorySchemaFile } from "./updateTestdirectorySchemaFile";

package/dist/src/server/neovim/environment/createTempDir.d.ts

@@ -1,3 +1,4 @@
 import type { TestDirectory } from "../../types";
 import type { TestServerConfig } from "../../updateTestdirectorySchemaFile";
 export declare function createTempDir(config: TestServerConfig): Promise<TestDirectory>;
+export type TestDirsPath = "testdirs";

package/dist/src/server/neovim/environment/createTempDir.test.d.ts

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

package/dist/src/server/neovim/environment/createTempDir.test.js

@@ -0,0 +1,29 @@
+import fs, { rmdirSync } from "fs";
+import nodePath from "path";
+import { expect, it } from "vitest";
+import { createTempDir } from "./createTempDir";
+class TempDirectory {
+    path;
+    constructor(path) {
+        this.path = path;
+    }
+    static create() {
+        const tmp = fs.mkdtempSync("test-temp-dir-");
+        return new TempDirectory(tmp);
+    }
+    [Symbol.dispose]() {
+        rmdirSync(this.path, { recursive: true });
+    }
+}
+it("should create a temp dir with no contents", async () => {
+    // typically the user will want to have contents, but this should not be an error
+    await using dir = TempDirectory.create();
+    const result = await createTempDir({
+        testEnvironmentPath: dir.path,
+        outputFilePath: nodePath.join(dir.path, "MyTestDirectory.ts"),
+    });
+    expect(result.contents).toEqual({});
+    expect(result.testEnvironmentPath).toEqual(dir.path);
+    expect(result.testEnvironmentPath.startsWith("test-temp-dir-")).toBeTruthy();
+    expect(result.testEnvironmentPathRelative.startsWith("testdirs")).toBeTruthy();
+});

package/dist/src/server/server.d.ts

@@ -1,5 +1,5 @@
 import type { inferRouterInputs } from "@trpc/server";
-import { TestServer } from ".";
+import { TestServer } from "./TestServer";
 import type { TestServerConfig } from "./updateTestdirectorySchemaFile";
 /** Stack for managing resources that need to be disposed of when the server
  * shuts down */
@@ -35,7 +35,7 @@ declare function createAppRouter(config: TestServerConfig): import("@trpc/server
             };
             output: import("./types").TestDirectory;
         }>;
-        onStdout: import("@trpc/server").TRPCSubscriptionProcedure<{
+        onStdout: import("@trpc/server/unstable-core-do-not-import").LegacyObservableSubscriptionProcedure<{
             input: {
                 client: {
                     tabId: string;

package/dist/src/server/server.js

@@ -1,7 +1,7 @@
 import { z } from "zod";
-import { TestServer } from ".";
 import { trpc } from "./connection/trpc";
 import * as neovim from "./neovim";
+import { TestServer } from "./TestServer";
 import { tabIdSchema } from "./utilities/tabId";
 /** Stack for managing resources that need to be disposed of when the server
  * shuts down */