@nordicsemiconductor/pc-nrfconnect-shared 76.0.0 → 79.0.0

package/ipc/serialPort.ts

@@ -0,0 +1,167 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import type {
+    AutoDetectTypes,
+    SetOptions,
+    UpdateOptions,
+} from '@serialport/bindings-cpp';
+import type { SerialPortOpenOptions } from 'serialport';
+
+import { broadcast, onBroadcasted } from './infrastructure/mainToRenderer';
+import {
+    handle,
+    handleWithSender,
+    invoke,
+} from './infrastructure/rendererToMain';
+
+const channel = {
+    // **************
+    // Commands (from the renderer processes of apps to the main process)
+    // **************
+    open: 'serialport:open',
+    close: 'serialport:close',
+    write: 'serialport:write',
+    update: 'serialport:update',
+    set: 'serialport:set',
+
+    // **************
+    // Queries (from the renderer processes of apps to the main process)
+    // **************
+    isOpen: 'serialport:is-open',
+    getOptions: 'serialport:get-options',
+
+    // **************
+    // Callbacks (from the the main process to the renderer processes of apps)
+    // **************
+    onClosed: 'serialport:on-close',
+    onUpdated: 'serialport:on-update',
+    onSet: 'serialport:on-set',
+    onChanged: 'serialport:on-changed',
+
+    // Would be nice to rename the next two channels, but we cannot change the
+    // string because it would break interoperability between apps and launchers
+    onDataReived: 'serialport:on-data',
+    onDataWritten: 'serialport:on-write',
+};
+
+export type OverwriteOptions = {
+    overwrite?: boolean;
+    settingsLocked?: boolean;
+};
+
+// **************
+// Commands (from the renderer processes of apps to the main process)
+// **************
+
+type Open = (
+    options: SerialPortOpenOptions<AutoDetectTypes>,
+    overwriteOptions: OverwriteOptions
+) => void;
+const open = invoke<Open>(channel.open);
+const registerOpen = handleWithSender<Open>(channel.open);
+
+type Close = (path: string) => void;
+const close = invoke<Close>(channel.close);
+const registerClose = handleWithSender<Close>(channel.close);
+
+type Write = (path: string, data: string | number[] | Buffer) => void;
+const write = invoke<Write>(channel.write);
+const registerWrite = handle<Write>(channel.write);
+
+type Update = (path: string, options: UpdateOptions) => void;
+const update = invoke<Update>(channel.update);
+const registerUpdate = handle<Update>(channel.update);
+
+type Set = (path: string, set: SetOptions) => void;
+const set = invoke<Set>(channel.set);
+const registerSet = handle<Set>(channel.set);
+
+// **************
+// Queries (from the renderer processes of apps to the main process)
+// **************
+
+type IsOpen = (path: string) => boolean;
+const isOpen = invoke<IsOpen>(channel.isOpen);
+const registerIsOpen = handle<IsOpen>(channel.isOpen);
+
+type GetOptions = (
+    path: string
+) => SerialPortOpenOptions<AutoDetectTypes> | undefined;
+const getOptions = invoke<GetOptions>(channel.getOptions);
+const registerGetOptions = handle<GetOptions>(channel.getOptions);
+
+// **************
+// Callbacks (from the the main process to the renderer processes of apps)
+// **************
+
+type OnDataReceived = (data: unknown) => void;
+const broadcastDataReceived = broadcast<OnDataReceived>(channel.onDataReived);
+const registerOnDataReceived = (path: string) =>
+    onBroadcasted<OnDataReceived>(channel.onDataReived, path);
+
+type OnDataWritten = (data: string | number[] | Buffer) => void;
+const broadcastDataWritten = broadcast<OnDataWritten>(channel.onDataWritten);
+const registerOnDataWritten = (path: string) =>
+    onBroadcasted<OnDataWritten>(channel.onDataWritten, path);
+
+type OnClosed = () => void;
+const broadcastClosed = broadcast<OnClosed>(channel.onClosed);
+const registerOnClosed = (path: string) =>
+    onBroadcasted<OnClosed>(channel.onClosed, path);
+
+type OnUpdate = (newOptions: UpdateOptions) => void;
+const broadcastUpdated = broadcast<OnUpdate>(channel.onUpdated);
+const registerOnUpdated = (path: string) =>
+    onBroadcasted<OnUpdate>(channel.onUpdated, path);
+
+type OnSet = (newOptions: SetOptions) => void;
+const broadcastSet = broadcast<OnSet>(channel.onSet);
+const registerOnSet = (path: string) =>
+    onBroadcasted<OnSet>(channel.onSet, path);
+
+type OnChanged = (newOptions: SerialPortOpenOptions<AutoDetectTypes>) => void;
+const broadcastChanged = broadcast<OnChanged>(channel.onChanged);
+const registerOnChanged = (path: string) =>
+    onBroadcasted<OnChanged>(channel.onChanged, path);
+
+export const inRenderer = {
+    broadcastChanged,
+    broadcastClosed,
+    broadcastDataReceived,
+    broadcastDataWritten,
+    broadcastSet,
+    broadcastUpdated,
+};
+
+export const forRenderer = {
+    registerClose,
+    registerGetOptions,
+    registerIsOpen,
+    registerOpen,
+    registerSet,
+    registerUpdate,
+    registerWrite,
+};
+
+export const inMain = {
+    open,
+    close,
+    write,
+    update,
+    set,
+    isOpen,
+    getOptions,
+};
+
+export const forMain = {
+    registerOnDataReceived,
+    registerOnDataWritten,
+    registerOnClosed,
+    registerOnUpdated,
+    registerOnSet,
+    registerOnChanged,
+};

