typescript-virtual-container 1.5.3 → 1.5.4

package/scripts/build-all.mjs

@@ -1,226 +0,0 @@
-#!/usr/bin/env node
-/**
- * scripts/build-all.mjs
- *
- * Orchestrates the full build pipeline:
- *  1. rimraf builds/           — clean previous artifacts
- *  2. generate-manuals-bundle  — inline all man pages
- *  3. esbuild all targets      — with dynamic output filenames
- *  4. copy web build to examples/
- *  5. update README.md         — replace filenames in marked sections
- */
-
-import { execSync } from "node:child_process";
-import { copyFileSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
-import { BUILDS_DIR, NAMES } from "./build-names.mjs";
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const root = join(__dirname, "..");
-const GH_BASE = "https://raw.githubusercontent.com/itsrealfortune/typescript-virtual-container/refs/heads/main/builds";
-
-function run(cmd) {
-  console.log(`\n$ ${cmd}`);
-  execSync(cmd, { stdio: "inherit", cwd: root });
-}
-
-// ── 1. Clean ──────────────────────────────────────────────────────────────────
-run(`bunx rimraf ${BUILDS_DIR}`);
-mkdirSync(BUILDS_DIR, { recursive: true });
-
-// ── 2. Manuals bundle ─────────────────────────────────────────────────────────
-run("node scripts/generate-manuals-bundle.mjs");
-
-// ── 3. esbuild targets ───────────────────────────────────────────────────────
-const ESBUILD = "bunx esbuild";
-const BANNER = `--banner:js='#!/usr/bin/env node'`;
-
-const targets = [
-  // self-standalone (ESM, interactive CLI)
-  `${ESBUILD} src/self-standalone.ts --bundle --platform=node --format=esm --target=node18 \
---outfile=${BUILDS_DIR}/${NAMES.selfStandalone} --tree-shaking=true --minify ${BANNER}`,
-
-  // standalone SSH+SFTP (CJS)
-  `${ESBUILD} src/standalone.ts --bundle --platform=node --target=node18 \
---outfile=${BUILDS_DIR}/${NAMES.standalone} --tree-shaking=true --minify ${BANNER}`,
-
-  // standalone SSH only (no SFTP)
-  `${ESBUILD} src/standalone-wo-sftp.ts --bundle --platform=node --target=node18 \
---outfile=${BUILDS_DIR}/${NAMES.standaloneNoSftp} --tree-shaking=true --minify ${BANNER}`,
-];
-
-for (const cmd of targets) {
-  run(cmd.replace(/\s+/g, " ").trim());
-}
-
-// // ── 4. Copy web to examples/ ─────────────────────────────────────────────────
-// const examplesDir = join(root, "examples");
-// mkdirSync(examplesDir, { recursive: true });
-// copyFileSync(
-//   join(BUILDS_DIR, NAMES.web),
-//   join(examplesDir, "web.min.js"),
-// );
-// console.log(`\n✓ Copied ${NAMES.web} → examples/web.min.js`);
-
-// ── 4. Run build.js ───────────────────────────────────────────────────────────
-run("node build.js");
-
-// ── 5. Copy demo to docs/ ─────────────────────────────────────────────────────
-const docsDir = join(root, "docs");
-mkdirSync(docsDir, { recursive: true });
-copyFileSync(join(root, "examples", "app.js"), join(docsDir, "app.js"));
-copyFileSync(join(root, "examples", "index.html"), join(docsDir, "demo.html"));
-console.log("\n✓ Copied examples/app.js → docs/app.js");
-console.log("✓ Copied examples/index.html → docs/demo.html");
-
-// ── 6. Update README.md ───────────────────────────────────────────────────────
-const readmePath = join(root, "README.md");
-let readme = readFileSync(readmePath, "utf8");
-
-const { selfStandalone, standalone, standaloneNoSftp, web } = NAMES;
-
-// Helper: replace content between <!-- BUILD:tag --> and <!-- /BUILD:tag -->
-function replaceSection(tag, content) {
-  const re = new RegExp(
-    `(<!-- BUILD:${tag} -->)[\\s\\S]*?(<!-- \\/BUILD:${tag} -->)`,
-    "g",
-  );
-  readme = readme.replace(re, `$1\n${content}\n$2`);
-}
-
-// Overview table — web and selfStandalone filenames
-replaceSection(
-  "mode-table",
-  [
-    `| Mode | Entry point | Use case |`,
-    `|------|-------------|----------|`,
-    `| **SSH/SFTP server** | \`VirtualSshServer\` / \`VirtualSftpServer\` | Honeypots, remote testing, training environments |`,
-    `| **Web shell** | \`builds/${web}\` (ESM) | Embedded terminals, interactive tutorials, browser demos |`,
-    `| **Standalone CLI** | \`builds/${selfStandalone}\` (single file) | Local shell, one-liner demos, no install required |`,
-  ].join("\n"),
-);
-
-// curl commands block
-replaceSection(
-  "curl-start",
-  [
-    `#### Interactivea local shell — persists VFS in .vfs/ in the current directory`,
-    `\`\`\`bash`,
-    `curl -s ${GH_BASE}/${selfStandalone} -o ${selfStandalone} && node ${selfStandalone}`,
-    `\`\`\``,
-    ``,
-    `#### SSH server (connect with any SSH client on port 2222)`,
-    `\`\`\`bash`,
-    `curl -s ${GH_BASE}/${standalone} -o ${standalone} && node ${standalone}`,
-    `\`\`\``,
-    ``,
-    `#### SSH server without SFTP (lighter build)`,
-    `\`\`\`bash`,
-    `curl -s ${GH_BASE}/${standaloneNoSftp} -o ${standaloneNoSftp} && node ${standaloneNoSftp}`,
-    `\`\`\``,
-  ].join("\n"),
-);
-
-// self-standalone options block
-replaceSection(
-  "selfStandalone-options",
-  [
-    `**\`${selfStandalone}\` options:**`,
-    ``,
-    `\`\`\`bash`,
-    `node ${selfStandalone}                  # boot as root`,
-    `node ${selfStandalone} --user alice     # boot as alice (prompts for password if set)`,
-    `node ${selfStandalone} --user=alice     # same, inline form`,
-    `SSH_MIMIC_HOSTNAME=my-box node ${selfStandalone}  # custom hostname`,
-    `\`\`\``,
-  ].join("\n"),
-);
-
-// Web bundles comparison table
-replaceSection(
-  "web-table",
-  [
-    `| Bundle | Format | Entry point | Use case |`,
-    `|--------|--------|-------------|----------|`,
-    `| \`builds/${web}\` | ESM | \`createWebShell()\` | Embedded terminals, modern bundlers |`,
-  ].join("\n"),
-);
-replaceSection(
-  "web-options",
-  [
-    `**\`${web}\`** — lightweight shell with IndexedDB VFS:`,
-    ``,
-    `\`\`\`html`,
-    `<script type="module">`,
-    `  import { createWebShell } from "./builds/${web}";`,
-    ``,
-    `  const shell = createWebShell("web-vm", {`,
-    `    vfs: { databaseName: "virtual-env-js", storeName: "vfs" },`,
-    `  });`,
-    `  await shell.ensureInitialized();`,
-    ``,
-    `  const out = await shell.executeCommandLine("ls /etc && echo hello");`,
-    `  console.log(out.stdout);`,
-    `</script>`,
-    `\`\`\``,
-    ``,
-    `**\`${web}\`** — mirrors the \`VirtualShell\` programmatic API:`,
-    ``,
-    `\`\`\`html`,
-    `<script type="module">`,
-    `  import { createVirtualShellShim } from "./builds/${web}";`,
-    ``,
-    `  const shell = createVirtualShellShim("web-vm");`,
-    `  await shell.ensureInitialized();`,
-    `  await shell.executeCommandLine("mkdir -p /app && echo hello > /app/file.txt");`,
-    `  console.log(shell.getVfs().readFile("/app/file.txt")); // hello`,
-    `</script>`,
-    `\`\`\``,
-  ].join("\n"),
-);
-
-// Changelog lines
-replaceSection(
-  "changelog",
-  [
-    `- [x] Web shell bundles (\`${web}\`) — fully browser-native with IndexedDB VFS`,
-    `- [x] Self-standalone CLI (\`${selfStandalone}\`) — single-file interactive shell, per-user history, tab completion`,
-  ].join("\n"),
-);
-
-writeFileSync(readmePath, readme, "utf8");
-console.log("✓ README.md updated with current build filenames");
-
-
-// ── 7. Strip .html from internal links in docs/ ───────────────────────────────
-// TypeDoc hardcodes .html — post-process all generated files to remove the
-// extension so GitHub Pages serves clean URLs (e.g. /docs/classes/VirtualShell)
-import { readdirSync } from "node:fs";
-
-function stripHtmlExtensions(dir) {
-  for (const entry of readdirSync(dir, { withFileTypes: true })) {
-    const full = join(dir, entry.name);
-    if (entry.isDirectory()) {
-      stripHtmlExtensions(full);
-    } else if (entry.name.endsWith(".html")) {
-      let src = readFileSync(full, "utf8");
-      // Replace href="...something.html" and href="...something.html#anchor"
-      // Only relative links (no http/https)
-      src = src.replace(
-        /href="(?!https?:\/\/)([^"]*)\.html(#[^"]*)?"/g,
-        (_, path, hash) => `href="${path}${hash ?? ""}"`,
-      );
-      writeFileSync(full, src, "utf8");
-    }
-  }
-}
-
-stripHtmlExtensions(docsDir);
-console.log("\n✓ Stripped .html from internal links in docs/");
-
-// ── Summary ──────────────────────────────────────────────────────────────────
-console.log("\n✅ Build complete:");
-for (const [key, name] of Object.entries(NAMES)) {
-  console.log(`   ${key.padEnd(16)} → builds/${name}`);
-}

