camstreamerlib 4.0.37 → 5.0.0-4d910ae

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 (134) hide show
  1. package/README.md +39 -2
  2. package/cjs/CamOverlayAPI.d.ts +204 -204
  3. package/cjs/CamStreamerAPI.d.ts +311 -311
  4. package/cjs/CamStreamerAPI.js +1 -1
  5. package/cjs/CamSwitcherAPI.d.ts +32 -31
  6. package/cjs/CamSwitcherAPI.js +2 -0
  7. package/cjs/PlaneTrackerAPI.d.ts +25 -28
  8. package/cjs/VapixAPI.d.ts +15 -15
  9. package/cjs/VapixAPI.js +2 -2
  10. package/cjs/bin/CreatePackage.js +17 -7
  11. package/cjs/internal/transformers.d.ts +4 -4
  12. package/cjs/internal/utils.js +3 -3
  13. package/cjs/internal/versionCompare.d.ts +2 -2
  14. package/cjs/node/CamOverlayDrawingAPI.d.ts +0 -3
  15. package/cjs/node/CamOverlayPainter/Frame.d.ts +0 -1
  16. package/cjs/node/CamOverlayPainter/ResourceManager.d.ts +2 -2
  17. package/cjs/node/CamOverlayPainter/ResourceManager.js +17 -7
  18. package/cjs/node/CamScripterAPICameraEventsGenerator.d.ts +0 -1
  19. package/cjs/node/DefaultClient.d.ts +0 -2
  20. package/cjs/node/Digest.js +17 -7
  21. package/cjs/node/HttpRequestSender.d.ts +0 -2
  22. package/cjs/node/HttpRequestSender.test.js +17 -7
  23. package/cjs/node/HttpServer.d.ts +0 -2
  24. package/cjs/node/HttpServer.js +17 -7
  25. package/cjs/node/TimeZoneDaemon.js +1 -2
  26. package/cjs/node/VapixEvents.js +1 -1
  27. package/cjs/node/WsClient.js +1 -1
  28. package/cjs/types/CamOverlayAPI/CamOverlayAPI.d.ts +320 -4097
  29. package/cjs/types/CamOverlayAPI/CamOverlayAPI.js +2 -2
  30. package/cjs/types/CamOverlayAPI/accuweatherSchema.d.ts +12 -67
  31. package/cjs/types/CamOverlayAPI/customGraphicsSchema.d.ts +40 -572
  32. package/cjs/types/CamOverlayAPI/htmlOverlaySchema.d.ts +6 -59
  33. package/cjs/types/CamOverlayAPI/htmlOverlaySchema.js +1 -1
  34. package/cjs/types/CamOverlayAPI/imagesSchema.d.ts +6 -75
  35. package/cjs/types/CamOverlayAPI/infotickerSchema.d.ts +11 -74
  36. package/cjs/types/CamOverlayAPI/pipSchema.d.ts +12 -97
  37. package/cjs/types/CamOverlayAPI/pipSchema.js +2 -2
  38. package/cjs/types/CamOverlayAPI/ptzCompassSchema.d.ts +12 -71
  39. package/cjs/types/CamOverlayAPI/ptzCompassSchema.js +1 -1
  40. package/cjs/types/CamOverlayAPI/ptzSchema.d.ts +8 -99
  41. package/cjs/types/CamOverlayAPI/scoreBoardSchema.d.ts +20 -254
  42. package/cjs/types/CamOverlayAPI/screenSharingSchema.d.ts +5 -43
  43. package/cjs/types/CamOverlayAPI/serviceCommonTypes.d.ts +15 -94
  44. package/cjs/types/CamOverlayAPI/webCameraSharingSchema.d.ts +5 -43
  45. package/cjs/types/CamScripterAPI.d.ts +11 -81
  46. package/cjs/types/CamStreamerAPI/CamStreamerAPI.d.ts +1095 -24193
  47. package/cjs/types/CamStreamerAPI/facebookSchema.d.ts +32 -509
  48. package/cjs/types/CamStreamerAPI/oldStreamSchema.d.ts +8 -143
  49. package/cjs/types/CamStreamerAPI/streamCommonTypes.d.ts +32 -493
  50. package/cjs/types/CamStreamerAPI/streamsSchema.d.ts +425 -7786
  51. package/cjs/types/CamStreamerAPI/windySchema.d.ts +36 -476
  52. package/cjs/types/CamStreamerAPI/youtubeSchema.d.ts +32 -487
  53. package/cjs/types/CamStreamerAPI/youtubeSchema.js +1 -1
  54. package/cjs/types/CamSwitcherAPI.d.ts +75 -700
  55. package/cjs/types/CamSwitcherAPI.js +1 -0
  56. package/cjs/types/GenetecAgent.d.ts +12 -132
  57. package/cjs/types/MilestoneAgent.d.ts +4 -46
  58. package/cjs/types/PlaneTrackerAPI.d.ts +265 -1205
  59. package/cjs/types/PlaneTrackerAPI.js +5 -5
  60. package/cjs/types/VapixAPI.d.ts +129 -1653
  61. package/cjs/types/VapixAPI.js +1 -1
  62. package/cjs/types/common.d.ts +11 -35
  63. package/cjs/types/common.js +1 -1
  64. package/cjs/types/ws/CamOverlayEvents.d.ts +9 -69
  65. package/cjs/types/ws/CamStreamerEvents.d.ts +22 -217
  66. package/cjs/types/ws/CamStreamerEvents.js +1 -0
  67. package/cjs/types/ws/CamSwitcherEvents.d.ts +46 -452
  68. package/cjs/types/ws/PlaneTrackerEvents.d.ts +361 -3522
  69. package/cjs/types/ws/PlaneTrackerEvents.js +1 -1
  70. package/cjs/web/WsClient.js +1 -1
  71. package/esm/CamStreamerAPI.js +1 -1
  72. package/esm/CamSwitcherAPI.js +2 -0
  73. package/esm/VapixAPI.js +2 -2
  74. package/esm/node/TimeZoneDaemon.js +1 -2
  75. package/esm/node/VapixEvents.js +1 -1
  76. package/esm/node/WsClient.js +1 -1
  77. package/esm/types/CamOverlayAPI/CamOverlayAPI.js +2 -2
  78. package/esm/types/CamOverlayAPI/htmlOverlaySchema.js +1 -1
  79. package/esm/types/CamOverlayAPI/pipSchema.js +2 -2
  80. package/esm/types/CamOverlayAPI/ptzCompassSchema.js +1 -1
  81. package/esm/types/CamStreamerAPI/youtubeSchema.js +1 -1
  82. package/esm/types/CamSwitcherAPI.js +1 -0
  83. package/esm/types/PlaneTrackerAPI.js +5 -5
  84. package/esm/types/VapixAPI.js +1 -1
  85. package/esm/types/common.js +1 -1
  86. package/esm/types/ws/CamStreamerEvents.js +1 -0
  87. package/esm/types/ws/PlaneTrackerEvents.js +1 -1
  88. package/esm/web/WsClient.js +1 -1
  89. package/package.json +106 -107
  90. package/types/CamOverlayAPI.d.ts +204 -204
  91. package/types/CamStreamerAPI.d.ts +311 -311
  92. package/types/CamSwitcherAPI.d.ts +32 -31
  93. package/types/PlaneTrackerAPI.d.ts +25 -28
  94. package/types/VapixAPI.d.ts +15 -15
  95. package/types/internal/transformers.d.ts +4 -4
  96. package/types/internal/versionCompare.d.ts +2 -2
  97. package/types/node/CamOverlayDrawingAPI.d.ts +0 -3
  98. package/types/node/CamOverlayPainter/Frame.d.ts +0 -1
  99. package/types/node/CamOverlayPainter/ResourceManager.d.ts +2 -2
  100. package/types/node/CamScripterAPICameraEventsGenerator.d.ts +0 -1
  101. package/types/node/DefaultClient.d.ts +0 -2
  102. package/types/node/HttpRequestSender.d.ts +0 -2
  103. package/types/node/HttpServer.d.ts +0 -2
  104. package/types/types/CamOverlayAPI/CamOverlayAPI.d.ts +320 -4097
  105. package/types/types/CamOverlayAPI/accuweatherSchema.d.ts +12 -67
  106. package/types/types/CamOverlayAPI/customGraphicsSchema.d.ts +40 -572
  107. package/types/types/CamOverlayAPI/htmlOverlaySchema.d.ts +6 -59
  108. package/types/types/CamOverlayAPI/imagesSchema.d.ts +6 -75
  109. package/types/types/CamOverlayAPI/infotickerSchema.d.ts +11 -74
  110. package/types/types/CamOverlayAPI/pipSchema.d.ts +12 -97
  111. package/types/types/CamOverlayAPI/ptzCompassSchema.d.ts +12 -71
  112. package/types/types/CamOverlayAPI/ptzSchema.d.ts +8 -99
  113. package/types/types/CamOverlayAPI/scoreBoardSchema.d.ts +20 -254
  114. package/types/types/CamOverlayAPI/screenSharingSchema.d.ts +5 -43
  115. package/types/types/CamOverlayAPI/serviceCommonTypes.d.ts +15 -94
  116. package/types/types/CamOverlayAPI/webCameraSharingSchema.d.ts +5 -43
  117. package/types/types/CamScripterAPI.d.ts +11 -81
  118. package/types/types/CamStreamerAPI/CamStreamerAPI.d.ts +1095 -24193
  119. package/types/types/CamStreamerAPI/facebookSchema.d.ts +32 -509
  120. package/types/types/CamStreamerAPI/oldStreamSchema.d.ts +8 -143
  121. package/types/types/CamStreamerAPI/streamCommonTypes.d.ts +32 -493
  122. package/types/types/CamStreamerAPI/streamsSchema.d.ts +425 -7786
  123. package/types/types/CamStreamerAPI/windySchema.d.ts +36 -476
  124. package/types/types/CamStreamerAPI/youtubeSchema.d.ts +32 -487
  125. package/types/types/CamSwitcherAPI.d.ts +75 -700
  126. package/types/types/GenetecAgent.d.ts +12 -132
  127. package/types/types/MilestoneAgent.d.ts +4 -46
  128. package/types/types/PlaneTrackerAPI.d.ts +265 -1205
  129. package/types/types/VapixAPI.d.ts +129 -1653
  130. package/types/types/common.d.ts +11 -35
  131. package/types/types/ws/CamOverlayEvents.d.ts +9 -69
  132. package/types/types/ws/CamStreamerEvents.d.ts +22 -217
  133. package/types/types/ws/CamSwitcherEvents.d.ts +46 -452
  134. package/types/types/ws/PlaneTrackerEvents.d.ts +361 -3522