package/ipc/sources.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { UrlString } from './MetaFiles';
+
+enum StandardSourceNames {
+    OFFICIAL = 'official',
+    LOCAL = 'local',
+}
+
+export const { LOCAL, OFFICIAL } = StandardSourceNames;
+export const allStandardSourceNames: SourceName[] = [OFFICIAL, LOCAL];
+
+export type SourceName = string;
+export type SourceUrl = UrlString;
+export type Source = { name: SourceName; url: SourceUrl };

package/jest.config.js

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+module.exports = require('./config/jest.config')(['react-ga']);

package/main/index.ts

@@ -4,29 +4,27 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-export const SERIALPORT_CHANNEL = {
-    OPEN: 'serialport:open',
-    CLOSE: 'serialport:close',
-    WRITE: 'serialport:write',
-    UPDATE: 'serialport:update',
-    SET: 'serialport:set',
+import { forRenderer as forRendererAppDetails } from '../ipc/appDetails';
+import { forRenderer as forRendererApps } from '../ipc/apps';
+import { forRenderer as forRendererOpenWindow } from '../ipc/openWindow';
+import { forRenderer as forRendererPreventSleep } from '../ipc/preventSleep';
+import {
+    forRenderer as forRendererSerialPort,
+    inRenderer as inRendererSerialPort,
+} from '../ipc/serialPort';
 
-    ON_CLOSED: 'serialport:on-close',
-    ON_DATA: 'serialport:on-data',
-    ON_UPDATE: 'serialport:on-update',
-    ON_SET: 'serialport:on-set',
-    ON_CHANGED: 'serialport:on-changed',
-    ON_WRITE: 'serialport:on-write',
+export { registerLauncherWindowFromMain } from '../ipc/infrastructure/mainToRenderer';
 
-    IS_OPEN: 'serialport:is-open',
-    GET_OPTIONS: 'serialport:get-options',
+export const appDetails = { forRenderer: forRendererAppDetails };
+export const apps = { forRenderer: forRendererApps };
+export const openWindow = { forRenderer: forRendererOpenWindow };
+export const preventSleep = { forRenderer: forRendererPreventSleep };
+export const serialPort = {
+    inRenderer: inRendererSerialPort,
+    forRenderer: forRendererSerialPort,
 };
 
-export type OverwriteOptions = {
-    overwrite?: boolean;
-    settingsLocked?: boolean;
-};
+export * from '../ipc/MetaFiles';
 
-export type OpenAppOptions = {
-    device?: { serialNumber: string; serialPortPath?: string };
-};
+export { type OverwriteOptions } from '../ipc/serialPort';
+export { type OpenAppOptions } from '../ipc/openWindow';

package/mocks/electronMock.ts

@@ -10,6 +10,8 @@ export const match = jest.fn();
 export const app = jest.fn();
 export const dialog = jest.fn();
 export const ipcRenderer = {
+    on: jest.fn(),
     once: jest.fn(),
+    invoke: jest.fn().mockResolvedValue(undefined),
     send: jest.fn(),
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nordicsemiconductor/pc-nrfconnect-shared",
-    "version": "76.0.0",
+    "version": "79.0.0",
     "description": "Shared commodities for developing pc-nrfconnect-* packages",
     "repository": {
         "type": "git",
@@ -15,21 +15,6 @@
         "nrfconnect-license": "./scripts/nrfconnect-license.ts",
         "run-esbuild": "./scripts/esbuild.js"
     },
-    "files": [
-        "./config",
-        "./dist",
-        "fw",
-        "main",
-        "mocks",
-        "./scripts",
-        "./src",
-        "./test",
-        "./typings",
-        "./styles.scss",
-        "LICENSE",
-        "Changelog.md",
-        "README.md"
-    ],
     "main": "src",
     "scripts": {
         "test": "jest",
@@ -37,6 +22,7 @@
         "check:lint": "eslint --color .",
         "check:types": "tsc --noEmit",
         "check:license": "ts-node scripts/nrfconnect-license.ts check",
+        "clean-generate-types": "rimraf ./typings/generated",
         "generate-types": "tsc --emitDeclarationOnly --declaration --declarationMap --outDir ./typings/generated --rootDir .",
         "prepare": "ts-node scripts/installHusky.ts",
         "release-shared": "ts-node scripts/release-shared.ts",

package/scripts/check-app-properties.ts

@@ -10,7 +10,7 @@ import { execSync } from 'child_process';
 import { existsSync, readdirSync, readFileSync } from 'fs';
 import property from 'lodash/property';
 
-import { PackageJson } from '../src/utils/AppTypes';
+import { PackageJson } from '../ipc/MetaFiles';
 
 const format = (strings: string[]) =>
     strings.map(string => `\`${string}\``).join(', ');

package/scripts/esbuild-renderer.js

@@ -22,7 +22,9 @@ const projectSpecificTailwindConfigPath = path.join(
 const tailwindConfig = () =>
     fs.existsSync(projectSpecificTailwindConfigPath)
         ? projectSpecificTailwindConfigPath
-        : require.resolve('pc-nrfconnect-shared/config/tailwind.config.js');
+        : require.resolve(
+              '@nordicsemiconductor/pc-nrfconnect-shared/config/tailwind.config.js'
+          );
 
 function options(additionalOptions) {
     const { dependencies } = JSON.parse(

package/scripts/esbuild.js

@@ -26,7 +26,7 @@ if (!fs.existsSync(distFolder)) {
 fs.copyFileSync(
     join(
         process.cwd(),
-        './node_modules/pc-nrfconnect-shared/scripts/nordic-publish.js'
+        './node_modules/@nordicsemiconductor/pc-nrfconnect-shared/scripts/nordic-publish.js'
     ),
     join(distFolder, 'nordic-publish.js')
 );
@@ -34,7 +34,7 @@ fs.copyFileSync(
 fs.copyFileSync(
     join(
         process.cwd(),
-        './node_modules/pc-nrfconnect-shared/dist/bootstrap.css'
+        './node_modules/@nordicsemiconductor/pc-nrfconnect-shared/dist/bootstrap.css'
     ),
     join(distFolder, 'bootstrap.css')
 );
@@ -47,7 +47,7 @@ if (process.argv.includes('--include-bootloader')) {
     fs.copyFileSync(
         join(
             process.cwd(),
-            './node_modules/pc-nrfconnect-shared/fw/bootloader/graviton_bootloader_v1.0.1-[nRF5_SDK_15.0.1-1.alpha_f76d012].zip'
+            './node_modules/@nordicsemiconductor/pc-nrfconnect-shared/fw/bootloader/graviton_bootloader_v1.0.1-[nRF5_SDK_15.0.1-1.alpha_f76d012].zip'
         ),
         join(
             process.cwd(),

package/scripts/nordic-publish.ts

@@ -13,7 +13,7 @@ import FtpClient from 'ftp';
 import semver from 'semver';
 import calculateShasum from 'shasum';
 
-import { AppInfo, PackageJson, SourceJson } from '../src/utils/AppTypes';
+import { AppInfo, PackageJson, SourceJson } from '../ipc/MetaFiles';
 import checkAppProperties from './check-app-properties';
 
 interface LegacyAppInfo {

package/scripts/release-shared.ts

@@ -25,7 +25,7 @@
 */
 import { execSync, spawnSync } from 'node:child_process';
 
-import { PackageJson } from '../src/utils/AppTypes';
+import { PackageJson } from '../ipc/MetaFiles';
 
 const logError = (message: string) => {
     console.error(message);

package/src/About/ApplicationCard.tsx

@@ -5,51 +5,22 @@
  */
 
 import React, { useEffect, useState } from 'react';
-import { ipcRenderer } from 'electron';
 
+import {
+    AppDetailsFromLauncher,
+    inMain as appDetails,
+} from '../../ipc/appDetails';
 import Card from '../Card/Card';
 import FactoryResetButton from '../FactoryReset/FactoryResetButton';
 import AboutButton from './AboutButton';
 import Section from './Section';
 import ShortcutButton from './ShortcutButton';
 
-interface AppDetails {
-    coreVersion: string;
-    corePath: string;
-    homeDir: string;
-    tmpDir: string;
-}
-
-interface LauncerApp {
-    name?: string;
-    displayName?: string;
-    description?: string;
-    homepage?: string;
-    currentVersion?: string;
-    latestVersion?: string;
-    engineVersion?: string;
-    path?: string;
-    iconPath?: string;
-    shortcutIconPath?: string;
-    isOfficial?: string;
-    sharedVersion?: string;
-    source?: string;
-    url?: string;
-    releaseNote?: string;
-    upgradeAvailable?: string;
-    repositoryUrl?: string;
-}
-
-type DetailsFromLauncher = AppDetails & LauncerApp;
-
 export default () => {
-    const [appInfo, setAppInfo] = useState<DetailsFromLauncher>();
+    const [appInfo, setAppInfo] = useState<AppDetailsFromLauncher>();
 
     useEffect(() => {
-        ipcRenderer.once('app-details', (_, details: DetailsFromLauncher) => {
-            setAppInfo(details);
-        });
-        ipcRenderer.send('get-app-details');
+        appDetails.getAppDetails().then(setAppInfo);
     }, [setAppInfo]);
 
     if (appInfo == null) return null;

package/src/About/DeviceCard.tsx

@@ -36,7 +36,7 @@ export default () => {
         );
     }
 
-    const pca = device.boardVersion;
+    const pca = device.jlink?.boardVersion;
     const { name, cores } = deviceInfo(device);
 
     return (

package/src/App/App.tsx

@@ -9,9 +9,9 @@ import 'focus-visible';
 import React, { FC, ReactNode, useEffect, useMemo } from 'react';
 import Carousel from 'react-bootstrap/Carousel';
 import { useDispatch, useSelector } from 'react-redux';
-import { ipcRenderer } from 'electron';
 import { Reducer } from 'redux';
 
+import { inMain as openWindow } from '../../ipc/openWindow';
 import About from '../About/About';
 import BrokenDeviceDialog from '../Device/BrokenDeviceDialog/BrokenDeviceDialog';
 import { setAutoReselect } from '../Device/deviceAutoSelectSlice';
@@ -102,7 +102,7 @@ const ConnectedApp: FC<ConnectedAppProps> = ({
         hotKey: 'alt+l',
         title: 'Open launcher',
         isGlobal: true,
-        action: () => ipcRenderer.send('open-app-launcher'),
+        action: openWindow.openLauncher,
     });
 
     useEffect(() => {

package/src/Device/DeviceSelector/DeviceList/MoreDeviceInfo.tsx

@@ -20,11 +20,11 @@ const Row = ({ children }: { children: ReactNode }) => (
 );
 
 const PcaNumber = ({ device }: { device: Device }) => {
-    if (device.boardVersion == null) {
+    if (!device.jlink?.boardVersion) {
         return null;
     }
 
-    return <div>{device.boardVersion}</div>;
+    return <div>{device.jlink.boardVersion}</div>;
 };
 
 const MaybeDeviceName = ({ device }: { device: Device }) => {

package/src/Device/deviceInfo/deviceInfo.ts

@@ -181,7 +181,7 @@ const devicesByPca: { [P in DevicePCA]: DeviceInfo } = {
 };
 
 const deviceByPca = (device: Device) =>
-    devicesByPca[String(device.boardVersion).toUpperCase() as DevicePCA];
+    devicesByPca[String(device.jlink?.boardVersion).toUpperCase() as DevicePCA];
 
 const NORDIC_VENDOR_ID = '1915';
 const isNordicDevice = (device: Device) =>
@@ -240,7 +240,7 @@ export const displayedDeviceName = (
         return device.nickname;
     }
 
-    return deviceInfo(device).name || device.boardVersion || 'Unknown';
+    return deviceInfo(device).name || device.jlink?.boardVersion || 'Unknown';
 };
 
 export const productPageUrl = (device: Device) =>

package/src/SerialPort/SerialPort.test.ts

@@ -6,20 +6,16 @@
 
 import { ipcRenderer } from 'electron';
 
-import { OverwriteOptions, SERIALPORT_CHANNEL } from '../../main';
+import { OverwriteOptions } from '../../ipc/serialPort';
 import { createSerialPort } from './SerialPort';
 
-jest.mock('electron', () => ({
-    ipcRenderer: { invoke: jest.fn(), on: jest.fn(), send: jest.fn() },
-}));
-
 const defaultOptions = { path: '/dev/ROBOT', baudRate: 115200 };
 
 test('SerialPort is initialized with the correct setup', async () => {
     const port = await createSerialPort(defaultOptions);
 
     expect(ipcRenderer.invoke).toHaveBeenCalledWith(
-        SERIALPORT_CHANNEL.OPEN,
+        'serialport:open',
         defaultOptions,
         { overwrite: false, settingsLocked: false }
     );
@@ -31,7 +27,7 @@ test('SerialPort may be initialized with overwrite and settingsLocked', async ()
     let overwriteOptions: OverwriteOptions = { overwrite: true };
     await createSerialPort(defaultOptions, overwriteOptions);
     expect(ipcRenderer.invoke).toHaveBeenCalledWith(
-        SERIALPORT_CHANNEL.OPEN,
+        'serialport:open',
         defaultOptions,
         overwriteOptions
     );
@@ -39,7 +35,7 @@ test('SerialPort may be initialized with overwrite and settingsLocked', async ()
     overwriteOptions = { settingsLocked: true };
     await createSerialPort(defaultOptions, overwriteOptions);
     expect(ipcRenderer.invoke).toHaveBeenCalledWith(
-        SERIALPORT_CHANNEL.OPEN,
+        'serialport:open',
         defaultOptions,
         overwriteOptions
     );
@@ -47,7 +43,7 @@ test('SerialPort may be initialized with overwrite and settingsLocked', async ()
     overwriteOptions = { settingsLocked: true, overwrite: true };
     await createSerialPort(defaultOptions, overwriteOptions);
     expect(ipcRenderer.invoke).toHaveBeenCalledWith(
-        SERIALPORT_CHANNEL.OPEN,
+        'serialport:open',
         defaultOptions,
         overwriteOptions
     );