package/scripts/build-names.mjs

@@ -1,43 +0,0 @@
-/**
- * scripts/build-names.mjs
- *
- * Computes dynamic output filenames for all build targets from:
- *   - package.json  → package version (e.g. 1.5.0)
- *   - VirtualShell  → default kernel version (e.g. 1.0.0+itsrealfortune+1-amd64)
- *
- * Used by build-all.mjs to pass --outfile to esbuild.
- */
-
-import { readFileSync } from "node:fs";
-import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
-
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const root = join(__dirname, "..");
-
-// Package version
-const pkg = JSON.parse(readFileSync(join(root, "package.json"), "utf8"));
-const pkgVersion = pkg.version; // e.g. "1.5.0"
-
-// Kernel version — read from VirtualShell source to stay in sync
-const shellSrc = readFileSync(join(root, "src/VirtualShell/index.ts"), "utf8");
-const kernelMatch = shellSrc.match(/kernel:\s*"([^"]+)"/);
-const kernelRaw = kernelMatch?.[1] ?? "unknown";
-// Shorten: "1.0.0+itsrealfortune+1-amd64" → "k1.0.0"
-const kernelVersion = `k${kernelRaw.split("+")[0]}`;
-
-export const BUILDS_DIR = join(root, "builds");
-
-export const NAMES = {
-  selfStandalone:  `fortune-nyx-v${pkgVersion}-directbash-${kernelVersion}.mjs`,
-  standalone:      `fortune-nyx-v${pkgVersion}-ssh.cjs`,
-  standaloneNoSftp:`fortune-nyx-v${pkgVersion}-ssh-nosftp.js`,
-  web:             `fortune-nyx-v${pkgVersion}-web.min.js`
-};
-
-// Print for shell consumption: NAME=value pairs
-if (process.argv[1] === fileURLToPath(import.meta.url)) {
-  for (const [key, value] of Object.entries(NAMES)) {
-    console.log(`${key}=${value}`);
-  }
-}

