@lakutata/docker 3.0.0-beta.0

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 (305) hide show
  1. package/LICENSE +23 -0
  2. package/README.md +309 -0
  3. package/THIRD_PARTY_NOTICES.md +299 -0
  4. package/dist/cjs/client/BuildContext.d.ts +22 -0
  5. package/dist/cjs/client/BuildContext.js +76 -0
  6. package/dist/cjs/client/BuildKitProgress.d.ts +81 -0
  7. package/dist/cjs/client/BuildKitProgress.js +195 -0
  8. package/dist/cjs/client/DockerClient.d.ts +196 -0
  9. package/dist/cjs/client/DockerClient.js +312 -0
  10. package/dist/cjs/client/DockerConnection.d.ts +154 -0
  11. package/dist/cjs/client/DockerConnection.js +397 -0
  12. package/dist/cjs/client/DockerIgnore.d.ts +44 -0
  13. package/dist/cjs/client/DockerIgnore.js +186 -0
  14. package/dist/cjs/client/DockerRequestError.d.ts +17 -0
  15. package/dist/cjs/client/DockerRequestError.js +24 -0
  16. package/dist/cjs/client/DockerStreams.d.ts +35 -0
  17. package/dist/cjs/client/DockerStreams.js +117 -0
  18. package/dist/cjs/client/types/ContainerCreateResponse.d.ts +7 -0
  19. package/dist/cjs/client/types/ContainerCreateResponse.js +2 -0
  20. package/dist/cjs/client/types/ContainerStopQuery.d.ts +13 -0
  21. package/dist/cjs/client/types/ContainerStopQuery.js +2 -0
  22. package/dist/cjs/client/types/DeviceMapping.d.ts +8 -0
  23. package/dist/cjs/client/types/DeviceMapping.js +2 -0
  24. package/dist/cjs/client/types/IdResponse.d.ts +6 -0
  25. package/dist/cjs/client/types/IdResponse.js +2 -0
  26. package/dist/cjs/client/types/NetworkCreateResponse.d.ts +7 -0
  27. package/dist/cjs/client/types/NetworkCreateResponse.js +2 -0
  28. package/dist/cjs/client/types/PortBinding.d.ts +10 -0
  29. package/dist/cjs/client/types/PortBinding.js +2 -0
  30. package/dist/cjs/docker/ConnectionOptionsBuilder.d.ts +128 -0
  31. package/dist/cjs/docker/ConnectionOptionsBuilder.js +150 -0
  32. package/dist/cjs/docker/Docker.d.ts +301 -0
  33. package/dist/cjs/docker/Docker.js +703 -0
  34. package/dist/cjs/docker/exceptions/DockerConnectionException.d.ts +9 -0
  35. package/dist/cjs/docker/exceptions/DockerConnectionException.js +16 -0
  36. package/dist/cjs/docker/exceptions/DockerContainerNotFoundException.d.ts +9 -0
  37. package/dist/cjs/docker/exceptions/DockerContainerNotFoundException.js +16 -0
  38. package/dist/cjs/docker/exceptions/DockerImageBuildException.d.ts +9 -0
  39. package/dist/cjs/docker/exceptions/DockerImageBuildException.js +16 -0
  40. package/dist/cjs/docker/exceptions/DockerImageImportException.d.ts +9 -0
  41. package/dist/cjs/docker/exceptions/DockerImageImportException.js +16 -0
  42. package/dist/cjs/docker/exceptions/DockerImageNotFoundException.d.ts +10 -0
  43. package/dist/cjs/docker/exceptions/DockerImageNotFoundException.js +17 -0
  44. package/dist/cjs/docker/exceptions/DockerImagePullException.d.ts +9 -0
  45. package/dist/cjs/docker/exceptions/DockerImagePullException.js +16 -0
  46. package/dist/cjs/docker/exceptions/DockerImagePushException.d.ts +8 -0
  47. package/dist/cjs/docker/exceptions/DockerImagePushException.js +15 -0
  48. package/dist/cjs/docker/exceptions/DockerImageRepoTagNotFoundException.d.ts +8 -0
  49. package/dist/cjs/docker/exceptions/DockerImageRepoTagNotFoundException.js +15 -0
  50. package/dist/cjs/docker/exceptions/DockerNetworkNotFoundException.d.ts +9 -0
  51. package/dist/cjs/docker/exceptions/DockerNetworkNotFoundException.js +16 -0
  52. package/dist/cjs/docker/exceptions/DockerRequestException.d.ts +22 -0
  53. package/dist/cjs/docker/exceptions/DockerRequestException.js +24 -0
  54. package/dist/cjs/docker/interfaces/IDockerConnectionOptions.d.ts +75 -0
  55. package/dist/cjs/docker/interfaces/IDockerConnectionOptions.js +2 -0
  56. package/dist/cjs/docker/interfaces/IDockerHttpConnectionOptions.d.ts +16 -0
  57. package/dist/cjs/docker/interfaces/IDockerHttpConnectionOptions.js +2 -0
  58. package/dist/cjs/docker/interfaces/IDockerHttpsConnectionOptions.d.ts +16 -0
  59. package/dist/cjs/docker/interfaces/IDockerHttpsConnectionOptions.js +2 -0
  60. package/dist/cjs/docker/interfaces/IDockerKeyObject.d.ts +14 -0
  61. package/dist/cjs/docker/interfaces/IDockerKeyObject.js +2 -0
  62. package/dist/cjs/docker/interfaces/IDockerSSHConnectionOptions.d.ts +16 -0
  63. package/dist/cjs/docker/interfaces/IDockerSSHConnectionOptions.js +2 -0
  64. package/dist/cjs/docker/interfaces/IDockerSocketConnectionOptions.d.ts +7 -0
  65. package/dist/cjs/docker/interfaces/IDockerSocketConnectionOptions.js +2 -0
  66. package/dist/cjs/docker/lib/DockerContainer.d.ts +315 -0
  67. package/dist/cjs/docker/lib/DockerContainer.js +742 -0
  68. package/dist/cjs/docker/lib/DockerContainerTTY.d.ts +99 -0
  69. package/dist/cjs/docker/lib/DockerContainerTTY.js +157 -0
  70. package/dist/cjs/docker/lib/DockerImage.d.ts +153 -0
  71. package/dist/cjs/docker/lib/DockerImage.js +273 -0
  72. package/dist/cjs/docker/lib/EngineSettings.d.ts +41 -0
  73. package/dist/cjs/docker/lib/EngineSettings.js +86 -0
  74. package/dist/cjs/docker/lib/ParseBaseImages.d.ts +9 -0
  75. package/dist/cjs/docker/lib/ParseBaseImages.js +50 -0
  76. package/dist/cjs/docker/lib/ParseEnvToRecord.d.ts +14 -0
  77. package/dist/cjs/docker/lib/ParseEnvToRecord.js +25 -0
  78. package/dist/cjs/docker/lib/ParseRepositoryTag.d.ts +17 -0
  79. package/dist/cjs/docker/lib/ParseRepositoryTag.js +48 -0
  80. package/dist/cjs/docker/lib/RegistryAuth.d.ts +8 -0
  81. package/dist/cjs/docker/lib/RegistryAuth.js +15 -0
  82. package/dist/cjs/docker/options/DockerPruneOptions.d.ts +38 -0
  83. package/dist/cjs/docker/options/DockerPruneOptions.js +47 -0
  84. package/dist/cjs/docker/options/auth/DockerAuthOptions.d.ts +46 -0
  85. package/dist/cjs/docker/options/auth/DockerAuthOptions.js +59 -0
  86. package/dist/cjs/docker/options/container/ContainerCommitOptions.d.ts +28 -0
  87. package/dist/cjs/docker/options/container/ContainerCommitOptions.js +39 -0
  88. package/dist/cjs/docker/options/container/ContainerCreateTTYOptions.d.ts +32 -0
  89. package/dist/cjs/docker/options/container/ContainerCreateTTYOptions.js +43 -0
  90. package/dist/cjs/docker/options/container/ContainerExecOptions.d.ts +26 -0
  91. package/dist/cjs/docker/options/container/ContainerExecOptions.js +38 -0
  92. package/dist/cjs/docker/options/container/ContainerExportDirectoryOptions.d.ts +27 -0
  93. package/dist/cjs/docker/options/container/ContainerExportDirectoryOptions.js +39 -0
  94. package/dist/cjs/docker/options/container/ContainerKillOptions.d.ts +25 -0
  95. package/dist/cjs/docker/options/container/ContainerKillOptions.js +36 -0
  96. package/dist/cjs/docker/options/container/ContainerLogsOptions.d.ts +48 -0
  97. package/dist/cjs/docker/options/container/ContainerLogsOptions.js +56 -0
  98. package/dist/cjs/docker/options/container/ContainerRemoveOptions.d.ts +22 -0
  99. package/dist/cjs/docker/options/container/ContainerRemoveOptions.js +34 -0
  100. package/dist/cjs/docker/options/container/ContainerSettingOptions.d.ts +137 -0
  101. package/dist/cjs/docker/options/container/ContainerSettingOptions.js +136 -0
  102. package/dist/cjs/docker/options/container/ContainerStopOptions.d.ts +28 -0
  103. package/dist/cjs/docker/options/container/ContainerStopOptions.js +40 -0
  104. package/dist/cjs/docker/options/container/ContainerTTYConsoleSizeOptions.d.ts +26 -0
  105. package/dist/cjs/docker/options/container/ContainerTTYConsoleSizeOptions.js +40 -0
  106. package/dist/cjs/docker/options/image/ImageBuildOptions.d.ts +117 -0
  107. package/dist/cjs/docker/options/image/ImageBuildOptions.js +111 -0
  108. package/dist/cjs/docker/options/image/ImageExportOptions.d.ts +33 -0
  109. package/dist/cjs/docker/options/image/ImageExportOptions.js +44 -0
  110. package/dist/cjs/docker/options/image/ImageImportOptions.d.ts +28 -0
  111. package/dist/cjs/docker/options/image/ImageImportOptions.js +42 -0
  112. package/dist/cjs/docker/options/image/ImagePullOptions.d.ts +49 -0
  113. package/dist/cjs/docker/options/image/ImagePullOptions.js +63 -0
  114. package/dist/cjs/docker/options/image/ImagePushOptions.d.ts +41 -0
  115. package/dist/cjs/docker/options/image/ImagePushOptions.js +56 -0
  116. package/dist/cjs/docker/options/image/ImageRemoveOptions.d.ts +26 -0
  117. package/dist/cjs/docker/options/image/ImageRemoveOptions.js +38 -0
  118. package/dist/cjs/docker/options/image/ImageTagOptions.d.ts +25 -0
  119. package/dist/cjs/docker/options/image/ImageTagOptions.js +38 -0
  120. package/dist/cjs/docker/options/network/NetworkCreateOptions.d.ts +54 -0
  121. package/dist/cjs/docker/options/network/NetworkCreateOptions.js +63 -0
  122. package/dist/cjs/docker/types/ContainerBind.d.ts +19 -0
  123. package/dist/cjs/docker/types/ContainerBind.js +2 -0
  124. package/dist/cjs/docker/types/ContainerCapability.d.ts +286 -0
  125. package/dist/cjs/docker/types/ContainerCapability.js +290 -0
  126. package/dist/cjs/docker/types/ContainerConfig.d.ts +67 -0
  127. package/dist/cjs/docker/types/ContainerConfig.js +2 -0
  128. package/dist/cjs/docker/types/ContainerDevice.d.ts +19 -0
  129. package/dist/cjs/docker/types/ContainerDevice.js +2 -0
  130. package/dist/cjs/docker/types/ContainerExecResult.d.ts +20 -0
  131. package/dist/cjs/docker/types/ContainerExecResult.js +2 -0
  132. package/dist/cjs/docker/types/ContainerNetwork.d.ts +46 -0
  133. package/dist/cjs/docker/types/ContainerNetwork.js +2 -0
  134. package/dist/cjs/docker/types/ContainerPort.d.ts +25 -0
  135. package/dist/cjs/docker/types/ContainerPort.js +2 -0
  136. package/dist/cjs/docker/types/ContainerRestartPolicy.d.ts +11 -0
  137. package/dist/cjs/docker/types/ContainerRestartPolicy.js +2 -0
  138. package/dist/cjs/docker/types/ContainerState.d.ts +48 -0
  139. package/dist/cjs/docker/types/ContainerState.js +2 -0
  140. package/dist/cjs/docker/types/ContainerStats.d.ts +408 -0
  141. package/dist/cjs/docker/types/ContainerStats.js +2 -0
  142. package/dist/cjs/docker/types/DockerOutputCallback.d.ts +8 -0
  143. package/dist/cjs/docker/types/DockerOutputCallback.js +2 -0
  144. package/dist/cjs/docker/types/ImageConfig.d.ts +34 -0
  145. package/dist/cjs/docker/types/ImageConfig.js +2 -0
  146. package/dist/cjs/docker/types/ImageExposePort.d.ts +17 -0
  147. package/dist/cjs/docker/types/ImageExposePort.js +2 -0
  148. package/dist/cjs/docker/types/NetworkInfo.d.ts +59 -0
  149. package/dist/cjs/docker/types/NetworkInfo.js +2 -0
  150. package/dist/cjs/docker/types/RepositoryTag.d.ts +15 -0
  151. package/dist/cjs/docker/types/RepositoryTag.js +2 -0
  152. package/dist/cjs/exports/Docker.d.ts +73 -0
  153. package/dist/cjs/exports/Docker.js +92 -0
  154. package/dist/cjs/package.json +1 -0
  155. package/dist/esm/client/BuildContext.js +70 -0
  156. package/dist/esm/client/BuildKitProgress.js +190 -0
  157. package/dist/esm/client/DockerClient.js +307 -0
  158. package/dist/esm/client/DockerConnection.js +355 -0
  159. package/dist/esm/client/DockerIgnore.js +179 -0
  160. package/dist/esm/client/DockerRequestError.js +20 -0
  161. package/dist/esm/client/DockerStreams.js +111 -0
  162. package/dist/esm/client/types/ContainerCreateResponse.js +1 -0
  163. package/dist/esm/client/types/ContainerStopQuery.js +1 -0
  164. package/dist/esm/client/types/DeviceMapping.js +1 -0
  165. package/dist/esm/client/types/IdResponse.js +1 -0
  166. package/dist/esm/client/types/NetworkCreateResponse.js +1 -0
  167. package/dist/esm/client/types/PortBinding.js +1 -0
  168. package/dist/esm/docker/ConnectionOptionsBuilder.js +142 -0
  169. package/dist/esm/docker/Docker.js +697 -0
  170. package/dist/esm/docker/exceptions/DockerConnectionException.js +12 -0
  171. package/dist/esm/docker/exceptions/DockerContainerNotFoundException.js +12 -0
  172. package/dist/esm/docker/exceptions/DockerImageBuildException.js +12 -0
  173. package/dist/esm/docker/exceptions/DockerImageImportException.js +12 -0
  174. package/dist/esm/docker/exceptions/DockerImageNotFoundException.js +13 -0
  175. package/dist/esm/docker/exceptions/DockerImagePullException.js +12 -0
  176. package/dist/esm/docker/exceptions/DockerImagePushException.js +11 -0
  177. package/dist/esm/docker/exceptions/DockerImageRepoTagNotFoundException.js +11 -0
  178. package/dist/esm/docker/exceptions/DockerNetworkNotFoundException.js +12 -0
  179. package/dist/esm/docker/exceptions/DockerRequestException.js +20 -0
  180. package/dist/esm/docker/interfaces/IDockerConnectionOptions.js +1 -0
  181. package/dist/esm/docker/interfaces/IDockerHttpConnectionOptions.js +1 -0
  182. package/dist/esm/docker/interfaces/IDockerHttpsConnectionOptions.js +1 -0
  183. package/dist/esm/docker/interfaces/IDockerKeyObject.js +1 -0
  184. package/dist/esm/docker/interfaces/IDockerSSHConnectionOptions.js +1 -0
  185. package/dist/esm/docker/interfaces/IDockerSocketConnectionOptions.js +1 -0
  186. package/dist/esm/docker/lib/DockerContainer.js +739 -0
  187. package/dist/esm/docker/lib/DockerContainerTTY.js +154 -0
  188. package/dist/esm/docker/lib/DockerImage.js +270 -0
  189. package/dist/esm/docker/lib/EngineSettings.js +78 -0
  190. package/dist/esm/docker/lib/ParseBaseImages.js +47 -0
  191. package/dist/esm/docker/lib/ParseEnvToRecord.js +22 -0
  192. package/dist/esm/docker/lib/ParseRepositoryTag.js +45 -0
  193. package/dist/esm/docker/lib/RegistryAuth.js +12 -0
  194. package/dist/esm/docker/options/DockerPruneOptions.js +43 -0
  195. package/dist/esm/docker/options/auth/DockerAuthOptions.js +55 -0
  196. package/dist/esm/docker/options/container/ContainerCommitOptions.js +35 -0
  197. package/dist/esm/docker/options/container/ContainerCreateTTYOptions.js +39 -0
  198. package/dist/esm/docker/options/container/ContainerExecOptions.js +34 -0
  199. package/dist/esm/docker/options/container/ContainerExportDirectoryOptions.js +35 -0
  200. package/dist/esm/docker/options/container/ContainerKillOptions.js +32 -0
  201. package/dist/esm/docker/options/container/ContainerLogsOptions.js +52 -0
  202. package/dist/esm/docker/options/container/ContainerRemoveOptions.js +30 -0
  203. package/dist/esm/docker/options/container/ContainerSettingOptions.js +132 -0
  204. package/dist/esm/docker/options/container/ContainerStopOptions.js +36 -0
  205. package/dist/esm/docker/options/container/ContainerTTYConsoleSizeOptions.js +36 -0
  206. package/dist/esm/docker/options/image/ImageBuildOptions.js +107 -0
  207. package/dist/esm/docker/options/image/ImageExportOptions.js +40 -0
  208. package/dist/esm/docker/options/image/ImageImportOptions.js +38 -0
  209. package/dist/esm/docker/options/image/ImagePullOptions.js +59 -0
  210. package/dist/esm/docker/options/image/ImagePushOptions.js +52 -0
  211. package/dist/esm/docker/options/image/ImageRemoveOptions.js +34 -0
  212. package/dist/esm/docker/options/image/ImageTagOptions.js +34 -0
  213. package/dist/esm/docker/options/network/NetworkCreateOptions.js +59 -0
  214. package/dist/esm/docker/types/ContainerBind.js +1 -0
  215. package/dist/esm/docker/types/ContainerCapability.js +287 -0
  216. package/dist/esm/docker/types/ContainerConfig.js +1 -0
  217. package/dist/esm/docker/types/ContainerDevice.js +1 -0
  218. package/dist/esm/docker/types/ContainerExecResult.js +1 -0
  219. package/dist/esm/docker/types/ContainerNetwork.js +1 -0
  220. package/dist/esm/docker/types/ContainerPort.js +1 -0
  221. package/dist/esm/docker/types/ContainerRestartPolicy.js +1 -0
  222. package/dist/esm/docker/types/ContainerState.js +1 -0
  223. package/dist/esm/docker/types/ContainerStats.js +1 -0
  224. package/dist/esm/docker/types/DockerOutputCallback.js +1 -0
  225. package/dist/esm/docker/types/ImageConfig.js +1 -0
  226. package/dist/esm/docker/types/ImageExposePort.js +1 -0
  227. package/dist/esm/docker/types/NetworkInfo.js +1 -0
  228. package/dist/esm/docker/types/RepositoryTag.js +1 -0
  229. package/dist/esm/exports/Docker.js +73 -0
  230. package/dist/types/client/BuildContext.d.ts +22 -0
  231. package/dist/types/client/BuildKitProgress.d.ts +81 -0
  232. package/dist/types/client/DockerClient.d.ts +196 -0
  233. package/dist/types/client/DockerConnection.d.ts +154 -0
  234. package/dist/types/client/DockerIgnore.d.ts +44 -0
  235. package/dist/types/client/DockerRequestError.d.ts +17 -0
  236. package/dist/types/client/DockerStreams.d.ts +35 -0
  237. package/dist/types/client/types/ContainerCreateResponse.d.ts +7 -0
  238. package/dist/types/client/types/ContainerStopQuery.d.ts +13 -0
  239. package/dist/types/client/types/DeviceMapping.d.ts +8 -0
  240. package/dist/types/client/types/IdResponse.d.ts +6 -0
  241. package/dist/types/client/types/NetworkCreateResponse.d.ts +7 -0
  242. package/dist/types/client/types/PortBinding.d.ts +10 -0
  243. package/dist/types/docker/ConnectionOptionsBuilder.d.ts +128 -0
  244. package/dist/types/docker/Docker.d.ts +301 -0
  245. package/dist/types/docker/exceptions/DockerConnectionException.d.ts +9 -0
  246. package/dist/types/docker/exceptions/DockerContainerNotFoundException.d.ts +9 -0
  247. package/dist/types/docker/exceptions/DockerImageBuildException.d.ts +9 -0
  248. package/dist/types/docker/exceptions/DockerImageImportException.d.ts +9 -0
  249. package/dist/types/docker/exceptions/DockerImageNotFoundException.d.ts +10 -0
  250. package/dist/types/docker/exceptions/DockerImagePullException.d.ts +9 -0
  251. package/dist/types/docker/exceptions/DockerImagePushException.d.ts +8 -0
  252. package/dist/types/docker/exceptions/DockerImageRepoTagNotFoundException.d.ts +8 -0
  253. package/dist/types/docker/exceptions/DockerNetworkNotFoundException.d.ts +9 -0
  254. package/dist/types/docker/exceptions/DockerRequestException.d.ts +22 -0
  255. package/dist/types/docker/interfaces/IDockerConnectionOptions.d.ts +75 -0
  256. package/dist/types/docker/interfaces/IDockerHttpConnectionOptions.d.ts +16 -0
  257. package/dist/types/docker/interfaces/IDockerHttpsConnectionOptions.d.ts +16 -0
  258. package/dist/types/docker/interfaces/IDockerKeyObject.d.ts +14 -0
  259. package/dist/types/docker/interfaces/IDockerSSHConnectionOptions.d.ts +16 -0
  260. package/dist/types/docker/interfaces/IDockerSocketConnectionOptions.d.ts +7 -0
  261. package/dist/types/docker/lib/DockerContainer.d.ts +315 -0
  262. package/dist/types/docker/lib/DockerContainerTTY.d.ts +99 -0
  263. package/dist/types/docker/lib/DockerImage.d.ts +153 -0
  264. package/dist/types/docker/lib/EngineSettings.d.ts +41 -0
  265. package/dist/types/docker/lib/ParseBaseImages.d.ts +9 -0
  266. package/dist/types/docker/lib/ParseEnvToRecord.d.ts +14 -0
  267. package/dist/types/docker/lib/ParseRepositoryTag.d.ts +17 -0
  268. package/dist/types/docker/lib/RegistryAuth.d.ts +8 -0
  269. package/dist/types/docker/options/DockerPruneOptions.d.ts +38 -0
  270. package/dist/types/docker/options/auth/DockerAuthOptions.d.ts +46 -0
  271. package/dist/types/docker/options/container/ContainerCommitOptions.d.ts +28 -0
  272. package/dist/types/docker/options/container/ContainerCreateTTYOptions.d.ts +32 -0
  273. package/dist/types/docker/options/container/ContainerExecOptions.d.ts +26 -0
  274. package/dist/types/docker/options/container/ContainerExportDirectoryOptions.d.ts +27 -0
  275. package/dist/types/docker/options/container/ContainerKillOptions.d.ts +25 -0
  276. package/dist/types/docker/options/container/ContainerLogsOptions.d.ts +48 -0
  277. package/dist/types/docker/options/container/ContainerRemoveOptions.d.ts +22 -0
  278. package/dist/types/docker/options/container/ContainerSettingOptions.d.ts +137 -0
  279. package/dist/types/docker/options/container/ContainerStopOptions.d.ts +28 -0
  280. package/dist/types/docker/options/container/ContainerTTYConsoleSizeOptions.d.ts +26 -0
  281. package/dist/types/docker/options/image/ImageBuildOptions.d.ts +117 -0
  282. package/dist/types/docker/options/image/ImageExportOptions.d.ts +33 -0
  283. package/dist/types/docker/options/image/ImageImportOptions.d.ts +28 -0
  284. package/dist/types/docker/options/image/ImagePullOptions.d.ts +49 -0
  285. package/dist/types/docker/options/image/ImagePushOptions.d.ts +41 -0
  286. package/dist/types/docker/options/image/ImageRemoveOptions.d.ts +26 -0
  287. package/dist/types/docker/options/image/ImageTagOptions.d.ts +25 -0
  288. package/dist/types/docker/options/network/NetworkCreateOptions.d.ts +54 -0
  289. package/dist/types/docker/types/ContainerBind.d.ts +19 -0
  290. package/dist/types/docker/types/ContainerCapability.d.ts +286 -0
  291. package/dist/types/docker/types/ContainerConfig.d.ts +67 -0
  292. package/dist/types/docker/types/ContainerDevice.d.ts +19 -0
  293. package/dist/types/docker/types/ContainerExecResult.d.ts +20 -0
  294. package/dist/types/docker/types/ContainerNetwork.d.ts +46 -0
  295. package/dist/types/docker/types/ContainerPort.d.ts +25 -0
  296. package/dist/types/docker/types/ContainerRestartPolicy.d.ts +11 -0
  297. package/dist/types/docker/types/ContainerState.d.ts +48 -0
  298. package/dist/types/docker/types/ContainerStats.d.ts +408 -0
  299. package/dist/types/docker/types/DockerOutputCallback.d.ts +8 -0
  300. package/dist/types/docker/types/ImageConfig.d.ts +34 -0
  301. package/dist/types/docker/types/ImageExposePort.d.ts +17 -0
  302. package/dist/types/docker/types/NetworkInfo.d.ts +59 -0
  303. package/dist/types/docker/types/RepositoryTag.d.ts +15 -0
  304. package/dist/types/exports/Docker.d.ts +73 -0
  305. package/package.json +57 -0