package/README.md CHANGED
@@ -52,9 +52,46 @@ npm install camstreamerlib
52
52
 
53
53
  <details open>
54
54
 
55
- <summary>from version 3.\*.\* to 4.\*.\* (latest)</summary>
55
+ <summary>from version 4.\*.\* to 5.\*.\* (latest)</summary>
56
56
 
57
- ### Breaking changes when moving from version 3.\*.\* to 4.\*.\* (latest)
57
+ ### Breaking changes when moving from version 4.\*.\* to 5.\*.\* (latest)
58
+
59
+ <hr/>
60
+
61
+ ### Zod Upgraded to v4
62
+
63
+ The library now depends on `zod` v4 (`^4.6.7`) instead of v3 (fixes [GHSA-mrhx-c7xc-m3w5](https://github.com/advisories/GHSA-mrhx-c7xc-m3w5)). All exported schemas are zod v4 schemas.
64
+
65
+ - If your project uses the exported schemas together with its own `zod` (e.g. `z.array(domainIdSchema)`, `schema.extend(...)`, `z.infer<typeof schema>`, form resolvers), upgrade your `zod` to v4 as well. Mixing zod v3 and v4 schemas does not work.
66
+ - Object keys declared as `z.unknown()` / `z.any()` are now required in the inferred types (e.g. `TGuardTour` fields, `postJsonBody` in PlaneTracker events).
67
+ - See the [zod v4 migration guide](https://zod.dev/v4/changelog) for changes in your own schemas.
68
+
69
+ <hr/>
70
+
71
+ ### TypeScript 5.9 or Newer Required
72
+
73
+ Exported types (e.g. the camelCase/snake_case types in `CamSwitcherAPI` and `VapixAPI`) are built on `type-fest` v5, which requires TypeScript `>=5.9` with `strict: true` in your `tsconfig.json`.
74
+
75
+ <hr/>
76
+
77
+ ### VapixEvents Upgraded to eventemitter2 v6
78
+
79
+ `VapixEvents` now extends `EventEmitter2` from `eventemitter2` v6. Its typings are stricter, e.g. `eventNames()` returns `(string | symbol | event[])[]` instead of `string[]`, so code relying on the old types may need to narrow the values.
80
+
81
+ <hr/>
82
+
83
+ ### Node.js 18 or Newer Required
84
+
85
+ `package.json` now declares `"engines": { "node": ">=18" }`.
86
+
87
+ <hr/>
88
+ </details>
89
+
90
+ <details>
91
+
92
+ <summary>from version 3.\*.\* to 4.\*.\*</summary>
93
+
94
+ ### Breaking changes when moving from version 3.\*.\* to 4.\*.\*
58
95
 
59
96
  <hr/>
60
97