@tui-sandbox/library 7.0.1 → 7.2.0

package/dist/browser/assets/{index-Bf37MeF1.css → index-D6fBrqAi.css}

@@ -29,4 +29,4 @@
  *   The original design remains. The terminal itself
  *   has been extended to include xterm CSI codes, among
  *   other features.
- */.xterm{cursor:text;position:relative;user-select:none;-ms-user-select:none;-webkit-user-select:none}.xterm.focus,.xterm:focus{outline:none}.xterm .xterm-helpers{position:absolute;top:0;z-index:5}.xterm .xterm-helper-textarea{padding:0;border:0;margin:0;position:absolute;opacity:0;left:-9999em;top:0;width:0;height:0;z-index:-5;white-space:nowrap;overflow:hidden;resize:none}.xterm .composition-view{background:#000;color:#fff;display:none;position:absolute;white-space:nowrap;z-index:1}.xterm .composition-view.active{display:block}.xterm .xterm-viewport{background-color:#000;overflow-y:scroll;cursor:default;position:absolute;right:0;left:0;top:0;bottom:0}.xterm .xterm-screen{position:relative}.xterm .xterm-screen canvas{position:absolute;left:0;top:0}.xterm .xterm-scroll-area{visibility:hidden}.xterm-char-measure-element{display:inline-block;visibility:hidden;position:absolute;top:0;left:-9999em;line-height:normal}.xterm.enable-mouse-events{cursor:default}.xterm.xterm-cursor-pointer,.xterm .xterm-cursor-pointer{cursor:pointer}.xterm.column-select.focus{cursor:crosshair}.xterm .xterm-accessibility:not(.debug),.xterm .xterm-message{position:absolute;left:0;top:0;bottom:0;right:0;z-index:10;color:transparent;pointer-events:none}.xterm .xterm-accessibility-tree:not(.debug) *::selection{color:transparent}.xterm .xterm-accessibility-tree{-webkit-user-select:text;user-select:text;white-space:pre}.xterm .live-region{position:absolute;left:-9999px;width:1px;height:1px;overflow:hidden}.xterm-dim{opacity:1!important}.xterm-underline-1{text-decoration:underline}.xterm-underline-2{text-decoration:double underline}.xterm-underline-3{text-decoration:wavy underline}.xterm-underline-4{text-decoration:dotted underline}.xterm-underline-5{text-decoration:dashed underline}.xterm-overline{text-decoration:overline}.xterm-overline.xterm-underline-1{text-decoration:overline underline}.xterm-overline.xterm-underline-2{text-decoration:overline double underline}.xterm-overline.xterm-underline-3{text-decoration:overline wavy underline}.xterm-overline.xterm-underline-4{text-decoration:overline dotted underline}.xterm-overline.xterm-underline-5{text-decoration:overline dashed underline}.xterm-strikethrough{text-decoration:line-through}.xterm-screen .xterm-decoration-container .xterm-decoration{z-index:6;position:absolute}.xterm-screen .xterm-decoration-container .xterm-decoration.xterm-decoration-top-layer{z-index:7}.xterm-decoration-overview-ruler{z-index:8;position:absolute;top:0;right:0;pointer-events:none}.xterm-decoration-top{z-index:2;position:relative}@font-face{font-family:DejaVuSansMNerdFontMono;src:url(/assets/DejaVuSansMNerdFontMono-Regular-CRJgiq0O.ttf);font-weight:400;font-style:normal}:root{color-scheme:dark;background-color:#000}#app{display:flex;height:100vh;width:100vw}*{font-family:DejaVuSansMNerdFontMono,monospace}body{overflow-y:hidden;overflow-x:hidden}
+ */.xterm{cursor:text;position:relative;user-select:none;-ms-user-select:none;-webkit-user-select:none}.xterm.focus,.xterm:focus{outline:none}.xterm .xterm-helpers{position:absolute;top:0;z-index:5}.xterm .xterm-helper-textarea{padding:0;border:0;margin:0;position:absolute;opacity:0;left:-9999em;top:0;width:0;height:0;z-index:-5;white-space:nowrap;overflow:hidden;resize:none}.xterm .composition-view{background:#000;color:#fff;display:none;position:absolute;white-space:nowrap;z-index:1}.xterm .composition-view.active{display:block}.xterm .xterm-viewport{background-color:#000;overflow-y:scroll;cursor:default;position:absolute;right:0;left:0;top:0;bottom:0}.xterm .xterm-screen{position:relative}.xterm .xterm-screen canvas{position:absolute;left:0;top:0}.xterm .xterm-scroll-area{visibility:hidden}.xterm-char-measure-element{display:inline-block;visibility:hidden;position:absolute;top:0;left:-9999em;line-height:normal}.xterm.enable-mouse-events{cursor:default}.xterm.xterm-cursor-pointer,.xterm .xterm-cursor-pointer{cursor:pointer}.xterm.column-select.focus{cursor:crosshair}.xterm .xterm-accessibility:not(.debug),.xterm .xterm-message{position:absolute;left:0;top:0;bottom:0;right:0;z-index:10;color:transparent;pointer-events:none}.xterm .xterm-accessibility-tree:not(.debug) *::selection{color:transparent}.xterm .xterm-accessibility-tree{-webkit-user-select:text;user-select:text;white-space:pre}.xterm .live-region{position:absolute;left:-9999px;width:1px;height:1px;overflow:hidden}.xterm-dim{opacity:1!important}.xterm-underline-1{text-decoration:underline}.xterm-underline-2{text-decoration:double underline}.xterm-underline-3{text-decoration:wavy underline}.xterm-underline-4{text-decoration:dotted underline}.xterm-underline-5{text-decoration:dashed underline}.xterm-overline{text-decoration:overline}.xterm-overline.xterm-underline-1{text-decoration:overline underline}.xterm-overline.xterm-underline-2{text-decoration:overline double underline}.xterm-overline.xterm-underline-3{text-decoration:overline wavy underline}.xterm-overline.xterm-underline-4{text-decoration:overline dotted underline}.xterm-overline.xterm-underline-5{text-decoration:overline dashed underline}.xterm-strikethrough{text-decoration:line-through}.xterm-screen .xterm-decoration-container .xterm-decoration{z-index:6;position:absolute}.xterm-screen .xterm-decoration-container .xterm-decoration.xterm-decoration-top-layer{z-index:7}.xterm-decoration-overview-ruler{z-index:8;position:absolute;top:0;right:0;pointer-events:none}.xterm-decoration-top{z-index:2;position:relative}@font-face{font-family:DejaVuSansMNerdFontMono;src:url(/assets/DejaVuSansMNerdFontMono-Regular-CRJgiq0O.ttf);font-weight:400;font-style:normal}:root{color-scheme:dark;background-color:#000}#app{display:flex;height:100vh;width:100vw}*{font-family:DejaVuSansMNerdFontMono,monospace}.xterm .xterm-viewport{overflow-y:hidden}body{overflow-y:hidden;overflow-x:hidden;margin:0}

package/dist/browser/index.html

@@ -3,8 +3,8 @@
   <head>
     <meta charset="UTF-8" />
     <title>tui-sandbox integration tests</title>
-    <script type="module" crossorigin src="/assets/index-Bup5cvb2.js"></script>
-    <link rel="stylesheet" crossorigin href="/assets/index-Bf37MeF1.css">
+    <script type="module" crossorigin src="/assets/index-D3uBGfVO.js"></script>
+    <link rel="stylesheet" crossorigin href="/assets/index-D6fBrqAi.css">
   </head>
   <body>
     <div id="app"></div>

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

@@ -1,8 +1,10 @@
-import type { BlockingCommandClientInput } from "../server/server.js";
-import type { BlockingShellCommandOutput, StartNeovimGenericArguments, TestDirectory } from "../server/types.js";
+import type { BlockingCommandClientInput, ExCommandClientInput, LuaCodeClientInput } from "../server/server.js";
+import type { BlockingShellCommandOutput, RunExCommandOutput, RunLuaCodeOutput, StartNeovimGenericArguments, TestDirectory } from "../server/types.js";
 declare global {
     interface Window {
         startNeovim(startArguments?: StartNeovimGenericArguments): Promise<TestDirectory>;
         runBlockingShellCommand(input: BlockingCommandClientInput): Promise<BlockingShellCommandOutput>;
+        runLuaCode(input: LuaCodeClientInput): Promise<RunLuaCodeOutput>;
+        runExCommand(input: ExCommandClientInput): Promise<RunExCommandOutput>;
     }
 }

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

@@ -16,3 +16,9 @@ window.startNeovim = async function (startArgs) {
 window.runBlockingShellCommand = async function (input) {
     return client.runBlockingShellCommand(input);
 };
+window.runLuaCode = async function (input) {
+    return client.runLuaCode(input);
+};
+window.runExCommand = async function (input) {
+    return client.runExCommand(input);
+};

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

@@ -1,6 +1,6 @@
 import "@xterm/xterm/css/xterm.css";
-import type { BlockingCommandClientInput } from "../server/server.js";
-import type { BlockingShellCommandOutput, StartNeovimGenericArguments, TestDirectory } from "../server/types.js";
+import type { BlockingCommandClientInput, ExCommandClientInput, LuaCodeClientInput } from "../server/server.js";
+import type { BlockingShellCommandOutput, RunExCommandOutput, RunLuaCodeOutput, StartNeovimGenericArguments, TestDirectory } from "../server/types.js";
 import "./style.css";
 /** Manages the terminal state in the browser as well as the (browser's)
  * connection to the server side terminal application api. */
@@ -12,4 +12,6 @@ export declare class TerminalClient {
     constructor(app: HTMLElement);
     startNeovim(args: StartNeovimGenericArguments): Promise<TestDirectory>;
     runBlockingShellCommand(input: BlockingCommandClientInput): Promise<BlockingShellCommandOutput>;
+    runLuaCode(input: LuaCodeClientInput): Promise<RunLuaCodeOutput>;
+    runExCommand(input: ExCommandClientInput): Promise<RunExCommandOutput>;
 }

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

@@ -77,4 +77,18 @@ export class TerminalClient {
             tabId: this.tabId,
         });
     }
+    async runLuaCode(input) {
+        await this.ready;
+        return this.trpc.neovim.runLuaCode.mutate({
+            luaCode: input.luaCode,
+            tabId: this.tabId,
+        });
+    }
+    async runExCommand(input) {
+        await this.ready;
+        return this.trpc.neovim.runExCommand.mutate({
+            command: input.command,
+            tabId: this.tabId,
+        });
+    }
 }