@@ -0,0 +1,47 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.DockerPruneOptions = void 0;
13
+ const core_1 = require("@lakutata/core");
14
+ const dto_1 = require("@lakutata/core/decorator/dto");
15
+ /**
16
+ * Which unused resources {@link Docker.prune} removes, each kind as its `docker … prune` command does without options.
17
+ * Called without options, it prunes the containers and the images; the networks and the volumes only when asked (the
18
+ * volumes, as `docker system prune --volumes`).
19
+ * @example
20
+ * ```typescript
21
+ * import {Docker} from 'lakutata/com/docker'
22
+ *
23
+ * declare const docker: Docker
24
+ *
25
+ * //The stopped containers and the unused networks, keeping the images and the volumes
26
+ * await docker.prune({containers: true, images: false, networks: true, volumes: false})
27
+ * ```
28
+ */
29
+ class DockerPruneOptions extends core_1.DTO {
30
+ }
31
+ exports.DockerPruneOptions = DockerPruneOptions;
32
+ __decorate([
33
+ (0, dto_1.Expect)(core_1.DTO.Boolean().optional().default(true)),
34
+ __metadata("design:type", Boolean)
35
+ ], DockerPruneOptions.prototype, "containers", void 0);
36
+ __decorate([
37
+ (0, dto_1.Expect)(core_1.DTO.Boolean().optional().default(true)),
38
+ __metadata("design:type", Boolean)
39
+ ], DockerPruneOptions.prototype, "images", void 0);
40
+ __decorate([
41
+ (0, dto_1.Expect)(core_1.DTO.Boolean().optional().default(false)),
42
+ __metadata("design:type", Boolean)
43
+ ], DockerPruneOptions.prototype, "networks", void 0);
44
+ __decorate([
45
+ (0, dto_1.Expect)(core_1.DTO.Boolean().optional().default(false)),
46
+ __metadata("design:type", Boolean)
47
+ ], DockerPruneOptions.prototype, "volumes", void 0);
@@ -0,0 +1,46 @@
1
+ import { DTO } from '@lakutata/core';
2
+ /**
3
+ * The credentials of an image registry: checked by {@link Docker.loginRepository} and
4
+ * {@link Docker.checkRepositoryAuth}, and sent with the image pulls ({@link ImagePullOptions.auth}), pushes
5
+ * ({@link ImagePushOptions.auth}) and builds ({@link ImageBuildOptions.auth}), each of them given every field set
6
+ * (the tokens included). Only `serverAddress` is required.
7
+ * @example
8
+ * ```typescript
9
+ * import {Docker} from 'lakutata/com/docker'
10
+ *
11
+ * declare const docker: Docker
12
+ *
13
+ * const valid: boolean = await docker.checkRepositoryAuth({
14
+ * serverAddress: 'registry.example.com:5000',
15
+ * username: 'ci',
16
+ * password: process.env.REGISTRY_PASSWORD ?? ''
17
+ * })
18
+ * ```
19
+ */
20
+ export declare class DockerAuthOptions extends DTO {
21
+ /**
22
+ * The user name.
23
+ */
24
+ username?: string;
25
+ /**
26
+ * The password, or a personal access token of the registry.
27
+ */
28
+ password?: string;
29
+ /**
30
+ * The registry address, a host name or an IP address with its port when it is not the default one, without a
31
+ * protocol (`registry.example.com`, `10.0.0.5:5000`). Required.
32
+ */
33
+ serverAddress: string;
34
+ /**
35
+ * The e-mail address of the account, for the old registries asking for it; the current ones ignore it.
36
+ */
37
+ email?: string | undefined;
38
+ /**
39
+ * An identity token (an OAuth refresh token) the registry gave at a previous login, used instead of the password.
40
+ */
41
+ identityToken?: string | undefined;
42
+ /**
43
+ * A bearer token the registry gave, used instead of the user name and the password.
44
+ */
45
+ registryToken?: string | undefined;
46
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.DockerAuthOptions = void 0;
13
+ const core_1 = require("@lakutata/core");
14
+ const dto_1 = require("@lakutata/core/decorator/dto");
15
+ /**
16
+ * The credentials of an image registry: checked by {@link Docker.loginRepository} and
17
+ * {@link Docker.checkRepositoryAuth}, and sent with the image pulls ({@link ImagePullOptions.auth}), pushes
18
+ * ({@link ImagePushOptions.auth}) and builds ({@link ImageBuildOptions.auth}), each of them given every field set
19
+ * (the tokens included). Only `serverAddress` is required.
20
+ * @example
21
+ * ```typescript
22
+ * import {Docker} from 'lakutata/com/docker'
23
+ *
24
+ * declare const docker: Docker
25
+ *
26
+ * const valid: boolean = await docker.checkRepositoryAuth({
27
+ * serverAddress: 'registry.example.com:5000',
28
+ * username: 'ci',
29
+ * password: process.env.REGISTRY_PASSWORD ?? ''
30
+ * })
31
+ * ```
32
+ */
33
+ class DockerAuthOptions extends core_1.DTO {
34
+ }
35
+ exports.DockerAuthOptions = DockerAuthOptions;
36
+ __decorate([
37
+ (0, dto_1.Expect)(core_1.DTO.String().optional()),
38
+ __metadata("design:type", String)
39
+ ], DockerAuthOptions.prototype, "username", void 0);
40
+ __decorate([
41
+ (0, dto_1.Expect)(core_1.DTO.String().optional()),
42
+ __metadata("design:type", String)
43
+ ], DockerAuthOptions.prototype, "password", void 0);
44
+ __decorate([
45
+ (0, dto_1.Expect)(core_1.DTO.String().required()),
46
+ __metadata("design:type", String)
47
+ ], DockerAuthOptions.prototype, "serverAddress", void 0);
48
+ __decorate([
49
+ (0, dto_1.Expect)(core_1.DTO.String().optional()),
50
+ __metadata("design:type", Object)
51
+ ], DockerAuthOptions.prototype, "email", void 0);
52
+ __decorate([
53
+ (0, dto_1.Expect)(core_1.DTO.String().optional()),
54
+ __metadata("design:type", Object)
55
+ ], DockerAuthOptions.prototype, "identityToken", void 0);
56
+ __decorate([
57
+ (0, dto_1.Expect)(core_1.DTO.String().optional()),
58
+ __metadata("design:type", Object)
59
+ ], DockerAuthOptions.prototype, "registryToken", void 0);
@@ -0,0 +1,28 @@
1
+ import { DTO } from '@lakutata/core';
2
+ /**
3
+ * How `DockerContainer.commit()` creates an image of the container's current file system (`docker commit`), the
4
+ * created image returned.
5
+ * @example
6
+ * ```typescript
7
+ * import {Docker} from 'lakutata/com/docker'
8
+ *
9
+ * declare const docker: Docker
10
+ *
11
+ * const container = await docker.getContainer('web')
12
+ * const image = await container.commit({repoTag: 'web-snapshot:2026-10-04'})
13
+ * console.log(image.id)
14
+ * ```
15
+ */
16
+ export declare class ContainerCommitOptions extends DTO {
17
+ /**
18
+ * The repository and tag of the image, `repo:tag` (`my-app:snapshot`, `registry.example.com:5000/team/app:1.0`); a
19
+ * repository without a tag is tagged `latest`. Without it, the image has no name (dangling) and is known by its ID
20
+ * only.
21
+ */
22
+ repoTag?: string;
23
+ /**
24
+ * Pause the container while the image is created, for a consistent file system; it resumes after.
25
+ * @default true
26
+ */
27
+ pauseBeforeCommitting?: boolean;
28
+ }
@@ -0,0 +1,39 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.ContainerCommitOptions = void 0;
13
+ const core_1 = require("@lakutata/core");
14
+ const dto_1 = require("@lakutata/core/decorator/dto");
15
+ /**
16
+ * How `DockerContainer.commit()` creates an image of the container's current file system (`docker commit`), the
17
+ * created image returned.
18
+ * @example
19
+ * ```typescript
20
+ * import {Docker} from 'lakutata/com/docker'
21
+ *
22
+ * declare const docker: Docker
23
+ *
24
+ * const container = await docker.getContainer('web')
25
+ * const image = await container.commit({repoTag: 'web-snapshot:2026-10-04'})
26
+ * console.log(image.id)
27
+ * ```
28
+ */
29
+ class ContainerCommitOptions extends core_1.DTO {
30
+ }
31
+ exports.ContainerCommitOptions = ContainerCommitOptions;
32
+ __decorate([
33
+ (0, dto_1.Expect)(core_1.DTO.String().optional()),
34
+ __metadata("design:type", String)
35
+ ], ContainerCommitOptions.prototype, "repoTag", void 0);
36
+ __decorate([
37
+ (0, dto_1.Expect)(core_1.DTO.Boolean().optional().default(true)),
38
+ __metadata("design:type", Boolean)
39
+ ], ContainerCommitOptions.prototype, "pauseBeforeCommitting", void 0);
@@ -0,0 +1,32 @@
1
+ import { DTO } from '@lakutata/core';
2
+ import { ContainerTTYConsoleSizeOptions } from './ContainerTTYConsoleSizeOptions.js';
3
+ /**
4
+ * The interactive command `DockerContainer.createTTY()` runs in a running container with a terminal (`docker exec -it`),
5
+ * read and written through the returned `DockerContainerTTY`.
6
+ * @example
7
+ * ```typescript
8
+ * import {Docker} from 'lakutata/com/docker'
9
+ *
10
+ * declare const docker: Docker
11
+ *
12
+ * const container = await docker.getContainer('web')
13
+ * const tty = await container.createTTY({cmd: ['/bin/bash', '-l'], consoleSize: {cols: 120, rows: 40}})
14
+ * tty.onData((chunk: Buffer): void => {
15
+ * process.stdout.write(chunk)
16
+ * })
17
+ * tty.write('ls -la\n')
18
+ * ```
19
+ */
20
+ export declare class ContainerCreateTTYOptions extends DTO {
21
+ /**
22
+ * The command: the executable followed by its arguments (`['/bin/bash', '-l']`, at least one item), run as they
23
+ * are; or a command line (`'top -d 1'`), run by `/bin/sh -c`. The default needs a shell in the image (not in the
24
+ * distroless ones).
25
+ * @default ['/bin/sh']
26
+ */
27
+ cmd?: string | string[];
28
+ /**
29
+ * The terminal's initial size; without it, Docker's default size, until `DockerContainerTTY.resize()` is called.
30
+ */
31
+ consoleSize?: ContainerTTYConsoleSizeOptions;
32
+ }
@@ -0,0 +1,43 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.ContainerCreateTTYOptions = void 0;
13
+ const core_1 = require("@lakutata/core");
14
+ const dto_1 = require("@lakutata/core/decorator/dto");
15
+ const ContainerTTYConsoleSizeOptions_js_1 = require("./ContainerTTYConsoleSizeOptions.js");
16
+ /**
17
+ * The interactive command `DockerContainer.createTTY()` runs in a running container with a terminal (`docker exec -it`),
18
+ * read and written through the returned `DockerContainerTTY`.
19
+ * @example
20
+ * ```typescript
21
+ * import {Docker} from 'lakutata/com/docker'
22
+ *
23
+ * declare const docker: Docker
24
+ *
25
+ * const container = await docker.getContainer('web')
26
+ * const tty = await container.createTTY({cmd: ['/bin/bash', '-l'], consoleSize: {cols: 120, rows: 40}})
27
+ * tty.onData((chunk: Buffer): void => {
28
+ * process.stdout.write(chunk)
29
+ * })
30
+ * tty.write('ls -la\n')
31
+ * ```
32
+ */
33
+ class ContainerCreateTTYOptions extends core_1.DTO {
34
+ }
35
+ exports.ContainerCreateTTYOptions = ContainerCreateTTYOptions;
36
+ __decorate([
37
+ (0, dto_1.Expect)(core_1.DTO.Alternatives(core_1.DTO.String(), core_1.DTO.Array(core_1.DTO.String()).min(1)).optional()),
38
+ __metadata("design:type", Object)
39
+ ], ContainerCreateTTYOptions.prototype, "cmd", void 0);
40
+ __decorate([
41
+ (0, dto_1.Expect)(ContainerTTYConsoleSizeOptions_js_1.ContainerTTYConsoleSizeOptions.optional()),
42
+ __metadata("design:type", ContainerTTYConsoleSizeOptions_js_1.ContainerTTYConsoleSizeOptions)
43
+ ], ContainerCreateTTYOptions.prototype, "consoleSize", void 0);
@@ -0,0 +1,26 @@
1
+ import { DTO } from '@lakutata/core';
2
+ /**
3
+ * The command `DockerContainer.exec()` runs in a running container, without a terminal nor an input (`docker exec`); it
4
+ * resolves once the command exits, with its exit code and its standard output and error output apart.
5
+ * @example
6
+ * ```typescript
7
+ * import {Docker, type ContainerExecResult} from 'lakutata/com/docker'
8
+ *
9
+ * declare const docker: Docker
10
+ *
11
+ * const container = await docker.getContainer('web')
12
+ * const listing: ContainerExecResult = await container.exec({cmd: ['ls', '-la', '/app']})
13
+ * //A command line, run by /bin/sh -c
14
+ * const count: ContainerExecResult = await container.exec({cmd: 'ls /app | wc -l'})
15
+ * if (count.exitCode !== 0) console.error(count.stderr)
16
+ * console.log(listing.stdout, count.stdout)
17
+ * ```
18
+ */
19
+ export declare class ContainerExecOptions extends DTO {
20
+ /**
21
+ * The command: the executable followed by its arguments (`['ls', '-la', '/app']`, at least one item), run as they
22
+ * are; or a command line (`'ls /app | wc -l'`), run by `/bin/sh -c`, which needs a shell in the container.
23
+ * Required.
24
+ */
25
+ cmd: string | string[];
26
+ }
@@ -0,0 +1,38 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.ContainerExecOptions = void 0;
13
+ const core_1 = require("@lakutata/core");
14
+ const dto_1 = require("@lakutata/core/decorator/dto");
15
+ /**
16
+ * The command `DockerContainer.exec()` runs in a running container, without a terminal nor an input (`docker exec`); it
17
+ * resolves once the command exits, with its exit code and its standard output and error output apart.
18
+ * @example
19
+ * ```typescript
20
+ * import {Docker, type ContainerExecResult} from 'lakutata/com/docker'
21
+ *
22
+ * declare const docker: Docker
23
+ *
24
+ * const container = await docker.getContainer('web')
25
+ * const listing: ContainerExecResult = await container.exec({cmd: ['ls', '-la', '/app']})
26
+ * //A command line, run by /bin/sh -c
27
+ * const count: ContainerExecResult = await container.exec({cmd: 'ls /app | wc -l'})
28
+ * if (count.exitCode !== 0) console.error(count.stderr)
29
+ * console.log(listing.stdout, count.stdout)
30
+ * ```
31
+ */
32
+ class ContainerExecOptions extends core_1.DTO {
33
+ }
34
+ exports.ContainerExecOptions = ContainerExecOptions;
35
+ __decorate([
36
+ (0, dto_1.Expect)(core_1.DTO.Alternatives(core_1.DTO.String(), core_1.DTO.Array(core_1.DTO.String()).min(1)).required()),
37
+ __metadata("design:type", Object)
38
+ ], ContainerExecOptions.prototype, "cmd", void 0);
@@ -0,0 +1,27 @@
1
+ import { DTO } from '@lakutata/core';
2
+ import { Writable } from 'node:stream';
3
+ /**
4
+ * What `DockerContainer.exportDirectory()` copies out of a container (`docker cp`): a file or directory of the
5
+ * container, written as an uncompressed tar archive to a file or a stream. The container may be stopped.
6
+ * @example
7
+ * ```typescript
8
+ * import {Docker} from 'lakutata/com/docker'
9
+ *
10
+ * declare const docker: Docker
11
+ *
12
+ * const container = await docker.getContainer('web')
13
+ * await container.exportDirectory({path: '/var/log/nginx', destination: '/backup/nginx-logs.tar'})
14
+ * ```
15
+ */
16
+ export declare class ContainerExportDirectoryOptions extends DTO {
17
+ /**
18
+ * The absolute path of the file or directory in the container (`/var/log/nginx`); the archive holds it under its
19
+ * base name (`nginx/…`). Required.
20
+ */
21
+ path: string;
22
+ /**
23
+ * Where the tar archive is written: the path of a host file, created or replaced, or a writable stream, ended once
24
+ * the archive is written. Required.
25
+ */
26
+ destination: string | Writable;
27
+ }
@@ -0,0 +1,39 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.ContainerExportDirectoryOptions = void 0;
13
+ const core_1 = require("@lakutata/core");
14
+ const dto_1 = require("@lakutata/core/decorator/dto");
15
+ const node_stream_1 = require("node:stream");
16
+ /**
17
+ * What `DockerContainer.exportDirectory()` copies out of a container (`docker cp`): a file or directory of the
18
+ * container, written as an uncompressed tar archive to a file or a stream. The container may be stopped.
19
+ * @example
20
+ * ```typescript
21
+ * import {Docker} from 'lakutata/com/docker'
22
+ *
23
+ * declare const docker: Docker
24
+ *
25
+ * const container = await docker.getContainer('web')
26
+ * await container.exportDirectory({path: '/var/log/nginx', destination: '/backup/nginx-logs.tar'})
27
+ * ```
28
+ */
29
+ class ContainerExportDirectoryOptions extends core_1.DTO {
30
+ }
31
+ exports.ContainerExportDirectoryOptions = ContainerExportDirectoryOptions;
32
+ __decorate([
33
+ (0, dto_1.Expect)(core_1.DTO.String().required()),
34
+ __metadata("design:type", String)
35
+ ], ContainerExportDirectoryOptions.prototype, "path", void 0);
36
+ __decorate([
37
+ (0, dto_1.Expect)(core_1.DTO.Alternatives(core_1.DTO.String(), core_1.DTO.InstanceOf(node_stream_1.Stream)).required()),
38
+ __metadata("design:type", Object)
39
+ ], ContainerExportDirectoryOptions.prototype, "destination", void 0);
@@ -0,0 +1,25 @@
1
+ import { DTO } from '@lakutata/core';
2
+ /**
3
+ * How `DockerContainer.kill()` kills a running container (`docker kill`).
4
+ * @example
5
+ * ```typescript
6
+ * import {Docker} from 'lakutata/com/docker'
7
+ *
8
+ * declare const docker: Docker
9
+ *
10
+ * const container = await docker.getContainer('web')
11
+ * //Reload the configuration of the main process
12
+ * await container.kill({signal: 'SIGHUP'})
13
+ * //SIGKILL
14
+ * await container.kill()
15
+ * ```
16
+ */
17
+ export declare class ContainerKillOptions extends DTO {
18
+ /**
19
+ * The signal sent to the container's main process: a name (`'SIGHUP'`, `'SIGTERM'`, also without its `SIG` prefix)
20
+ * or a number (`15`, `'15'`). A signal the daemon does not know is refused by it (`DockerRequestException`,
21
+ * HTTP 400 or 500).
22
+ * @default 'SIGKILL'
23
+ */
24
+ signal?: string | number;
25
+ }
@@ -0,0 +1,36 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.ContainerKillOptions = void 0;
13
+ const core_1 = require("@lakutata/core");
14
+ const dto_1 = require("@lakutata/core/decorator/dto");
15
+ /**
16
+ * How `DockerContainer.kill()` kills a running container (`docker kill`).
17
+ * @example
18
+ * ```typescript
19
+ * import {Docker} from 'lakutata/com/docker'
20
+ *
21
+ * declare const docker: Docker
22
+ *
23
+ * const container = await docker.getContainer('web')
24
+ * //Reload the configuration of the main process
25
+ * await container.kill({signal: 'SIGHUP'})
26
+ * //SIGKILL
27
+ * await container.kill()
28
+ * ```
29
+ */
30
+ class ContainerKillOptions extends core_1.DTO {
31
+ }
32
+ exports.ContainerKillOptions = ContainerKillOptions;
33
+ __decorate([
34
+ (0, dto_1.Expect)(core_1.DTO.Alternatives(core_1.DTO.String(), core_1.DTO.Number().integer().positive()).optional().default('SIGKILL')),
35
+ __metadata("design:type", Object)
36
+ ], ContainerKillOptions.prototype, "signal", void 0);
@@ -0,0 +1,48 @@
1
+ import { DTO } from '@lakutata/core';
2
+ /**
3
+ * Which logs `DockerContainer.logs()` reads (`docker logs`): a readable stream of the container's standard output and
4
+ * error output, interleaved, as text (the multiplexing of a container without a terminal removed).
5
+ * @example
6
+ * ```typescript
7
+ * import {Docker} from 'lakutata/com/docker'
8
+ *
9
+ * declare const docker: Docker
10
+ *
11
+ * const container = await docker.getContainer('web')
12
+ * //The last 100 lines of the past hour, then the new ones as they are written
13
+ * const logs: NodeJS.ReadableStream = await container.logs({
14
+ * since: Math.floor(Date.now() / 1000) - 3600,
15
+ * tail: 100,
16
+ * timestamps: true
17
+ * })
18
+ * logs.pipe(process.stdout)
19
+ * ```
20
+ */
21
+ export declare class ContainerLogsOptions extends DTO {
22
+ /**
23
+ * Keep the stream open and give the new lines as the container writes them (`docker logs --follow`): the stream
24
+ * ends when the container stops. `false` ends the stream after the existing lines.
25
+ * @default true
26
+ */
27
+ follow?: boolean;
28
+ /**
29
+ * Only the lines written from this time on, a UNIX timestamp in seconds; `0` for no lower bound.
30
+ * @default 0
31
+ */
32
+ since?: number;
33
+ /**
34
+ * Only the lines written before this time, a UNIX timestamp in seconds; `0` for no upper bound.
35
+ * @default 0
36
+ */
37
+ until?: number;
38
+ /**
39
+ * Prefix each line with the time it was written, an RFC 3339 date with nanoseconds
40
+ * (`2026-10-04T08:15:30.123456789Z `).
41
+ * @default false
42
+ */
43
+ timestamps?: boolean;
44
+ /**
45
+ * Only this number of lines, from the end of the existing logs; all the lines when absent.
46
+ */
47
+ tail?: number;
48
+ }
@@ -0,0 +1,56 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.ContainerLogsOptions = void 0;
13
+ const core_1 = require("@lakutata/core");
14
+ const dto_1 = require("@lakutata/core/decorator/dto");
15
+ /**
16
+ * Which logs `DockerContainer.logs()` reads (`docker logs`): a readable stream of the container's standard output and
17
+ * error output, interleaved, as text (the multiplexing of a container without a terminal removed).
18
+ * @example
19
+ * ```typescript
20
+ * import {Docker} from 'lakutata/com/docker'
21
+ *
22
+ * declare const docker: Docker
23
+ *
24
+ * const container = await docker.getContainer('web')
25
+ * //The last 100 lines of the past hour, then the new ones as they are written
26
+ * const logs: NodeJS.ReadableStream = await container.logs({
27
+ * since: Math.floor(Date.now() / 1000) - 3600,
28
+ * tail: 100,
29
+ * timestamps: true
30
+ * })
31
+ * logs.pipe(process.stdout)
32
+ * ```
33
+ */
34
+ class ContainerLogsOptions extends core_1.DTO {
35
+ }
36
+ exports.ContainerLogsOptions = ContainerLogsOptions;
37
+ __decorate([
38
+ (0, dto_1.Expect)(core_1.DTO.Boolean().optional().default(true)),
39
+ __metadata("design:type", Boolean)
40
+ ], ContainerLogsOptions.prototype, "follow", void 0);
41
+ __decorate([
42
+ (0, dto_1.Expect)(core_1.DTO.Number().integer().optional().default(0)),
43
+ __metadata("design:type", Number)
44
+ ], ContainerLogsOptions.prototype, "since", void 0);
45
+ __decorate([
46
+ (0, dto_1.Expect)(core_1.DTO.Number().integer().optional().default(0)),
47
+ __metadata("design:type", Number)
48
+ ], ContainerLogsOptions.prototype, "until", void 0);
49
+ __decorate([
50
+ (0, dto_1.Expect)(core_1.DTO.Boolean().optional().default(false)),
51
+ __metadata("design:type", Boolean)
52
+ ], ContainerLogsOptions.prototype, "timestamps", void 0);
53
+ __decorate([
54
+ (0, dto_1.Expect)(core_1.DTO.Number().integer().optional()),
55
+ __metadata("design:type", Number)
56
+ ], ContainerLogsOptions.prototype, "tail", void 0);
@@ -0,0 +1,22 @@
1
+ import { DTO } from '@lakutata/core';
2
+ /**
3
+ * How `DockerContainer.remove()` removes a container (`docker rm -v`): its anonymous volumes are removed with it, the
4
+ * named volumes are kept.
5
+ * @example
6
+ * ```typescript
7
+ * import {Docker} from 'lakutata/com/docker'
8
+ *
9
+ * declare const docker: Docker
10
+ *
11
+ * const container = await docker.getContainer('web')
12
+ * await container.remove({force: true})
13
+ * ```
14
+ */
15
+ export declare class ContainerRemoveOptions extends DTO {
16
+ /**
17
+ * Kill the container first when it is running (`docker rm --force`); without it, removing a running container
18
+ * fails.
19
+ * @default false
20
+ */
21
+ force?: boolean;
22
+ }