sfml.js 0.0.1 → 1.0.0-rc.2

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 (741) hide show
  1. package/LICENSE +1 -1
  2. package/README.ja.md +173 -0
  3. package/README.ko.md +173 -0
  4. package/README.md +129 -20
  5. package/README.zh-CN.md +173 -0
  6. package/assets/branding/sfml-js-symbol-pentagon.svg +24 -0
  7. package/assets/branding/sfml-js-wordmark-dark.svg +20 -0
  8. package/assets/branding/sfml-js-wordmark.svg +19 -0
  9. package/assets/breakout.png +0 -0
  10. package/binding.gyp +95 -183
  11. package/dist/audio/effect-processor.d.ts +67 -0
  12. package/dist/audio/effect-processor.js +58 -0
  13. package/dist/audio/input-sound-file.d.ts +138 -0
  14. package/dist/audio/input-sound-file.js +253 -0
  15. package/dist/audio/listener.d.ts +90 -0
  16. package/dist/audio/listener.js +148 -0
  17. package/dist/audio/music.d.ts +210 -0
  18. package/dist/audio/music.js +353 -0
  19. package/dist/audio/output-sound-file.d.ts +47 -0
  20. package/dist/audio/output-sound-file.js +102 -0
  21. package/dist/audio/playback-device.d.ts +121 -0
  22. package/dist/audio/playback-device.js +152 -0
  23. package/dist/audio/sound-buffer-recorder.d.ts +114 -0
  24. package/dist/audio/sound-buffer-recorder.js +142 -0
  25. package/dist/audio/sound-buffer.d.ts +150 -0
  26. package/dist/audio/sound-buffer.js +237 -0
  27. package/dist/audio/sound-file-factory.d.ts +100 -0
  28. package/dist/audio/sound-file-factory.js +225 -0
  29. package/dist/audio/sound-file-reader.d.ts +191 -0
  30. package/dist/audio/sound-file-reader.js +132 -0
  31. package/dist/audio/sound-file-writer.d.ts +59 -0
  32. package/dist/audio/sound-file-writer.js +20 -0
  33. package/dist/audio/sound-recorder.d.ts +184 -0
  34. package/dist/audio/sound-recorder.js +286 -0
  35. package/dist/audio/sound-source.d.ts +336 -0
  36. package/dist/audio/sound-source.js +389 -0
  37. package/dist/audio/sound-stream.d.ts +76 -0
  38. package/dist/audio/sound-stream.js +83 -0
  39. package/dist/audio/sound.d.ts +41 -0
  40. package/dist/audio/sound.js +66 -0
  41. package/dist/audio/value.d.ts +359 -0
  42. package/dist/audio/value.js +353 -0
  43. package/dist/audio/worker.d.ts +306 -0
  44. package/dist/audio/worker.js +2 -0
  45. package/dist/graphics/blend-mode.d.ts +248 -0
  46. package/dist/graphics/blend-mode.js +234 -0
  47. package/dist/graphics/boolean-vector.d.ts +134 -0
  48. package/dist/graphics/boolean-vector.js +202 -0
  49. package/dist/graphics/circle-shape.d.ts +84 -0
  50. package/dist/graphics/circle-shape.js +72 -0
  51. package/dist/graphics/color.d.ts +278 -0
  52. package/dist/graphics/color.js +291 -0
  53. package/dist/graphics/convex-shape.d.ts +56 -0
  54. package/dist/graphics/convex-shape.js +59 -0
  55. package/dist/graphics/drawable.d.ts +22 -0
  56. package/dist/graphics/drawable.js +20 -0
  57. package/dist/graphics/font.d.ts +199 -0
  58. package/dist/graphics/font.js +319 -0
  59. package/dist/graphics/glsl-matrix.d.ts +62 -0
  60. package/dist/graphics/glsl-matrix.js +106 -0
  61. package/dist/graphics/glsl.d.ts +165 -0
  62. package/dist/graphics/glsl.js +215 -0
  63. package/dist/graphics/glyph.d.ts +133 -0
  64. package/dist/graphics/glyph.js +138 -0
  65. package/dist/graphics/image.d.ts +192 -0
  66. package/dist/graphics/image.js +285 -0
  67. package/dist/graphics/primitive-type.d.ts +51 -0
  68. package/dist/graphics/primitive-type.js +60 -0
  69. package/dist/graphics/rect.d.ts +203 -0
  70. package/dist/graphics/rect.js +249 -0
  71. package/dist/graphics/rectangle-shape.d.ts +55 -0
  72. package/dist/graphics/rectangle-shape.js +60 -0
  73. package/dist/graphics/render-states.d.ts +188 -0
  74. package/dist/graphics/render-states.js +115 -0
  75. package/dist/graphics/render-target.d.ts +222 -0
  76. package/dist/graphics/render-target.js +434 -0
  77. package/dist/graphics/render-texture.d.ts +130 -0
  78. package/dist/graphics/render-texture.js +187 -0
  79. package/dist/graphics/render-window.d.ts +138 -0
  80. package/dist/graphics/render-window.js +154 -0
  81. package/dist/graphics/shader.d.ts +192 -0
  82. package/dist/graphics/shader.js +321 -0
  83. package/dist/graphics/shape.d.ts +189 -0
  84. package/dist/graphics/shape.js +277 -0
  85. package/dist/graphics/sprite.d.ts +104 -0
  86. package/dist/graphics/sprite.js +164 -0
  87. package/dist/graphics/stencil-mode.d.ts +230 -0
  88. package/dist/graphics/stencil-mode.js +173 -0
  89. package/dist/graphics/swap.d.ts +17 -0
  90. package/dist/graphics/swap.js +16 -0
  91. package/dist/graphics/text.d.ts +759 -0
  92. package/dist/graphics/text.js +724 -0
  93. package/dist/graphics/texture.d.ts +255 -0
  94. package/dist/graphics/texture.js +390 -0
  95. package/dist/graphics/transform.d.ts +129 -0
  96. package/dist/graphics/transform.js +274 -0
  97. package/dist/graphics/transformable.d.ts +24 -0
  98. package/dist/graphics/transformable.js +38 -0
  99. package/dist/graphics/vertex-array.d.ts +123 -0
  100. package/dist/graphics/vertex-array.js +234 -0
  101. package/dist/graphics/vertex-buffer.d.ts +205 -0
  102. package/dist/graphics/vertex-buffer.js +256 -0
  103. package/dist/graphics/vertex.d.ts +111 -0
  104. package/dist/graphics/vertex.js +134 -0
  105. package/dist/graphics/view.d.ts +172 -0
  106. package/dist/graphics/view.js +296 -0
  107. package/dist/index.d.ts +116 -0
  108. package/dist/index.js +251 -0
  109. package/dist/internal/audio-codec-registry.d.ts +13 -0
  110. package/dist/internal/audio-codec-registry.js +64 -0
  111. package/dist/internal/audio-input-stream.d.ts +13 -0
  112. package/dist/internal/audio-input-stream.js +44 -0
  113. package/dist/internal/audio-music-pump.d.ts +63 -0
  114. package/dist/internal/audio-music-pump.js +193 -0
  115. package/dist/internal/audio-native.d.ts +145 -0
  116. package/dist/internal/audio-native.js +24 -0
  117. package/dist/internal/audio-recorder-session.d.ts +77 -0
  118. package/dist/internal/audio-recorder-session.js +182 -0
  119. package/dist/internal/audio-worker-session.d.ts +18 -0
  120. package/dist/internal/audio-worker-session.js +82 -0
  121. package/dist/internal/audio-worker.d.ts +1 -0
  122. package/dist/internal/audio-worker.js +134 -0
  123. package/dist/internal/glsl-value.d.ts +51 -0
  124. package/dist/internal/glsl-value.js +69 -0
  125. package/dist/internal/graphics-state.d.ts +45 -0
  126. package/dist/internal/graphics-state.js +123 -0
  127. package/dist/internal/input-stream.d.ts +4 -0
  128. package/dist/internal/input-stream.js +25 -0
  129. package/dist/internal/lazy-value.d.ts +17 -0
  130. package/dist/internal/lazy-value.js +43 -0
  131. package/dist/internal/native.d.ts +317 -0
  132. package/dist/internal/native.js +8 -0
  133. package/dist/internal/numeric-properties.d.ts +2 -0
  134. package/dist/internal/numeric-properties.js +39 -0
  135. package/dist/internal/render-states.d.ts +4 -0
  136. package/dist/internal/render-states.js +44 -0
  137. package/dist/internal/scalar.d.ts +52 -0
  138. package/dist/internal/scalar.js +95 -0
  139. package/dist/internal/shaped-glyph.d.ts +32 -0
  140. package/dist/internal/shaped-glyph.js +51 -0
  141. package/dist/internal/struct-view.d.ts +11 -0
  142. package/dist/internal/struct-view.js +39 -0
  143. package/dist/internal/text-indices.d.ts +7 -0
  144. package/dist/internal/text-indices.js +22 -0
  145. package/dist/internal/transformable.d.ts +124 -0
  146. package/dist/internal/transformable.js +121 -0
  147. package/dist/internal/value-storage.d.ts +33 -0
  148. package/dist/internal/value-storage.js +21 -0
  149. package/dist/network/common.d.ts +23 -0
  150. package/dist/network/common.js +78 -0
  151. package/dist/network/dns.d.ts +124 -0
  152. package/dist/network/dns.js +142 -0
  153. package/dist/network/ftp.d.ts +265 -0
  154. package/dist/network/ftp.js +417 -0
  155. package/dist/network/gen/constants.d.ts +878 -0
  156. package/dist/network/gen/constants.js +886 -0
  157. package/dist/network/http.d.ts +458 -0
  158. package/dist/network/http.js +732 -0
  159. package/dist/network/ip-address.d.ts +210 -0
  160. package/dist/network/ip-address.js +301 -0
  161. package/dist/network/packet.d.ts +249 -0
  162. package/dist/network/packet.js +326 -0
  163. package/dist/network/sftp.d.ts +661 -0
  164. package/dist/network/sftp.js +826 -0
  165. package/dist/network/socket-selector.d.ts +132 -0
  166. package/dist/network/socket-selector.js +214 -0
  167. package/dist/network/socket.d.ts +301 -0
  168. package/dist/network/socket.js +402 -0
  169. package/dist/network/tcp-listener.d.ts +114 -0
  170. package/dist/network/tcp-listener.js +199 -0
  171. package/dist/network/tcp-socket.d.ts +307 -0
  172. package/dist/network/tcp-socket.js +493 -0
  173. package/dist/network/tls-material.d.ts +22 -0
  174. package/dist/network/tls-material.js +52 -0
  175. package/dist/network/udp-socket.d.ts +178 -0
  176. package/dist/network/udp-socket.js +285 -0
  177. package/dist/system/angle.d.ts +77 -0
  178. package/dist/system/angle.js +122 -0
  179. package/dist/system/clock.d.ts +65 -0
  180. package/dist/system/clock.js +99 -0
  181. package/dist/system/err.d.ts +18 -0
  182. package/dist/system/err.js +61 -0
  183. package/dist/system/error.d.ts +15 -0
  184. package/dist/system/error.js +22 -0
  185. package/dist/system/file-input-stream.d.ts +68 -0
  186. package/dist/system/file-input-stream.js +148 -0
  187. package/dist/system/input-stream.d.ts +114 -0
  188. package/dist/system/input-stream.js +106 -0
  189. package/dist/system/operators.d.ts +291 -0
  190. package/dist/system/operators.js +505 -0
  191. package/dist/system/sleep.d.ts +9 -0
  192. package/dist/system/sleep.js +28 -0
  193. package/dist/system/suspend-aware-clock.d.ts +22 -0
  194. package/dist/system/suspend-aware-clock.js +29 -0
  195. package/dist/system/time.d.ts +100 -0
  196. package/dist/system/time.js +188 -0
  197. package/dist/system/timeout-with-predicate.d.ts +60 -0
  198. package/dist/system/timeout-with-predicate.js +52 -0
  199. package/dist/system/unicode.d.ts +54 -0
  200. package/dist/system/unicode.js +67 -0
  201. package/dist/system/vector2.d.ts +302 -0
  202. package/dist/system/vector2.js +314 -0
  203. package/dist/system/vector3.d.ts +249 -0
  204. package/dist/system/vector3.js +266 -0
  205. package/dist/system/version.d.ts +51 -0
  206. package/dist/system/version.js +24 -0
  207. package/dist/window/clipboard.d.ts +14 -0
  208. package/dist/window/clipboard.js +26 -0
  209. package/dist/window/context-settings.d.ts +94 -0
  210. package/dist/window/context-settings.js +84 -0
  211. package/dist/window/context.d.ts +87 -0
  212. package/dist/window/context.js +122 -0
  213. package/dist/window/cursor.d.ts +58 -0
  214. package/dist/window/cursor.js +80 -0
  215. package/dist/window/event.d.ts +529 -0
  216. package/dist/window/event.js +87 -0
  217. package/dist/window/gen/constants.d.ts +2213 -0
  218. package/dist/window/gen/constants.js +2227 -0
  219. package/dist/window/joystick.d.ts +81 -0
  220. package/dist/window/joystick.js +80 -0
  221. package/dist/window/keyboard.d.ts +50 -0
  222. package/dist/window/keyboard.js +59 -0
  223. package/dist/window/mouse.d.ts +31 -0
  224. package/dist/window/mouse.js +57 -0
  225. package/dist/window/sensor.d.ts +26 -0
  226. package/dist/window/sensor.js +40 -0
  227. package/dist/window/touch.d.ts +27 -0
  228. package/dist/window/touch.js +44 -0
  229. package/dist/window/video-mode.d.ts +77 -0
  230. package/dist/window/video-mode.js +99 -0
  231. package/dist/window/vulkan.d.ts +32 -0
  232. package/dist/window/vulkan.js +45 -0
  233. package/dist/window/window.d.ts +355 -0
  234. package/dist/window/window.js +434 -0
  235. package/docs/README.ja.md +30 -0
  236. package/docs/README.ko.md +30 -0
  237. package/docs/README.md +30 -0
  238. package/docs/README.zh-CN.md +30 -0
  239. package/docs/api.ja.md +84 -0
  240. package/docs/api.ko.md +84 -0
  241. package/docs/api.md +81 -0
  242. package/docs/api.zh-CN.md +81 -0
  243. package/docs/audio.ja.md +249 -0
  244. package/docs/audio.ko.md +251 -0
  245. package/docs/audio.md +252 -0
  246. package/docs/audio.zh-CN.md +252 -0
  247. package/docs/concepts.ja.md +130 -0
  248. package/docs/concepts.ko.md +130 -0
  249. package/docs/concepts.md +131 -0
  250. package/docs/concepts.zh-CN.md +131 -0
  251. package/docs/development.ja.md +148 -0
  252. package/docs/development.ko.md +148 -0
  253. package/docs/development.md +150 -0
  254. package/docs/development.zh-CN.md +150 -0
  255. package/docs/getting-started.ja.md +154 -0
  256. package/docs/getting-started.ko.md +154 -0
  257. package/docs/getting-started.md +156 -0
  258. package/docs/getting-started.zh-CN.md +156 -0
  259. package/docs/graphics.ja.md +256 -0
  260. package/docs/graphics.ko.md +254 -0
  261. package/docs/graphics.md +255 -0
  262. package/docs/graphics.zh-CN.md +257 -0
  263. package/docs/network.ja.md +214 -0
  264. package/docs/network.ko.md +216 -0
  265. package/docs/network.md +218 -0
  266. package/docs/network.zh-CN.md +218 -0
  267. package/docs/system.ja.md +169 -0
  268. package/docs/system.ko.md +171 -0
  269. package/docs/system.md +173 -0
  270. package/docs/system.zh-CN.md +173 -0
  271. package/docs/window.ja.md +138 -0
  272. package/docs/window.ko.md +140 -0
  273. package/docs/window.md +141 -0
  274. package/docs/window.zh-CN.md +141 -0
  275. package/native/addon.cc +129 -0
  276. package/native/audio-binding.cc +543 -0
  277. package/native/audio-codec-binding.cc +246 -0
  278. package/native/audio-device-binding.cc +160 -0
  279. package/native/audio-file-binding.cc +192 -0
  280. package/native/audio-recorder-binding.cc +237 -0
  281. package/native/audio-recorder.h +39 -0
  282. package/native/audio-state.h +220 -0
  283. package/native/audio-stream-binding.cc +284 -0
  284. package/native/audio-stream.h +28 -0
  285. package/native/audio-worker-binding.cc +447 -0
  286. package/native/audio-worker.h +121 -0
  287. package/native/batch-drawable.cc +189 -0
  288. package/native/batch-drawable.h +57 -0
  289. package/native/context-binding.cc +180 -0
  290. package/native/context-settings.h +74 -0
  291. package/native/deferred-delete.cc +49 -0
  292. package/native/deferred-delete.h +84 -0
  293. package/native/error-stream-binding.cc +270 -0
  294. package/native/exception-boundary.h +97 -0
  295. package/native/font-binding.cc +210 -0
  296. package/native/font-state.h +27 -0
  297. package/native/graphics-binding.cc +338 -0
  298. package/native/graphics-state.h +253 -0
  299. package/native/image-binding.cc +258 -0
  300. package/native/image-state.h +93 -0
  301. package/native/input-binding.cc +246 -0
  302. package/native/numeric-fields.h +96 -0
  303. package/native/render-window-binding.cc +103 -0
  304. package/native/render-window-state.h +22 -0
  305. package/native/shader-binding.cc +292 -0
  306. package/native/shape-binding.cc +283 -0
  307. package/native/shape-state.h +68 -0
  308. package/native/shaped-glyph-storage.h +45 -0
  309. package/native/shared-handle.h +69 -0
  310. package/native/stream-binding.cc +286 -0
  311. package/native/system-binding.cc +91 -0
  312. package/native/text-binding.cc +205 -0
  313. package/native/text-state.h +101 -0
  314. package/native/texture-binding.cc +330 -0
  315. package/native/texture-resource.h +52 -0
  316. package/native/time-value.h +28 -0
  317. package/native/transformable-binding.cc +23 -0
  318. package/native/transformable-state.h +44 -0
  319. package/native/value-binding.h +200 -0
  320. package/native/value-layout.h +116 -0
  321. package/native/values-binding.cc +27 -0
  322. package/native/vertex-binding.cc +50 -0
  323. package/native/vertex-buffer-binding.cc +232 -0
  324. package/native/vertex-storage.h +20 -0
  325. package/native/view-data.h +24 -0
  326. package/native/window-binding.cc +388 -0
  327. package/native/window-event.h +92 -0
  328. package/native/window-owner.h +81 -0
  329. package/package.json +87 -35
  330. package/src/audio/effect-processor.ts +86 -0
  331. package/src/audio/input-sound-file.ts +259 -0
  332. package/src/audio/listener.ts +136 -0
  333. package/src/audio/music.ts +357 -0
  334. package/src/audio/output-sound-file.ts +96 -0
  335. package/src/audio/playback-device.ts +145 -0
  336. package/src/audio/sound-buffer-recorder.ts +141 -0
  337. package/src/audio/sound-buffer.ts +275 -0
  338. package/src/audio/sound-file-factory.ts +235 -0
  339. package/src/audio/sound-file-reader.ts +224 -0
  340. package/src/audio/sound-file-writer.ts +61 -0
  341. package/src/audio/sound-recorder.ts +315 -0
  342. package/src/audio/sound-source.ts +396 -0
  343. package/src/audio/sound-stream.ts +108 -0
  344. package/src/audio/sound.ts +63 -0
  345. package/src/audio/value.ts +408 -0
  346. package/src/audio/worker.ts +308 -0
  347. package/src/graphics/blend-mode.ts +291 -0
  348. package/src/graphics/boolean-vector.ts +225 -0
  349. package/src/graphics/circle-shape.ts +113 -0
  350. package/src/graphics/color.ts +374 -0
  351. package/src/graphics/convex-shape.ts +76 -0
  352. package/src/graphics/drawable.ts +32 -0
  353. package/src/graphics/font.ts +377 -0
  354. package/src/graphics/glsl-matrix.ts +110 -0
  355. package/src/graphics/glsl.ts +229 -0
  356. package/src/graphics/glyph.ts +186 -0
  357. package/src/graphics/image.ts +366 -0
  358. package/src/graphics/primitive-type.ts +56 -0
  359. package/src/graphics/rect.ts +350 -0
  360. package/src/graphics/rectangle-shape.ts +76 -0
  361. package/src/graphics/render-states.ts +238 -0
  362. package/src/graphics/render-target.ts +554 -0
  363. package/src/graphics/render-texture.ts +234 -0
  364. package/src/graphics/render-window.ts +250 -0
  365. package/src/graphics/shader.ts +353 -0
  366. package/src/graphics/shape.ts +343 -0
  367. package/src/graphics/sprite.ts +203 -0
  368. package/src/graphics/stencil-mode.ts +258 -0
  369. package/src/graphics/swap.ts +28 -0
  370. package/src/graphics/text.ts +944 -0
  371. package/src/graphics/texture.ts +529 -0
  372. package/src/graphics/transform.ts +321 -0
  373. package/src/graphics/transformable.ts +37 -0
  374. package/src/graphics/vertex-array.ts +270 -0
  375. package/src/graphics/vertex-buffer.ts +345 -0
  376. package/src/graphics/vertex.ts +211 -0
  377. package/src/graphics/view.ts +355 -0
  378. package/src/index.ts +147 -0
  379. package/src/internal/audio-codec-registry.ts +68 -0
  380. package/src/internal/audio-input-stream.ts +42 -0
  381. package/src/internal/audio-music-pump.ts +199 -0
  382. package/src/internal/audio-native.ts +176 -0
  383. package/src/internal/audio-recorder-session.ts +234 -0
  384. package/src/internal/audio-worker-session.ts +89 -0
  385. package/src/internal/audio-worker.ts +146 -0
  386. package/src/internal/glsl-value.ts +79 -0
  387. package/src/internal/graphics-state.ts +131 -0
  388. package/src/internal/input-stream.ts +30 -0
  389. package/src/internal/lazy-value.ts +62 -0
  390. package/src/internal/native.ts +581 -0
  391. package/src/internal/numeric-properties.ts +37 -0
  392. package/src/internal/render-states.ts +42 -0
  393. package/src/internal/scalar.ts +117 -0
  394. package/src/internal/shaped-glyph.ts +68 -0
  395. package/src/internal/struct-view.ts +49 -0
  396. package/src/internal/text-indices.ts +19 -0
  397. package/src/internal/transformable.ts +260 -0
  398. package/src/internal/value-storage.ts +40 -0
  399. package/src/network/common.ts +58 -0
  400. package/src/network/dns.ts +191 -0
  401. package/src/network/ftp.ts +386 -0
  402. package/src/network/gen/constants.ts +879 -0
  403. package/src/network/http.ts +680 -0
  404. package/src/network/ip-address.ts +311 -0
  405. package/src/network/packet.ts +388 -0
  406. package/src/network/sftp.ts +1015 -0
  407. package/src/network/socket-selector.ts +206 -0
  408. package/src/network/socket.ts +415 -0
  409. package/src/network/tcp-listener.ts +193 -0
  410. package/src/network/tcp-socket.ts +569 -0
  411. package/src/network/tls-material.ts +46 -0
  412. package/src/network/udp-socket.ts +294 -0
  413. package/src/system/angle.ts +132 -0
  414. package/src/system/clock.ts +104 -0
  415. package/src/system/err.ts +58 -0
  416. package/src/system/error.ts +18 -0
  417. package/src/system/file-input-stream.ts +147 -0
  418. package/src/system/input-stream.ts +150 -0
  419. package/src/system/operators.ts +681 -0
  420. package/src/system/sleep.ts +25 -0
  421. package/src/system/suspend-aware-clock.ts +27 -0
  422. package/src/system/time.ts +218 -0
  423. package/src/system/timeout-with-predicate.ts +94 -0
  424. package/src/system/unicode.ts +64 -0
  425. package/src/system/vector2.ts +549 -0
  426. package/src/system/vector3.ts +433 -0
  427. package/src/system/version.ts +66 -0
  428. package/src/window/clipboard.ts +22 -0
  429. package/src/window/context-settings.ts +143 -0
  430. package/src/window/context.ts +152 -0
  431. package/src/window/cursor.ts +116 -0
  432. package/src/window/event.ts +580 -0
  433. package/src/window/gen/constants.ts +2231 -0
  434. package/src/window/joystick.ts +108 -0
  435. package/src/window/keyboard.ts +78 -0
  436. package/src/window/mouse.ts +58 -0
  437. package/src/window/sensor.ts +37 -0
  438. package/src/window/touch.ts +42 -0
  439. package/src/window/video-mode.ts +136 -0
  440. package/src/window/vulkan.ts +42 -0
  441. package/src/window/window.ts +579 -0
  442. package/test/native/audio-probes.cc +181 -0
  443. package/test/native/deferred-delete-probes.cc +62 -0
  444. package/test/native/drawable-probes.cc +168 -0
  445. package/test/native/exception-probes.cc +83 -0
  446. package/test/native/image-probes.cc +105 -0
  447. package/test/native/matrix-probes.cc +67 -0
  448. package/test/native/network-oracle.cc +32 -0
  449. package/test/native/render-texture-probes.cc +193 -0
  450. package/test/native/shader-probes.cc +69 -0
  451. package/test/native/shape-probes.cc +160 -0
  452. package/test/native/sprite-probes.cc +146 -0
  453. package/test/native/system-probes.cc +109 -0
  454. package/test/native/text-probes.cc +211 -0
  455. package/test/native/texture-probes.cc +200 -0
  456. package/test/native/time-probes.cc +143 -0
  457. package/test/native/transform-probes.cc +92 -0
  458. package/test/native/transformable-probes.cc +152 -0
  459. package/test/native/value-oracle.h +88 -0
  460. package/test/native/value-probes.cc +379 -0
  461. package/test/native/vertex-array-probes.cc +82 -0
  462. package/test/native/vertex-buffer-probes.cc +87 -0
  463. package/test/native/view-probes.cc +150 -0
  464. package/test/native/window-probes.cc +172 -0
  465. package/test/tsconfig.json +8 -0
  466. package/tools/configure-lsp.cjs +23 -0
  467. package/tools/constant-docs.cjs +109 -0
  468. package/tools/constant-docs.json +1318 -0
  469. package/tools/generate-network-constants.cjs +59 -0
  470. package/tools/generate-window-constants.cjs +178 -0
  471. package/tools/lib_downloader.cjs +92 -0
  472. package/tools/lib_downloader_urls.cjs +23 -0
  473. package/tsconfig.json +11 -4
  474. package/index.d.ts +0 -1
  475. package/lib/clock.d.ts +0 -8
  476. package/lib/clock.js +0 -5
  477. package/lib/color.d.ts +0 -11
  478. package/lib/color.js +0 -98
  479. package/lib/common.js +0 -47
  480. package/lib/drawable/circle_shape.d.ts +0 -5
  481. package/lib/drawable/circle_shape.js +0 -26
  482. package/lib/drawable/convex_shape.d.ts +0 -5
  483. package/lib/drawable/convex_shape.js +0 -35
  484. package/lib/drawable/drawable.d.ts +0 -6
  485. package/lib/drawable/drawable.js +0 -18
  486. package/lib/drawable/plugin_package.d.ts +0 -31
  487. package/lib/drawable/plugin_package.js +0 -102
  488. package/lib/drawable/rectangle_shape.d.ts +0 -9
  489. package/lib/drawable/rectangle_shape.js +0 -28
  490. package/lib/drawable/shape.d.ts +0 -14
  491. package/lib/drawable/shape.js +0 -30
  492. package/lib/drawable/sprite.d.ts +0 -17
  493. package/lib/drawable/sprite.js +0 -53
  494. package/lib/drawable/text.d.ts +0 -26
  495. package/lib/drawable/text.js +0 -88
  496. package/lib/drawable/transformable.d.ts +0 -28
  497. package/lib/drawable/transformable.js +0 -113
  498. package/lib/drawable/vertex_array.d.ts +0 -40
  499. package/lib/drawable/vertex_array.js +0 -128
  500. package/lib/font.d.ts +0 -24
  501. package/lib/font.js +0 -137
  502. package/lib/image.d.ts +0 -26
  503. package/lib/image.js +0 -147
  504. package/lib/joystick.d.ts +0 -21
  505. package/lib/joystick.js +0 -72
  506. package/lib/keyboard.d.ts +0 -113
  507. package/lib/keyboard.js +0 -17
  508. package/lib/mouse.d.ts +0 -6
  509. package/lib/mouse.js +0 -39
  510. package/lib/poll_event.d.ts +0 -138
  511. package/lib/rect.d.ts +0 -18
  512. package/lib/rect.js +0 -119
  513. package/lib/render_window.d.ts +0 -67
  514. package/lib/render_window.js +0 -197
  515. package/lib/sensor.d.ts +0 -12
  516. package/lib/sensor.js +0 -34
  517. package/lib/sfml.d.ts +0 -32
  518. package/lib/sfml.js +0 -36
  519. package/lib/sound/base.d.ts +0 -33
  520. package/lib/sound/base.js +0 -109
  521. package/lib/sound/music.d.ts +0 -15
  522. package/lib/sound/music.js +0 -65
  523. package/lib/sound/sound.d.ts +0 -16
  524. package/lib/sound/sound.js +0 -55
  525. package/lib/sound/sound_buffer.d.ts +0 -14
  526. package/lib/sound/sound_buffer.js +0 -78
  527. package/lib/texture.d.ts +0 -21
  528. package/lib/texture.js +0 -127
  529. package/lib/time.d.ts +0 -13
  530. package/lib/time.js +0 -41
  531. package/lib/touch.d.ts +0 -7
  532. package/lib/touch.js +0 -34
  533. package/lib/vector2.d.ts +0 -49
  534. package/lib/vector2.js +0 -141
  535. package/lib/vector3.d.ts +0 -47
  536. package/lib/vector3.js +0 -154
  537. package/lib/vertex.d.ts +0 -14
  538. package/lib/vertex.js +0 -177
  539. package/lib/video_mode.d.ts +0 -12
  540. package/lib/video_mode.js +0 -99
  541. package/src/base_class_with_loading.h +0 -21
  542. package/src/clock.cc +0 -71
  543. package/src/clock.h +0 -30
  544. package/src/color.cc +0 -189
  545. package/src/color.h +0 -49
  546. package/src/drawable/circle_shape.cc +0 -78
  547. package/src/drawable/circle_shape.h +0 -28
  548. package/src/drawable/convex_shape.cc +0 -57
  549. package/src/drawable/convex_shape.h +0 -29
  550. package/src/drawable/drawable-inl.h +0 -29
  551. package/src/drawable/drawable.cc +0 -41
  552. package/src/drawable/drawable.h +0 -49
  553. package/src/drawable/package_plugin-inl.h +0 -191
  554. package/src/drawable/package_plugin.h +0 -60
  555. package/src/drawable/rectangle_shape.cc +0 -69
  556. package/src/drawable/rectangle_shape.h +0 -29
  557. package/src/drawable/shape.cc +0 -67
  558. package/src/drawable/shape.h +0 -39
  559. package/src/drawable/sprite.cc +0 -122
  560. package/src/drawable/sprite.h +0 -45
  561. package/src/drawable/text.cc +0 -133
  562. package/src/drawable/text.h +0 -54
  563. package/src/drawable/vertex_array.cc +0 -248
  564. package/src/drawable/vertex_array.h +0 -46
  565. package/src/font.cc +0 -214
  566. package/src/font.h +0 -44
  567. package/src/gen/.gitkeep +0 -0
  568. package/src/gen/joystick_axis.cc +0 -30
  569. package/src/gen/keycode.cc +0 -226
  570. package/src/gen/mouse_button.cc +0 -30
  571. package/src/gen/sensor_type.cc +0 -26
  572. package/src/image.cc +0 -379
  573. package/src/image.h +0 -72
  574. package/src/joystick.cc +0 -132
  575. package/src/joystick.h +0 -32
  576. package/src/keyboard.cc +0 -65
  577. package/src/keyboard.h +0 -27
  578. package/src/mouse.cc +0 -95
  579. package/src/mouse.h +0 -30
  580. package/src/plugins/transformable_plugin-inl.h +0 -121
  581. package/src/plugins/transformable_plugin.h +0 -42
  582. package/src/poll_event.cc +0 -326
  583. package/src/poll_event.h +0 -18
  584. package/src/rect-inl.h +0 -154
  585. package/src/rect.cc +0 -28
  586. package/src/rect.h +0 -105
  587. package/src/render_window.cc +0 -413
  588. package/src/render_window.h +0 -111
  589. package/src/render_window_async_display.cc +0 -49
  590. package/src/render_window_async_draw.cc +0 -56
  591. package/src/resizable_buffer.h +0 -104
  592. package/src/sensor.cc +0 -82
  593. package/src/sensor.h +0 -28
  594. package/src/sfml.cc +0 -85
  595. package/src/sound/music.cc +0 -113
  596. package/src/sound/music.h +0 -35
  597. package/src/sound/sound.cc +0 -116
  598. package/src/sound/sound.h +0 -41
  599. package/src/sound/sound_buffer.cc +0 -226
  600. package/src/sound/sound_buffer.h +0 -46
  601. package/src/sound/sound_source.cc +0 -124
  602. package/src/sound/sound_source.h +0 -80
  603. package/src/texture.cc +0 -246
  604. package/src/texture.h +0 -47
  605. package/src/time.cc +0 -177
  606. package/src/time.h +0 -42
  607. package/src/touch.cc +0 -54
  608. package/src/touch.h +0 -23
  609. package/src/utils-inl.h +0 -48
  610. package/src/utils.h +0 -21
  611. package/src/vector2-inl.h +0 -198
  612. package/src/vector2.cc +0 -36
  613. package/src/vector2.h +0 -133
  614. package/src/vector3-inl.h +0 -200
  615. package/src/vector3.cc +0 -36
  616. package/src/vector3.h +0 -134
  617. package/src/vertex.cc +0 -238
  618. package/src/vertex.h +0 -114
  619. package/src/video_mode.cc +0 -184
  620. package/src/video_mode.h +0 -38
  621. package/src/workers/load_from_file_worker.h +0 -79
  622. package/src/workers/save_to_file_worker.h +0 -79
  623. package/third_party/sfml/include/SFML/Audio/AlResource.hpp +0 -70
  624. package/third_party/sfml/include/SFML/Audio/Export.hpp +0 -48
  625. package/third_party/sfml/include/SFML/Audio/InputSoundFile.hpp +0 -268
  626. package/third_party/sfml/include/SFML/Audio/Listener.hpp +0 -234
  627. package/third_party/sfml/include/SFML/Audio/Music.hpp +0 -337
  628. package/third_party/sfml/include/SFML/Audio/OutputSoundFile.hpp +0 -133
  629. package/third_party/sfml/include/SFML/Audio/Sound.hpp +0 -264
  630. package/third_party/sfml/include/SFML/Audio/SoundBuffer.hpp +0 -352
  631. package/third_party/sfml/include/SFML/Audio/SoundBufferRecorder.hpp +0 -144
  632. package/third_party/sfml/include/SFML/Audio/SoundFileFactory.hpp +0 -197
  633. package/third_party/sfml/include/SFML/Audio/SoundFileFactory.inl +0 -100
  634. package/third_party/sfml/include/SFML/Audio/SoundFileReader.hpp +0 -165
  635. package/third_party/sfml/include/SFML/Audio/SoundFileWriter.hpp +0 -125
  636. package/third_party/sfml/include/SFML/Audio/SoundRecorder.hpp +0 -410
  637. package/third_party/sfml/include/SFML/Audio/SoundSource.hpp +0 -332
  638. package/third_party/sfml/include/SFML/Audio/SoundStream.hpp +0 -420
  639. package/third_party/sfml/include/SFML/Audio.hpp +0 -56
  640. package/third_party/sfml/include/SFML/Config.hpp +0 -248
  641. package/third_party/sfml/include/SFML/GpuPreference.hpp +0 -74
  642. package/third_party/sfml/include/SFML/Graphics/BlendMode.hpp +0 -219
  643. package/third_party/sfml/include/SFML/Graphics/CircleShape.hpp +0 -154
  644. package/third_party/sfml/include/SFML/Graphics/Color.hpp +0 -275
  645. package/third_party/sfml/include/SFML/Graphics/ConvexShape.hpp +0 -153
  646. package/third_party/sfml/include/SFML/Graphics/Drawable.hpp +0 -126
  647. package/third_party/sfml/include/SFML/Graphics/Export.hpp +0 -48
  648. package/third_party/sfml/include/SFML/Graphics/Font.hpp +0 -496
  649. package/third_party/sfml/include/SFML/Graphics/Glsl.hpp +0 -227
  650. package/third_party/sfml/include/SFML/Graphics/Glsl.inl +0 -155
  651. package/third_party/sfml/include/SFML/Graphics/Glyph.hpp +0 -81
  652. package/third_party/sfml/include/SFML/Graphics/Image.hpp +0 -346
  653. package/third_party/sfml/include/SFML/Graphics/PrimitiveType.hpp +0 -58
  654. package/third_party/sfml/include/SFML/Graphics/Rect.hpp +0 -274
  655. package/third_party/sfml/include/SFML/Graphics/Rect.inl +0 -171
  656. package/third_party/sfml/include/SFML/Graphics/RectangleShape.hpp +0 -132
  657. package/third_party/sfml/include/SFML/Graphics/RenderStates.hpp +0 -174
  658. package/third_party/sfml/include/SFML/Graphics/RenderTarget.hpp +0 -518
  659. package/third_party/sfml/include/SFML/Graphics/RenderTexture.hpp +0 -334
  660. package/third_party/sfml/include/SFML/Graphics/RenderWindow.hpp +0 -302
  661. package/third_party/sfml/include/SFML/Graphics/Shader.hpp +0 -875
  662. package/third_party/sfml/include/SFML/Graphics/Shape.hpp +0 -355
  663. package/third_party/sfml/include/SFML/Graphics/Sprite.hpp +0 -279
  664. package/third_party/sfml/include/SFML/Graphics/Text.hpp +0 -513
  665. package/third_party/sfml/include/SFML/Graphics/Texture.hpp +0 -733
  666. package/third_party/sfml/include/SFML/Graphics/Transform.hpp +0 -497
  667. package/third_party/sfml/include/SFML/Graphics/Transformable.hpp +0 -429
  668. package/third_party/sfml/include/SFML/Graphics/Vertex.hpp +0 -148
  669. package/third_party/sfml/include/SFML/Graphics/VertexArray.hpp +0 -223
  670. package/third_party/sfml/include/SFML/Graphics/VertexBuffer.hpp +0 -408
  671. package/third_party/sfml/include/SFML/Graphics/View.hpp +0 -343
  672. package/third_party/sfml/include/SFML/Graphics.hpp +0 -68
  673. package/third_party/sfml/include/SFML/Main.hpp +0 -43
  674. package/third_party/sfml/include/SFML/Network/Export.hpp +0 -48
  675. package/third_party/sfml/include/SFML/Network/Ftp.hpp +0 -616
  676. package/third_party/sfml/include/SFML/Network/Http.hpp +0 -482
  677. package/third_party/sfml/include/SFML/Network/IpAddress.hpp +0 -328
  678. package/third_party/sfml/include/SFML/Network/Packet.hpp +0 -545
  679. package/third_party/sfml/include/SFML/Network/Socket.hpp +0 -219
  680. package/third_party/sfml/include/SFML/Network/SocketHandle.hpp +0 -57
  681. package/third_party/sfml/include/SFML/Network/SocketSelector.hpp +0 -263
  682. package/third_party/sfml/include/SFML/Network/TcpListener.hpp +0 -170
  683. package/third_party/sfml/include/SFML/Network/TcpSocket.hpp +0 -316
  684. package/third_party/sfml/include/SFML/Network/UdpSocket.hpp +0 -292
  685. package/third_party/sfml/include/SFML/Network.hpp +0 -53
  686. package/third_party/sfml/include/SFML/OpenGL.hpp +0 -78
  687. package/third_party/sfml/include/SFML/System/Clock.hpp +0 -117
  688. package/third_party/sfml/include/SFML/System/Err.hpp +0 -80
  689. package/third_party/sfml/include/SFML/System/Export.hpp +0 -48
  690. package/third_party/sfml/include/SFML/System/FileInputStream.hpp +0 -169
  691. package/third_party/sfml/include/SFML/System/InputStream.hpp +0 -152
  692. package/third_party/sfml/include/SFML/System/Lock.hpp +0 -139
  693. package/third_party/sfml/include/SFML/System/MemoryInputStream.hpp +0 -148
  694. package/third_party/sfml/include/SFML/System/Mutex.hpp +0 -148
  695. package/third_party/sfml/include/SFML/System/NativeActivity.hpp +0 -62
  696. package/third_party/sfml/include/SFML/System/NonCopyable.hpp +0 -129
  697. package/third_party/sfml/include/SFML/System/Sleep.hpp +0 -52
  698. package/third_party/sfml/include/SFML/System/String.hpp +0 -669
  699. package/third_party/sfml/include/SFML/System/String.inl +0 -53
  700. package/third_party/sfml/include/SFML/System/Thread.hpp +0 -282
  701. package/third_party/sfml/include/SFML/System/Thread.inl +0 -90
  702. package/third_party/sfml/include/SFML/System/ThreadLocal.hpp +0 -103
  703. package/third_party/sfml/include/SFML/System/ThreadLocalPtr.hpp +0 -158
  704. package/third_party/sfml/include/SFML/System/ThreadLocalPtr.inl +0 -77
  705. package/third_party/sfml/include/SFML/System/Time.hpp +0 -488
  706. package/third_party/sfml/include/SFML/System/Utf.hpp +0 -763
  707. package/third_party/sfml/include/SFML/System/Utf.inl +0 -752
  708. package/third_party/sfml/include/SFML/System/Vector2.hpp +0 -301
  709. package/third_party/sfml/include/SFML/System/Vector2.inl +0 -161
  710. package/third_party/sfml/include/SFML/System/Vector3.hpp +0 -302
  711. package/third_party/sfml/include/SFML/System/Vector3.inl +0 -168
  712. package/third_party/sfml/include/SFML/System.hpp +0 -60
  713. package/third_party/sfml/include/SFML/Window/Clipboard.hpp +0 -119
  714. package/third_party/sfml/include/SFML/Window/Context.hpp +0 -195
  715. package/third_party/sfml/include/SFML/Window/ContextSettings.hpp +0 -149
  716. package/third_party/sfml/include/SFML/Window/Cursor.hpp +0 -241
  717. package/third_party/sfml/include/SFML/Window/Event.hpp +0 -285
  718. package/third_party/sfml/include/SFML/Window/Export.hpp +0 -48
  719. package/third_party/sfml/include/SFML/Window/GlResource.hpp +0 -109
  720. package/third_party/sfml/include/SFML/Window/Joystick.hpp +0 -227
  721. package/third_party/sfml/include/SFML/Window/Keyboard.hpp +0 -491
  722. package/third_party/sfml/include/SFML/Window/Mouse.hpp +0 -180
  723. package/third_party/sfml/include/SFML/Window/Sensor.hpp +0 -150
  724. package/third_party/sfml/include/SFML/Window/Touch.hpp +0 -137
  725. package/third_party/sfml/include/SFML/Window/VideoMode.hpp +0 -228
  726. package/third_party/sfml/include/SFML/Window/Vulkan.hpp +0 -115
  727. package/third_party/sfml/include/SFML/Window/Window.hpp +0 -354
  728. package/third_party/sfml/include/SFML/Window/WindowBase.hpp +0 -518
  729. package/third_party/sfml/include/SFML/Window/WindowHandle.hpp +0 -101
  730. package/third_party/sfml/include/SFML/Window/WindowStyle.hpp +0 -53
  731. package/third_party/sfml/include/SFML/Window.hpp +0 -58
  732. package/tools/clang_format.js +0 -9
  733. package/tools/copier/linux.js +0 -21
  734. package/tools/copier/macos.js +0 -34
  735. package/tools/copier/windows.js +0 -33
  736. package/tools/joystick_axis.js +0 -63
  737. package/tools/keycode.js +0 -92
  738. package/tools/lib_downloader.js +0 -107
  739. package/tools/lib_downloader_urls.js +0 -59
  740. package/tools/mouse_button.js +0 -92
  741. package/tools/sensor_type.js +0 -63
