camstreamerlib 4.0.0-beta.10 → 4.0.0-beta.101

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 (408) hide show
  1. package/README.md +143 -38
  2. package/cjs/CamOverlayAPI.d.ts +579 -341
  3. package/cjs/CamOverlayAPI.js +112 -149
  4. package/cjs/CamScripterAPI.d.ts +44 -17
  5. package/cjs/CamScripterAPI.js +50 -34
  6. package/cjs/CamStreamerAPI.d.ts +2080 -14
  7. package/cjs/CamStreamerAPI.js +171 -44
  8. package/cjs/CamSwitcherAPI.d.ts +158 -43
  9. package/cjs/CamSwitcherAPI.js +138 -122
  10. package/cjs/PlaneTrackerAPI.d.ts +241 -0
  11. package/cjs/PlaneTrackerAPI.js +254 -0
  12. package/cjs/VapixAPI.d.ts +84 -44
  13. package/cjs/VapixAPI.js +285 -213
  14. package/cjs/{CreatePackage.js → bin/CreatePackage.js} +44 -18
  15. package/cjs/errors/errors.d.ts +69 -4
  16. package/cjs/errors/errors.js +138 -7
  17. package/cjs/index.d.ts +20 -7
  18. package/cjs/index.js +28 -9
  19. package/cjs/internal/ProxyClient.d.ts +8 -9
  20. package/cjs/internal/ProxyClient.js +28 -34
  21. package/cjs/internal/WsEvents.d.ts +37 -0
  22. package/cjs/{CamSwitcherEvents.js → internal/WsEvents.js} +28 -22
  23. package/cjs/internal/types.d.ts +47 -0
  24. package/cjs/internal/types.js +2 -0
  25. package/cjs/internal/utils.d.ts +3 -1
  26. package/cjs/internal/utils.js +15 -3
  27. package/cjs/internal/versionCompare.d.ts +2 -2
  28. package/cjs/node/CamOverlayDrawingAPI.d.ts +41 -0
  29. package/cjs/{CamOverlayDrawingAPI.js → node/CamOverlayDrawingAPI.js} +28 -20
  30. package/{esm → cjs/node}/CamOverlayPainter/Frame.d.ts +8 -37
  31. package/cjs/{CamOverlayPainter → node/CamOverlayPainter}/Frame.js +33 -0
  32. package/cjs/{CamOverlayPainter → node/CamOverlayPainter}/Painter.d.ts +5 -21
  33. package/cjs/{CamOverlayPainter → node/CamOverlayPainter}/Painter.js +5 -17
  34. package/cjs/node/CamOverlayPainter/ResourceManager.d.ts +15 -0
  35. package/cjs/node/CamOverlayPainter/ResourceManager.js +72 -0
  36. package/cjs/node/CamScripterAPICameraEventsGenerator.d.ts +31 -0
  37. package/cjs/{CamScripterAPICameraEventsGenerator.js → node/CamScripterAPICameraEventsGenerator.js} +13 -13
  38. package/cjs/node/DefaultClient.d.ts +7 -6
  39. package/cjs/node/DefaultClient.js +12 -14
  40. package/cjs/{internal → node}/Digest.js +24 -1
  41. package/cjs/node/Digest.test.js +13 -0
  42. package/cjs/node/HttpRequestSender.d.ts +1 -0
  43. package/cjs/node/HttpRequestSender.js +14 -4
  44. package/cjs/node/HttpServer.d.ts +1 -1
  45. package/cjs/node/HttpServer.js +29 -6
  46. package/cjs/node/TimeZoneDaemon.d.ts +6 -0
  47. package/cjs/node/TimeZoneDaemon.js +29 -0
  48. package/cjs/node/VapixEvents.d.ts +16 -0
  49. package/cjs/{VapixEvents.js → node/VapixEvents.js} +10 -10
  50. package/cjs/node/WsClient.d.ts +9 -18
  51. package/cjs/node/WsClient.js +27 -20
  52. package/cjs/node/events/AxisCameraStationEvents.d.ts +12 -0
  53. package/cjs/node/events/AxisCameraStationEvents.js +53 -0
  54. package/cjs/node/events/GenetecAgent.d.ts +16 -0
  55. package/cjs/node/events/GenetecAgent.js +124 -0
  56. package/cjs/node/index.d.ts +18 -2
  57. package/cjs/node/index.js +39 -5
  58. package/cjs/{models/CamOverlayAPI/widgetsSchema.d.ts → types/CamOverlayAPI/CamOverlayAPI.d.ts} +2356 -849
  59. package/cjs/types/CamOverlayAPI/CamOverlayAPI.js +92 -0
  60. package/cjs/{models → types}/CamOverlayAPI/accuweatherSchema.d.ts +19 -19
  61. package/cjs/{models → types}/CamOverlayAPI/accuweatherSchema.js +7 -8
  62. package/cjs/{models → types}/CamOverlayAPI/customGraphicsSchema.d.ts +122 -121
  63. package/cjs/{models → types}/CamOverlayAPI/customGraphicsSchema.js +5 -6
  64. package/{esm/models → cjs/types}/CamOverlayAPI/imagesSchema.d.ts +21 -21
  65. package/cjs/types/CamOverlayAPI/imagesSchema.js +9 -0
  66. package/cjs/{models → types}/CamOverlayAPI/index.d.ts +2 -4
  67. package/cjs/{models → types}/CamOverlayAPI/index.js +2 -4
  68. package/cjs/{models → types}/CamOverlayAPI/infotickerSchema.d.ts +27 -27
  69. package/cjs/{models → types}/CamOverlayAPI/infotickerSchema.js +6 -7
  70. package/{esm/models → cjs/types}/CamOverlayAPI/pipSchema.d.ts +23 -23
  71. package/cjs/{models → types}/CamOverlayAPI/pipSchema.js +5 -6
  72. package/{esm/models → cjs/types}/CamOverlayAPI/ptzCompassSchema.d.ts +20 -17
  73. package/cjs/{models → types}/CamOverlayAPI/ptzCompassSchema.js +5 -5
  74. package/{esm/models → cjs/types}/CamOverlayAPI/ptzSchema.d.ts +30 -30
  75. package/cjs/types/CamOverlayAPI/ptzSchema.js +12 -0
  76. package/cjs/types/CamOverlayAPI/scoreBoardSchema.d.ts +357 -0
  77. package/cjs/types/CamOverlayAPI/scoreBoardSchema.js +132 -0
  78. package/cjs/{models → types}/CamOverlayAPI/screenSharingSchema.d.ts +17 -17
  79. package/cjs/types/CamOverlayAPI/screenSharingSchema.js +8 -0
  80. package/{esm/models/CamOverlayAPI/widgetCommonSchema.d.ts → cjs/types/CamOverlayAPI/serviceCommonTypes.d.ts} +79 -60
  81. package/cjs/{models/CamOverlayAPI/widgetCommonSchema.js → types/CamOverlayAPI/serviceCommonTypes.js} +33 -18
  82. package/{esm/models → cjs/types}/CamOverlayAPI/webCameraSharingSchema.d.ts +17 -17
  83. package/cjs/types/CamOverlayAPI/webCameraSharingSchema.js +8 -0
  84. package/cjs/types/CamOverlayDrawingAPI.d.ts +48 -0
  85. package/cjs/types/CamOverlayDrawingAPI.js +2 -0
  86. package/cjs/types/CamOverlayPainter.d.ts +76 -0
  87. package/cjs/types/CamOverlayPainter.js +14 -0
  88. package/cjs/types/CamScripterAPI.d.ts +86 -23
  89. package/cjs/types/CamScripterAPI.js +24 -8
  90. package/cjs/types/CamScripterAPICameraEventsGenerator.d.ts +45 -0
  91. package/cjs/types/CamScripterAPICameraEventsGenerator.js +2 -0
  92. package/cjs/types/CamStreamerAPI/CamStreamerAPI.d.ts +13791 -0
  93. package/cjs/types/CamStreamerAPI/CamStreamerAPI.js +153 -0
  94. package/cjs/types/CamStreamerAPI/churchSchema.d.ts +275 -0
  95. package/cjs/types/CamStreamerAPI/churchSchema.js +11 -0
  96. package/cjs/types/CamStreamerAPI/daCastSchema.d.ts +275 -0
  97. package/cjs/types/CamStreamerAPI/daCastSchema.js +11 -0
  98. package/cjs/types/CamStreamerAPI/dailymotionSchema.d.ts +275 -0
  99. package/cjs/types/CamStreamerAPI/dailymotionSchema.js +11 -0
  100. package/cjs/types/CamStreamerAPI/facebookSchema.d.ts +275 -0
  101. package/cjs/types/CamStreamerAPI/facebookSchema.js +11 -0
  102. package/cjs/types/CamStreamerAPI/gameChangerSchema.d.ts +275 -0
  103. package/cjs/types/CamStreamerAPI/gameChangerSchema.js +11 -0
  104. package/cjs/types/CamStreamerAPI/hlsPullSchema.d.ts +275 -0
  105. package/cjs/types/CamStreamerAPI/hlsPullSchema.js +11 -0
  106. package/cjs/types/CamStreamerAPI/hlsPushSchema.d.ts +275 -0
  107. package/cjs/types/CamStreamerAPI/hlsPushSchema.js +11 -0
  108. package/cjs/types/CamStreamerAPI/ibmSchema.d.ts +275 -0
  109. package/cjs/types/CamStreamerAPI/ibmSchema.js +11 -0
  110. package/cjs/types/CamStreamerAPI/index.d.ts +8 -0
  111. package/cjs/types/CamStreamerAPI/index.js +24 -0
  112. package/cjs/types/CamStreamerAPI/microsoftAzureSchema.d.ts +275 -0
  113. package/cjs/types/CamStreamerAPI/microsoftAzureSchema.js +11 -0
  114. package/cjs/types/CamStreamerAPI/microsoftStreamSchema.d.ts +275 -0
  115. package/cjs/types/CamStreamerAPI/microsoftStreamSchema.js +11 -0
  116. package/cjs/types/CamStreamerAPI/mpegDvbSchema.d.ts +323 -0
  117. package/cjs/types/CamStreamerAPI/mpegDvbSchema.js +27 -0
  118. package/cjs/types/{CamStreamerAPI.d.ts → CamStreamerAPI/oldStreamSchema.d.ts} +100 -31
  119. package/cjs/types/CamStreamerAPI/oldStreamSchema.js +53 -0
  120. package/cjs/types/CamStreamerAPI/rtmpSchema.d.ts +284 -0
  121. package/cjs/types/CamStreamerAPI/rtmpSchema.js +14 -0
  122. package/cjs/types/CamStreamerAPI/sdCardSchema.d.ts +275 -0
  123. package/cjs/types/CamStreamerAPI/sdCardSchema.js +11 -0
  124. package/cjs/types/CamStreamerAPI/srtSchema.d.ts +275 -0
  125. package/cjs/types/CamStreamerAPI/srtSchema.js +11 -0
  126. package/cjs/types/CamStreamerAPI/streamCommonTypes.d.ts +492 -0
  127. package/cjs/types/CamStreamerAPI/streamCommonTypes.js +85 -0
  128. package/cjs/types/CamStreamerAPI/twitchSchema.d.ts +275 -0
  129. package/cjs/types/CamStreamerAPI/twitchSchema.js +11 -0
  130. package/cjs/types/CamStreamerAPI/vimeoSchema.d.ts +275 -0
  131. package/cjs/types/CamStreamerAPI/vimeoSchema.js +11 -0
  132. package/cjs/types/CamStreamerAPI/windySchema.d.ts +275 -0
  133. package/cjs/types/CamStreamerAPI/windySchema.js +11 -0
  134. package/cjs/types/CamStreamerAPI/wowzaSchema.d.ts +275 -0
  135. package/cjs/types/CamStreamerAPI/wowzaSchema.js +11 -0
  136. package/cjs/types/CamStreamerAPI/youtubeSchema.d.ts +317 -0
  137. package/cjs/types/CamStreamerAPI/youtubeSchema.js +25 -0
  138. package/cjs/types/CamSwitcherAPI.d.ts +189 -110
  139. package/cjs/types/CamSwitcherAPI.js +38 -1
  140. package/cjs/{events → types}/GenetecAgent.d.ts +47 -47
  141. package/cjs/types/GenetecAgent.js +31 -0
  142. package/cjs/types/PlaneTrackerAPI.d.ts +980 -0
  143. package/cjs/types/PlaneTrackerAPI.js +333 -0
  144. package/cjs/types/VapixAPI.d.ts +339 -99
  145. package/cjs/types/VapixAPI.js +66 -3
  146. package/cjs/types/VapixEvents.d.ts +15 -0
  147. package/cjs/types/VapixEvents.js +2 -0
  148. package/cjs/types/common.d.ts +18 -5
  149. package/cjs/types/common.js +5 -2
  150. package/cjs/types/ws/CamOverlayEvents.d.ts +88 -0
  151. package/cjs/types/ws/CamOverlayEvents.js +19 -0
  152. package/cjs/types/ws/CamStreamerEvents.d.ts +249 -0
  153. package/cjs/types/ws/CamStreamerEvents.js +32 -0
  154. package/cjs/types/ws/PlaneTrackerEvents.d.ts +1703 -0
  155. package/cjs/types/ws/PlaneTrackerEvents.js +207 -0
  156. package/cjs/web/DefaultClient.d.ts +7 -4
  157. package/cjs/web/DefaultClient.js +25 -9
  158. package/cjs/web/WsClient.d.ts +9 -5
  159. package/cjs/web/WsClient.js +16 -18
  160. package/cjs/ws/CamOverlayEvents.d.ts +8 -0
  161. package/cjs/ws/CamOverlayEvents.js +24 -0
  162. package/cjs/ws/CamStreamerEvents.d.ts +8 -0
  163. package/cjs/ws/CamStreamerEvents.js +24 -0
  164. package/cjs/ws/CamSwitcherEvents.d.ts +8 -0
  165. package/cjs/ws/CamSwitcherEvents.js +24 -0
  166. package/cjs/ws/PlaneTrackerEvents.d.ts +9 -0
  167. package/cjs/ws/PlaneTrackerEvents.js +30 -0
  168. package/esm/CamOverlayAPI.js +111 -148
  169. package/esm/CamScripterAPI.js +48 -32
  170. package/esm/CamStreamerAPI.js +166 -40
  171. package/esm/CamSwitcherAPI.js +136 -120
  172. package/esm/PlaneTrackerAPI.js +250 -0
  173. package/esm/VapixAPI.js +285 -213
  174. package/esm/{CreatePackage.js → bin/CreatePackage.js} +16 -16
  175. package/esm/errors/errors.js +120 -6
  176. package/esm/index.js +20 -7
  177. package/esm/internal/ProxyClient.js +28 -34
  178. package/esm/{CamSwitcherEvents.js → internal/WsEvents.js} +26 -20
  179. package/esm/internal/types.js +1 -0
  180. package/esm/internal/utils.js +11 -1
  181. package/esm/{CamOverlayDrawingAPI.js → node/CamOverlayDrawingAPI.js} +26 -18
  182. package/esm/{CamOverlayPainter → node/CamOverlayPainter}/Frame.js +33 -0
  183. package/esm/{CamOverlayPainter → node/CamOverlayPainter}/Painter.js +2 -13
  184. package/esm/{CamOverlayPainter → node/CamOverlayPainter}/ResourceManager.js +7 -5
  185. package/esm/{CamScripterAPICameraEventsGenerator.js → node/CamScripterAPICameraEventsGenerator.js} +11 -11
  186. package/esm/node/DefaultClient.js +12 -14
  187. package/esm/node/Digest.test.js +11 -0
  188. package/esm/node/HttpRequestSender.js +14 -4
  189. package/esm/node/HttpServer.js +1 -1
  190. package/esm/node/TimeZoneDaemon.js +25 -0
  191. package/esm/{VapixEvents.js → node/VapixEvents.js} +10 -10
  192. package/esm/node/WsClient.js +22 -15
  193. package/esm/{events → node/events}/AxisCameraStationEvents.js +18 -13
  194. package/esm/node/events/GenetecAgent.js +120 -0
  195. package/esm/node/index.js +18 -2
  196. package/esm/types/CamOverlayAPI/CamOverlayAPI.js +76 -0
  197. package/esm/{models → types}/CamOverlayAPI/accuweatherSchema.js +3 -4
  198. package/esm/{models → types}/CamOverlayAPI/customGraphicsSchema.js +3 -4
  199. package/esm/types/CamOverlayAPI/imagesSchema.js +6 -0
  200. package/esm/{models → types}/CamOverlayAPI/index.js +2 -4
  201. package/esm/{models → types}/CamOverlayAPI/infotickerSchema.js +3 -4
  202. package/esm/{models → types}/CamOverlayAPI/pipSchema.js +4 -5
  203. package/esm/{models → types}/CamOverlayAPI/ptzCompassSchema.js +4 -4
  204. package/esm/types/CamOverlayAPI/ptzSchema.js +9 -0
  205. package/esm/types/CamOverlayAPI/scoreBoardSchema.js +129 -0
  206. package/esm/types/CamOverlayAPI/screenSharingSchema.js +5 -0
  207. package/esm/{models/CamOverlayAPI/widgetCommonSchema.js → types/CamOverlayAPI/serviceCommonTypes.js} +32 -17
  208. package/esm/types/CamOverlayAPI/webCameraSharingSchema.js +5 -0
  209. package/esm/types/CamOverlayDrawingAPI.js +1 -0
  210. package/esm/types/CamOverlayPainter.js +11 -0
  211. package/esm/types/CamScripterAPI.js +23 -7
  212. package/esm/types/CamScripterAPICameraEventsGenerator.js +1 -0
  213. package/esm/types/CamStreamerAPI/CamStreamerAPI.js +131 -0
  214. package/esm/types/CamStreamerAPI/churchSchema.js +5 -0
  215. package/esm/types/CamStreamerAPI/daCastSchema.js +5 -0
  216. package/esm/types/CamStreamerAPI/dailymotionSchema.js +5 -0
  217. package/esm/types/CamStreamerAPI/facebookSchema.js +5 -0
  218. package/esm/types/CamStreamerAPI/gameChangerSchema.js +5 -0
  219. package/esm/types/CamStreamerAPI/hlsPullSchema.js +5 -0
  220. package/esm/types/CamStreamerAPI/hlsPushSchema.js +5 -0
  221. package/esm/types/CamStreamerAPI/ibmSchema.js +5 -0
  222. package/esm/types/CamStreamerAPI/index.js +8 -0
  223. package/esm/types/CamStreamerAPI/microsoftAzureSchema.js +5 -0
  224. package/esm/types/CamStreamerAPI/microsoftStreamSchema.js +5 -0
  225. package/esm/types/CamStreamerAPI/mpegDvbSchema.js +21 -0
  226. package/esm/types/CamStreamerAPI/oldStreamSchema.js +50 -0
  227. package/esm/types/CamStreamerAPI/rtmpSchema.js +8 -0
  228. package/esm/types/CamStreamerAPI/sdCardSchema.js +5 -0
  229. package/esm/types/CamStreamerAPI/srtSchema.js +5 -0
  230. package/esm/types/CamStreamerAPI/streamCommonTypes.js +82 -0
  231. package/esm/types/CamStreamerAPI/twitchSchema.js +5 -0
  232. package/esm/types/CamStreamerAPI/vimeoSchema.js +5 -0
  233. package/esm/types/CamStreamerAPI/windySchema.js +5 -0
  234. package/esm/types/CamStreamerAPI/wowzaSchema.js +5 -0
  235. package/esm/types/CamStreamerAPI/youtubeSchema.js +19 -0
  236. package/esm/types/CamSwitcherAPI.js +38 -1
  237. package/esm/types/GenetecAgent.js +28 -0
  238. package/esm/types/PlaneTrackerAPI.js +330 -0
  239. package/esm/types/VapixAPI.js +65 -2
  240. package/esm/types/VapixEvents.js +1 -0
  241. package/esm/types/common.js +4 -1
  242. package/esm/types/ws/CamOverlayEvents.js +16 -0
  243. package/esm/types/ws/CamStreamerEvents.js +29 -0
  244. package/esm/types/ws/PlaneTrackerEvents.js +204 -0
  245. package/esm/web/DefaultClient.js +25 -9
  246. package/esm/web/WsClient.js +16 -18
  247. package/esm/ws/CamOverlayEvents.js +20 -0
  248. package/esm/ws/CamStreamerEvents.js +20 -0
  249. package/esm/ws/CamSwitcherEvents.js +20 -0
  250. package/esm/ws/PlaneTrackerEvents.js +26 -0
  251. package/package.json +43 -9
  252. package/{esm → types}/CamOverlayAPI.d.ts +579 -341
  253. package/types/CamScripterAPI.d.ts +46 -0
  254. package/types/CamStreamerAPI.d.ts +2082 -0
  255. package/types/CamSwitcherAPI.d.ts +167 -0
  256. package/types/PlaneTrackerAPI.d.ts +241 -0
  257. package/types/VapixAPI.d.ts +118 -0
  258. package/types/bin/CreatePackage.d.ts +1 -0
  259. package/types/errors/errors.d.ts +102 -0
  260. package/types/index.d.ts +27 -0
  261. package/types/internal/ProxyClient.d.ts +10 -0
  262. package/types/internal/WsEvents.d.ts +37 -0
  263. package/types/internal/types.d.ts +47 -0
  264. package/{esm → types}/internal/utils.d.ts +3 -1
  265. package/{esm → types}/internal/versionCompare.d.ts +2 -2
  266. package/types/node/CamOverlayDrawingAPI.d.ts +41 -0
  267. package/{cjs → types/node}/CamOverlayPainter/Frame.d.ts +8 -37
  268. package/{esm → types/node}/CamOverlayPainter/Painter.d.ts +5 -21
  269. package/types/node/CamOverlayPainter/ResourceManager.d.ts +15 -0
  270. package/types/node/CamScripterAPICameraEventsGenerator.d.ts +31 -0
  271. package/types/node/DefaultClient.d.ts +16 -0
  272. package/types/node/Digest.test.d.ts +1 -0
  273. package/{esm → types}/node/HttpRequestSender.d.ts +1 -0
  274. package/{esm → types}/node/HttpServer.d.ts +1 -1
  275. package/types/node/TimeZoneDaemon.d.ts +6 -0
  276. package/types/node/VapixEvents.d.ts +16 -0
  277. package/types/node/WsClient.d.ts +30 -0
  278. package/types/node/events/AxisCameraStationEvents.d.ts +12 -0
  279. package/types/node/events/GenetecAgent.d.ts +16 -0
  280. package/types/node/index.d.ts +18 -0
  281. package/{esm/models/CamOverlayAPI/widgetsSchema.d.ts → types/types/CamOverlayAPI/CamOverlayAPI.d.ts} +2356 -849
  282. package/{esm/models → types/types}/CamOverlayAPI/accuweatherSchema.d.ts +19 -19
  283. package/{esm/models → types/types}/CamOverlayAPI/customGraphicsSchema.d.ts +122 -121
  284. package/{cjs/models → types/types}/CamOverlayAPI/imagesSchema.d.ts +21 -21
  285. package/{esm/models → types/types}/CamOverlayAPI/index.d.ts +2 -4
  286. package/{esm/models → types/types}/CamOverlayAPI/infotickerSchema.d.ts +27 -27
  287. package/{cjs/models → types/types}/CamOverlayAPI/pipSchema.d.ts +23 -23
  288. package/{cjs/models → types/types}/CamOverlayAPI/ptzCompassSchema.d.ts +20 -17
  289. package/{cjs/models → types/types}/CamOverlayAPI/ptzSchema.d.ts +30 -30
  290. package/types/types/CamOverlayAPI/scoreBoardSchema.d.ts +357 -0
  291. package/{esm/models → types/types}/CamOverlayAPI/screenSharingSchema.d.ts +17 -17
  292. package/{cjs/models/CamOverlayAPI/widgetCommonSchema.d.ts → types/types/CamOverlayAPI/serviceCommonTypes.d.ts} +79 -60
  293. package/{cjs/models → types/types}/CamOverlayAPI/webCameraSharingSchema.d.ts +17 -17
  294. package/types/types/CamOverlayDrawingAPI.d.ts +48 -0
  295. package/types/types/CamOverlayPainter.d.ts +76 -0
  296. package/types/types/CamScripterAPI.d.ts +130 -0
  297. package/types/types/CamScripterAPICameraEventsGenerator.d.ts +45 -0
  298. package/types/types/CamStreamerAPI/CamStreamerAPI.d.ts +13791 -0
  299. package/types/types/CamStreamerAPI/churchSchema.d.ts +275 -0
  300. package/types/types/CamStreamerAPI/daCastSchema.d.ts +275 -0
  301. package/types/types/CamStreamerAPI/dailymotionSchema.d.ts +275 -0
  302. package/types/types/CamStreamerAPI/facebookSchema.d.ts +275 -0
  303. package/types/types/CamStreamerAPI/gameChangerSchema.d.ts +275 -0
  304. package/types/types/CamStreamerAPI/hlsPullSchema.d.ts +275 -0
  305. package/types/types/CamStreamerAPI/hlsPushSchema.d.ts +275 -0
  306. package/types/types/CamStreamerAPI/ibmSchema.d.ts +275 -0
  307. package/types/types/CamStreamerAPI/index.d.ts +8 -0
  308. package/types/types/CamStreamerAPI/microsoftAzureSchema.d.ts +275 -0
  309. package/types/types/CamStreamerAPI/microsoftStreamSchema.d.ts +275 -0
  310. package/types/types/CamStreamerAPI/mpegDvbSchema.d.ts +323 -0
  311. package/{esm/types/CamStreamerAPI.d.ts → types/types/CamStreamerAPI/oldStreamSchema.d.ts} +100 -31
  312. package/types/types/CamStreamerAPI/rtmpSchema.d.ts +284 -0
  313. package/types/types/CamStreamerAPI/sdCardSchema.d.ts +275 -0
  314. package/types/types/CamStreamerAPI/srtSchema.d.ts +275 -0
  315. package/types/types/CamStreamerAPI/streamCommonTypes.d.ts +492 -0
  316. package/types/types/CamStreamerAPI/twitchSchema.d.ts +275 -0
  317. package/types/types/CamStreamerAPI/vimeoSchema.d.ts +275 -0
  318. package/types/types/CamStreamerAPI/windySchema.d.ts +275 -0
  319. package/types/types/CamStreamerAPI/wowzaSchema.d.ts +275 -0
  320. package/types/types/CamStreamerAPI/youtubeSchema.d.ts +317 -0
  321. package/{esm → types}/types/CamSwitcherAPI.d.ts +189 -110
  322. package/{esm/events → types/types}/GenetecAgent.d.ts +47 -47
  323. package/types/types/PlaneTrackerAPI.d.ts +980 -0
  324. package/{esm → types}/types/VapixAPI.d.ts +339 -99
  325. package/types/types/VapixEvents.d.ts +15 -0
  326. package/{esm → types}/types/common.d.ts +18 -5
  327. package/types/types/ws/CamOverlayEvents.d.ts +88 -0
  328. package/types/types/ws/CamStreamerEvents.d.ts +249 -0
  329. package/types/types/ws/PlaneTrackerEvents.d.ts +1703 -0
  330. package/types/web/DefaultClient.d.ts +8 -0
  331. package/types/web/WsClient.d.ts +17 -0
  332. package/types/ws/CamOverlayEvents.d.ts +8 -0
  333. package/types/ws/CamStreamerEvents.d.ts +8 -0
  334. package/types/ws/CamSwitcherEvents.d.ts +8 -0
  335. package/types/ws/PlaneTrackerEvents.d.ts +9 -0
  336. package/cjs/CamOverlayDrawingAPI.d.ts +0 -86
  337. package/cjs/CamOverlayPainter/ResourceManager.d.ts +0 -14
  338. package/cjs/CamOverlayPainter/ResourceManager.js +0 -46
  339. package/cjs/CamScripterAPICameraEventsGenerator.d.ts +0 -74
  340. package/cjs/CamSwitcherEvents.d.ts +0 -18
  341. package/cjs/VapixEvents.d.ts +0 -43
  342. package/cjs/events/AxisCameraStationEvents.d.ts +0 -9
  343. package/cjs/events/AxisCameraStationEvents.js +0 -48
  344. package/cjs/events/GenetecAgent.js +0 -123
  345. package/cjs/internal/common.d.ts +0 -34
  346. package/cjs/internal/common.js +0 -27
  347. package/cjs/models/CamOverlayAPI/constants.d.ts +0 -11
  348. package/cjs/models/CamOverlayAPI/constants.js +0 -14
  349. package/cjs/models/CamOverlayAPI/fileSchema.d.ts +0 -28
  350. package/cjs/models/CamOverlayAPI/fileSchema.js +0 -17
  351. package/cjs/models/CamOverlayAPI/imagesSchema.js +0 -10
  352. package/cjs/models/CamOverlayAPI/ptzSchema.js +0 -13
  353. package/cjs/models/CamOverlayAPI/screenSharingSchema.js +0 -9
  354. package/cjs/models/CamOverlayAPI/webCameraSharingSchema.js +0 -9
  355. package/cjs/models/CamOverlayAPI/widgetsSchema.js +0 -27
  356. package/cjs/node/WsEventClient.d.ts +0 -13
  357. package/cjs/node/WsEventClient.js +0 -22
  358. package/cjs/types/CamOverlayAPI.d.ts +0 -328
  359. package/cjs/types/CamOverlayAPI.js +0 -26
  360. package/cjs/types/CamStreamerAPI.js +0 -28
  361. package/esm/CamOverlayDrawingAPI.d.ts +0 -86
  362. package/esm/CamOverlayPainter/ResourceManager.d.ts +0 -14
  363. package/esm/CamScripterAPI.d.ts +0 -19
  364. package/esm/CamScripterAPICameraEventsGenerator.d.ts +0 -74
  365. package/esm/CamStreamerAPI.d.ts +0 -16
  366. package/esm/CamSwitcherAPI.d.ts +0 -52
  367. package/esm/CamSwitcherEvents.d.ts +0 -18
  368. package/esm/VapixAPI.d.ts +0 -78
  369. package/esm/VapixEvents.d.ts +0 -43
  370. package/esm/errors/errors.d.ts +0 -37
  371. package/esm/events/AxisCameraStationEvents.d.ts +0 -9
  372. package/esm/events/GenetecAgent.js +0 -119
  373. package/esm/index.d.ts +0 -14
  374. package/esm/internal/ProxyClient.d.ts +0 -11
  375. package/esm/internal/common.d.ts +0 -34
  376. package/esm/internal/common.js +0 -20
  377. package/esm/models/CamOverlayAPI/constants.d.ts +0 -11
  378. package/esm/models/CamOverlayAPI/constants.js +0 -11
  379. package/esm/models/CamOverlayAPI/fileSchema.d.ts +0 -28
  380. package/esm/models/CamOverlayAPI/fileSchema.js +0 -14
  381. package/esm/models/CamOverlayAPI/imagesSchema.js +0 -7
  382. package/esm/models/CamOverlayAPI/ptzSchema.js +0 -10
  383. package/esm/models/CamOverlayAPI/screenSharingSchema.js +0 -6
  384. package/esm/models/CamOverlayAPI/webCameraSharingSchema.js +0 -6
  385. package/esm/models/CamOverlayAPI/widgetsSchema.js +0 -24
  386. package/esm/node/DefaultClient.d.ts +0 -15
  387. package/esm/node/WsClient.d.ts +0 -39
  388. package/esm/node/WsEventClient.d.ts +0 -13
  389. package/esm/node/WsEventClient.js +0 -18
  390. package/esm/types/CamOverlayAPI.d.ts +0 -328
  391. package/esm/types/CamOverlayAPI.js +0 -14
  392. package/esm/types/CamScripterAPI.d.ts +0 -67
  393. package/esm/types/CamStreamerAPI.js +0 -25
  394. package/esm/web/DefaultClient.d.ts +0 -5
  395. package/esm/web/WsClient.d.ts +0 -13
  396. package/esm/web/index.d.ts +0 -2
  397. /package/cjs/{CreatePackage.d.ts → bin/CreatePackage.d.ts} +0 -0
  398. /package/cjs/{internal → node}/Digest.d.ts +0 -0
  399. /package/{esm/CreatePackage.d.ts → cjs/node/Digest.test.d.ts} +0 -0
  400. /package/cjs/types/{CamSwitcherEvents.d.ts → ws/CamSwitcherEvents.d.ts} +0 -0
  401. /package/cjs/types/{CamSwitcherEvents.js → ws/CamSwitcherEvents.js} +0 -0
  402. /package/esm/{internal → node}/Digest.js +0 -0
  403. /package/esm/types/{CamSwitcherEvents.js → ws/CamSwitcherEvents.js} +0 -0
  404. /package/{esm → types}/internal/constants.d.ts +0 -0
  405. /package/{esm → types}/internal/transformers.d.ts +0 -0
  406. /package/{esm/internal → types/node}/Digest.d.ts +0 -0
  407. /package/{esm/types → types/types/ws}/CamSwitcherEvents.d.ts +0 -0
  408. /package/{esm/node → types/web}/index.d.ts +0 -0
