typescript-virtual-container 1.5.2 → 1.5.4

package/src/types/commands.ts

@@ -1,146 +0,0 @@
-/** Command invocation mode used by shell runtime. */
-export type CommandMode = "shell" | "exec";
-
-import type { VirtualShell } from "../VirtualShell";
-import type { VirtualActiveSession } from "../VirtualUserManager";
-
-/**
- * Normalized command execution output.
- *
- * A command can write text, control session lifecycle, request UI state
- * transitions, and update active identity/cwd.
- */
-export interface CommandResult {
-	/** Standard output payload to append in terminal. */
-	stdout?: string;
-	/** Standard error payload to append in terminal. */
-	stderr?: string;
-	/** Request full terminal clear before next prompt. */
-	clearScreen?: boolean;
-	/** Request current shell/exec session close. */
-	closeSession?: boolean;
-	/** Optional exit code (default behavior handled by caller). */
-	exitCode?: number;
-	/** Optional cwd to apply for next prompt iteration. */
-	nextCwd?: string;
-	/** Optional user switch for current session state. */
-	switchUser?: string;
-	/** Request opening built-in nano editor workflow. */
-	openEditor?: NanoEditorSession;
-	/** Request opening built-in htop-like screen. */
-	openHtop?: boolean;
-	/** Request sudo password challenge flow. */
-	sudoChallenge?: SudoChallenge;
-	/** Request a generic password challenge (adduser, passwd). */
-	passwordChallenge?: PasswordChallenge;
-}
-
-/** Deferred sudo challenge metadata returned by sudo command. */
-export interface SudoChallenge {
-	/** User currently requesting elevation. */
-	username: string;
-	/** Target identity for elevated command. */
-	targetUser: string;
-	/** Command to execute after successful challenge; null for login shell. */
-	commandLine: string | null;
-	/** True when challenge targets interactive login shell. */
-	loginShell: boolean;
-	/** Prompt text shown before password input. */
-	prompt: string;
-	/**
-	 * Challenge mode.
-	 * - `"sudo"` (default): verify `username`'s password, then run `commandLine`.
-	 * - `"passwd"`: multi-step new-password flow; `onPassword` handles each step.
-	 * - `"confirm"`: text confirmation flow (e.g. deluser); `onPassword` receives typed text.
-	 */
-	mode?: "sudo" | "passwd" | "confirm";
-	/**
-	 * Optional async handler called when the user submits input.
-	 * Receives the typed text and the shell instance.
-	 * Returns a `CommandResult` written to the terminal, or `null` to show
-	 * another prompt (pass `nextPrompt` to change the prompt text).
-	 */
-	onPassword?: (input: string, shell: VirtualShell) => Promise<{
-		result: CommandResult | null;
-		nextPrompt?: string;
-	}>;
-}
-
-/** Generic password challenge — used by adduser, passwd, deluser. */
-export interface PasswordChallenge {
-	/** Lines to print before the first prompt. */
-	preamble?: string;
-	/** Primary prompt text (e.g. "New password: "). */
-	prompt: string;
-	/** If set, a second prompt is shown for confirmation. */
-	confirmPrompt?: string;
-	/** Prompt shown for a destructive confirmation (y/N). */
-	confirmText?: string;
-	/** Tag identifying what to do with the entered value. */
-	action: "adduser" | "passwd" | "deluser" | "su";
-	/** Username targeted by the action. */
-	targetUsername: string;
-	/** For adduser: the new user's username (already validated). */
-	newUsername?: string;
-}
-
-/** State payload used by nano command interactive editor flow. */
-export interface NanoEditorSession {
-	/** Final destination path to write when save succeeds. */
-	targetPath: string;
-	/** Temporary scratch path used while editing. */
-	tempPath: string;
-	/** Initial editor content shown to user. */
-	initialContent: string;
-}
-
-/** Per-session shell environment (variables, last exit code). */
-export interface ShellEnv {
-	/** Environment variables visible to commands. */
-	vars: Record<string, string>;
-	/** Exit status of the last executed command. */
-	lastExitCode: number;
-}
-
-/** Runtime context object passed to each command module. */
-export interface CommandContext {
-	/** Authenticated user currently bound to stream. */
-	authUser: string;
-	/** Virtual hostname shown in prompt and banners. */
-	hostname: string;
-	/** Snapshot of currently active user sessions. */
-	activeSessions: VirtualActiveSession[];
-	/** Original unparsed command line input. */
-	rawInput: string;
-	/** Invocation mode (interactive shell or direct exec). */
-	mode: CommandMode;
-	/** Tokenized arguments excluding command name. */
-	args: string[];
-	/** Virtual shell instance. */
-	shell: VirtualShell;
-	/** Optional stdin payload (used by pipes/redirections). */
-	stdin?: string;
-	/** Current working directory for command execution. */
-	cwd: string;
-	/** Per-session environment available to command modules. */
-	env: ShellEnv;
-}
-
-/** Contract implemented by each shell command module. */
-export interface ShellModule {
-	/** Primary command name used in CLI. */
-	name: string;
-	/** Parameter help snippets displayed by help command. */
-	params: string[];
-	/** Command handler implementation. */
-	run: (ctx: CommandContext) => CommandResult | Promise<CommandResult>;
-	/** Optional alternative command names. */
-	aliases?: string[];
-	/** Short description shown in `help`. */
-	description?: string;
-	/** Category used for grouped help output. */
-	category?: string;
-}
-
-/** Command return union allowing sync or async handlers. */
-export type CommandOutcome = CommandResult | Promise<CommandResult>;

