typescript-virtual-container 1.4.8 → 1.4.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (122) hide show
  1. package/README.md +1 -1
  2. package/builds/self-standalone.js +2 -3
  3. package/builds/standalone-wo-sftp.js +2 -3
  4. package/builds/standalone.cjs +37 -38
  5. package/builds/web-full-api.min.js +0 -1
  6. package/builds/web.min.js +0 -1
  7. package/dist/Honeypot/index.d.ts +6 -0
  8. package/dist/Honeypot/index.d.ts.map +1 -1
  9. package/dist/Honeypot/index.js +20 -0
  10. package/dist/Honeypot/index.js.map +1 -1
  11. package/dist/SSHMimic/index.d.ts +6 -5
  12. package/dist/SSHMimic/index.d.ts.map +1 -1
  13. package/dist/SSHMimic/index.js +6 -5
  14. package/dist/SSHMimic/index.js.map +1 -1
  15. package/dist/SSHMimic/sftp.d.ts +1 -0
  16. package/dist/SSHMimic/sftp.d.ts.map +1 -1
  17. package/dist/SSHMimic/sftp.js.map +1 -1
  18. package/dist/VirtualFileSystem/internalTypes.d.ts +4 -0
  19. package/dist/VirtualFileSystem/internalTypes.d.ts.map +1 -1
  20. package/dist/VirtualFileSystem/journal.d.ts +1 -0
  21. package/dist/VirtualFileSystem/journal.d.ts.map +1 -1
  22. package/dist/VirtualFileSystem/journal.js.map +1 -1
  23. package/dist/VirtualShell/idleManager.d.ts +6 -2
  24. package/dist/VirtualShell/idleManager.d.ts.map +1 -1
  25. package/dist/VirtualShell/idleManager.js +10 -6
  26. package/dist/VirtualShell/idleManager.js.map +1 -1
  27. package/dist/VirtualShell/index.d.ts +13 -1
  28. package/dist/VirtualShell/index.d.ts.map +1 -1
  29. package/dist/VirtualShell/index.js +10 -5
  30. package/dist/VirtualShell/index.js.map +1 -1
  31. package/dist/VirtualUserManager/index.d.ts +4 -2
  32. package/dist/VirtualUserManager/index.d.ts.map +1 -1
  33. package/dist/VirtualUserManager/index.js +0 -1
  34. package/dist/VirtualUserManager/index.js.map +1 -1
  35. package/dist/commands/command-helpers.d.ts +5 -2
  36. package/dist/commands/command-helpers.d.ts.map +1 -1
  37. package/dist/commands/command-helpers.js.map +1 -1
  38. package/dist/index.d.ts +5 -2
  39. package/dist/index.d.ts.map +1 -1
  40. package/dist/index.js.map +1 -1
  41. package/docs/assets/hierarchy.js +1 -1
  42. package/docs/assets/navigation.js +1 -1
  43. package/docs/assets/search.js +1 -1
  44. package/docs/classes/HoneyPot.html +9 -9
  45. package/docs/classes/IdleManager.html +12 -9
  46. package/docs/classes/SshClient.html +18 -18
  47. package/docs/classes/VirtualFileSystem.html +34 -42
  48. package/docs/classes/VirtualPackageManager.html +13 -13
  49. package/docs/classes/VirtualSftpServer.html +3 -3
  50. package/docs/classes/VirtualShell.html +33 -29
  51. package/docs/classes/VirtualSshServer.html +12 -7
  52. package/docs/classes/VirtualUserManager.html +30 -30
  53. package/docs/functions/assertDiff.html +2 -2
  54. package/docs/functions/diffSnapshots.html +2 -2
  55. package/docs/functions/formatDiff.html +2 -2
  56. package/docs/functions/getArg.html +3 -3
  57. package/docs/functions/getFlag.html +2 -2
  58. package/docs/functions/ifFlag.html +2 -2
  59. package/docs/hierarchy.html +1 -1
  60. package/docs/index.html +3 -3
  61. package/docs/interfaces/AuditLogEntry.html +3 -3
  62. package/docs/interfaces/CommandContext.html +13 -13
  63. package/docs/interfaces/CommandResult.html +13 -13
  64. package/docs/interfaces/ExecStream.html +6 -6
  65. package/docs/interfaces/HoneyPotStats.html +5 -3
  66. package/docs/interfaces/IdleManagerOptions.html +3 -3
  67. package/docs/interfaces/InstalledPackage.html +11 -11
  68. package/docs/interfaces/NanoEditorSession.html +5 -5
  69. package/docs/interfaces/PackageDefinition.html +14 -14
  70. package/docs/interfaces/PackageFile.html +5 -5
  71. package/docs/interfaces/PasswordChallenge.html +16 -0
  72. package/docs/interfaces/RemoveOptions.html +3 -3
  73. package/docs/interfaces/ShellEnv.html +4 -4
  74. package/docs/interfaces/ShellModule.html +8 -8
  75. package/docs/interfaces/ShellProperties.html +5 -5
  76. package/docs/interfaces/ShellStream.html +7 -7
  77. package/docs/interfaces/SudoChallenge.html +9 -9
  78. package/docs/interfaces/VfsBaseNode.html +7 -7
  79. package/docs/interfaces/VfsDiff.html +6 -6
  80. package/docs/interfaces/VfsDiffEntry.html +4 -4
  81. package/docs/interfaces/VfsDiffModified.html +6 -6
  82. package/docs/interfaces/VfsDirectoryNode.html +8 -8
  83. package/docs/interfaces/VfsFileNode.html +9 -9
  84. package/docs/interfaces/VfsOptions.html +6 -6
  85. package/docs/interfaces/VfsSnapshot.html +3 -3
  86. package/docs/interfaces/VfsSnapshotBaseNode.html +4 -4
  87. package/docs/interfaces/VfsSnapshotDirectoryNode.html +5 -5
  88. package/docs/interfaces/VfsSnapshotFileNode.html +6 -6
  89. package/docs/interfaces/VirtualActiveSession.html +12 -0
  90. package/docs/interfaces/VirtualSftpServerOptions.html +7 -0
  91. package/docs/interfaces/VirtualShellVfsLike.html +15 -0
  92. package/docs/interfaces/VirtualShellVfsOptions.html +3 -0
  93. package/docs/interfaces/WriteFileOptions.html +4 -4
  94. package/docs/modules.html +1 -1
  95. package/docs/types/ArgParseOptions.html +4 -0
  96. package/docs/types/CommandMode.html +2 -2
  97. package/docs/types/CommandOutcome.html +2 -2
  98. package/docs/types/IdleState.html +1 -1
  99. package/docs/types/VfsNodeStats.html +2 -2
  100. package/docs/types/VfsNodeType.html +2 -2
  101. package/docs/types/VfsPersistenceMode.html +2 -2
  102. package/docs/types/VfsSnapshotNode.html +2 -2
  103. package/examples/web.min.js +0 -1
  104. package/package.json +10 -10
  105. package/scripts/generate-manuals-bundle.mjs +1 -1
  106. package/scripts/publish-package.sh +1 -1
  107. package/src/Honeypot/index.ts +24 -0
  108. package/src/SSHMimic/index.ts +7 -5
  109. package/src/SSHMimic/sftp.ts +6 -0
  110. package/src/VirtualFileSystem/internalTypes.ts +4 -0
  111. package/src/VirtualFileSystem/journal.ts +1 -0
  112. package/src/VirtualShell/idleManager.ts +10 -6
  113. package/src/VirtualShell/index.ts +18 -3
  114. package/src/VirtualUserManager/index.ts +4 -2
  115. package/src/commands/command-helpers.ts +5 -1
  116. package/src/index.ts +5 -1
  117. package/typedoc.json +45 -0
  118. package/builds/self-standalone.js.map +0 -7
  119. package/builds/standalone-wo-sftp.js.map +0 -7
  120. package/builds/standalone.cjs.map +0 -7
  121. package/builds/web-full-api.min.js.map +0 -7
  122. package/builds/web.min.js.map +0 -7
