camstreamerlib 4.0.36 → 5.0.0-20ab5c4

package/README.md

@@ -52,9 +52,46 @@ npm install camstreamerlib
 
 <details open>
 
-<summary>from version 3.\*.\* to 4.\*.\* (latest)</summary>
+<summary>from version 4.\*.\* to 5.\*.\* (latest)</summary>
 
-### Breaking changes when moving from version 3.\*.\* to 4.\*.\* (latest)
+### Breaking changes when moving from version 4.\*.\* to 5.\*.\* (latest)
+
+<hr/>
+
+### Zod Upgraded to v4
+
+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.
+
+-   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.
+-   Object keys declared as `z.unknown()` / `z.any()` are now required in the inferred types (e.g. `TGuardTour` fields, `postJsonBody` in PlaneTracker events).
+-   See the [zod v4 migration guide](https://zod.dev/v4/changelog) for changes in your own schemas.
+
+<hr/>
+
+### TypeScript 5.9 or Newer Required
+
+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`.
+
+<hr/>
+
+### VapixEvents Upgraded to eventemitter2 v6
+
+`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.
+
+<hr/>
+
+### Node.js 18 or Newer Required
+
+`package.json` now declares `"engines": { "node": ">=18" }`.
+
+<hr/>
+</details>
+
+<details>
+
+<summary>from version 3.\*.\* to 4.\*.\*</summary>
+
+### Breaking changes when moving from version 3.\*.\* to 4.\*.\*
 
 <hr/>