package/src/types/pipeline.ts

@@ -1,52 +0,0 @@
-/** Represents a single command in a pipeline. */
-export interface PipelineCommand {
-	/** Command name */
-	name: string;
-	/** Command arguments */
-	args: string[];
-	/** Input redirection file path (< file) */
-	inputFile?: string;
-	/** Output redirection file path (> file) */
-	outputFile?: string;
-	/** Append to output file (>> file) */
-	appendOutput?: boolean;
-	/** Stderr redirection file path (2> file) */
-	stderrFile?: string;
-	/** Append stderr to file (2>> file) */
-	stderrAppend?: boolean;
-	/** Redirect stderr to stdout (2>&1) */
-	stderrToStdout?: boolean;
-}
-
-/** Logical operator connecting two statement groups. */
-export type LogicalOp = "&&" | "||" | ";";
-
-/** Represents a parsed shell pipeline */
-export interface Pipeline {
-	/** List of commands in the pipeline */
-	commands: PipelineCommand[];
-	/** Whether this is a valid pipeline */
-	isValid: boolean;
-	/** Error message if parsing failed */
-	error?: string;
-}
-
-/** A statement: one pipeline optionally followed by && / || / ; and the next statement */
-export interface Statement {
-	/** Pipeline to execute for this statement. */
-	pipeline: Pipeline;
-	/** Operator connecting this statement to the next one. */
-	op?: LogicalOp;
-	/** Optional next statement in sequence. */
-	next?: Statement;
-}
-
-/** Top-level parse result for a script. */
-export interface Script {
-	/** Statements contained in the script. */
-	statements: Statement[];
-	/** Whether the script was parsed successfully. */
-	isValid: boolean;
-	/** Optional parse error message. */
-	error?: string;
-}

package/src/types/streams.ts

@@ -1,32 +0,0 @@
-/**
- * Minimal stream contract used by exec command handlers.
- */
-export interface ExecStream {
-	/** Writes text to stdout channel. */
-	write(data: string): void;
-	/** Signals output completion. */
-	end(): void;
-	/** Sets process-like exit code for exec response. */
-	exit(code: number): void;
-	/** Writable stderr channel. */
-	stderr: {
-		/** Writes text to stderr channel. */
-		write(data: string): void;
-	};
-}
-
-/**
- * Minimal interactive stream contract used by shell mode.
- */
-export interface ShellStream {
-	/** Writes text to shell output channel. */
-	write(data: string): void;
-	/** Sets shell exit code on close. */
-	exit(code: number): void;
-	/** Ends shell stream. */
-	end(): void;
-	/** Subscribes to incoming user input chunks. */
-	on(event: "data", listener: (chunk: Buffer) => void): void;
-	/** Subscribes to stream close event. */
-	on(event: "close", listener: () => void): void;
-}

package/src/types/tar-stream.d.ts