package/docs/types/VfsNodeType.html CHANGED
@@ -1,2 +1,2 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VfsNodeType | typescript-virtual-container</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">VfsNodeType</a></li></ul><h1>Type Alias VfsNodeType</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">VfsNodeType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;file&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;directory&quot;</span></div><div class="tsd-comment tsd-typography"><p>Supported virtual node kinds.</p>
2
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/d6b2c55e130d43f4ac8acc8d9d91e80481fa4c36/src/types/vfs.ts#L2">src/types/vfs.ts:2</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VfsNodeType | typescript-virtual-container - v1.4.9</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container - v1.4.9</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">VfsNodeType</a></li></ul><h1>Type Alias VfsNodeType</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">VfsNodeType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;file&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;directory&quot;</span></div><div class="tsd-comment tsd-typography"><p>Supported virtual node kinds.</p>
2
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/0d803b637251950a3a6075168d6d3d1127271694/src/types/vfs.ts#L2">src/types/vfs.ts:2</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container - v1.4.9</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/types/VfsPersistenceMode.html CHANGED
@@ -1,5 +1,5 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VfsPersistenceMode | typescript-virtual-container</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">VfsPersistenceMode</a></li></ul><h1>Type Alias VfsPersistenceMode</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">VfsPersistenceMode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;memory&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;fs&quot;</span></div><div class="tsd-comment tsd-typography"><p>&quot;memory&quot; — pure in-memory, no disk I/O (default).</p>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VfsPersistenceMode | typescript-virtual-container - v1.4.9</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container - v1.4.9</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">VfsPersistenceMode</a></li></ul><h1>Type Alias VfsPersistenceMode</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">VfsPersistenceMode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;memory&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;fs&quot;</span></div><div class="tsd-comment tsd-typography"><p>&quot;memory&quot; — pure in-memory, no disk I/O (default).</p>
2
2
  <p>&quot;fs&quot; — mirrors the VFS tree to a directory on the host filesystem.