package/dist/src/server/cypress-support/contents.js

@@ -4,14 +4,19 @@ const __filename = fileURLToPath(import.meta.url);
 export async function createCypressSupportFileContents() {
     // this is the interface of tui-sandbox as far as cypress in the user's
     // application is concerned
-    let text = ` 
-/// <reference types="cypress" />
+    let text = `/// <reference types="cypress" />
 //
 // This file is autogenerated by tui-sandbox. Do not edit it directly.
 //
-import type { BlockingCommandClientInput } from "@tui-sandbox/library/dist/src/server/server"
+import type {
+  BlockingCommandClientInput,
+  ExCommandClientInput,
+  LuaCodeClientInput,
+} from "@tui-sandbox/library/dist/src/server/server"
 import type {
   BlockingShellCommandOutput,
+  RunExCommandOutput,
+  RunLuaCodeOutput,
   StartNeovimGenericArguments,
 } from "@tui-sandbox/library/dist/src/server/types"
 import type { OverrideProperties } from "type-fest"
@@ -26,6 +31,8 @@ declare global {
   interface Window {
     startNeovim(startArguments?: MyStartNeovimServerArguments): Promise<NeovimContext>
     runBlockingShellCommand(input: BlockingCommandClientInput): Promise<BlockingShellCommandOutput>
+    runLuaCode(input: LuaCodeClientInput): Promise<RunLuaCodeOutput>
+    runExCommand(input: ExCommandClientInput): Promise<RunExCommandOutput>
   }
 }
 
@@ -56,6 +63,18 @@ Cypress.Commands.add("typeIntoTerminal", (text: string, options?: Partial<Cypres
   cy.get("textarea").focus().type(text, options)
 })
 
+Cypress.Commands.add("runLuaCode", (input: LuaCodeClientInput) => {
+  cy.window().then(async win => {
+    return await win.runLuaCode(input)
+  })
+})
+
+Cypress.Commands.add("runExCommand", (input: ExCommandClientInput) => {
+  cy.window().then(async win => {
+    return await win.runExCommand(input)
+  })
+})
+
 before(function () {
   // disable Cypress's default behavior of logging all XMLHttpRequests and
   // fetches to the Command Log
@@ -75,6 +94,10 @@ declare global {
       /** Runs a shell command in a blocking manner, waiting for the command to
        * finish before returning. Requires neovim to be running. */
       runBlockingShellCommand(input: BlockingCommandClientInput): Chainable<BlockingShellCommandOutput>
+
+      runLuaCode(input: LuaCodeClientInput): Chainable<RunLuaCodeOutput>
+
+      runExCommand(input: ExCommandClientInput): Chainable<RunExCommandOutput>
     }
   }
 }

package/dist/src/server/cypress-support/contents.test.js

@@ -6,9 +6,15 @@ it("should return the expected contents", async () => {
     //
     // This file is autogenerated by tui-sandbox. Do not edit it directly.
     //
-    import type { BlockingCommandClientInput } from "@tui-sandbox/library/dist/src/server/server"
+    import type {
+      BlockingCommandClientInput,
+      ExCommandClientInput,
+      LuaCodeClientInput,
+    } from "@tui-sandbox/library/dist/src/server/server"
     import type {
       BlockingShellCommandOutput,
+      RunExCommandOutput,
+      RunLuaCodeOutput,
       StartNeovimGenericArguments,
     } from "@tui-sandbox/library/dist/src/server/types"
     import type { OverrideProperties } from "type-fest"
@@ -23,6 +29,8 @@ it("should return the expected contents", async () => {
       interface Window {
         startNeovim(startArguments?: MyStartNeovimServerArguments): Promise<NeovimContext>
         runBlockingShellCommand(input: BlockingCommandClientInput): Promise<BlockingShellCommandOutput>
+        runLuaCode(input: LuaCodeClientInput): Promise<RunLuaCodeOutput>
+        runExCommand(input: ExCommandClientInput): Promise<RunExCommandOutput>
       }
     }
 
@@ -53,6 +61,18 @@ it("should return the expected contents", async () => {
       cy.get("textarea").focus().type(text, options)
     })
 
+    Cypress.Commands.add("runLuaCode", (input: LuaCodeClientInput) => {
+      cy.window().then(async win => {
+        return await win.runLuaCode(input)
+      })
+    })
+
+    Cypress.Commands.add("runExCommand", (input: ExCommandClientInput) => {
+      cy.window().then(async win => {
+        return await win.runExCommand(input)
+      })
+    })
+
     before(function () {
       // disable Cypress's default behavior of logging all XMLHttpRequests and
       // fetches to the Command Log
@@ -72,6 +92,10 @@ it("should return the expected contents", async () => {
           /** Runs a shell command in a blocking manner, waiting for the command to
            * finish before returning. Requires neovim to be running. */
           runBlockingShellCommand(input: BlockingCommandClientInput): Chainable<BlockingShellCommandOutput>
+
+          runLuaCode(input: LuaCodeClientInput): Chainable<RunLuaCodeOutput>
+
+          runExCommand(input: ExCommandClientInput): Chainable<RunExCommandOutput>
         }
       }
     }

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

@@ -1,6 +1,6 @@
 import "core-js/proposals/async-explicit-resource-management.js";
-import type { BlockingCommandInput } from "../server.js";
-import type { BlockingShellCommandOutput, StartNeovimGenericArguments, TestDirectory } from "../types.js";
+import type { BlockingCommandInput, ExCommandInput, LuaCodeInput } from "../server.js";
+import type { BlockingShellCommandOutput, RunExCommandOutput, RunLuaCodeOutput, StartNeovimGenericArguments, TestDirectory } from "../types.js";
 import type { TestServerConfig } from "../updateTestdirectorySchemaFile.js";
 import type { TabId } from "../utilities/tabId.js";
 import type { TerminalDimensions } from "./NeovimApplication.js";
@@ -13,3 +13,5 @@ export declare function sendStdin(options: {
     data: string;
 }): Promise<void>;
 export declare function runBlockingShellCommand(signal: AbortSignal | undefined, input: BlockingCommandInput, allowFailure: boolean): Promise<BlockingShellCommandOutput>;
+export declare function runLuaCode(options: LuaCodeInput): Promise<RunLuaCodeOutput>;
+export declare function runExCommand(options: ExCommandInput): Promise<RunExCommandOutput>;

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

@@ -70,3 +70,39 @@ export async function runBlockingShellCommand(signal, input, allowFailure) {
         throw new Error(`Error running shell blockingCommand (${input.command})`, { cause: e });
     }
 }
+export async function runLuaCode(options) {
+    const neovim = neovims.get(options.tabId.tabId);
+    assert(neovim !== undefined, `Neovim instance for clientId not found - cannot run Lua code. Maybe neovim's not started yet?`);
+    assert(neovim.application, `Neovim application not found for client id ${options.tabId.tabId}. Maybe it's not started yet?`);
+    const api = await neovim.state?.client.get();
+    if (!api) {
+        throw new Error(`Neovim API not available for client id ${options.tabId.tabId}. Maybe it's not started yet?`);
+    }
+    console.log(`Neovim ${neovim.application.processId()} running Lua code: ${options.luaCode}`);
+    try {
+        const value = await api.lua(options.luaCode);
+        return { value };
+    }
+    catch (e) {
+        console.warn(`Error running Lua code: ${options.luaCode}`, e);
+        throw new Error(`Error running Lua code: ${options.luaCode}`, { cause: e });
+    }
+}
+export async function runExCommand(options) {
+    const neovim = neovims.get(options.tabId.tabId);
+    assert(neovim !== undefined, `Neovim instance for clientId not found - cannot runExCommand. Maybe neovim's not started yet?`);
+    assert(neovim.application, `Neovim application not found for client id ${options.tabId.tabId}. Maybe it's not started yet?`);
+    const api = await neovim.state?.client.get();
+    if (!api) {
+        throw new Error(`Neovim API not available for client id ${options.tabId.tabId}. Maybe it's not started yet?`);
+    }
+    console.log(`Neovim ${neovim.application.processId()} running Ex command: ${options.command}`);
+    try {
+        const output = await api.commandOutput(options.command);
+        return { value: output };
+    }
+    catch (e) {
+        console.warn(`Error running Ex command: ${options.command}`, e);
+        throw new Error(`Error running Ex command: ${options.command}`, { cause: e });
+    }
+}

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

@@ -44,6 +44,50 @@ declare const blockingCommandInputSchema: z.ZodObject<{
 }>;
 export type BlockingCommandClientInput = Except<BlockingCommandInput, "tabId">;
 export type BlockingCommandInput = z.infer<typeof blockingCommandInputSchema>;
+declare const luaCodeInputSchema: z.ZodObject<{
+    tabId: z.ZodObject<{
+        tabId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        tabId: string;
+    }, {
+        tabId: string;
+    }>;
+    luaCode: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    tabId: {
+        tabId: string;
+    };
+    luaCode: string;
+}, {
+    tabId: {
+        tabId: string;
+    };
+    luaCode: string;
+}>;
+export type LuaCodeClientInput = Except<LuaCodeInput, "tabId">;
+export type LuaCodeInput = z.infer<typeof luaCodeInputSchema>;
+declare const exCommandInputSchema: z.ZodObject<{
+    tabId: z.ZodObject<{
+        tabId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        tabId: string;
+    }, {
+        tabId: string;
+    }>;
+    command: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    command: string;
+    tabId: {
+        tabId: string;
+    };
+}, {
+    command: string;
+    tabId: {
+        tabId: string;
+    };
+}>;
+export type ExCommandClientInput = Except<ExCommandInput, "tabId">;
+export type ExCommandInput = z.infer<typeof exCommandInputSchema>;
 /** @private */
 export declare function createAppRouter(config: TestServerConfig): Promise<import("@trpc/server/unstable-core-do-not-import").BuiltRouter<{
     ctx: object;
@@ -108,6 +152,24 @@ export declare function createAppRouter(config: TestServerConfig): Promise<impor
             };
             output: import("./types.js").BlockingShellCommandOutput;
         }>;
+        runLuaCode: import("@trpc/server").TRPCMutationProcedure<{
+            input: {
+                tabId: {
+                    tabId: string;
+                };
+                luaCode: string;
+            };
+            output: import("./types.js").RunLuaCodeOutput;
+        }>;
+        runExCommand: import("@trpc/server").TRPCMutationProcedure<{
+            input: {
+                command: string;
+                tabId: {
+                    tabId: string;
+                };
+            };
+            output: import("./types.js").RunExCommandOutput;
+        }>;
     }>;
 }>>>;
 export type AppRouter = Awaited<ReturnType<typeof createAppRouter>>;

package/dist/src/server/server.js

@@ -16,6 +16,8 @@ const blockingCommandInputSchema = z.object({
     cwd: z.string().optional(),
     envOverrides: z.record(z.string()).optional(),
 });
+const luaCodeInputSchema = z.object({ tabId: tabIdSchema, luaCode: z.string() });
+const exCommandInputSchema = z.object({ tabId: tabIdSchema, command: z.string() });
 /** @private */
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export async function createAppRouter(config) {
@@ -54,6 +56,12 @@ export async function createAppRouter(config) {
             runBlockingShellCommand: trpc.procedure.input(blockingCommandInputSchema).mutation(async (options) => {
                 return neovim.runBlockingShellCommand(options.signal, options.input, options.input.allowFailure ?? false);
             }),
+            runLuaCode: trpc.procedure.input(luaCodeInputSchema).mutation(options => {
+                return neovim.runLuaCode(options.input);
+            }),
+            runExCommand: trpc.procedure.input(exCommandInputSchema).mutation(options => {
+                return neovim.runExCommand(options.input);
+            }),
         }),
     });
     return appRouter;

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

@@ -1,3 +1,4 @@
+import type { VimValue } from "neovim/lib/types/VimValue.js";
 /** Describes the contents of the test directory, which is a blueprint for
  * files and directories. Tests can create a unique, safe environment for
  * interacting with the contents of such a directory.
@@ -33,3 +34,9 @@ export type BlockingShellCommandOutput = {
 } | {
     type: "failed";
 };
+export type RunLuaCodeOutput = {
+    value?: VimValue;
+};
+export type RunExCommandOutput = {
+    value?: string;
+};