@@ -1,38 +0,0 @@
-declare module "tar-stream" {
-	export interface TarStreamEntryHeader {
-		name: string;
-		mode?: number;
-		size?: number;
-		mtime?: Date;
-	}
-
-	export interface TarStreamPack {
-		entry(
-			header: TarStreamEntryHeader,
-			data: string | Buffer,
-			callback?: (error?: Error | null) => void,
-		): void;
-		finalize(): void;
-		destroy?(error?: Error): void;
-		on(event: "data", listener: (chunk: Buffer) => void): this;
-		on(event: "end", listener: () => void): this;
-		on(event: "error", listener: (error: Error) => void): this;
-	}
-
-	export interface TarStreamExtract {
-		on(
-			event: "entry",
-			listener: (
-				header: TarStreamEntryHeader,
-				stream: NodeJS.ReadableStream,
-				next: () => void,
-			) => void,
-		): this;
-		on(event: "finish", listener: () => void): this;
-		on(event: "error", listener: (error: Error) => void): this;
-		end(buffer: Buffer): void;
-	}
-
-	export function pack(): TarStreamPack;
-	export function extract(): TarStreamExtract;
-}

package/src/types/vfs.ts

@@ -1,98 +0,0 @@
-/** Supported virtual node kinds. */
-export type VfsNodeType = "file" | "directory";
-
-/** Shared metadata fields available on file and directory stats. */
-export interface VfsBaseNode {
-	/** Node name without parent path. */
-	name: string;
-	/** Absolute normalized node path. */
-	path: string;
-	/** POSIX-like mode bits. */
-	mode: number;
-	/** Node creation timestamp. */
-	createdAt: Date;
-	/** Last update timestamp. */
-	updatedAt: Date;
-}
-
-/** Stat shape returned for file nodes. */
-export interface VfsFileNode extends VfsBaseNode {
-	type: "file";
-	/** True when file content stored as gzip bytes. */
-	compressed: boolean;
-	/** Stored byte length (compressed when compressed=true). */
-	size: number;
-}
-
-/** Stat shape returned for directory nodes. */
-export interface VfsDirectoryNode extends VfsBaseNode {
-	type: "directory";
-	/** Number of direct children in directory. */
-	childrenCount: number;
-}
-
-/** Union of file and directory stat responses. */
-export type VfsNodeStats = VfsFileNode | VfsDirectoryNode;
-
-/** Optional behavior flags for writeFile operations. */
-export interface WriteFileOptions {
-	/** POSIX-like mode to apply on create or overwrite. */
-	mode?: number;
-	/** Store content compressed with gzip. */
-	compress?: boolean;
-}
-
-/** Optional behavior flags for remove operations. */
-export interface RemoveOptions {
-	/** Allow deleting non-empty directory trees. */
-	recursive?: boolean;
-}
-
-/** Base snapshot node schema used for archive serialization. */
-export interface VfsSnapshotBaseNode {
-	name: string;
-	mode: number;
-	/** ISO-8601 creation timestamp. */
-	createdAt: string;
-	/** ISO-8601 update timestamp. */
-	updatedAt: string;
-}
-
-/** Serialized snapshot shape for file nodes. */
-export interface VfsSnapshotFileNode extends VfsSnapshotBaseNode {
-	type: "file";
-	compressed: boolean;
-	/** Base64-encoded raw file bytes. */
-	contentBase64: string;
-}
-
-/** Serialized snapshot shape for directory nodes. */
-export interface VfsSnapshotDirectoryNode extends VfsSnapshotBaseNode {
-	type: "directory";
-	children: VfsSnapshotNode[];
-}
-
-/** Union of serialized snapshot node variants. */
-export type VfsSnapshotNode = VfsSnapshotFileNode | VfsSnapshotDirectoryNode;
-
-/** Top-level serialized filesystem snapshot. */
-export interface VfsSnapshot {
-	root: VfsSnapshotDirectoryNode;
-}
-
-/** Options for mounting a host directory into the VFS. */
-export interface MountOptions {
-	/** Absolute path inside the VM (e.g. `"/app"`). */
-	vPath: string;
-	/** Path on the host filesystem. Relative paths resolved from `process.cwd()`. */
-	hostPath: string;
-	/** When `true` (default), write operations inside the mount throw `EROFS`. */
-	readOnly?: boolean;
-}
-
-/** Describes an active mount point. */
-export interface MountPoint {
-	vPath:    string;
-	hostPath: string;
-	readOnly: boolean;
-}