@@ -0,0 +1,826 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Sftp = exports.SftpListingResult = exports.SftpAttributesResult = exports.FileType = exports.SftpPathResult = exports.SftpResult = exports.SftpHostKeyType = exports.SftpResultValue = void 0;
4
+ const ssh2_1 = require("ssh2");
5
+ const node_net_1 = require("node:net");
6
+ const node_events_1 = require("node:events");
7
+ const node_crypto_1 = require("node:crypto");
8
+ const ip_address_1 = require("./ip-address");
9
+ const time_1 = require("../system/time");
10
+ const timeout_with_predicate_1 = require("../system/timeout-with-predicate");
11
+ const common_1 = require("./common");
12
+ const constants_1 = require("./gen/constants");
13
+ var constants_2 = require("./gen/constants");
14
+ Object.defineProperty(exports, "SftpResultValue", { enumerable: true, get: function () { return constants_2.SftpResultValue; } });
15
+ Object.defineProperty(exports, "SftpHostKeyType", { enumerable: true, get: function () { return constants_2.SftpHostKeyType; } });
16
+ /**
17
+ * SFTP operation status and message.
18
+ * @zh SFTP 操作状态和消息。
19
+ * @ja SFTP 操作の状態とメッセージ。
20
+ * @ko SFTP 작업 상태와 메시지.
21
+ */
22
+ class SftpResult {
23
+ /**
24
+ * Create a result from a result code and optional description.
25
+ * @zh 从结果码及可选说明创建结果。
26
+ * @ja 結果コードと任意の説明から結果を作成します。
27
+ * @ko 결과 코드와 선택적 설명으로 결과를 생성합니다.
28
+ */
29
+ constructor(value, message = '') {
30
+ this.value = value;
31
+ this.message = message;
32
+ }
33
+ /**
34
+ * Return whether the result is Success.
35
+ * @zh 返回结果是否为 Success。
36
+ * @ja 結果が Success かどうかを返します。
37
+ * @ko 결과가 Success인지 반환합니다.
38
+ */
39
+ isOk() { return this.value === constants_1.SftpResultValue.Success; }
40
+ /**
41
+ * Return the result code.
42
+ * @zh 返回结果码。
43
+ * @ja 結果コードを返します。
44
+ * @ko 결과 코드를 반환합니다.
45
+ */
46
+ getValue() { return this.value; }
47
+ /**
48
+ * Return the error or status description.
49
+ * @zh 返回错误或状态说明。
50
+ * @ja エラーまたは状態の説明を返します。
51
+ * @ko 오류 또는 상태 설명을 반환합니다.
52
+ */
53
+ getMessage() { return this.message; }
54
+ }
55
+ /**
56
+ * SFTP result code enumeration.
57
+ * @zh SFTP 结果码枚举。
58
+ * @ja SFTP 結果コードの列挙型。
59
+ * @ko SFTP 결과 코드 열거형.
60
+ */
61
+ SftpResult.Value = constants_1.SftpResultValue;
62
+ exports.SftpResult = SftpResult;
63
+ /**
64
+ * Operation result containing a remote path.
65
+ * @zh 带远端路径的操作结果。
66
+ * @ja リモートパスを含む操作結果。
67
+ * @ko 원격 경로를 포함하는 작업 결과.
68
+ */
69
+ class SftpPathResult extends SftpResult {
70
+ /**
71
+ * Copy the result status and attach a path.
72
+ * @zh 复制结果状态并附加路径。
73
+ * @ja 結果の状態をコピーし、パスを付加します。
74
+ * @ko 결과 상태를 복사하고 경로를 첨부합니다.
75
+ */
76
+ constructor(result, path = '') {
77
+ super(result.getValue(), result.getMessage());
78
+ this.path = path;
79
+ }
80
+ /**
81
+ * Return the remote path; failed results usually contain an empty string.
82
+ * @zh 返回远端路径;失败结果通常为空字符串。
83
+ * @ja リモートパスを返します。失敗結果では通常、空文字列です。
84
+ * @ko 원격 경로를 반환하며 실패한 결과에서는 보통 빈 문자열입니다.
85
+ */
86
+ getPath() { return this.path; }
87
+ }
88
+ exports.SftpPathResult = SftpPathResult;
89
+ /**
90
+ * Remote filesystem entry type.
91
+ * @zh 远端文件系统条目类型。
92
+ * @ja リモートファイルシステムのエントリー型。
93
+ * @ko 원격 파일 시스템 항목 타입.
94
+ */
95
+ var FileType;
96
+ (function (FileType) {
97
+ /**
98
+ * No type set.
99
+ * @zh 未设置类型。
100
+ * @ja 型が未設定です。
101
+ * @ko 타입이 설정되지 않았습니다.
102
+ */
103
+ FileType[FileType["None"] = 0] = "None";
104
+ /**
105
+ * Entry does not exist.
106
+ * @zh 条目不存在。
107
+ * @ja エントリーが存在しません。
108
+ * @ko 항목이 없습니다.
109
+ */
110
+ FileType[FileType["NotFound"] = 1] = "NotFound";
111
+ /**
112
+ * Regular file.
113
+ * @zh 普通文件。
114
+ * @ja 通常ファイル。
115
+ * @ko 일반 파일.
116
+ */
117
+ FileType[FileType["Regular"] = 2] = "Regular";
118
+ /**
119
+ * Directory.
120
+ * @zh 目录。
121
+ * @ja ディレクトリ。
122
+ * @ko 디렉터리.
123
+ */
124
+ FileType[FileType["Directory"] = 3] = "Directory";
125
+ /**
126
+ * Symbolic link.
127
+ * @zh 符号链接。
128
+ * @ja シンボリックリンク。
129
+ * @ko 심볼릭 링크.
130
+ */
131
+ FileType[FileType["Symlink"] = 4] = "Symlink";
132
+ /**
133
+ * Block device.
134
+ * @zh 块设备。
135
+ * @ja ブロックデバイス。
136
+ * @ko 블록 장치.
137
+ */
138
+ FileType[FileType["Block"] = 5] = "Block";
139
+ /**
140
+ * Character device.
141
+ * @zh 字符设备。
142
+ * @ja キャラクターデバイス。
143
+ * @ko 문자 장치.
144
+ */
145
+ FileType[FileType["Character"] = 6] = "Character";
146
+ /**
147
+ * Named pipe.
148
+ * @zh 命名管道。
149
+ * @ja 名前付きパイプ。
150
+ * @ko 이름 있는 파이프.
151
+ */
152
+ FileType[FileType["Fifo"] = 7] = "Fifo";
153
+ /**
154
+ * Socket.
155
+ * @zh 套接字。
156
+ * @ja ソケット。
157
+ * @ko 소켓.
158
+ */
159
+ FileType[FileType["Socket"] = 8] = "Socket";
160
+ /**
161
+ * Unknown type.
162
+ * @zh 未知类型。
163
+ * @ja 不明な型。
164
+ * @ko 알 수 없는 타입.
165
+ */
166
+ FileType[FileType["Unknown"] = 9] = "Unknown";
167
+ })(FileType = exports.FileType || (exports.FileType = {}));
168
+ /**
169
+ * Result containing attributes of one filesystem entry.
170
+ * @zh 带单个文件系统条目属性的结果。
171
+ * @ja 単一ファイルシステムエントリーの属性を含む結果。
172
+ * @ko 파일 시스템 항목 하나의 속성을 포함하는 결과.
173
+ */
174
+ class SftpAttributesResult extends SftpResult {
175
+ /**
176
+ * Copy the result status and attach an attributes object.
177
+ * @zh 复制结果状态并附加属性对象。
178
+ * @ja 結果の状態をコピーし、属性オブジェクトを付加します。
179
+ * @ko 결과 상태를 복사하고 속성 객체를 첨부합니다.
180
+ */
181
+ constructor(result, attributes = { path: '' }) {
182
+ super(result.getValue(), result.getMessage());
183
+ this.attributes = attributes;
184
+ }
185
+ /**
186
+ * Return the attributes object held by this result.
187
+ * @zh 返回此结果持有的属性对象。
188
+ * @ja この結果が保持する属性オブジェクトを返します。
189
+ * @ko 이 결과가 보유한 속성 객체를 반환합니다.
190
+ */
191
+ getAttributes() { return this.attributes; }
192
+ }
193
+ exports.SftpAttributesResult = SftpAttributesResult;
194
+ /**
195
+ * Result containing a list of directory entry attributes.
196
+ * @zh 带目录条目属性列表的结果。
197
+ * @ja ディレクトリエントリーの属性一覧を含む結果。
198
+ * @ko 디렉터리 항목 속성 목록을 포함하는 결과.
199
+ */
200
+ class SftpListingResult extends SftpResult {
201
+ /**
202
+ * Copy the result status and attach an entry list.
203
+ * @zh 复制结果状态并附加条目列表。
204
+ * @ja 結果の状態をコピーし、エントリー一覧を付加します。
205
+ * @ko 결과 상태를 복사하고 항목 목록을 첨부합니다.
206
+ */
207
+ constructor(result, listing = []) {
208
+ super(result.getValue(), result.getMessage());
209
+ this.listing = listing;
210
+ }
211
+ /**
212
+ * Return the directory entry list held by this result.
213
+ * @zh 返回此结果持有的目录条目列表。
214
+ * @ja この結果が保持するディレクトリエントリー一覧を返します。
215
+ * @ko 이 결과가 보유한 디렉터리 항목 목록을 반환합니다.
216
+ */
217
+ getListing() { return this.listing; }
218
+ }
219
+ exports.SftpListingResult = SftpListingResult;
220
+ class OperationError extends Error {
221
+ constructor(value, message) {
222
+ super(message);
223
+ this.value = value;
224
+ }
225
+ }
226
+ const ok = () => new SftpResult(constants_1.SftpResultValue.Success);
227
+ function position(value) {
228
+ if (typeof value !== 'bigint' || value < 0n ||
229
+ value > BigInt(Number.MAX_SAFE_INTEGER)) {
230
+ throw new RangeError('ssh2 file offsets must be exact integers up to 2^53 - 1');
231
+ }
232
+ return Number(value);
233
+ }
234
+ function result(error) {
235
+ if (error instanceof OperationError)
236
+ return new SftpResult(error.value, error.message);
237
+ const err = error;
238
+ const statuses = [constants_1.SftpResultValue.Success, constants_1.SftpResultValue.EndOfFile, constants_1.SftpResultValue.NoSuchFile,
239
+ constants_1.SftpResultValue.PermissionDenied, constants_1.SftpResultValue.Failure, constants_1.SftpResultValue.BadMessage, constants_1.SftpResultValue.NoConnection,
240
+ constants_1.SftpResultValue.ConnectionLost, constants_1.SftpResultValue.OperationUnsupported, constants_1.SftpResultValue.InvalidHandle,
241
+ constants_1.SftpResultValue.NoSuchPath, constants_1.SftpResultValue.FileAlreadyExists, constants_1.SftpResultValue.WriteProtect, constants_1.SftpResultValue.NoMedia,
242
+ constants_1.SftpResultValue.NoSpaceOnFileSystem, constants_1.SftpResultValue.QuotaExceeded, constants_1.SftpResultValue.UnknownPrincipal,
243
+ constants_1.SftpResultValue.LockConflict, constants_1.SftpResultValue.DirectoryNotEmpty, constants_1.SftpResultValue.NotADirectory,
244
+ constants_1.SftpResultValue.InvalidFilename, constants_1.SftpResultValue.LinkLoop];
245
+ const code = typeof err.code === 'number' ? statuses[err.code]
246
+ : err.code === 'ECONNREFUSED' ? constants_1.SftpResultValue.Refused
247
+ : err.level === 'client-authentication' ? constants_1.SftpResultValue.AuthenticationFailed
248
+ : undefined;
249
+ return new SftpResult(code ?? constants_1.SftpResultValue.Error, err.message ?? String(error));
250
+ }
251
+ function attributes(path, input) {
252
+ const integer = (value) => {
253
+ if (value === undefined)
254
+ return undefined;
255
+ if (!Number.isSafeInteger(value) || value < 0) {
256
+ throw new RangeError('SFTP attribute exceeds exact integer range');
257
+ }
258
+ return BigInt(value);
259
+ };
260
+ const types = {
261
+ 8: FileType.Regular, 4: FileType.Directory, 10: FileType.Symlink,
262
+ 6: FileType.Block, 2: FileType.Character, 1: FileType.Fifo, 12: FileType.Socket,
263
+ };
264
+ return { path,
265
+ type: input.mode === undefined ? undefined
266
+ : types[Math.floor(input.mode / 4096) % 16] ?? FileType.Unknown,
267
+ size: integer(input.size), permissions: input.mode === undefined
268
+ ? undefined : input.mode % 4096,
269
+ userId: integer(input.uid), groupId: integer(input.gid),
270
+ accessTime: input.atime === undefined ? undefined : new Date(input.atime * 1000),
271
+ modificationTime: input.mtime === undefined ? undefined : new Date(input.mtime * 1000) };
272
+ }
273
+ /**
274
+ * Asynchronous SFTP client based on ssh2; file operations run in call order.
275
+ * @zh 基于 ssh2 的异步 SFTP 客户端,文件操作按调用顺序执行。
276
+ * @ja ssh2 ベースの非同期 SFTP クライアント。ファイル操作は呼び出し順に実行します。
277
+ * @ko ssh2 기반 비동기 SFTP 클라이언트. 파일 작업은 호출 순서대로 실행됩니다.
278
+ */
279
+ class Sftp {
280
+ constructor() {
281
+ /** 认证尝试轮次。 */
282
+ this.authRound = 0;
283
+ /** 是否已完成认证。 */
284
+ this.authenticated = false;
285
+ /** 用于唤醒等待器的事件总线。 */
286
+ this.events = new node_events_1.EventEmitter();
287
+ /** 确保文件操作按调用顺序执行的队列。 */
288
+ this.queue = new common_1.SerialQueue();
289
+ /** 接收数据或完成 RPC 时的进度回调,用于超时重置。 */
290
+ this.progress = () => { };
291
+ }
292
+ /**
293
+ * Establish an SSH handshake on port 22 by default; then call login
294
+ * to authenticate. Host trust is not verified automatically; applications
295
+ * can verify the host fingerprint via getSessionInfo before logging in.
296
+ * @zh 建立 SSH 握手,默认端口 22;随后调用 login 完成身份认证。
297
+ * 不自动核验主机可信性,应用可在登录前通过 getSessionInfo 核验主机指纹。
298
+ * @ja SSH ハンドシェイクを確立します。既定のポートは 22 で、
299
+ * その後 login で認証します。ホストの信頼性は自動検証しません。
300
+ * アプリケーションはログイン前に getSessionInfo で指紋を検証できます。
301
+ * @ko SSH 핸드셰이크를 수행하며 기본 포트는 22입니다. 이후 login으로 인증합니다.
302
+ * 호스트 신뢰성은 자동으로 검증하지 않습니다. 애플리케이션은 로그인 전에
303
+ * getSessionInfo로 호스트 지문을 검증할 수 있습니다.
304
+ */
305
+ connect(server, port = 22, timeout = time_1.Time.Zero) {
306
+ if (!(server instanceof ip_address_1.IpAddress))
307
+ throw new TypeError('Expected IpAddress');
308
+ (0, common_1.uint)(port, 65535);
309
+ return this.queue.run(async () => {
310
+ this.close();
311
+ this.failure = undefined;
312
+ const client = new ssh2_1.Client();
313
+ const transport = new node_net_1.Socket();
314
+ this.client = client;
315
+ this.transport = transport;
316
+ transport.on('data', () => this.progress());
317
+ transport.on('error', error => {
318
+ if (this.transport !== transport)
319
+ return;
320
+ this.failure = error;
321
+ this.events.emit('change');
322
+ });
323
+ client.on('error', error => {
324
+ if (this.client !== client)
325
+ return;
326
+ this.failure = error;
327
+ this.events.emit('change');
328
+ });
329
+ client.on('close', () => {
330
+ if (this.client !== client)
331
+ return;
332
+ this.client = undefined;
333
+ this.sftp = undefined;
334
+ this.nextAuth = undefined;
335
+ this.events.emit('change');
336
+ });
337
+ client.on('handshake', algorithms => {
338
+ this.algorithms = algorithms;
339
+ this.progress();
340
+ });
341
+ client.on('ready', () => {
342
+ this.authenticated = true;
343
+ this.events.emit('change');
344
+ });
345
+ try {
346
+ await this.timed(timeout, async () => {
347
+ transport.connect(port, server.toString());
348
+ client.connect({ sock: transport, username: '', readyTimeout: 0,
349
+ hostVerifier: (key) => { this.key = Buffer.from(key); return true; },
350
+ authHandler: (_methods, _partial, next) => {
351
+ this.nextAuth = next;
352
+ this.authRound++;
353
+ this.events.emit('change');
354
+ }, });
355
+ await this.state(() => !!this.nextAuth);
356
+ });
357
+ return ok();
358
+ }
359
+ catch (error) {
360
+ this.close();
361
+ return result(error);
362
+ }
363
+ });
364
+ }
365
+ /**
366
+ * Close the session immediately and return success;
367
+ * timeout is used only for argument validation.
368
+ * @zh 立即关闭会话并返回成功结果;timeout 仅作参数校验。
369
+ * @ja セッションを即座に閉じて成功結果を返します。
370
+ * timeout は引数の検証にのみ使用します。
371
+ * @ko 즉시 세션을 닫고 성공 결과를 반환합니다.
372
+ * timeout은 인수 검증에만 사용합니다.
373
+ */
374
+ disconnect(timeout = time_1.Time.Zero) {
375
+ (0, common_1.millisecondsOf)(timeout instanceof timeout_with_predicate_1.TimeoutWithPredicate
376
+ ? timeout.getPeriod() : timeout);
377
+ this.close();
378
+ return Promise.resolve(ok());
379
+ }
380
+ /**
381
+ * Destroy the SSH connection immediately and wake pending operations.
382
+ * @zh 立即销毁 SSH 连接并唤醒待完成操作。
383
+ * @ja SSH 接続を即座に破棄し、未完了の操作を起こします。
384
+ * @ko 즉시 SSH 연결을 해제하고 대기 중인 작업을 깨웁니다.
385
+ */
386
+ close() {
387
+ const client = this.client;
388
+ this.client = undefined;
389
+ this.sftp = undefined;
390
+ this.nextAuth = undefined;
391
+ this.authenticated = false;
392
+ this.key = undefined;
393
+ this.algorithms = undefined;
394
+ client?.destroy();
395
+ this.transport?.destroy();
396
+ this.transport = undefined;
397
+ this.events.emit('change');
398
+ }
399
+ login(name, passwordOrPublic, keyOrTimeout, passphrase = '', timeout = time_1.Time.Zero) {
400
+ const publicKey = typeof keyOrTimeout === 'string' || keyOrTimeout instanceof Uint8Array;
401
+ const duration = publicKey ? timeout : keyOrTimeout ?? time_1.Time.Zero;
402
+ let method;
403
+ if (publicKey) {
404
+ const key = ssh2_1.utils.parseKey(typeof keyOrTimeout === 'string'
405
+ ? keyOrTimeout : (0, common_1.bytes)(keyOrTimeout), passphrase);
406
+ if (key instanceof Error)
407
+ return Promise.resolve(result(key));
408
+ const advertised = ssh2_1.utils.parseKey(typeof passwordOrPublic === 'string'
409
+ ? passwordOrPublic : (0, common_1.bytes)(passwordOrPublic));
410
+ if (advertised instanceof Error || !key.getPublicSSH().equals(advertised.getPublicSSH())) {
411
+ return Promise.resolve(new SftpResult(constants_1.SftpResultValue.PublicKeyUnverified, 'Public and private keys do not match'));
412
+ }
413
+ method = { type: 'publickey', username: name, key };
414
+ }
415
+ else {
416
+ if (typeof passwordOrPublic !== 'string')
417
+ throw new TypeError('Expected password');
418
+ method = { type: 'password', username: name, password: passwordOrPublic };
419
+ }
420
+ return this.queue.run(async () => {
421
+ try {
422
+ await this.timed(duration, async () => {
423
+ if (!this.nextAuth)
424
+ throw new OperationError(constants_1.SftpResultValue.Disconnected, 'Connect before login');
425
+ const next = this.nextAuth;
426
+ this.nextAuth = undefined;
427
+ const round = this.authRound;
428
+ next(method);
429
+ await this.state(() => this.authenticated || this.authRound !== round);
430
+ if (!this.authenticated) {
431
+ throw new OperationError(constants_1.SftpResultValue.AuthenticationFailed, 'Authentication rejected');
432
+ }
433
+ this.sftp = await this.rpc(done => this.client.sftp(done));
434
+ });
435
+ return ok();
436
+ }
437
+ catch (error) {
438
+ return result(error);
439
+ }
440
+ });
441
+ }
442
+ /**
443
+ * Return a snapshot of the host public key and negotiated algorithms,
444
+ * or undefined if handshake information is not ready.
445
+ * @zh 返回主机公钥和协商算法的快照;握手信息未就绪时为 undefined。
446
+ * @ja ホスト公開鍵と合意したアルゴリズムのスナップショットを返します。
447
+ * ハンドシェイク情報が未準備なら undefined です。
448
+ * @ko 호스트 공개 키와 협상한 알고리즘의 스냅샷을 반환하며,
449
+ * 핸드셰이크 정보가 준비되지 않았으면 undefined입니다.
450
+ */
451
+ getSessionInfo() {
452
+ if (!this.key || !this.algorithms)
453
+ return undefined;
454
+ const { key, algorithms: a } = this;
455
+ const keyName = key.length >= 4
456
+ ? key.toString('ascii', 4, 4 + key.readUInt32BE()) : '';
457
+ const names = {
458
+ 'ssh-rsa': constants_1.SftpHostKeyType.Rsa, 'ssh-dss': constants_1.SftpHostKeyType.Dsa,
459
+ 'ecdsa-sha2-nistp256': constants_1.SftpHostKeyType.Ecdsa256,
460
+ 'ecdsa-sha2-nistp384': constants_1.SftpHostKeyType.Ecdsa384,
461
+ 'ecdsa-sha2-nistp521': constants_1.SftpHostKeyType.Ecdsa521,
462
+ 'ssh-ed25519': constants_1.SftpHostKeyType.Ed25519,
463
+ };
464
+ return { hostKey: { type: names[keyName] ?? constants_1.SftpHostKeyType.Unknown,
465
+ data: Uint8Array.from(key), sha1: (0, node_crypto_1.createHash)('sha1').update(key).digest(),
466
+ sha256: (0, node_crypto_1.createHash)('sha256').update(key).digest() },
467
+ keyExchangeAlgorithm: a.kex, hostKeyAlgorithm: a.serverHostKey,
468
+ clientToServerEncryptionAlgorithm: a.cs.cipher,
469
+ serverToClientEncryptionAlgorithm: a.sc.cipher,
470
+ clientToServerMacAlgorithm: a.cs.mac, serverToClientMacAlgorithm: a.sc.mac,
471
+ clientToServerCompressionAlgorithm: a.cs.compress,
472
+ serverToClientCompressionAlgorithm: a.sc.compress };
473
+ }
474
+ /**
475
+ * Ask the server to resolve a canonical absolute path.
476
+ * @zh 请求服务器解析规范化绝对路径。
477
+ * @ja 正規化された絶対パスの解決をサーバーに要求します。
478
+ * @ko 서버에 정규화된 절대 경로 확인을 요청합니다.
479
+ */
480
+ resolvePath(path, timeout = time_1.Time.Zero) {
481
+ return this.queue.run(async () => {
482
+ try {
483
+ const resolved = await this.timed(timeout, () => this.rpc(done => this.channel().realpath(path, done)));
484
+ return new SftpPathResult(ok(), resolved);
485
+ }
486
+ catch (error) {
487
+ return new SftpPathResult(result(error));
488
+ }
489
+ });
490
+ }
491
+ /**
492
+ * Query the server's default working directory for the current session.
493
+ * @zh 查询服务器对当前会话的默认工作目录。
494
+ * @ja 現在のセッションに対するサーバーの既定作業ディレクトリを照会します。
495
+ * @ko 현재 세션에 대한 서버의 기본 작업 디렉터리를 조회합니다.
496
+ */
497
+ getWorkingDirectory(timeout = time_1.Time.Zero) {
498
+ return this.resolvePath('.', timeout);
499
+ }
500
+ /**
501
+ * Query remote attributes; followLinks follows symbolic links by default,
502
+ * while false queries the link itself.
503
+ * @zh 查询远端属性;followLinks 默认跟随符号链接,false 查询链接自身。
504
+ * @ja リモート属性を照会します。followLinks は既定でシンボリックリンクを
505
+ * たどり、false ならリンク自体を照会します。
506
+ * @ko 원격 속성을 조회합니다. followLinks는 기본적으로 심볼릭 링크를 따르며,
507
+ * false이면 링크 자체를 조회합니다.
508
+ */
509
+ getAttributes(path, followLinks = true, timeout = time_1.Time.Zero) {
510
+ return this.queue.run(async () => {
511
+ try {
512
+ const data = await this.timed(timeout, () => this.rpc(done => (followLinks ? this.channel().stat(path, done) : this.channel().lstat(path, done))));
513
+ return new SftpAttributesResult(ok(), attributes(path, data));
514
+ }
515
+ catch (error) {
516
+ return new SftpAttributesResult(result(error));
517
+ }
518
+ });
519
+ }
520
+ /**
521
+ * Read directory entries and their attributes asynchronously.
522
+ * @zh 异步读取目录条目及其属性。
523
+ * @ja ディレクトリエントリーとその属性を非同期に読み取ります。
524
+ * @ko 디렉터리 항목과 속성을 비동기로 읽습니다.
525
+ */
526
+ getDirectoryListing(path, timeout = time_1.Time.Zero) {
527
+ return this.queue.run(async () => {
528
+ try {
529
+ const listing = await this.timed(timeout, () => this.rpc(done => this.channel().readdir(path, done)));
530
+ return new SftpListingResult(ok(), listing.map(entry => attributes(entry.filename, entry.attrs)));
531
+ }
532
+ catch (error) {
533
+ return new SftpListingResult(result(error));
534
+ }
535
+ });
536
+ }
537
+ /**
538
+ * Create a remote directory with default Unix permissions of 0o755.
539
+ * @zh 创建远端目录,默认 Unix 权限为 0o755。
540
+ * @ja リモートディレクトリを作成します。既定の Unix 権限は 0o755 です。
541
+ * @ko 원격 디렉터리를 생성하며 기본 Unix 권한은 0o755입니다.
542
+ */
543
+ createDirectory(path, permissions = 0o755, timeout = time_1.Time.Zero) {
544
+ (0, common_1.uint)(permissions, 0o7777);
545
+ return this.run(timeout, () => this.rpc(done => this.channel().mkdir(path, { mode: permissions }, done)));
546
+ }
547
+ /**
548
+ * Delete an empty remote directory.
549
+ * @zh 删除远端空目录。
550
+ * @ja 空のリモートディレクトリを削除します。
551
+ * @ko 비어 있는 원격 디렉터리를 삭제합니다.
552
+ */
553
+ deleteDirectory(path, timeout = time_1.Time.Zero) {
554
+ return this.run(timeout, () => this.rpc(done => this.channel().rmdir(path, done)));
555
+ }
556
+ /**
557
+ * Rename a remote path; overwrite true requires server support for
558
+ * the OpenSSH overwrite-rename extension.
559
+ * @zh 重命名远端路径;overwrite 为 true 时要求服务端支持 OpenSSH 覆盖重命名扩展。
560
+ * @ja リモートパスを改名します。overwrite が true の場合は
561
+ * OpenSSH の上書き改名拡張へのサーバー対応が必要です。
562
+ * @ko 원격 경로 이름을 변경합니다. overwrite가 true이면 서버가
563
+ * OpenSSH 덮어쓰기 이름 변경 확장을 지원해야 합니다.
564
+ */
565
+ rename(oldPath, newPath, overwrite = false, timeout = time_1.Time.Zero) {
566
+ return this.run(timeout, () => this.rpc(done => (overwrite
567
+ ? this.channel().ext_openssh_rename(oldPath, newPath, done)
568
+ : this.channel().rename(oldPath, newPath, done))));
569
+ }
570
+ /**
571
+ * Delete a remote file or symbolic link.
572
+ * @zh 删除远端文件或符号链接。
573
+ * @ja リモートファイルまたはシンボリックリンクを削除します。
574
+ * @ko 원격 파일 또는 심볼릭 링크를 삭제합니다.
575
+ */
576
+ deleteFile(path, timeout = time_1.Time.Zero) {
577
+ return this.run(timeout, () => this.rpc(done => this.channel().unlink(path, done)));
578
+ }
579
+ /**
580
+ * Download chunks from byte offset offset, awaiting callback sequentially;
581
+ * the maximum offset is 2^53-1.
582
+ * @zh 从字节偏移 offset 开始分块下载;依次等待 callback,偏移最大为 2^53−1。
583
+ * @ja バイト位置 offset からチャンク単位でダウンロードし、callback を順に
584
+ * 待機します。オフセットの最大値は 2^53-1 です。
585
+ * @ko 바이트 오프셋 offset부터 청크 단위로 다운로드하며 callback을
586
+ * 순서대로 기다립니다. 최대 오프셋은 2^53-1입니다.
587
+ */
588
+ download(path, callback, offset = 0n, timeout = time_1.Time.Zero) {
589
+ let at = position(offset);
590
+ return this.run(timeout, async () => {
591
+ const channel = this.channel();
592
+ const handle = await this.rpc(done => channel.open(path, 'r', done));
593
+ try {
594
+ for (;;) {
595
+ if (this.sftp !== channel)
596
+ throw new OperationError(constants_1.SftpResultValue.Disconnected, 'Transfer ended');
597
+ const data = Buffer.allocUnsafe(65536);
598
+ const start = at;
599
+ const count = await this.rpc(done => channel.read(handle, data, 0, data.length, start, (error, count) => done(error, count)));
600
+ at = position(BigInt(at) + BigInt(count));
601
+ const more = await callback(data.subarray(0, count));
602
+ if (typeof more !== 'boolean')
603
+ throw new TypeError('Expected callback boolean');
604
+ if (!more || !count)
605
+ break;
606
+ }
607
+ }
608
+ finally {
609
+ if (this.sftp === channel)
610
+ await this.rpc(done => channel.close(handle, done));
611
+ }
612
+ });
613
+ }
614
+ /**
615
+ * Upload a file using callback-provided chunks, awaiting each chunk's write.
616
+ * @zh 按回调提供的数据块上传文件,逐块等待写入完成。
617
+ * @ja コールバックが提供するチャンクでファイルをアップロードし、
618
+ * 各チャンクの書き込み完了を待ちます。
619
+ * @ko 콜백이 제공하는 청크로 파일을 업로드하며 각 청크의 쓰기 완료를 기다립니다.
620
+ * @param path - Remote file path.
621
+ * @zh path - 远端文件路径。
622
+ * @ja path - リモートファイルのパス。
623
+ * @ko path - 원격 파일 경로.
624
+ * @param callback - Callback that fills the buffer and sets size.
625
+ * @zh callback - 填充缓冲区和 size 的回调。
626
+ * @ja callback - バッファを埋めて size を設定するコールバック。
627
+ * @ko callback - 버퍼를 채우고 size를 설정하는 콜백.
628
+ * @param permissions - Permissions for new files; defaults to 0o644.
629
+ * @zh permissions - 新建文件权限,默认 0o644。
630
+ * @ja permissions - 新規ファイルの権限。既定は 0o644 です。
631
+ * @ko permissions - 새 파일 권한. 기본값은 0o644입니다.
632
+ * @param truncate - Whether to clear an existing file; defaults to true.
633
+ * @zh truncate - 是否清空现有文件,默认 true。
634
+ * @ja truncate - 既存ファイルを空にするか。既定は true です。
635
+ * @ko truncate - 기존 파일을 비울지 여부. 기본값은 true입니다.
636
+ * @param append - Whether to request append writes; defaults to false.
637
+ * @zh append - 是否要求追加写入,默认 false。
638
+ * @ja append - 追記書き込みを要求するか。既定は false です。
639
+ * @ko append - 추가 쓰기를 요청할지 여부. 기본값은 false입니다.
640
+ * @param offset - Starting byte offset; defaults to 0n, maximum 2^53-1.
641
+ * @zh offset - 起始字节偏移,默认 0n,最大 2^53−1。
642
+ * @ja offset - 開始バイトオフセット。既定は 0n、最大値は 2^53-1 です。
643
+ * @ko offset - 시작 바이트 오프셋. 기본값은 0n, 최대값은 2^53-1입니다.
644
+ * @param timeout - No-progress timeout configuration; no timeout by default.
645
+ * @zh timeout - 无进展超时配置,默认不限时。
646
+ * @ja timeout - 進捗がない場合のタイムアウト設定。既定では制限なしです。
647
+ * @ko timeout - 진행이 없을 때의 제한 시간 설정. 기본적으로 제한이 없습니다.
648
+ */
649
+ upload(path, callback, permissions = 0o644, truncate = true, append = false, offset = 0n, timeout = time_1.Time.Zero) {
650
+ let at = position(offset);
651
+ (0, common_1.uint)(permissions, 0o7777);
652
+ return this.run(timeout, async () => {
653
+ const channel = this.channel();
654
+ // SSH_FXF_WRITE | CREAT, with TRUNC and APPEND as independent flags.
655
+ const flags = 2 + 8 + (truncate ? 16 : 0) + (append ? 4 : 0);
656
+ const handle = await this.rpc(done => channel.open(path, flags, { mode: permissions }, done));
657
+ try {
658
+ for (;;) {
659
+ const data = Buffer.allocUnsafe(65536);
660
+ const chunk = { data, size: data.length };
661
+ const more = await callback(chunk);
662
+ if (this.sftp !== channel)
663
+ throw new OperationError(constants_1.SftpResultValue.Disconnected, 'Transfer ended');
664
+ if (typeof more !== 'boolean' || chunk.data !== data) {
665
+ throw new TypeError('Fill the provided upload buffer and return boolean');
666
+ }
667
+ (0, common_1.uint)(chunk.size, data.length);
668
+ if (chunk.size) {
669
+ const start = at;
670
+ await this.rpc(done => channel.write(handle, data, 0, chunk.size, start, done));
671
+ at = position(BigInt(at) + BigInt(chunk.size));
672
+ }
673
+ if (!more || !chunk.size)
674
+ break;
675
+ }
676
+ }
677
+ finally {
678
+ if (this.sftp === channel)
679
+ await this.rpc(done => channel.close(handle, done));
680
+ }
681
+ });
682
+ }
683
+ /** 将队列操作包装为标准 SftpResult 结果。 */
684
+ run(timeout, action) {
685
+ return this.queue.run(async () => {
686
+ try {
687
+ await this.timed(timeout, action);
688
+ return ok();
689
+ }
690
+ catch (error) {
691
+ return result(error);
692
+ }
693
+ });
694
+ }
695
+ /** 返回当前 SFTP 通道,未认证时抛出错误。 */
696
+ channel() {
697
+ if (!this.sftp)
698
+ throw new OperationError(constants_1.SftpResultValue.Disconnected, 'SFTP is not authenticated');
699
+ return this.sftp;
700
+ }
701
+ /** 等待 check 为 true、故障出现或连接关闭。 */
702
+ async state(check) {
703
+ await (0, common_1.waitFor)(this.events, () => check() || !!this.failure || !this.client);
704
+ if (this.failure)
705
+ throw this.failure;
706
+ if (!this.client)
707
+ throw new OperationError(constants_1.SftpResultValue.Disconnected, 'SSH connection closed');
708
+ }
709
+ /** 包装 ssh2 回调为 Promise,连接关闭时自动拒绝。 */
710
+ rpc(call) {
711
+ const client = this.client;
712
+ if (!client)
713
+ return Promise.reject(new OperationError(constants_1.SftpResultValue.Disconnected, 'SSH connection closed'));
714
+ return new Promise((resolve, reject) => {
715
+ const done = (error, value) => {
716
+ client.off('close', closed);
717
+ this.progress();
718
+ if (error)
719
+ reject(error);
720
+ else
721
+ resolve(value);
722
+ };
723
+ function closed() {
724
+ done(new OperationError(constants_1.SftpResultValue.Disconnected, 'SSH connection closed'));
725
+ }
726
+ client.once('close', closed);
727
+ try {
728
+ call(done);
729
+ }
730
+ catch (error) {
731
+ done(error);
732
+ }
733
+ });
734
+ }
735
+ /** 运行操作并应用超时;每次收到数据或 RPC 完成时重置计时。 */
736
+ async timed(timeout, action) {
737
+ const config = timeout instanceof timeout_with_predicate_1.TimeoutWithPredicate ? timeout
738
+ : new timeout_with_predicate_1.TimeoutWithPredicate(timeout);
739
+ const period = (0, common_1.millisecondsOf)(config.getPeriod());
740
+ let timer;
741
+ let stopped = false;
742
+ let timedOut = false;
743
+ let rejectTimeout;
744
+ const deadline = new Promise((_resolve, reject) => { rejectTimeout = reject; });
745
+ const client = this.client;
746
+ const closed = () => {
747
+ if (client !== this.client && !timedOut) {
748
+ rejectTimeout(new OperationError(constants_1.SftpResultValue.Disconnected, 'SSH connection closed'));
749
+ }
750
+ };
751
+ this.events.on('change', closed);
752
+ const touch = () => {
753
+ if (stopped || !period)
754
+ return;
755
+ if (timer)
756
+ clearTimeout(timer);
757
+ timer = setTimeout(() => {
758
+ try {
759
+ if (config.getPredicate()()) {
760
+ touch();
761
+ return;
762
+ }
763
+ timedOut = true;
764
+ rejectTimeout(new OperationError(constants_1.SftpResultValue.Timeout, 'SFTP operation timed out'));
765
+ }
766
+ catch (error) {
767
+ timedOut = true;
768
+ rejectTimeout(error);
769
+ }
770
+ this.close();
771
+ }, period);
772
+ };
773
+ this.progress = touch;
774
+ touch();
775
+ try {
776
+ const operation = action();
777
+ const value = await Promise.race([operation, deadline]);
778
+ if (timedOut)
779
+ throw new OperationError(constants_1.SftpResultValue.Timeout, 'SFTP operation timed out');
780
+ return value;
781
+ }
782
+ finally {
783
+ stopped = true;
784
+ if (timer)
785
+ clearTimeout(timer);
786
+ this.events.off('change', closed);
787
+ this.progress = () => { };
788
+ }
789
+ }
790
+ }
791
+ /**
792
+ * Basic result type.
793
+ * @zh 基本结果类型。
794
+ * @ja 基本結果型。
795
+ * @ko 기본 결과 타입.
796
+ */
797
+ Sftp.Result = SftpResult;
798
+ /**
799
+ * Path result type.
800
+ * @zh 路径结果类型。
801
+ * @ja パス結果型。
802
+ * @ko 경로 결과 타입.
803
+ */
804
+ Sftp.PathResult = SftpPathResult;
805
+ /**
806
+ * Attributes result type.
807
+ * @zh 属性结果类型。
808
+ * @ja 属性結果型。
809
+ * @ko 속성 결과 타입.
810
+ */
811
+ Sftp.AttributesResult = SftpAttributesResult;
812
+ /**
813
+ * Directory listing result type.
814
+ * @zh 目录列表结果类型。
815
+ * @ja ディレクトリ一覧結果型。
816
+ * @ko 디렉터리 목록 결과 타입.
817
+ */
818
+ Sftp.ListingResult = SftpListingResult;
819
+ /**
820
+ * Server host public key type.
821
+ * @zh 服务端主机公钥类型。
822
+ * @ja サーバーホストの公開鍵型。
823
+ * @ko 서버 호스트 공개 키 타입.
824
+ */
825
+ Sftp.HostKeyType = constants_1.SftpHostKeyType;
826
+ exports.Sftp = Sftp;