package/esm/VapixAPI.js CHANGED
@@ -1,55 +1,69 @@
1
- import * as prettifyXml from 'prettify-xml';
2
- import { isNullish, responseStringify } from './internal/common';
3
- import { sdCardWatchedStatuses, APP_IDS, maxFpsResponseSchema, dateTimeinfoSchema, audioDeviceRequestSchema, audioSampleRatesResponseSchema, } from './types/VapixAPI';
4
- import { ApplicationAPIError, MaxFPSError, NoDeviceInfoError, PtzNotSupportedError, SDCardActionError, SDCardJobError, } from './errors/errors';
1
+ import { arrayToUrl, isNullish, paramToUrl } from './internal/utils';
2
+ import { sdCardWatchedStatuses, APP_IDS, maxFpsResponseSchema, dateTimeinfoSchema, audioDeviceRequestSchema, audioSampleRatesResponseSchema, timeZoneSchema, getPortsResponseSchema, guardTourSchema, ptzOverviewSchema, cameraPTZItemDataSchema, applicationListSchema, sdCardInfoSchema, } from './types/VapixAPI';
3
+ import { ApplicationAPIError, MaxFPSError, NoDeviceInfoError, PtzNotSupportedError, ErrorWithResponse, SDCardActionError, SDCardJobError, SettingParameterError, TimezoneFetchError, TimezoneNotSetupError, } from './errors/errors';
5
4
  import { ProxyClient } from './internal/ProxyClient';