3
3
  <code>snapshotPath</code> must be set to the directory where the binary
4
4
  snapshot file will be read/written (<code>vfs-snapshot.vfsb</code>).</p>
5
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/d6b2c55e130d43f4ac8acc8d9d91e80481fa4c36/src/VirtualFileSystem/index.ts#L36">src/VirtualFileSystem/index.ts:36</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
5
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/0d803b637251950a3a6075168d6d3d1127271694/src/VirtualFileSystem/index.ts#L36">src/VirtualFileSystem/index.ts:36</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container - v1.4.9</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/types/VfsSnapshotNode.html CHANGED
@@ -1,2 +1,2 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VfsSnapshotNode | typescript-virtual-container</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">VfsSnapshotNode</a></li></ul><h1>Type Alias VfsSnapshotNode</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">VfsSnapshotNode</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/VfsSnapshotFileNode.html" class="tsd-signature-type tsd-kind-interface">VfsSnapshotFileNode</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/VfsSnapshotDirectoryNode.html" class="tsd-signature-type tsd-kind-interface">VfsSnapshotDirectoryNode</a></div><div class="tsd-comment tsd-typography"><p>Union of serialized snapshot node variants.</p>
2
- </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/d6b2c55e130d43f4ac8acc8d9d91e80481fa4c36/src/types/vfs.ts#L76">src/types/vfs.ts:76</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VfsSnapshotNode | typescript-virtual-container - v1.4.9</title><meta name="description" content="Documentation for typescript-virtual-container"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">typescript-virtual-container - v1.4.9</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">VfsSnapshotNode</a></li></ul><h1>Type Alias VfsSnapshotNode</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">VfsSnapshotNode</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/VfsSnapshotFileNode.html" class="tsd-signature-type tsd-kind-interface">VfsSnapshotFileNode</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/VfsSnapshotDirectoryNode.html" class="tsd-signature-type tsd-kind-interface">VfsSnapshotDirectoryNode</a></div><div class="tsd-comment tsd-typography"><p>Union of serialized snapshot node variants.</p>
2
+ </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/itsrealfortune/typescript-virtual-container/blob/0d803b637251950a3a6075168d6d3d1127271694/src/types/vfs.ts#L76">src/types/vfs.ts:76</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">typescript-virtual-container - v1.4.9</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/examples/web.min.js CHANGED
@@ -10,4 +10,3 @@ var R=Object.defineProperty;var F=(o,e,t)=>e in o?R(o,e,{enumerable:!0,configura
10
10
  `),this.vfs.exists("/etc/hosts")||this.vfs.writeFile("/etc/hosts",`127.0.0.1 localhost
11
11
  ::1 localhost
12
12
  `),this.initialized=!0)}getCurrentWorkingDirectory(){return this.cwd}async executeCommandLine(e,t=!0){await this.ensureInitialized();let r=e.trim();if(!r)return{exitCode:0};let n=await E(r,this.env.vars,this.env.lastExitCode,a=>this.executeCommandLine(a,!1).then(c=>c.stdout??"")),s=$(n),i=await this.executeStatements(s.statements);return this.env.lastExitCode=i.exitCode??0,t&&await this.vfs.flushMirror(),i}async executeStatements(e){let t={exitCode:0},r=0;for(;r<e.length;){let n=e[r];if(t=await this.executePipeline(n.pipeline.commands),this.env.lastExitCode=t.exitCode??0,t.closeSession||t.switchUser)return t;let s=n.op;if(!(!s||s===";")){if(s==="&&"){if((t.exitCode??0)!==0)for(;r<e.length&&e[r]?.op==="&&";)r+=1}else if(s==="||"&&(t.exitCode??0)===0)for(;r<e.length&&e[r]?.op==="||";)r+=1}r+=1}return t}async executePipeline(e){return e.length===0?{exitCode:0}:e.length===1?this.executeSingleCommandWithRedirections(e[0]):this.executePipelineChain(e)}async executeSingleCommandWithRedirections(e){let t;if(e.inputFile){let n=u(e.inputFile,this.cwd);try{t=this.vfs.readFile(n)}catch{return{stderr:`${e.inputFile}: No such file or directory`,exitCode:1}}}let r=await this.executeCommand(e.name,e.args,t);if(e.outputFile){let n=u(e.outputFile,this.cwd),s=r.stdout??"";if(e.appendOutput&&this.vfs.exists(n)){let i=this.vfs.readFile(n);this.vfs.writeFile(n,`${i}${s}`)}else this.vfs.writeFile(n,s);return{...r,stdout:""}}return r}async executePipelineChain(e){let t="",r=0;for(let n=0;n<e.length;n+=1){let s=e[n];if(n===0&&s.inputFile){let a=u(s.inputFile,this.cwd);try{t=this.vfs.readFile(a)}catch{return{stderr:`${s.inputFile}: No such file or directory`,exitCode:1}}}let i=await this.executeCommand(s.name,s.args,t);t=i.stdout??"",r=i.exitCode??0}return{stdout:t,exitCode:r}}async executeCommand(e,t,r){let n=this.resolveCommand(e);if(!n)return{stderr:`${e}: command not found`,exitCode:127};let i={args:t.map(a=>w(a,this.env.vars,this.env.lastExitCode,this.env.vars.HOME)),stdin:r,cwd:this.cwd,env:this.env,rawInput:`${e} ${t.join(" ")}`.trim(),shell:this};try{let a=await n.run(i);return a.nextCwd&&(this.cwd=a.nextCwd,this.env.vars.PWD=a.nextCwd),a}catch(a){return{stderr:a instanceof Error?a.message:String(a),exitCode:1}}}};function ie(o="typescript-vm",e={}){return new W(o,e)}export{N as IndexedDbMirrorVfs,W as WebShell,ie as createWebShell};
13
- //# sourceMappingURL=web.min.js.map
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "type": "module",
7
- "version": "1.4.8",
7
+ "version": "1.4.9",
8
8
  "license": "MIT",
9
9
  "repository": {
10
10
  "type": "git",
@@ -28,20 +28,20 @@
28
28
  "test-battery": "bun test tests/",
29
29
  "test-salve": "for f in tests/*.test.ts; do echo \"\\n🧪 Testing $f...\"; bun test \"$f\" --timeout 10000; sleep 0.25; done",
30
30
  "build": "tsc --project tsconfig.json",
31
- "deploy:npm": "npm publish --access public",
31
+ "deploy:npm": "bun publish --access public",
32
32
  "bench": "rm -rf .benchmark-shells/ && bun benchmark-virtualshell.ts",
33
- "standalone-build:wo-sftp": "bunx esbuild src/standalone-wo-sftp.ts --bundle --platform=node --target=node18 --outfile=builds/standalone-wo-sftp.js --tree-shaking=true --minify --sourcemap --banner:js='#!/usr/bin/env node'",
34
- "web-build": "bunx esbuild src/web.ts --bundle --platform=browser --format=esm --target=es2020 --outfile=builds/web.min.js --tree-shaking=true --minify --sourcemap",
35
- "web-build-iife": "bunx esbuild src/web.ts --bundle --platform=browser --format=iife --target=es2020 --outfile=builds/web-iife.min.js --tree-shaking=true --minify --sourcemap --global-name=WebShellLib",
33
+ "standalone-build:wo-sftp": "bunx esbuild src/standalone-wo-sftp.ts --bundle --platform=node --target=node18 --outfile=builds/standalone-wo-sftp.js --tree-shaking=true --minify --banner:js='#!/usr/bin/env node'",
34
+ "web-build": "bunx esbuild src/web.ts --bundle --platform=browser --format=esm --target=es2020 --outfile=builds/web.min.js --tree-shaking=true --minify",
35
+ "web-build-iife": "bunx esbuild src/web.ts --bundle --platform=browser --format=iife --target=es2020 --outfile=builds/web-iife.min.js --tree-shaking=true --minify --global-name=WebShellLib",
36
36
  "example-build": "bun run web-build && cp builds/web.min.js examples/web.min.js",
37
- "example-serve": "cd examples && node server.js",
38
- "web-full-build": "bunx esbuild src/web-api.ts --bundle --platform=browser --format=esm --target=es2020 --outfile=builds/web-full-api.min.js --tree-shaking=true --minify --sourcemap --alias:node:events=./polyfills/node_events/index.js --alias:node:path=./polyfills/node_path/index.js --alias:node:os=./polyfills/node_os/index.js --alias:node:fs=./polyfills/node_fs/index.js --alias:node:fs/promises=./polyfills/node_fs/promises.js --alias:node:crypto=./polyfills/node_crypto/index.js --alias:node:child_process=./polyfills/node_child_process/index.js --alias:node:zlib=./polyfills/node_zlib/index.js --alias:node:vm=./polyfills/node_vm/index.js",
37
+ "example-serve": "cd examples && bun server.js",
38
+ "web-full-build": "bunx esbuild src/web-api.ts --bundle --platform=browser --format=esm --target=es2020 --outfile=builds/web-full-api.min.js --tree-shaking=true --minify --alias:node:events=./polyfills/node_events/index.js --alias:node:path=./polyfills/node_path/index.js --alias:node:os=./polyfills/node_os/index.js --alias:node:fs=./polyfills/node_fs/index.js --alias:node:fs/promises=./polyfills/node_fs/promises.js --alias:node:crypto=./polyfills/node_crypto/index.js --alias:node:child_process=./polyfills/node_child_process/index.js --alias:node:zlib=./polyfills/node_zlib/index.js --alias:node:vm=./polyfills/node_vm/index.js",
39
39
  "publish-package": "bash ./scripts/publish-package.sh",
40
- "self-standalone-build": "bunx esbuild src/self-standalone.ts --bundle --platform=node --format=esm --target=node18 --outfile=builds/self-standalone.js --tree-shaking=true --minify --sourcemap --banner:js='#!/usr/bin/env node'",
41
- "standalone-build": "bunx esbuild src/standalone.ts --bundle --platform=node --target=node18 --outfile=builds/standalone.cjs --tree-shaking=true --minify --sourcemap --banner:js='#!/usr/bin/env node'",
40
+ "self-standalone-build": "bunx esbuild src/self-standalone.ts --bundle --platform=node --format=esm --target=node18 --outfile=builds/self-standalone.js --tree-shaking=true --minify --banner:js='#!/usr/bin/env node'",
41
+ "standalone-build": "bunx esbuild src/standalone.ts --bundle --platform=node --target=node18 --outfile=builds/standalone.cjs --tree-shaking=true --minify --banner:js='#!/usr/bin/env node'",
42
42
  "build-all": "bun run generate-manuals && bun run self-standalone-build && bun run standalone-build && bun run standalone-build:wo-sftp && bun run web-build && bun run web-full-build && bun run example-build",
43
43
  "publish-doc": "bunx typedoc && bunx gh-pages -d docs",
44
- "generate-manuals": "node scripts/generate-manuals-bundle.mjs"
44
+ "generate-manuals": "bun scripts/generate-manuals-bundle.mjs"
45
45
  },
46
46
  "devDependencies": {
47
47
  "@biomejs/biome": "^2.4.15",
package/scripts/generate-manuals-bundle.mjs CHANGED
@@ -1,4 +1,4 @@
1
- #!/usr/bin/env node
1
+ #!/usr/bin/env bun
2
2
  /**
3
3
  * scripts/generate-manuals-bundle.mjs
4
4
  *
package/scripts/publish-package.sh CHANGED
@@ -11,7 +11,7 @@ if [[ -n "$(git status --porcelain)" ]]; then
11
11
  exit 1
12
12
  fi
13
13
 
14
- VERSION="$(node -p "require('./package.json').version")"
14
+ VERSION="$(bun -e "console.log(require('./package.json').version)")"
15
15
  TAG="v${VERSION}"
16
16
 
17
17
  if [[ -z "${VERSION}" ]]; then
package/src/Honeypot/index.ts CHANGED
@@ -43,6 +43,8 @@ export interface HoneyPotStats {
43
43
  userDeleted: number;
44
44
  clientConnects: number;
45
45
  clientDisconnects: number;
46
+ shellFreezes: number;
47
+ shellThaws: number;
46
48
  }
47
49
 
48
50
  const perf: PerfLogger = createPerfLogger("HoneyPot");
@@ -68,9 +70,13 @@ export class HoneyPot {
68
70
  userDeleted: 0,
69
71
  clientConnects: 0,
70
72
  clientDisconnects: 0,
73
+ shellFreezes: 0,
74
+ shellThaws: 0,
71
75
  };
72
76
 
73
77
  private maxLogSize: number;
78
+ /** Reference kept so VFS events can ping the shell's idle manager. */
79
+ private _shell: VirtualShell | null = null;
74
80
 
75
81
  /**
76
82
  * Creates a new HoneyPot instance.
@@ -99,6 +105,7 @@ export class HoneyPot {
99
105
  sftp?: SftpMimic,
100
106
  ): void {
101
107
  perf.mark("attach");
108
+ this._shell = shell;
102
109
  this.attachVirtualShell(shell);
103
110
  this.attachVirtualFileSystem(vfs);
104
111
  this.attachVirtualUserManager(users);
@@ -130,23 +137,38 @@ export class HoneyPot {
130
137
  this.log("VirtualShell", "session:start", data);
131
138
  },
132
139
  );
140
+
141
+ (shell as EventEmitter).on("shell:freeze", () => {
142
+ this.stats.shellFreezes++;
143
+ this.log("VirtualShell", "shell:freeze", {});
144
+ });
145
+
146
+ (shell as EventEmitter).on("shell:thaw", () => {
147
+ this.stats.shellThaws++;
148
+ this.log("VirtualShell", "shell:thaw", {});
149
+ });
133
150
  }
134
151
 
135
152
  /**
136
153
  * Attaches to VirtualFileSystem events.
154
+ * Also pings the shell's idle manager so SFTP/direct VFS activity
155
+ * counts as activity and prevents spurious freezes.
137
156
  */
138
157
  private attachVirtualFileSystem(vfs: VirtualFileSystem): void {
139
158
  (vfs as EventEmitter).on("file:read", (data: Record<string, unknown>) => {
140
159
  this.stats.fileReads++;
160
+ this._shell?.pingIdle();
141
161
  this.log("VirtualFileSystem", "file:read", data);
142
162
  });
143
163
 
144
164
  (vfs as EventEmitter).on("file:write", (data: Record<string, unknown>) => {
145
165
  this.stats.fileWrites++;
166
+ this._shell?.pingIdle();
146
167
  this.log("VirtualFileSystem", "file:write", data);
147
168
  });
148
169
 
149
170
  (vfs as EventEmitter).on("dir:create", (data: Record<string, unknown>) => {
171
+ this._shell?.pingIdle();
150
172
  this.log("VirtualFileSystem", "dir:create", data);
151
173
  });
152
174
 
@@ -354,6 +376,8 @@ export class HoneyPot {
354
376
  userDeleted: 0,
355
377
  clientConnects: 0,
356
378
  clientDisconnects: 0,
379
+ shellFreezes: 0,
380
+ shellThaws: 0,
357
381
  };
358
382
  }
359
383
 
package/src/SSHMimic/index.ts CHANGED
@@ -26,6 +26,7 @@ const DEV = !!process.env.DEV_MODE;
26
26
  const devLog = DEV ? console.log.bind(console) : () => {};
27
27
 
28
28
 
29
+ /** @internal */
29
30
  interface RateLimitEntry {
30
31
  attempts: number;
31
32
  lockedUntil: number;
@@ -45,11 +46,12 @@ class SshMimic extends EventEmitter {
45
46
  /**
46
47
  * Creates a new SSH mimic server instance.
47
48
  *
48
- * @param port TCP port to bind on localhost.
49
- * @param hostname Virtual hostname used for the SSH ident and default shell label.
50
- * @param shell Optional preconfigured virtual shell instance to reuse.
51
- * @param maxAuthAttempts Max failed attempts per IP before lockout (default: 5).
52
- * @param lockoutDurationMs Lockout window in ms after exceeding attempts (default: 60 000).
49
+ * @param options - Configuration object for the SSH server.
50
+ * @param options.port - TCP port to bind on localhost.
51
+ * @param options.hostname - Virtual hostname used for the SSH ident and default shell label.
52
+ * @param options.shell - Optional preconfigured virtual shell instance to reuse.
53
+ * @param options.maxAuthAttempts - Max failed attempts per IP before lockout (default: 5).
54
+ * @param options.lockoutDurationMs - Lockout window in ms after exceeding attempts (default: 60 000).
53
55
  */
54
56
  constructor({
55
57
  port,
package/src/SSHMimic/sftp.ts CHANGED
@@ -41,6 +41,7 @@ const OPEN_MODE = {
41
41
 
42
42
  const perf: PerfLogger = createPerfLogger("SftpMimic");
43
43
 
44
+ /** @internal */
44
45
  interface SftpFileHandle {
45
46
  type: "file";
46
47
  path: string;
@@ -48,6 +49,7 @@ interface SftpFileHandle {
48
49
  buffer: Buffer;
49
50
  }
50
51
 
52
+ /** @internal */
51
53
  interface SftpDirHandle {
52
54
  type: "dir";
53
55
  path: string;
@@ -55,8 +57,10 @@ interface SftpDirHandle {
55
57
  index: number;
56
58
  }
57
59
 
60
+ /** @internal */
58
61
  type SftpHandle = SftpFileHandle | SftpDirHandle;
59
62
 
63
+ /** @internal */
60
64
  interface SftpAttributes {
61
65
  mode: number;
62
66
  uid: number;
@@ -66,6 +70,7 @@ interface SftpAttributes {
66
70
  mtime: number | Date;
67
71
  }
68
72
 
73
+ /** @internal */
69
74
  interface SftpServerStream {
70
75
  on(
71
76
  event: "OPEN",
@@ -139,6 +144,7 @@ interface SftpServerStream {
139
144
  ): void;
140
145
  }
141
146
 
147
+ /** Options for {@link SftpMimic} constructor. */
142
148
  export interface SftpMimicOptions {
143
149
  port: number;
144
150
  hostname?: string;
package/src/VirtualFileSystem/internalTypes.ts CHANGED
@@ -1,3 +1,4 @@
1
+ /** @internal */
1
2
  export type InternalNode = InternalFileNode | InternalStubNode | InternalDirectoryNode;
2
3
 
3
4
  interface InternalBaseNode {
@@ -9,6 +10,7 @@ interface InternalBaseNode {
9
10
  updatedAt: number;
10
11
  }
11
12
 
13
+ /** @internal */
12
14
  export interface InternalFileNode extends InternalBaseNode {
13
15
  type: "file";
14
16
  content: Buffer;
@@ -23,6 +25,7 @@ export interface InternalFileNode extends InternalBaseNode {
23
25
  * Lazy stub — stores static rootfs file content as a plain string.
24
26
  * No Buffer allocation until the file is actually read or written.
25
27
  * On first write, promoted to a real InternalFileNode.
28
+ * @internal
26
29
  */
27
30
  export interface InternalStubNode extends InternalBaseNode {
28
31
  type: "stub";
@@ -30,6 +33,7 @@ export interface InternalStubNode extends InternalBaseNode {
30
33
  stubContent: string;
31
34
  }
32
35
 
36
+ /** @internal */
33
37
  export interface InternalDirectoryNode extends InternalBaseNode {
34
38
  type: "directory";
35
39
  /** Null-prototype object — avoids Map overhead (~40% less RAM per entry). */
package/src/VirtualFileSystem/journal.ts CHANGED
@@ -32,6 +32,7 @@ export const JournalOp = {
32
32
 
33
33
  export type JournalOp = typeof JournalOp[keyof typeof JournalOp];
34
34
 
35
+ /** @internal */
35
36
  export interface JournalEntry {
36
37
  op: JournalOp;
37
38
  path: string;
package/src/VirtualShell/idleManager.ts CHANGED
@@ -78,16 +78,20 @@ export class IdleManager extends EventEmitter {
78
78
  clearInterval(this._checkTimer);
79
79
  this._checkTimer = null;
80
80
  }
81
- if (this._state === "frozen") await this._thaw();
81
+ if (this._state === "frozen") this._thaw();
82
82
  }
83
83
 
84
84
  /**
85
- * Signal activity — resets the idle clock and thaws if frozen.
85
+ * Signal activity — resets the idle clock and thaws synchronously if frozen.
86
86
  * Call this before every exec / keypress / session event.
87
+ *
88
+ * Thaw is intentionally synchronous: decodeVfs() is a pure CPU operation
89
+ * (~0.07 ms) with no I/O, so it is safe to block briefly on the hot path.
90
+ * This guarantees the VFS tree is fully restored before any command runs.
87
91
  */
88
- public async ping(): Promise<void> {
92
+ public ping(): void {
89
93
  this._lastActivity = Date.now();
90
- if (this._state === "frozen") await this._thaw();
94
+ if (this._state === "frozen") this._thaw();
91
95
  }
92
96
 
93
97
  /** Current idle state. */
@@ -121,9 +125,9 @@ export class IdleManager extends EventEmitter {
121
125
  this.emit("freeze");
122
126
  }
123
127
 
124
- private async _thaw(): Promise<void> {
128
+ private _thaw(): void {
125
129
  if (this._state !== "frozen" || !this._frozenBuffer) return;
126
- // Reconstruct the tree from the frozen buffer (~0.07 ms for typical rootfs)
130
+ // Reconstruct the tree from the frozen buffer (~0.07 ms — pure CPU, no I/O)
127
131
  const root = decodeVfs(this._frozenBuffer);
128
132
  this.vfs.importRootTree(root);
129
133
  this._frozenBuffer = null;
package/src/VirtualShell/index.ts CHANGED
@@ -42,6 +42,10 @@ export interface ShellProperties {
42
42
  arch: string;
43
43
  }
44
44
 
45
+ /**
46
+ * Minimal VFS interface accepted by {@link VirtualShell} as a drop-in replacement
47
+ * for the built-in {@link VirtualFileSystem}.
48
+ */
45
49
  export interface VirtualShellVfsLike {
46
50
  restoreMirror(): Promise<void>;
47
51
  flushMirror(): Promise<void>;
@@ -57,6 +61,9 @@ export interface VirtualShellVfsLike {
57
61
  getUsageBytes?(targetPath?: string): number;
58
62
  }
59
63
 
64
+ /**
65
+ * Constructor options for {@link VirtualShell} when passing an existing VFS instance.
66
+ */
60
67
  export interface VirtualShellVfsOptions {
61
68
  vfsInstance?: VirtualShellVfsLike;
62
69
  }
@@ -153,7 +160,7 @@ class VirtualShell extends EventEmitter {
153
160
  *
154
161
  * @param hostname Virtual hostname used for prompts and idents.
155
162
  * @param properties Customizable properties shown in `uname -a` and similar commands.
156
- * @param vfsOptions Optional VFS persistence options (mode, snapshotPath).
163
+ * @param vfsOptionsOrInstance Optional VFS persistence options (mode, snapshotPath) or an existing VFS instance.
157
164
  */
158
165
  constructor(
159
166
  hostname: string,
@@ -239,7 +246,7 @@ class VirtualShell extends EventEmitter {
239
246
  */
240
247
  executeCommand(rawInput: string, authUser: string, cwd: string): void {
241
248
  perf.mark("executeCommand");
242
- if (this._idle) void this._idle.ping();
249
+ this._idle?.ping();
243
250
  runCommand(rawInput, authUser, this.hostname, "shell", cwd, this);
244
251
  this.emit("command", { command: rawInput, user: authUser, cwd });
245
252
  }
@@ -266,7 +273,7 @@ class VirtualShell extends EventEmitter {
266
273
  terminalSize: { cols: number; rows: number },
267
274
  ): void {
268
275
  perf.mark("startInteractiveSession");
269
- if (this._idle) void this._idle.ping();
276
+ this._idle?.ping();
270
277
  // Interactive shell logic
271
278
  this.emit("session:start", { user: authUser, sessionId, remoteAddress });
272
279
  startShell(
@@ -452,6 +459,14 @@ class VirtualShell extends EventEmitter {
452
459
  public get idleMs(): number {
453
460
  return this._idle?.idleMs ?? 0;
454
461
  }
462
+
463
+ /**
464
+ * Ping the idle manager to signal external activity (e.g. SFTP, direct VFS writes).
465
+ * No-op when idle management is disabled.
466
+ */
467
+ public pingIdle(): void {
468
+ this._idle?.ping();
469
+ }
455
470
  }
456
471
 
457
472
  export { VirtualShell };
package/src/VirtualUserManager/index.ts CHANGED
@@ -5,7 +5,10 @@ import type { PerfLogger } from "../utils/perfLogger";
5
5
  import { createPerfLogger } from "../utils/perfLogger";
6
6
  import type VirtualFileSystem from "../VirtualFileSystem";
7
7
 
8
- /** Persisted virtual user credential record. */
8
+ /**
9
+ * Persisted virtual user credential record.
10
+ * @internal
11
+ */
9
12
  export interface VirtualUserRecord {
10
13
  /** Unique login name. */
11
14
  username: string;
@@ -61,7 +64,6 @@ export class VirtualUserManager extends EventEmitter {
61
64
  * Creates a user manager instance backed by a virtual filesystem.
62
65
  *
63
66
  * @param vfs Backing virtual filesystem used for persistence.
64
- * @param defaultRootPassword Initial root password used when root is created.
65
67
  * @param autoSudoForNewUsers Whether newly created users are added to sudoers.
66
68
  */
67
69
  constructor(
package/src/commands/command-helpers.ts CHANGED
@@ -1,4 +1,8 @@
1
- type ArgParseOptions = {
1
+ /**
2
+ * Options for argument parsing helpers.
3
+ * @public
4
+ */
5
+ export type ArgParseOptions = {
2
6
  flags?: string[];
3
7
  flagsWithValue?: string[];
4
8
  };
package/src/index.ts CHANGED
@@ -1,10 +1,12 @@
1
1
  export { HoneyPot } from "./Honeypot/index";
2
2
  export { SshClient } from "./SSHClient/index";
3
3
  export { SftpMimic as VirtualSftpServer, SshMimic as VirtualSshServer } from "./SSHMimic/index";
4
+ export type { SftpMimicOptions as VirtualSftpServerOptions } from "./SSHMimic/sftp";
4
5
  export { default as VirtualFileSystem } from "./VirtualFileSystem/index";
5
6
  export { VirtualPackageManager } from "./VirtualPackageManager/index";
6
7
  export { VirtualShell } from "./VirtualShell/index";
7
8
  export { VirtualUserManager } from "./VirtualUserManager/index";
9
+ export type { VirtualActiveSession } from "./VirtualUserManager/index";
8
10
  export { IdleManager } from "./VirtualShell/idleManager";
9
11
  export type { IdleManagerOptions, IdleState } from "./VirtualShell/idleManager";
10
12
 
@@ -18,6 +20,7 @@ export type {
18
20
  CommandOutcome,
19
21
  CommandResult,
20
22
  NanoEditorSession,
23
+ PasswordChallenge,
21
24
  ShellEnv,
22
25
  ShellModule,
23
26
  SudoChallenge
@@ -38,7 +41,7 @@ export type {
38
41
  WriteFileOptions
39
42
  } from "./types/vfs";
40
43
  export type { VfsOptions, VfsPersistenceMode } from "./VirtualFileSystem/index";
41
- export type { ShellProperties } from "./VirtualShell/index";
44
+ export type { ShellProperties, VirtualShellVfsLike, VirtualShellVfsOptions } from "./VirtualShell/index";
42
45
 
43
46
  export type {
44
47
  InstalledPackage, PackageDefinition,
@@ -60,4 +63,5 @@ export {
60
63
  getFlag,
61
64
  ifFlag
62
65
  } from "./commands/command-helpers";
66
+ export type { ArgParseOptions } from "./commands/command-helpers";
63
67
 
package/typedoc.json ADDED
@@ -0,0 +1,45 @@
1
+ {
2
+ "entryPoints": ["src/index.ts"],
3
+ "out": "docs",
4
+ "name": "typescript-virtual-container",
5
+ "includeVersion": true,
6
+ "readme": "README.md",
7
+ "blockTags": [
8
+ "@abstract",
9
+ "@alpha",
10
+ "@async",
11
+ "@beta",
12
+ "@decorator",
13
+ "@deprecated",
14
+ "@eventProperty",
15
+ "@example",
16
+ "@experimental",
17
+ "@fires",
18
+ "@ignore",
19
+ "@inheritDoc",
20
+ "@internal",
21
+ "@label",
22
+ "@link",
23
+ "@module",
24
+ "@namespace",
25
+ "@override",
26
+ "@packageDocumentation",
27
+ "@param",
28
+ "@privateRemarks",
29
+ "@property",
30
+ "@public",
31
+ "@readonly",
32
+ "@remarks",
33
+ "@returns",
34
+ "@satisfies",
35
+ "@sealed",
36
+ "@since",
37
+ "@throws",
38
+ "@typeParam",
39
+ "@virtual"
40
+ ],
41
+ "excludePrivate": true,
42
+ "excludeInternal": true,
43
+ "treatWarningsAsErrors": false,
44
+ "skipErrorChecking": false
45
+ }