@freestyle-sh/with-ttyd 0.0.6 → 0.0.8

package/dist/index.d.ts

@@ -22,6 +22,10 @@ type TtydConfig = {
     title?: string;
     /** Read-only terminal (no input allowed) */
     readOnly?: boolean;
+    /** Xterm.js theme settings passed to ttyd client options */
+    theme?: Record<string, string | number | boolean>;
+    /** TTYD client options (xterm.js options, ttyd client flags) */
+    clientOptions?: Record<string, unknown>;
 };
 type ResolvedTerminalConfig = {
     port: number;
@@ -34,6 +38,8 @@ type ResolvedTerminalConfig = {
     };
     title: string;
     readOnly: boolean;
+    theme?: Record<string, string | number | boolean>;
+    clientOptions?: Record<string, unknown>;
 };
 declare class VmWebTerminal<T extends TtydConfig[] = TtydConfig[]> extends VmWith<VmWebTerminalInstance<T>> {
     private resolvedTerminals;

package/dist/index.js

@@ -23,7 +23,9 @@ class VmWebTerminal extends VmWith {
         cwd: config.cwd ?? "/root",
         credential: config.credential,
         title: config.title ?? `terminal-${port}`,
-        readOnly: config.readOnly ?? false
+        readOnly: config.readOnly ?? false,
+        theme: config.theme,
+        clientOptions: config.clientOptions
       };
     });
   }
@@ -66,6 +68,24 @@ class VmWebTerminal extends VmWith {
       } else {
         args.push(`--writable`);
       }
+      if (t.theme && t.clientOptions && "theme" in t.clientOptions) {
+        throw new Error(
+          `Client option conflict for terminal on port ${t.port}: theme is set in both theme and clientOptions`
+        );
+      }
+      const clientOptions = {
+        ...t.clientOptions ?? {}
+      };
+      if (t.theme) {
+        clientOptions.theme = t.theme;
+      }
+      for (const [key, value] of Object.entries(clientOptions)) {
+        if (value === void 0) {
+          continue;
+        }
+        const serialized = typeof value === "string" || typeof value === "number" || typeof value === "boolean" ? String(value) : JSON.stringify(value);
+        args.push(`-t '${key}=${serialized}'`);
+      }
       args.push(t.command);
       return {
         name: `web-terminal-${t.port}`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freestyle-sh/with-ttyd",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Web terminal for freestyle sandboxes",
   "type": "module",
   "main": "./dist/index.js",
@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "freestyle-sandboxes": "^0.1.28",
-    "@freestyle-sh/with-pty": "^0.0.2"
+    "@freestyle-sh/with-pty": "^0.0.4"
   },
   "scripts": {
     "build": "pkgroll"

package/src/index.ts

@@ -23,6 +23,10 @@ export type TtydConfig = {
   title?: string;
   /** Read-only terminal (no input allowed) */
   readOnly?: boolean;
+  /** Xterm.js theme settings passed to ttyd client options */
+  theme?: Record<string, string | number | boolean>;
+  /** TTYD client options (xterm.js options, ttyd client flags) */
+  clientOptions?: Record<string, unknown>;
 };
 
 export type ResolvedTerminalConfig = {
@@ -33,6 +37,8 @@ export type ResolvedTerminalConfig = {
   credential?: { username: string; password: string };
   title: string;
   readOnly: boolean;
+  theme?: Record<string, string | number | boolean>;
+  clientOptions?: Record<string, unknown>;
 };
 
 // ============================================================================
@@ -73,6 +79,8 @@ export class VmWebTerminal<
         credential: config.credential,
         title: config.title ?? `terminal-${port}`,
         readOnly: config.readOnly ?? false,
+        theme: config.theme,
+        clientOptions: config.clientOptions,
       };
     });
   }
@@ -129,6 +137,33 @@ export class VmWebTerminal<
         args.push(`--writable`);
       }
 
+      if (t.theme && t.clientOptions && "theme" in t.clientOptions) {
+        throw new Error(
+          `Client option conflict for terminal on port ${t.port}: theme is set in both theme and clientOptions`,
+        );
+      }
+
+      const clientOptions: Record<string, unknown> = {
+        ...(t.clientOptions ?? {}),
+      };
+
+      if (t.theme) {
+        clientOptions.theme = t.theme;
+      }
+
+      for (const [key, value] of Object.entries(clientOptions)) {
+        if (value === undefined) {
+          continue;
+        }
+        const serialized =
+          typeof value === "string" ||
+          typeof value === "number" ||
+          typeof value === "boolean"
+            ? String(value)
+            : JSON.stringify(value);
+        args.push(`-t '${key}=${serialized}'`);
+      }
+
       // Shell command at the end
       args.push(t.command);