6
- import { arrayToUrl, paramToUrl } from './internal/utils';
7
5
  import { z } from 'zod';
8
6
  import { XMLParser } from 'fast-xml-parser';
9
7
  export class VapixAPI {
10
8
  client;
11
- constructor(client, getProxyUrl) {
12
- this.client = new ProxyClient(client, getProxyUrl);
9
+ CustomFormData;
10
+ constructor(client, CustomFormData = FormData) {
11
+ this.client = client;
12
+ this.CustomFormData = CustomFormData;
13
13
  }
14
- async getUrlEncoded(proxy, path, parameters, headers = {}) {
14
+ getClient(proxyParams) {
15
+ return proxyParams ? new ProxyClient(this.client, proxyParams) : this.client;
16
+ }
17
+ async postUrlEncoded(path, parameters, headers, options) {
15
18
  const data = paramToUrl(parameters);
16
19
  const head = { ...headers, 'Content-Type': 'application/x-www-form-urlencoded' };
17
- const res = await this.client.post(proxy, path, data, {}, head);
20
+ const agent = this.getClient(options?.proxyParams);
21
+ const res = await agent.post({ path, data, headers: head, timeout: options?.timeout });
18
22
  if (!res.ok) {
19
- throw new Error(await responseStringify(res));
23
+ throw new ErrorWithResponse(res);
20
24
  }
21
25
  return res;
22
26
  }
23
- async postJson(proxy, path, jsonData, headers = {}) {
27
+ async postJson(path, jsonData, headers, options) {
24
28
  const data = JSON.stringify(jsonData);
25
29
  const head = { ...headers, 'Content-Type': 'application/json' };
26
- const res = await this.client.post(proxy, path, data, {}, head);
30
+ const agent = this.getClient(options?.proxyParams);
31
+ const res = await agent.post({ path, data, headers: head, timeout: options?.timeout });
27
32
  if (!res.ok) {
28
- throw new Error(await responseStringify(res));
33
+ throw new ErrorWithResponse(res);
29
34
  }
30
35
  return res;
31
36
  }
32
- async getCameraImage(params, proxy = null) {
33
- return await this.client.get(proxy, '/axis-cgi/jpg/image.cgi', params);
37
+ async getCameraImage(parameters, options) {
38
+ const agent = this.getClient(options?.proxyParams);
39
+ return (await agent.get({
40
+ path: '/axis-cgi/jpg/image.cgi',
41
+ parameters,
42
+ timeout: options?.timeout,
43
+ }));
34
44
  }
35
- async getEventDeclarations(proxy = null) {
45
+ async getEventDeclarations(options) {
36
46
  const data = '<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope">' +
37
47
  '<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"' +
38
48
  'xmlns:xsd="http://www.w3.org/2001/XMLSchema">' +
39
49
  '<GetEventInstances xmlns="http://www.axis.com/vapix/ws/event1"/>' +
40
50
  '</s:Body>' +
41
51
  '</s:Envelope>';
42
- const res = await this.client.post(proxy, '/vapix/services', data, { 'Content-Type': 'application/soap+xml' });
52
+ const agent = this.getClient(options?.proxyParams);
53
+ const res = await agent.post({
54
+ path: '/vapix/services',
55
+ data,
56
+ headers: { 'Content-Type': 'application/soap+xml' },
57
+ });
43
58
  if (!res.ok) {
44
- throw new Error(await responseStringify(res));
59
+ throw new ErrorWithResponse(res);
45
60
  }
46
- const declarations = await res.text();
47
- return prettifyXml(declarations);
61
+ return await res.text();
48
62
  }
49
- async getSupportedAudioSampleRate(proxy = null) {
50
- const url = '/axis-cgi/audio/streamingcapabilities.cgi';
63
+ async getSupportedAudioSampleRate(options) {
64
+ const path = '/axis-cgi/audio/streamingcapabilities.cgi';
51
65
  const jsonData = { apiVersion: '1.0', method: 'list' };
52
- const res = await this.postJson(proxy, url, jsonData);
66
+ const res = await this.postJson(path, jsonData, undefined, options);
53
67
  const encoders = audioSampleRatesResponseSchema.parse(await res.json()).data.encoders;
54
68
  const data = encoders.aac ?? encoders.AAC ?? [];
55
69
  return data.map((item) => {
@@ -59,7 +73,7 @@ export class VapixAPI {
59
73
  };
60
74
  });
61
75
  }
62
- async performAutofocus(proxy = null) {
76
+ async performAutofocus(options) {
63
77
  try {
64
78
  const data = {
65
79
  apiVersion: '1',
@@ -72,19 +86,19 @@ export class VapixAPI {
72
86
  ],
73
87
  },
74
88
  };
75
- await this.postJson(proxy, '/axis-cgi/opticscontrol.cgi', data);
89
+ await this.postJson('/axis-cgi/opticscontrol.cgi', data, undefined, options);
76
90
  }
77
91
  catch (err) {
78
- await this.getUrlEncoded(proxy, '/axis-cgi/opticssetup.cgi', {
92
+ await this.postUrlEncoded('/axis-cgi/opticssetup.cgi', {
79
93
  autofocus: 'perform',
80
94
  source: '1',
81
- });
95
+ }, undefined, options);
82
96
  }
83
97
  }
84
- async checkSDCard(proxy = null) {
85
- const res = await this.getUrlEncoded(proxy, '/axis-cgi/disks/list.cgi', {
98
+ async checkSDCard(options) {
99
+ const res = await this.postUrlEncoded('/axis-cgi/disks/list.cgi', {
86
100
  diskid: 'SD_DISK',
87
- });
101
+ }, undefined, options);
88
102
  const xmlText = await res.text();
89
103
  const parser = new XMLParser({
90
104
  ignoreAttributes: false,
@@ -93,23 +107,23 @@ export class VapixAPI {
93
107
  });
94
108
  const result = parser.parse(xmlText);
95
109
  const data = result.root.disks.disk;
96
- return {
110
+ return sdCardInfoSchema.parse({
97
111
  totalSize: parseInt(data.totalsize),
98
112
  freeSize: parseInt(data.freesize),
99
113
  status: sdCardWatchedStatuses.includes(data.status) ? data.status : 'disconnected',
100
- };
114
+ });
101
115
  }
102
- mountSDCard(proxy = null) {
103
- return this._doSDCardMountAction('MOUNT', proxy);
116
+ mountSDCard(options) {
117
+ return this._doSDCardMountAction('MOUNT', options);
104
118
  }
105
- unmountSDCard(proxy = null) {
106
- return this._doSDCardMountAction('UNMOUNT', proxy);
119
+ unmountSDCard(options) {
120
+ return this._doSDCardMountAction('UNMOUNT', options);
107
121
  }
108
- async _doSDCardMountAction(action, proxy = null) {
109
- const res = await this.getUrlEncoded(proxy, '/axis-cgi/disks/mount.cgi', {
122
+ async _doSDCardMountAction(action, options) {
123
+ const res = await this.postUrlEncoded('/axis-cgi/disks/mount.cgi', {
110
124
  action: action,
111
125
  diskid: 'SD_DISK',
112
- });
126
+ }, undefined, options);
113
127
  const textXml = await res.text();
114
128
  const parser = new XMLParser({
115
129
  ignoreAttributes: false,
@@ -119,15 +133,15 @@ export class VapixAPI {
119
133
  const result = parser.parse(textXml);
120
134
  const job = result.root.job;
121
135
  if (job.result !== 'OK') {
122
- throw new SDCardActionError(action, await responseStringify(res));
136
+ throw new SDCardActionError(action, job.description);
123
137
  }
124
138
  return Number(job.jobid);
125
139
  }
126
- async fetchSDCardJobProgress(jobId, proxy = null) {
127
- const res = await this.getUrlEncoded(proxy, '/disks/job.cgi', {
140
+ async fetchSDCardJobProgress(jobId, options) {
141
+ const res = await this.postUrlEncoded('/disks/job.cgi', {
128
142
  jobid: String(jobId),
129
143
  diskid: 'SD_DISK',
130
- });
144
+ }, undefined, options);
131
145
  const textXml = await res.text();
132
146
  const parser = new XMLParser({
133
147
  ignoreAttributes: false,
@@ -136,19 +150,19 @@ export class VapixAPI {
136
150
  });
137
151
  const job = parser.parse(textXml).root.job;
138
152
  if (job.result !== 'OK') {
139
- throw new SDCardJobError();
153
+ throw new SDCardJobError(job.description);
140
154
  }
141
155
  return Number(job.progress);
142
156
  }
143
- downloadCameraReport(proxy = null) {
144
- return this.getUrlEncoded(proxy, '/axis-cgi/serverreport.cgi', { mode: 'text' });
157
+ downloadCameraReport(options) {
158
+ return this.postUrlEncoded('/axis-cgi/serverreport.cgi', { mode: 'text' }, undefined, options);
145
159
  }
146
- getSystemLog(proxy = null) {
147
- return this.getUrlEncoded(proxy, '/axis-cgi/admin/systemlog.cgi');
160
+ getSystemLog(options) {
161
+ return this.postUrlEncoded('/axis-cgi/admin/systemlog.cgi', undefined, undefined, options);
148
162
  }
149
- async getMaxFps(channel, proxy = null) {
163
+ async getMaxFps(channel, options) {
150
164
  const data = { apiVersion: '1.0', method: 'getCaptureModes' };
151
- const res = await this.postJson(proxy, '/axis-cgi/capturemode.cgi', data);
165
+ const res = await this.postJson('/axis-cgi/capturemode.cgi', data, undefined, options);
152
166
  const response = maxFpsResponseSchema.parse(await res.json());
153
167
  const channels = response.data;
154
168
  if (channels === undefined) {
@@ -166,21 +180,40 @@ export class VapixAPI {
166
180
  if (isNullish(captureMode.maxFPS)) {
167
181
  throw new MaxFPSError('FPS_NOT_SPECIFIED');
168
182
  }
169
- return captureMode.maxFPS;
183
+ return z.number().parse(captureMode.maxFPS);
170
184
  }
171
- async getTimezone(proxy = null) {
172
- const data = { apiVersion: '1.0', method: 'getDateTimeInfo' };
173
- const res = await this.postJson(proxy, '/axis-cgi/time.cgi', data);
174
- return (await res.json())?.timeZone ?? 'Europe/Prague';
185
+ async getTimezone(options) {
186
+ try {
187
+ const agent = this.getClient(options?.proxyParams);
188
+ const resV2 = await agent.get({ path: '/config/rest/time/v2/timeZone', timeout: options?.timeout });
189
+ if (!resV2.ok) {
190
+ throw new ErrorWithResponse(resV2);
191
+ }
192
+ const json = await resV2.json();
193
+ const data = timeZoneSchema.parse(json);
194
+ if (data.status === 'error') {
195
+ throw new TimezoneFetchError(data.error.message);
196
+ }
197
+ return data.data.activeTimeZone;
198
+ }
199
+ catch (error) {
200
+ console.warn('Failed to fetch time zone data from time API v2:', error instanceof Error ? error.message : JSON.stringify(error));
201
+ console.warn('Falling back to deprecated time API v1');
202
+ }
203
+ const data = await this.getDateTimeInfo(options);
204
+ if (data.data.timeZone === undefined) {
205
+ throw new TimezoneNotSetupError();
206
+ }
207
+ return z.string().parse(data.data.timeZone);
175
208
  }
176
- async getDateTimeInfo(proxy = null) {
209
+ async getDateTimeInfo(options) {
177
210
  const data = { apiVersion: '1.0', method: 'getDateTimeInfo' };
178
- const res = await this.postJson(proxy, '/axis-cgi/time.cgi', data);
211
+ const res = await this.postJson('/axis-cgi/time.cgi', data, undefined, options);
179
212
  return dateTimeinfoSchema.parse(await res.json());
180
213
  }
181
- async getDevicesSettings(proxy = null) {
214
+ async getDevicesSettings(options) {
182
215
  const data = { apiVersion: '1.0', method: 'getDevicesSettings' };
183
- const res = await this.postJson(proxy, '/axis-cgi/audiodevicecontrol.cgi', data);
216
+ const res = await this.postJson('/axis-cgi/audiodevicecontrol.cgi', data, undefined, options);
184
217
  const result = audioDeviceRequestSchema.parse(await res.json());
185
218
  return result.data.devices.map((device) => ({
186
219
  ...device,
@@ -188,52 +221,45 @@ export class VapixAPI {
188
221
  outputs: (device.outputs || []).sort((a, b) => a.id.localeCompare(b.id)),
189
222
  }));
190
223
  }
191
- async fetchRemoteDeviceInfo(payload, proxy = null) {
192
- const res = await this.postJson(proxy, '/axis-cgi/basicdeviceinfo.cgi', payload);
193
- const textXml = await res.text();
194
- const parser = new XMLParser({
195
- ignoreAttributes: false,
196
- attributeNamePrefix: '',
197
- allowBooleanAttributes: true,
198
- });
199
- const result = parser.parse(textXml);
200
- if (isNullish(result.body.data)) {
224
+ async fetchRemoteDeviceInfo(payload, options) {
225
+ const res = await this.postJson('/axis-cgi/basicdeviceinfo.cgi', payload, undefined, options);
226
+ const json = await res.json();
227
+ if (isNullish(json.data)) {
201
228
  throw new NoDeviceInfoError();
202
229
  }
203
- return result.data;
230
+ return json.data;
204
231
  }
205
- async getHeaders(proxy = null) {
232
+ async getHeaders(options) {
206
233
  const data = { apiVersion: '1.0', method: 'list' };
207
- const res = await this.postJson(proxy, '/axis-cgi/customhttpheader.cgi', data);
234
+ const res = await this.postJson('/axis-cgi/customhttpheader.cgi', data, undefined, options);
208
235
  return z.object({ data: z.record(z.string()) }).parse(await res.json()).data;
209
236
  }
210
- async setHeaders(headers, proxy = null) {
237
+ async setHeaders(headers, options) {
211
238
  const data = { apiVersion: '1.0', method: 'set', params: headers };
212
- return this.postJson(proxy, '/axis-cgi/customhttpheader.cgi', data);
239
+ return this.postJson('/axis-cgi/customhttpheader.cgi', data, undefined, options);
213
240
  }
214
- async getParameter(paramNames, proxy = null) {
215
- const response = await this.getUrlEncoded(proxy, '/axis-cgi/param.cgi', {
241
+ async getParameter(paramNames, options) {
242
+ const response = await this.postUrlEncoded('/axis-cgi/param.cgi', {
216
243
  action: 'list',
217
244
  group: arrayToUrl(paramNames),
218
- });
219
- return parseParameters(await response.text());
245
+ }, undefined, options);
246
+ return VapixAPI.parseParameters(await response.text());
220
247
  }
221
- async setParameter(params, proxy = null) {
222
- const res = await this.getUrlEncoded(proxy, '/axis-cgi/param.cgi', {
248
+ async setParameter(params, options) {
249
+ const res = await this.postUrlEncoded('/axis-cgi/param.cgi', {
223
250
  ...params,
224
251
  action: 'update',
225
- });
252
+ }, undefined, options);
226
253
  const responseText = await res.text();
227
254
  if (responseText.startsWith('# Error')) {
228
- throw new Error(responseText);
255
+ throw new SettingParameterError(responseText);
229
256
  }
230
- return true;
231
257
  }
232
- async getGuardTourList(proxy = null) {
258
+ async getGuardTourList(options) {
233
259
  const gTourList = new Array();
234
- const response = await this.getParameter('GuardTour', proxy);
260
+ const response = await this.getParameter('GuardTour', options);
235
261
  for (let i = 0; i < 20; i++) {
236
- const gTourBaseName = 'root.GuardTour.G' + i;
262
+ const gTourBaseName = 'GuardTour.G' + i;
237
263
  if (gTourBaseName + '.CamNbr' in response) {
238
264
  const gTour = {
239
265
  id: gTourBaseName,
@@ -245,7 +271,7 @@ export class VapixAPI {
245
271
  tour: [],
246
272
  };
247
273
  for (let j = 0; j < 100; j++) {
248
- const tourBaseName = 'root.GuardTour.G' + i + '.Tour.T' + j;
274
+ const tourBaseName = 'GuardTour.G' + i + '.Tour.T' + j;
249
275
  if (tourBaseName + '.MoveSpeed' in response) {
250
276
  const tour = {
251
277
  moveSpeed: response[tourBaseName + '.MoveSpeed'],
@@ -263,18 +289,18 @@ export class VapixAPI {
263
289
  break;
264
290
  }
265
291
  }
266
- return gTourList;
292
+ return guardTourSchema.parse(gTourList);
267
293
  }
268
- setGuardTourEnabled(guardTourID, enable, proxy = null) {
269
- const options = {};
270
- options[guardTourID + '.Running'] = enable ? 'yes' : 'no';
271
- return this.setParameter(options, proxy);
294
+ setGuardTourEnabled(guardTourId, enable, options) {
295
+ const params = {};
296
+ params[guardTourId + '.Running'] = enable ? 'yes' : 'no';
297
+ return this.setParameter(params, options);
272
298
  }
273
- async getPTZPresetList(channel, proxy = null) {
274
- const res = await this.getUrlEncoded(proxy, '/axis-cgi/com/ptz.cgi', {
299
+ async getPTZPresetList(channel, options) {
300
+ const res = await this.postUrlEncoded('/axis-cgi/com/ptz.cgi', {
275
301
  query: 'presetposcam',
276
- camera: channel.toString(),
277
- });
302
+ camera: channel,
303
+ }, undefined, options);
278
304
  const text = await res.text();
279
305
  const lines = text.split(/[\r\n]/);
280
306
  const positions = [];
@@ -287,68 +313,88 @@ export class VapixAPI {
287
313
  }
288
314
  }
289
315
  }
290
- return positions;
316
+ return z.array(z.string()).parse(positions);
291
317
  }
292
- async listPTZ(camera, proxy = null) {
318
+ async listPTZ(camera, options) {
293
319
  const url = `/axis-cgi/com/ptz.cgi`;
294
- const response = await this.getUrlEncoded(proxy, url, {
320
+ const response = await this.postUrlEncoded(url, {
295
321
  camera,
296
322
  query: 'presetposcamdata',
297
323
  format: 'json',
298
- });
324
+ }, undefined, options);
299
325
  const text = await response.text();
300
326
  if (text === '') {
301
327
  throw new PtzNotSupportedError();
302
328
  }
303
- return parseCameraPtzResponse(text)[camera] ?? [];
329
+ return VapixAPI.parseCameraPtzResponse(text)[camera] ?? [];
304
330
  }
305
- async listPtzVideoSourceOverview(proxy = null) {
306
- const response = await this.getUrlEncoded(proxy, '/axis-cgi/com/ptz.cgi', {
331
+ async listPtzVideoSourceOverview(options) {
332
+ const response = await this.postUrlEncoded('/axis-cgi/com/ptz.cgi', {
307
333
  query: 'presetposall',
308
334
  format: 'json',
309
- });
335
+ }, undefined, options);
310
336
  const text = await response.text();
311
337
  if (text === '') {
312
338
  throw new PtzNotSupportedError();
313
339
  }
314
- const data = parseCameraPtzResponse(text);
340
+ const data = VapixAPI.parseCameraPtzResponse(text);
315
341
  const res = {};
316
342
  Object.keys(data)
317
343
  .map(Number)
318
344
  .forEach((camera) => {
319
- if (data[camera] !== undefined) {
320
- res[camera - 1] = data[camera]?.map(({ data: itemData, ...d }) => d);
345
+ const item = data[camera];
346
+ if (item !== undefined) {
347
+ res[camera - 1] = item.map(({ data: itemData, ...d }) => d);
321
348
  }
322
349
  });
323
- return res;
350
+ return ptzOverviewSchema.parse(res);
324
351
  }
325
- goToPreset(channel, presetName, proxy = null) {
326
- return this.getUrlEncoded(proxy, '/axis-cgi/com/ptz.cgi', {
352
+ goToPreset(channel, presetName, options) {
353
+ return this.postUrlEncoded('/axis-cgi/com/ptz.cgi', {
327
354
  camera: channel.toString(),
328
355
  gotoserverpresetname: presetName,
329
- });
356
+ }, undefined, options);
330
357
  }
331
- async getPtzPosition(camera, proxy = null) {
332
- const res = await this.getUrlEncoded(proxy, '/axis-cgi/com/ptz.cgi', {
358
+ async getPtzPosition(camera, options) {
359
+ const res = await this.postUrlEncoded('/axis-cgi/com/ptz.cgi', {
333
360
  query: 'position',
334
361
  camera: camera.toString(),
335
- });
336
- const params = parseParameters(await res.text());
337
- return {
362
+ }, undefined, options);
363
+ const params = VapixAPI.parseParameters(await res.text());
364
+ return cameraPTZItemDataSchema.parse({
338
365
  pan: Number(params.pan),
339
366
  tilt: Number(params.tilt),
340
367
  zoom: Number(params.zoom),
341
- };
342
- }
343
- async getInputState(port, proxy = null) {
344
- const response = await (await this.getUrlEncoded(proxy, '/axis-cgi/io/port.cgi', { checkactive: port.toString() })).text();
345
- return response.split('=')[1]?.indexOf('active') === 0;
346
- }
347
- async setOutputState(port, active, proxy = null) {
348
- return this.getUrlEncoded(proxy, '/axis-cgi/io/port.cgi', { action: active ? `${port}:/` : `${port}:\\` });
368
+ });
349
369
  }
350
- async getApplicationList(proxy = null) {
351
- const res = await this.client.get(proxy, '/axis-cgi/applications/list.cgi');
370
+ async getPorts(options) {
371
+ const res = await this.postJson('/axis-cgi/io/portmanagement.cgi', {
372
+ apiVersion: '1.0',
373
+ context: '',
374
+ method: 'getPorts',
375
+ }, undefined, options);
376
+ const portResponseParsed = getPortsResponseSchema.parse(await res.json());
377
+ return portResponseParsed.data.items;
378
+ }
379
+ async setPorts(ports, options) {
380
+ await this.postJson('/axis-cgi/io/portmanagement.cgi', {
381
+ apiVersion: '1.0',
382
+ context: '',
383
+ method: 'setPorts',
384
+ params: { ports },
385
+ }, undefined, options);
386
+ }
387
+ async setPortStateSequence(port, sequence, options) {
388
+ await this.postJson('/axis-cgi/io/portmanagement.cgi', {
389
+ apiVersion: '1.0',
390
+ context: '',
391
+ method: 'setStateSequence',
392
+ params: { port, sequence },
393
+ }, undefined, options);
394
+ }
395
+ async getApplicationList(options) {
396
+ const agent = this.getClient(options?.proxyParams);
397
+ const res = await agent.get({ path: '/axis-cgi/applications/list.cgi', timeout: options?.timeout });
352
398
  const xml = await res.text();
353
399
  const parser = new XMLParser({
354
400
  ignoreAttributes: false,
@@ -356,121 +402,147 @@ export class VapixAPI {
356
402
  allowBooleanAttributes: true,
357
403
  });
358
404
  const result = parser.parse(xml);
359
- return result.reply.application.map((app) => {
405
+ let apps = result.reply.application ?? [];
406
+ if (!Array.isArray(apps)) {
407
+ apps = [apps];
408
+ }
409
+ const appList = apps.map((app) => {
360
410
  return {
361
411
  ...app,
362
412
  appId: APP_IDS.find((id) => id.toLowerCase() === app.Name.toLowerCase()) ?? null,
363
413
  };
364
414
  });
365
- }
366
- async startApplication(applicationID, proxy = null) {
367
- const res = await this.client.get(proxy, '/axis-cgi/applications/control.cgi', {
368
- package: applicationID.toLowerCase(),
369
- action: 'start',
415
+ return applicationListSchema.parse(appList);
416
+ }
417
+ async startApplication(applicationId, options) {
418
+ const agent = this.getClient(options?.proxyParams);
419
+ const res = await agent.get({
420
+ path: '/axis-cgi/applications/control.cgi',
421
+ parameters: {
422
+ package: applicationId.toLowerCase(),
423
+ action: 'start',
424
+ },
425
+ timeout: options?.timeout,
370
426
  });
371
427
  const text = (await res.text()).trim().toLowerCase();
372
428
  if (text !== 'ok' && !(text.startsWith('error:') && text.substring(7) === '6')) {
373
- throw new ApplicationAPIError('START', await responseStringify(res));
429
+ throw new ApplicationAPIError('START', text);
374
430
  }
375
431
  }
376
- async restartApplication(applicationID, proxy = null) {
377
- const res = await this.client.get(proxy, '/axis-cgi/applications/control.cgi', {
378
- package: applicationID.toLowerCase(),
379
- action: 'restart',
432
+ async restartApplication(applicationId, options) {
433
+ const agent = this.getClient(options?.proxyParams);
434
+ const res = await agent.get({
435
+ path: '/axis-cgi/applications/control.cgi',
436
+ parameters: {
437
+ package: applicationId.toLowerCase(),
438
+ action: 'restart',
439
+ },
440
+ timeout: options?.timeout,
380
441
  });
381
442
  const text = (await res.text()).trim().toLowerCase();
382
443
  if (text !== 'ok') {
383
- throw new ApplicationAPIError('RESTART', await responseStringify(res));
444
+ throw new ApplicationAPIError('RESTART', text);
384
445
  }
385
446
  }
386
- async stopApplication(applicationID, proxy = null) {
387
- const res = await this.client.get(proxy, '/axis-cgi/applications/control.cgi', {
388
- package: applicationID.toLowerCase(),
389
- action: 'stop',
447
+ async stopApplication(applicationId, options) {
448
+ const agent = this.getClient(options?.proxyParams);
449
+ const res = await agent.get({
450
+ path: '/axis-cgi/applications/control.cgi',
451
+ parameters: {
452
+ package: applicationId.toLowerCase(),
453
+ action: 'stop',
454
+ },
455
+ timeout: options?.timeout,
390
456
  });
391
457
  const text = (await res.text()).trim().toLowerCase();
392
458
  if (text !== 'ok' && !(text.startsWith('error:') && text.substring(7) === '6')) {
393
- throw new ApplicationAPIError('STOP', await responseStringify(res));
459
+ throw new ApplicationAPIError('STOP', text);
394
460
  }
395
461
  }
396
- async installApplication(data, fileName) {
397
- const formData = new FormData();
462
+ async installApplication(data, fileName, options) {
463
+ const formData = new this.CustomFormData();
398
464
  formData.append('packfil', data, fileName);
399
- const res = await this.client.post(null, '/axis-cgi/applications/upload.cgi', formData, {}, {
400
- contentType: 'application/octet-stream',
465
+ const agent = this.getClient(options?.proxyParams);
466
+ const res = await agent.post({
467
+ path: '/axis-cgi/applications/upload.cgi',
468
+ data: formData,
469
+ headers: {
470
+ contentType: 'application/octet-stream',
471
+ },
472
+ timeout: options?.timeout ?? 120000,
401
473
  });
402
474
  if (!res.ok) {
403
- throw new Error(await responseStringify(res));
475
+ throw new ErrorWithResponse(res);
404
476
  }
405
477
  const text = await res.text();
406
478
  if (text.length > 5) {
407
- throw new Error('installing error: ' + text);
408
- }
409
- }
410
- }
411
- const parseParameters = (response) => {
412
- const params = {};
413
- const lines = response.split(/[\r\n]/);
414
- for (const line of lines) {
415
- if (line.length === 0 || line.substring(0, 7) === '# Error') {
416
- continue;
417
- }
418
- const delimiterPos = line.indexOf('=');
419
- if (delimiterPos !== -1) {
420
- const paramName = line.substring(0, delimiterPos).replace('root.', '');
421
- const paramValue = line.substring(delimiterPos + 1);
422
- params[paramName] = paramValue;
479
+ throw new ApplicationAPIError('INSTALL', text);
423
480
  }
424
481
  }
425
- return params;
426
- };
427
- const parseCameraPtzResponse = (response) => {
428
- const json = JSON.parse(response);
429
- const parsed = {};
430
- Object.keys(json).forEach((key) => {
431
- if (!key.startsWith('Camera ')) {
432
- return;
433
- }
434
- const camera = Number(key.replace('Camera ', ''));
435
- if (json[key].presets !== undefined) {
436
- parsed[camera] = parsePtz(json[key].presets);
437
- }
438
- });
439
- return parsed;
440
- };
441
- const parsePtz = (parsed) => {
442
- const res = [];
443
- parsed.forEach((value) => {
444
- const delimiterPos = value.indexOf('=');
445
- if (delimiterPos === -1) {
446
- return;
447
- }
448
- if (!value.startsWith('presetposno')) {
449
- return;
450
- }
451
- const id = Number(value.substring(11, delimiterPos));
452
- if (Number.isNaN(id)) {
453
- return;
482
+ static parseParameters = (response) => {
483
+ const params = {};
484
+ const lines = response.split(/[\r\n]/);
485
+ for (const line of lines) {
486
+ if (line.length === 0 || line.substring(0, 7) === '# Error') {
487
+ continue;
488
+ }
489
+ const delimiterPos = line.indexOf('=');
490
+ if (delimiterPos !== -1) {
491
+ const paramName = line.substring(0, delimiterPos).replace('root.', '');
492
+ const paramValue = line.substring(delimiterPos + 1);
493
+ params[paramName] = paramValue;
494
+ }
454
495
  }
455
- const data = value.substring(delimiterPos + 1).split(':');
456
- const getValue = (valueName) => {
457
- for (const d of data) {
458
- const p = d.split('=');
459
- if (p[0] === valueName) {
460
- return Number(p[1]);
461
- }
496
+ return params;
497
+ };
498
+ static parseCameraPtzResponse = (response) => {
499
+ const json = JSON.parse(response);
500
+ const parsed = {};
501
+ Object.keys(json).forEach((key) => {
502
+ if (!key.startsWith('Camera ')) {
503
+ return;
462
504
  }
463
- return 0;
464
- };
465
- res.push({
466
- id,
467
- name: data[0] ?? 'Preset ' + id,
468
- data: {
469
- pan: getValue('pan'),
470
- tilt: getValue('tilt'),
471
- zoom: getValue('zoom'),
472
- },
505
+ const camera = Number(key.replace('Camera ', ''));
506
+ if (json[key].presets !== undefined) {
507
+ parsed[camera] = VapixAPI.parsePtz(json[key].presets);
508
+ }
509
+ });
510
+ return parsed;
511
+ };
512
+ static parsePtz = (parsed) => {
513
+ const res = [];
514
+ parsed.forEach((value) => {
515
+ const delimiterPos = value.indexOf('=');
516
+ if (delimiterPos === -1) {
517
+ return;
518
+ }
519
+ if (!value.startsWith('presetposno')) {
520
+ return;
521
+ }
522
+ const id = Number(value.substring(11, delimiterPos));
523
+ if (Number.isNaN(id)) {
524
+ return;
525
+ }
526
+ const data = value.substring(delimiterPos + 1).split(':');
527
+ const getValue = (valueName) => {
528
+ for (const d of data) {
529
+ const p = d.split('=');
530
+ if (p[0] === valueName) {
531
+ return Number(p[1]);
532
+ }
533
+ }
534
+ return 0;
535
+ };
536
+ res.push({
537
+ id,
538
+ name: data[0] ?? 'Preset ' + id,
539
+ data: {
540
+ pan: getValue('pan'),
541
+ tilt: getValue('tilt'),
542
+ zoom: getValue('zoom'),
543
+ },
544
+ });
473
545
  });
474
- });
475
- return res;
476
- };
546
+ return res;
547
+ };
548
+ }