@tui-sandbox/library 11.6.5 → 11.6.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "11.6.5",
+  "version": "11.6.6",
   "repository": {
     "type": "git",
     "url": "https://github.com/mikavilpas/tui-sandbox"

package/src/client/terminal-terminal-client.ts

@@ -4,7 +4,7 @@ import "@xterm/xterm/css/xterm.css"
 import type { StartTerminalBrowserArguments } from "../browser/neovim-client.js"
 import type { BlockingCommandClientInput } from "../server/blockingCommandInputSchema.js"
 import type { AppRouter } from "../server/server.js"
-import type { BlockingShellCommandOutput, TestDirectory } from "../server/types.js"
+import type { BlockingShellCommandOutput, ServerTestDirectory } from "../server/types.js"
 import type { TuiTerminalApi } from "./startTerminal.js"
 import { getTabId, startTerminal } from "./startTerminal.js"
 import { supportDA1 } from "./terminal-config.js"
@@ -71,7 +71,7 @@ export class TerminalTerminalClient {
     })
   }
 
-  public async startTerminalApplication(args: StartTerminalBrowserArguments): Promise<TestDirectory> {
+  public async startTerminalApplication(args: StartTerminalBrowserArguments): Promise<ServerTestDirectory> {
     await this.ready
 
     args.browserSettings.configureTerminal?.({

package/src/server/applications/neovim/neovimRouter.ts

@@ -2,6 +2,7 @@ import type { Except } from "type-fest"
 import * as z from "zod"
 import { blockingCommandInputSchema } from "../../blockingCommandInputSchema.js"
 import { trpc } from "../../connection/trpc.js"
+import { serverTestDirectorySchema } from "../../types.js"
 import type { DirectoriesConfig } from "../../updateTestdirectorySchemaFile.js"
 import { tabIdSchema } from "../../utilities/tabId.js"
 import { timeoutable } from "../../utilities/timeoutable.js"
@@ -59,6 +60,7 @@ export function createNeovimRouter(config: DirectoriesConfig) {
           }),
         })
       )
+      .output(serverTestDirectorySchema)
       .mutation(options => {
         return neovim.start(
           options.input.startNeovimArguments,

package/src/server/applications/terminal/api.ts

@@ -1,6 +1,6 @@
 import assert from "assert"
 import type { BlockingCommandInput } from "../../blockingCommandInputSchema.js"
-import type { BlockingShellCommandOutput } from "../../types.js"
+import type { BlockingShellCommandOutput, TestDirectory } from "../../types.js"
 import type { DirectoriesConfig } from "../../updateTestdirectorySchemaFile.js"
 import { convertEventEmitterToAsyncGenerator } from "../../utilities/generator.js"
 import { Lazy } from "../../utilities/Lazy.js"
@@ -18,7 +18,7 @@ const resources: Lazy<AsyncDisposableStack> = new Lazy(() => {
 export async function start(
   { tabId, startTerminalArguments }: StartTerminalInput,
   config: DirectoriesConfig
-): Promise<void> {
+): Promise<TestDirectory> {
   const app = terminals.get(tabId.tabId)
   assert(app, `Terminal with tabId ${tabId.tabId} not found.`)
   const testDirectory = await prepareNewTestDirectory(config)
@@ -30,6 +30,8 @@ export async function start(
     },
     startTerminalArguments.terminalDimensions
   )
+
+  return testDirectory
 }
 
 export async function initializeStdout(

package/src/server/applications/terminal/terminalRouter.ts

@@ -1,6 +1,7 @@
 import * as z from "zod"
 import { blockingCommandInputSchema } from "../../blockingCommandInputSchema.js"
 import { trpc } from "../../connection/trpc.js"
+import { serverTestDirectorySchema } from "../../types.js"
 import type { DirectoriesConfig } from "../../updateTestdirectorySchemaFile.js"
 import { tabIdSchema } from "../../utilities/tabId.js"
 import * as terminal from "./api.js"
@@ -26,9 +27,12 @@ export function createTerminalRouter(config: DirectoriesConfig) {
       return terminal.initializeStdout(options.input, options.signal)
     }),
 
-    start: trpc.procedure.input(startTerminalInputSchema).mutation(options => {
-      return terminal.start(options.input, config)
-    }),
+    start: trpc.procedure
+      .input(startTerminalInputSchema)
+      .output(serverTestDirectorySchema)
+      .mutation(options => {
+        return terminal.start(options.input, config)
+      }),
 
     sendStdin: trpc.procedure.input(z.object({ tabId: tabIdSchema, data: z.string() })).mutation(options => {
       return terminal.sendStdin(options.input)

package/src/server/types.ts

@@ -1,4 +1,5 @@
 import type { VimValue } from "neovim/lib/types/VimValue.js"
+import * as z from "zod"
 
 /** Describes the contents of the test directory, which is a blueprint for
  * files and directories. Tests can create a unique, safe environment for
@@ -8,7 +9,7 @@ import type { VimValue } from "neovim/lib/types/VimValue.js"
  * be written with confidence that the files and directories they expect are
  * actually found. Otherwise the tests are brittle and can break easily.
  */
-export type TestDirectory<TContents extends object = object> = {
+export type TestDirectory<TContents extends Record<string, unknown> = Record<string, unknown>> = {
   /** The path to the unique test directory (the root).
    *
    * @example /Users/mikavilpas/git/tui-sandbox/packages/integration-tests/test-environment/testdirs/dir-0199UZ
@@ -31,6 +32,14 @@ export type TestDirectory<TContents extends object = object> = {
   contents: TContents
 }
 
+export const serverTestDirectorySchema = z.object({
+  rootPathAbsolute: z.string(),
+  testEnvironmentPath: z.string(),
+  testEnvironmentPathRelative: z.string(),
+  contents: z.record(z.string(), z.unknown()),
+})
+export type ServerTestDirectory = z.infer<typeof serverTestDirectorySchema>
+
 export type TestEnvironmentCommonEnvironmentVariables = {
   HOME: string