@nordicsemiconductor/pc-nrfconnect-shared 122.0.0 → 123.0.0

package/Changelog.md

@@ -7,6 +7,57 @@ This project does _not_ adhere to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html) but contrary to it
 every new version is a new major version.
 
+## 123 - 2023-11-07
+
+### Added
+
+-   PID to `nrfutil device` logs when trace is enabled.
+-   `launcherConfig` to retrieve the launcher config in any renderer process.
+-   Auto select device with `--comPort <path>`. Note this will only select the
+    device, it will not open a serial connection. App will need to do further
+    action if it wants to auto open a serial connection as well to that serial
+    port
+
+### Changed
+
+-   Analytic events names are now distinct with a prefix of the app name
+    `<AppName>:` e.g `npm:` or `ppk:`.
+-   `<App` component no longer provides property `reportUsageData` and for app
+    to enable telemetry they must now use `usageData.enableTelemetry()`
+-   The function to send telemetry data in `usageData` became async. If you have
+    to be sure they completed, you now have to await them.
+-   `getPersistedTerminalSettings` not takes in a device instead of a serial
+    number and returns undefined for devices with no serial number
+-   `persistTerminalSettings` not takes in a device instead of a serial number
+    and returns undefined for devices with no serial number
+-   `OpenAppOptions` must have serial number or com port path but not both
+
+### Fixed
+
+-   Serial port in the device list where not aligned correctly
+-   Auto select device when `--deviceSerial` is provided
+
+### Steps to upgrade when using this package
+
+-   In `package.json` bump `engines.nrfconnect` to at least `>=4.2.2`.
+-   Remove `reportUsageData` property if it is set in project. If this was set
+    to true add `usageData.enableTelemetry()` as shown below. For projects like
+    launcher add `usageData.enableTelemetry()` to main and renderer window.
+-   When using `getPersistedTerminalSettings` replace the serialNumber with the
+    device in question
+-   When using `persistTerminalSettings` replace the serialNumber with the
+    device in question s
+
+```tsx
+import React from 'react';
+import { App, render } from '@nordicsemiconductor/pc-nrfconnect-shared';
+import usageData from '@nordicsemiconductor/pc-nrfconnect-shared/src/utils/usageData';
+
+usageData.enableTelemetry();
+
+render(<App panes={[]} />);
+```
+
 ## 122 - 2023-11-02
 
 ### Changed