package/scripts/generate-manuals-bundle.mjs

@@ -1,49 +0,0 @@
-#!/usr/bin/env bun
-/**
- * scripts/generate-manuals-bundle.mjs
- *
- * Reads all .txt files from src/commands/manuals/ and generates
- * src/commands/manuals-bundle.ts — a static Record<string, string>
- * that is tree-shaken into standalone/web builds.
- *
- * Run: node scripts/generate-manuals-bundle.mjs
- * Called automatically by the "prebuild" step in package.json.
- */
-
-import { readdirSync, readFileSync, writeFileSync } from "node:fs";
-import { join, basename } from "node:path";
-import { fileURLToPath } from "node:url";
-
-const __dirname = fileURLToPath(new URL(".", import.meta.url));
-const manualsDir = join(__dirname, "../src/commands/manuals");
-const outFile = join(__dirname, "../src/commands/manuals-bundle.ts");
-
-const files = readdirSync(manualsDir)
-  .filter((f) => f.endsWith(".txt"))
-  .sort();
-
-const entries = files.map((file) => {
-  const key = basename(file, ".txt");
-  const content = readFileSync(join(manualsDir, file), "utf8").replace(/\n$/, "");
-  // Escape backticks and template literal syntax
-  const escaped = content.replace(/\\/g, "\\\\").replace(/`/g, "\\`").replace(/\$\{/g, "\\${");
-  return `\t"${key}": \`${escaped}\``;
-});
-
-const output = `/**
- * Auto-generated by scripts/generate-manuals-bundle.mjs
- * DO NOT EDIT — run \`node scripts/generate-manuals-bundle.mjs\` to regenerate.
- *
- * Inlines all src/commands/manuals/*.txt files so that standalone and web
- * builds have access to man pages without needing filesystem access.
- */
-/** biome-ignore-all lint/style/useNamingConvention: generated keys match command names (e.g. lsb_release) */
-
-/** Static map of command name → man page content. */
-export const MANUALS: Readonly<Record<string, string>> = {
-${entries.join(",\n")},
-} as const;
-`;
-
-writeFileSync(outFile, output, "utf8");
-console.log(`✓ Generated manuals-bundle.ts (${files.length} manuals)`);

package/scripts/postinstall.js

@@ -1,42 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const __dirname = fileURLToPath(new URL('.', import.meta.url));
-
-function deleteFile(filePath) {
-  if (fs.existsSync(filePath)) {
-    fs.unlinkSync(filePath);
-    console.log(`Deleted: ${filePath}`);
-  }
-}
-
-function deleteDirectory(dirPath) {
-  if (fs.existsSync(dirPath)) {
-    fs.rmSync(dirPath, { recursive: true, force: true });
-    console.log(`Deleted: ${dirPath}`);
-  }
-}
-
-const sshCryptoPath = path.join(
-  __dirname,
-  '..',
-  'node_modules',
-  'ssh2',
-  'lib',
-  'protocol',
-  'crypto',
-  'build',
-  'Release',
-  'sshcrypto.node'
-);
-
-const cpuFeaturesPath = path.join(
-  __dirname,
-  '..',
-  'node_modules',
-  'cpu-features'
-);
-
-deleteFile(sshCryptoPath);
-deleteDirectory(cpuFeaturesPath);

package/scripts/publish-package.sh

@@ -1,70 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-if ! git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
-  echo "Error: this command must run inside a git repository."
-  exit 1
-fi
-
-if [[ -n "$(git status --porcelain)" ]]; then
-  echo "Error: working tree is not clean. Commit or stash your changes first."
-  exit 1
-fi
-
-VERSION="$(bun -e "console.log(require('./package.json').version)")"
-TAG="v${VERSION}"
-
-if [[ -z "${VERSION}" ]]; then
-  echo "Error: package.json version is empty."
-  exit 1
-fi
-
-git fetch --tags --quiet
-
-TAG_EXISTS_LOCAL="false"
-TAG_EXISTS_REMOTE="false"
-
-if git rev-parse --verify --quiet "refs/tags/${TAG}" >/dev/null; then
-  TAG_EXISTS_LOCAL="true"
-fi
-
-if git ls-remote --tags origin "refs/tags/${TAG}" | grep -q .; then
-  TAG_EXISTS_REMOTE="true"
-fi
-
-if [[ "${TAG_EXISTS_LOCAL}" == "true" || "${TAG_EXISTS_REMOTE}" == "true" ]]; then
-  echo "Tag ${TAG} already exists. Deleting existing release/tag before republishing."
-
-  if command -v gh >/dev/null 2>&1; then
-    if gh release view "${TAG}" >/dev/null 2>&1; then
-      gh release delete "${TAG}" --yes
-      echo "GitHub release ${TAG} deleted."
-    fi
-  else
-    echo "gh CLI not found; skipping GitHub release deletion."
-  fi
-
-  if [[ "${TAG_EXISTS_LOCAL}" == "true" ]]; then
-    git tag -d "${TAG}" >/dev/null
-    echo "Local tag ${TAG} deleted."
-  fi
-
-  if [[ "${TAG_EXISTS_REMOTE}" == "true" ]]; then
-    git push --delete origin "${TAG}" >/dev/null
-    echo "Remote tag ${TAG} deleted."
-  fi
-fi
-
-git tag -a "${TAG}" -m "Release ${TAG}"
-git push origin "${TAG}"
-
-echo "Tag ${TAG} pushed."
-
-if command -v gh >/dev/null 2>&1; then
-  gh release create "${TAG}" --title "${TAG}" --generate-notes
-  echo "GitHub release ${TAG} created."
-else
-  echo "gh CLI not found; skipping GitHub release creation."
-fi
-
-echo "Done. The publish workflow should run from tag ${TAG}."