@nordicsemiconductor/pc-nrfconnect-shared 76.0.0 → 79.0.0

package/src/SerialPort/SerialPort.ts

@@ -9,11 +9,10 @@ import type {
     SetOptions,
     UpdateOptions,
 } from '@serialport/bindings-cpp';
-import { ipcRenderer } from 'electron';
 import EventEmitter from 'events';
 import type { SerialPortOpenOptions } from 'serialport';
 
-import { OverwriteOptions, SERIALPORT_CHANNEL } from '../../main';
+import { forMain, inMain, OverwriteOptions } from '../../ipc/serialPort';
 import logger from '../logging';
 
 export type SerialPort = Awaited<ReturnType<typeof createSerialPort>>;
@@ -29,77 +28,30 @@ export const createSerialPort = async (
     const eventEmitter = new EventEmitter();
     let closed = false;
 
-    ipcRenderer.on(`${SERIALPORT_CHANNEL.ON_DATA}_${path}`, (_event, data) =>
+    forMain.registerOnDataReceived(path)(data =>
         eventEmitter.emit('onData', data)
     );
-    ipcRenderer.on(`${SERIALPORT_CHANNEL.ON_CLOSED}_${path}`, () => {
+    forMain.registerOnDataWritten(path)(data =>
+        eventEmitter.emit('onDataWritten', data)
+    );
+
+    forMain.registerOnClosed(path)(() => {
         eventEmitter.emit('onClosed');
         closed = true;
     });
-    ipcRenderer.on(
-        `${SERIALPORT_CHANNEL.ON_UPDATE}_${path}`,
-        (_event, newOptions) => eventEmitter.emit('onUpdate', newOptions)
+    forMain.registerOnUpdated(path)(newOptions =>
+        eventEmitter.emit('onUpdate', newOptions)
     );
-    ipcRenderer.on(
-        `${SERIALPORT_CHANNEL.ON_SET}_${path}`,
-        (_event, newOptions) => eventEmitter.emit('onSet', newOptions)
+    forMain.registerOnSet(path)(newOptions =>
+        eventEmitter.emit('onSet', newOptions)
     );
-    ipcRenderer.on(
-        `${SERIALPORT_CHANNEL.ON_CHANGED}_${path}`,
-        (_event, newOptions) => eventEmitter.emit('onChange', newOptions)
-    );
-
-    // The origin of this event is emitted when a renderer writes to the port.
-    ipcRenderer.on(`${SERIALPORT_CHANNEL.ON_WRITE}_${path}`, (_event, data) =>
-        eventEmitter.emit('onDataWritten', data)
+    forMain.registerOnChanged(path)(newOptions =>
+        eventEmitter.emit('onChange', newOptions)
     );
 
-    const write = (data: string | number[] | Buffer): void => {
-        ipcRenderer.invoke(SERIALPORT_CHANNEL.WRITE, path, data);
-    };
-
-    const isOpen = (): Promise<boolean> =>
-        ipcRenderer.invoke(SERIALPORT_CHANNEL.IS_OPEN, path);
-
-    const close = async () => {
-        if (closed) return;
-        const error = await ipcRenderer.invoke(SERIALPORT_CHANNEL.CLOSE, path);
-        if (error) {
-            // IPC only carries the error message, that's why we throw new Error.
-            throw new Error(error);
-        }
-
-        try {
-            if (await isOpen()) {
-                logger.info(
-                    `Port ${options.path} still in use by other window(s)`
-                );
-            }
-        } catch {
-            logger.info(`Closed port: ${options.path}`);
-        }
-    };
-
-    // Only supports baudRate, same as serialport.io
-    const update = (newOptions: UpdateOptions) => {
-        ipcRenderer.invoke(SERIALPORT_CHANNEL.UPDATE, path, newOptions);
-    };
-
-    const set = (newOptions: SetOptions) => {
-        ipcRenderer.invoke(SERIALPORT_CHANNEL.SET, path, newOptions);
-    };
-
-    const getOptions = ():
-        | Promise<SerialPortOpenOptions<AutoDetectTypes>>
-        | undefined => ipcRenderer.invoke(SERIALPORT_CHANNEL.GET_OPTIONS, path);
-
     const openWithRetries = async (retryCount: number) => {
         try {
-            return (await ipcRenderer.invoke(
-                SERIALPORT_CHANNEL.OPEN,
-                options,
-                overwriteOptions
-            )) as string;
+            return await inMain.open(options, overwriteOptions);
         } catch (error) {
             if (
                 (error as Error).message.includes(
@@ -107,18 +59,37 @@ export const createSerialPort = async (
                 ) &&
                 retryCount > 0
             ) {
-                return new Promise<string>(resolve => {
+                return new Promise<void | string>(resolve => {
                     setTimeout(async () => {
-                        resolve(
-                            (await openWithRetries(retryCount - 1)) as string
-                        );
+                        resolve(await openWithRetries(retryCount - 1));
                     }, 50 + Math.random() * 100);
                 });
             }
-            return Promise.resolve<string>((error as Error).message);
+            return (error as Error).message;
+        }
+    };
+
+    const close = async () => {
+        if (closed) return;
+        await inMain.close(path);
+
+        try {
+            if (await inMain.isOpen(path)) {
+                logger.info(
+                    `Port ${options.path} still in use by other window(s)`
+                );
+            }
+        } catch {
+            logger.info(`Closed port: ${options.path}`);
         }
     };
 
+    const write = (data: string | number[] | Buffer) =>
+        inMain.write(path, data);
+    const update = (newOptions: UpdateOptions) =>
+        inMain.update(path, newOptions); // Only supports baudRate, same as serialport.io
+    const set = (newOptions: SetOptions) => inMain.set(path, newOptions);
+
     const error = await openWithRetries(3);
 
     if (error) {
@@ -138,12 +109,15 @@ export const createSerialPort = async (
 
     return {
         path,
-        write,
+
         close,
-        isOpen,
+        write,
         update,
         set,
-        getOptions,
+
+        isOpen: () => inMain.isOpen(path),
+        getOptions: () => inMain.getOptions(path),
+
         onData: (handler: (data: Uint8Array) => void) => {
             eventEmitter.on('onData', handler);
             return () => {
@@ -187,15 +161,11 @@ export const createSerialPort = async (
     };
 };
 
-export const getSerialPortOptions = async (
-    path: string
-): Promise<SerialPortOpenOptions<AutoDetectTypes> | undefined> => {
+export const getSerialPortOptions = async (path: string) => {
     try {
         console.log('will fetch options from path=', path);
-        return (await ipcRenderer.invoke(
-            SERIALPORT_CHANNEL.GET_OPTIONS,
-            path
-        )) as SerialPortOpenOptions<AutoDetectTypes> | undefined;
+
+        return await inMain.getOptions(path);
     } catch (error) {
         logger.error(`Failed to get options for port: ${path}`);
     }

package/src/index.ts

@@ -5,9 +5,7 @@
  */
 import { hideDialog, showDialog } from './ErrorDialog/errorDialogSlice';
 
-const ErrorDialogActions = { hideDialog, showDialog };
-
-export { ErrorDialogActions };
+export const ErrorDialogActions = { hideDialog, showDialog };
 
 export { default as App, type PaneProps } from './App/App';
 export { default as Logo } from './Logo/Logo';
@@ -130,8 +128,6 @@ export {
 } from './SerialPort/SerialPort';
 export { default as ConflictingSettingsDialog } from './SerialPort/ConflictingSettingsDialog';
 
-export { openAppWindow } from './OpenApp/openApp';
-
 export type { AppDispatch, AppThunk, NrfConnectState } from './store';
 
 export {
@@ -140,13 +136,6 @@ export {
     prepareDevice,
 } from './Device/deviceSetup';
 
-export type {
-    AppInfo,
-    AppVersions,
-    PackageJson,
-    SourceJson,
-} from './utils/AppTypes';
-
 export {
     addNewMessage,
     newCopiedFlashMessage,
@@ -155,3 +144,7 @@ export {
     newErrorFlashMessage,
     newSuccessFlashMessage,
 } from './FlashMessage/FlashMessageSlice';
+
+export { inMain as apps } from '../ipc/apps';
+export { inMain as openWindow } from '../ipc/openWindow';
+export { inMain as preventSleep } from '../ipc/preventSleep';

package/src/logging/sendInitialLogMessages.ts

@@ -5,8 +5,8 @@
  */
 
 import { getModuleVersions } from '@nordicsemiconductor/nrf-device-lib-js';
-import { ipcRenderer } from 'electron';
 
+import { inMain as appDetails } from '../../ipc/appDetails';
 import {
     getDeviceLibContext,
     getModuleVersion,
@@ -17,48 +17,45 @@ import logLibVersions from '../utils/logLibVersions';
 import logger from '.';
 
 let initialMessagesSent = false;
-export default () => {
+export default async () => {
     if (initialMessagesSent) return;
     initialMessagesSent = true;
 
     logLibVersions();
     logger.debug(`Application data folder: ${getAppDataDir()}`);
 
-    ipcRenderer.once('app-details', async (_event, details) => {
-        const {
-            name,
-            currentVersion,
-            engineVersion,
-            coreVersion,
-            corePath,
-            isOfficial,
-            installed,
-            homeDir,
-            tmpDir,
-            bundledJlink,
-        } = details;
-
-        const official = isOfficial ? 'official' : 'local';
-
-        logger.debug(`App ${name} v${currentVersion} ${official}`);
-        logger.debug(`App path: ${installed.path}`);
-        logger.debug(
-            `nRFConnect ${coreVersion}, required by the app is (${engineVersion})`
-        );
-        logger.debug(`nRFConnect path: ${corePath}`);
-        logger.debug(`HomeDir: ${homeDir}`);
-        logger.debug(`TmpDir: ${tmpDir}`);
-
-        if (bundledJlink) {
-            const versions = await getModuleVersions(getDeviceLibContext());
-            const jlinkVersion = getModuleVersion('JlinkARM', versions);
-
-            if (!describeVersion(jlinkVersion).includes(bundledJlink)) {
-                logger.info(
-                    `Installed JLink version does not match the provided version (${bundledJlink})`
-                );
-            }
+    const details = await appDetails.getAppDetails();
+
+    const {
+        name,
+        currentVersion,
+        engineVersion,
+        coreVersion,
+        corePath,
+        installed,
+        homeDir,
+        tmpDir,
+        bundledJlink,
+        source,
+    } = details;
+
+    logger.debug(`App ${name} v${currentVersion} (${source})`);
+    logger.debug(`App path: ${installed.path}`);
+    logger.debug(
+        `nRFConnect ${coreVersion}, required by the app is (${engineVersion})`
+    );
+    logger.debug(`nRFConnect path: ${corePath}`);
+    logger.debug(`HomeDir: ${homeDir}`);
+    logger.debug(`TmpDir: ${tmpDir}`);
+
+    if (bundledJlink) {
+        const versions = await getModuleVersions(getDeviceLibContext());
+        const jlinkVersion = getModuleVersion('JlinkARM', versions);
+
+        if (!describeVersion(jlinkVersion).includes(bundledJlink)) {
+            logger.info(
+                `Installed JLink version does not match the provided version (${bundledJlink})`
+            );
         }
-    });
-    ipcRenderer.send('get-app-details');
+    }
 };

package/src/utils/packageJson.ts

@@ -32,8 +32,8 @@ import { readFileSync } from 'fs';
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore This will be available when the app uses it.
 // eslint-disable-next-line import/no-unresolved
-import packageJsons from '../../../../package.json';
-import type { PackageJson } from './AppTypes';
+import packageJsons from '../../../../../package.json';
+import type { PackageJson } from '../../ipc/MetaFiles';
 
 let packageJson: PackageJson = packageJsons;
 

package/src/utils/systemReport.ts

@@ -95,9 +95,9 @@ const allDevicesReport = (allDevices: Device[] = []) => [
     '- Connected devices:',
     ...allDevices.map(
         d =>
-            `    - ${d.serialNumber} ${d.boardVersion || ''}: ${d.serialPorts
-                ?.map(s => s.comName)
-                .join(', ')}`
+            `    - ${d.serialNumber} ${
+                d.jlink?.boardVersion || ''
+            }: ${d.serialPorts?.map(s => s.comName).join(', ')}`
     ),
     '',
 ];

package/src/utils/usageData.ts

@@ -7,8 +7,8 @@
 import { ApplicationInsights } from '@microsoft/applicationinsights-web';
 import type Systeminformation from 'systeminformation';
 
+import type { PackageJson } from '../../ipc/MetaFiles';
 import logger from '../logging';
-import type { PackageJson } from './AppTypes';
 import { isDevelopment } from './environment';
 import {
     deleteIsSendingUsageData,

package/tailwind.config.js

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+const baseConfig = require('./config/tailwind.config.js');
+
+module.exports = {
+    ...baseConfig,
+};

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+    "extends": "./config/tsconfig.json",
+    "include": [
+        "./main/**/*.ts",
+        "./src/**/*.ts",
+        "./src/**/*.tsx",
+        "./typings/*.d.ts"
+    ]
+}