camstreamerlib 4.0.0-beta.99 → 4.0.1

package/README.md

@@ -1,13 +1,8 @@
-# CamStreamerLib - BETA
+# CamStreamerLib
 
-**This is beta version of CamStreamerLib v4, dont use it on production. Is going to be changed significantly.**
+Web and Node.js helper library for CamStreamer ACAP applications.
 
-**The documentation is in progress**
-
-Node.js helper library for CamStreamer ACAP applications.
-
-The library is primarily developed for the CamScripter ACAP application running directly in Axis cameras.
-Examples of CamScripter packages can be found at https://github.com/CamStreamer/CamScripterApp_examples
+The library is primarily developed for ACAP applications running directly in Axis cameras.
 
 ## Installation
 
@@ -26,7 +21,7 @@ npm install camstreamerlib
 | [CamSwitcherAPI](doc/CamSwitcherAPI.md)            | Module to access CamSwitcher API.                                                                                      |
 | [PlaneTrackerAPI](doc/PlaneTrackerAPI.md)          | Module to access PlaneTracker API.                                                                                     |
 | [CamStreamerEvents](doc/ws/CamStreamerEvents.md)   | Module which allows receiving events from CamStreamer ACAP application.                                                |
-| [OverlayEvents](doc/ws/OverlayEvents.md)           | Module which allows receiving events from Overlay ACAP application.                                                    |
+| [CamOverlayEvents](doc/ws/CamOverlayEvents.md)     | Module which allows receiving events from CamOverlay ACAP application.                                                 |
 | [CamSwitcherEvents](doc/ws/CamSwitcherEvents.md)   | Module which allows receiving events from CamSwitcher ACAP application.                                                |
 | [PlaneTrackerEvents](doc/ws/PlaneTrackerEvents.md) | Module which allows receiving events from PlaneTracker ACAP application.                                               |
 
@@ -56,11 +51,11 @@ npm install camstreamerlib
 
 ### ACAP API Class Constructors Updated
 
-All ACAP API classes now **require a client instance to be passed into their constructors** instead of options object.
+All ACAP API classes now **require a client instance to be passed into their constructors** instead of `options` object.
 
 -   This change improves flexibility by allowing you to use either the Node or Web client, depending on your environment.
 
-Example (before → now):
+**Example (before → now)**:
 
 ```typescript
 // Before
@@ -78,6 +73,12 @@ const coApi = new CamOverlayAPI({
 import { DefaultClient } from 'camstreamerlib/web';
 import { CamOverlayAPI } from 'camstreamerlib';
 
+// Use DefaultClient in constructor
+const coApi = new CamOverlayAPI(
+    new DefaultClient()
+);
+
+// Or adjust DefaultClient default values with your own
 const coApi = new CamOverlayAPI(
     new DefaultClient({
         tls: false,
@@ -109,17 +110,43 @@ import { Painter } from 'camstreamerlib/node';
 import { DefaultClient } from 'camstreamerlib/web';
 ```
 
-> Note: To ensure compatibility, set the module resolution in your projects tsconfig.json to `"moduleResolution": "bundler"`.
+> :information_source: Note: To ensure compatibility, set the module resolution in your web projects tsconfig.json to `"moduleResolution": "bundler"`.
 
-### Class and Method Refactored
+### Classes and Methods Refactored
 
 -   **CameraVapix API** has been renamed to [**VapixAPI**](doc/VapixAPI.md).
 -   **DefaultAgent** has been refactored into two separate classes - one for node, one for web as [**DefaultClient**](doc/Client.md)
 -   Several method names and parameter names across the library have been updated for consistency and clarity.
+-   New API modules and endpoints have been introduced, providing extended functionality and better coverage of the underlying service.
 
-> Please refer to [the documentation](#documentation-for-acap-and-camera-api).
+### Stream List Migration
 
--   New API modules and endpoints have been introduced, providing extended functionality and better coverage of the underlying service.
+-   `CamStreamerAPI.getStreamList()` and `getStream()` now throw a **`MigrationError`** when old-format (v3) stream data is detected on the camera.
+-   `MigrationError` provides four arrays to help you handle the transition: `.valid`, `.old`, `.invalid`, and `.unknown`.
+
+```typescript
+import { MigrationError } from 'camstreamerlib';
+
+try {
+    const streams = await csApi.getStreamList();
+} catch (e) {
+    if (e instanceof MigrationError) {
+        console.log('Valid streams:', e.valid);
+        console.log('Old-format streams needing migration:', e.old);
+    }
+}
+```
+
+### CreatePackage Script Path Changed
+
+-   The path to the `CreatePackage` script changed from `camstreamerlib/CreatePackage.js` to `camstreamerlib/bin/CreatePackage.js`.
+-   Update any `package.json` scripts accordingly:
+
+```json
+"scripts": {
+    "create-package": "node node_modules/camstreamerlib/bin/CreatePackage.js"
+}
+```
 
 <hr/>
 </details>
@@ -204,3 +231,5 @@ The zip package is created in the current directory. You can choose different lo
     "create-package": "node node_modules/camstreamerlib/bin/CreatePackage.js -i -e=react"
 }
 ```
+
+> :warning: Path to `CreatePackage` script has changed from `camstreamerlib/CreatePackage.js` to `camstreamerlib/bin/CreatePackage.js` (from v.4.0.0)