@nordicsemiconductor/pc-nrfconnect-shared 230.0.0 → 232.0.0

package/README.md

@@ -3,10 +3,10 @@
 This project provides shared commodities for developing nRF Connect for Desktop
 apps and their launcher:
 
--   React components
--   Build scripts
--   Configurations
--   Test facilities
+- React components
+- Build scripts
+- Configurations
+- Test facilities
 
 ## Developing a new feature or fixing an error
 
@@ -21,10 +21,10 @@ change as a new version right ahead, add a new section with the heading
 
 To release, two files must be up-to-date:
 
--   `package.json` contain the correct version number (one more than the last
-    release).
--   `Changelog.md` must contain an entry, with that version number and today's
-    date.
+- `package.json` contain the correct version number (one more than the last
+  release).
+- `Changelog.md` must contain an entry, with that version number and today's
+  date.
 
 By running `npm run prepare-shared-release` you update the version in
 `package.json` and in `Changelog.md` a potential `## Unreleased` heading is

package/config/colors.js

@@ -37,7 +37,7 @@ paletteColorsKeys.forEach(color => {
 });
 
 const colors = Object.entries(flattenedColors).filter(
-    ([key]) => !paletteColorsKeys.find(c => key.startsWith(c))
+    ([key]) => !paletteColorsKeys.find(c => key.startsWith(c)),
 );
 
 module.exports = {

package/config/eslintrc.js

@@ -17,9 +17,10 @@ module.exports = {
     extends: [
         'eslint:recommended',
         'airbnb',
-        'plugin:@typescript-eslint/recommended',
+        'plugin:@typescript-eslint/strict',
         'plugin:import/recommended',
         'plugin:import/typescript',
+        'plugin:jsonc/recommended-with-jsonc',
         'prettier',
     ],
     ignorePatterns: [
@@ -35,9 +36,7 @@ module.exports = {
             'error',
             { 'ts-expect-error': 'allow-with-description' },
         ],
-        '@typescript-eslint/no-empty-function': 'off',
         '@typescript-eslint/no-shadow': 'error',
-        '@typescript-eslint/no-var-requires': 'off',
         'import/default': 'error',
         'import/extensions': 'off',
         'import/named': 'error',
@@ -64,10 +63,11 @@ module.exports = {
                 plugins: [
                     'preset-lint-markdown-style-guide',
                     'frontmatter',
-                    ['lint-no-duplicate-headings', false],
-                    ['lint-list-item-indent', false],
                     ['lint-emphasis-marker', false],
+                    ['lint-list-item-content-indent', false],
+                    ['lint-list-item-indent', false],
                     ['lint-list-item-spacing', false],
+                    ['lint-no-duplicate-headings', false],
                     ['lint-no-literal-urls', false],
                 ],
             },
@@ -125,6 +125,19 @@ module.exports = {
             },
         ],
         'valid-jsdoc': ['error', { prefer: { return: 'returns' } }],
+        'no-empty-function': [
+            'error',
+            { allow: ['arrowFunctions', 'constructors'] },
+        ],
+        'no-return-await': 'off',
+        '@typescript-eslint/no-unused-vars': [
+            'error',
+            {
+                args: 'all',
+                argsIgnorePattern: '^_',
+                varsIgnorePattern: '^_',
+            },
+        ],
     },
     overrides: [
         {
@@ -158,10 +171,17 @@ module.exports = {
         },
         {
             files: ['*.json'],
+            parser: 'jsonc-eslint-parser',
             rules: {
                 'no-template-curly-in-string': 'off',
             },
         },
+        {
+            files: ['*.js'],
+            rules: {
+                '@typescript-eslint/no-require-imports': 'off',
+            },
+        },
         {
             files: [
                 '**/__tests__/**/*.[jt]s?(x)',

package/config/jest.config.js

@@ -18,7 +18,7 @@ module.exports = (disabledMocks = []) => ({
         '^electron-store$': `${mockDir}/electronStoreMock.ts`,
         '@electron/remote': `${mockDir}/remoteMock.ts`,
         'react-markdown': require.resolve(
-            'react-markdown/react-markdown.min.js'
+            'react-markdown/react-markdown.min.js',
         ),
         ...(disabledMocks.includes('packageJson')
             ? {}

package/ipc/MetaFiles.ts

@@ -49,7 +49,7 @@ export interface AppInfo {
 export const semver = z.string().regex(
     // From https://semver.org
     /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/,
-    'Is not a valid string for a semantic version'
+    'Is not a valid string for a semantic version',
 );
 
 const nrfutilModuleName = z.string();
@@ -60,7 +60,7 @@ export type NrfutilModuleVersion = z.infer<typeof nrfutilModuleVersion>;
 
 export const nrfModules = z.record(
     nrfutilModuleName,
-    z.tuple([nrfutilModuleVersion])
+    z.tuple([nrfutilModuleVersion]),
 );
 
 export type NrfutilModules = z.infer<typeof nrfModules>;

package/ipc/README.md

@@ -16,28 +16,28 @@ launcher will react in the way the apps expect it.
 
 There are a few conventions we follow with the code here in `ipc/`:
 
--   In each file there are pairs of functions: One to send a message over an IPC
-    channel (e.g. `openApp`) and another to register a handler for the messages
-    on that same channel (e.g. `registerOpenApp`).
+- In each file there are pairs of functions: One to send a message over an IPC
+  channel (e.g. `openApp`) and another to register a handler for the messages on
+  that same channel (e.g. `registerOpenApp`).
 
     Usually these two functions utilize a shared signature which is defined in a
     type above them. Usually the functions are defined by invoking functions
     from `infrastructure/mainToRenderer.ts` or
     `infrastructure/rendererToMain.ts` which also use that type.
 
--   The functions mentioned before are then exported in objects with the names
-    `inMain`, `forRenderer`, `inRenderer`, and `forMain` to signify how the
-    functions are supposed to be used. E.g. the mentioned `openApp` is in
-    `inMain` because it is called by code in the renderer processes to invoke
-    code in the main process to open an window. `registerOpenApp` is in
-    `forRenderer` because the handler is registered so that code in the renderer
-    processes can invoke it.
+- The functions mentioned before are then exported in objects with the names
+  `inMain`, `forRenderer`, `inRenderer`, and `forMain` to signify how the
+  functions are supposed to be used. E.g. the mentioned `openApp` is in `inMain`
+  because it is called by code in the renderer processes to invoke code in the
+  main process to open an window. `registerOpenApp` is in `forRenderer` because
+  the handler is registered so that code in the renderer processes can invoke
+  it.
 
     So, `inMain` and `forRenderer` are used when sending messages from the
     renderer processes to the main process. `inRenderer` and `forMain` are used,
     when sending messages from the main process to the renderer processes.
 
--   The code here in `ipc/` must neither reference any code in `src/` (which is
-    for code of the renderer processes) nor in `main/` (which is for code in the
-    main process). Only the other way around code in those two folders can
-    reference code in `ipc/`.
+- The code here in `ipc/` must neither reference any code in `src/` (which is
+  for code of the renderer processes) nor in `main/` (which is for code in the
+  main process). Only the other way around code in those two folders can
+  reference code in `ipc/`.

package/ipc/appDetails.ts

@@ -30,7 +30,7 @@ type GetAppDetails = () => AppDetailsFromLauncher;
 const getAppDetails = invoke<GetAppDetails>(channel.request);
 
 const registerGetAppDetails = (
-    onGetAppDetails: (webContents: WebContents) => AppDetailsFromLauncher
+    onGetAppDetails: (webContents: WebContents) => AppDetailsFromLauncher,
 ) => {
     handleWithSender<GetAppDetails>(channel.request)(onGetAppDetails);
 

package/ipc/apps.ts

@@ -119,23 +119,23 @@ export type GetDownloadableAppsResult = {
 type GetDownloadableApps = () => GetDownloadableAppsResult;
 
 const getDownloadableApps = invoke<GetDownloadableApps>(
-    channel.getDownloadableApps
+    channel.getDownloadableApps,
 );
 const registerGetDownloadableApps = handle<GetDownloadableApps>(
-    channel.getDownloadableApps
+    channel.getDownloadableApps,
 );
 
 // installDownloadableApp
 type InstallDownloadableApp = (
     app: DownloadableApp,
-    version?: string
+    version?: string,
 ) => DownloadableApp;
 
 const installDownloadableApp = invoke<InstallDownloadableApp>(
-    channel.installDownloadableApp
+    channel.installDownloadableApp,
 );
 const registerInstallDownloadableApp = handle<InstallDownloadableApp>(
-    channel.installDownloadableApp
+    channel.installDownloadableApp,
 );
 
 export const forRenderer = {

package/ipc/infrastructure/mainToRenderer.ts

@@ -25,7 +25,7 @@ export const on =
     <T extends (...args: never[]) => void>(channel: string) =>
     (handler: T) =>
         ipcRenderer.on(channel, (_event, ...args: unknown[]) =>
-            handler(...(args as Parameters<T>))
+            handler(...(args as Parameters<T>)),
         );
 
 // Broadcast with a subchannel
@@ -44,10 +44,10 @@ export const broadcast =
 export const onBroadcasted =
     <T extends (...args: never[]) => void>(
         channel: string,
-        subChannel: string
+        subChannel: string,
     ) =>
     (handler: T) =>
         ipcRenderer.on(
             `${channel}_${subChannel}`,
-            (_event, ...args: unknown[]) => handler(...(args as Parameters<T>))
+            (_event, ...args: unknown[]) => handler(...(args as Parameters<T>)),
         );

package/ipc/infrastructure/rendererToMain.ts

@@ -16,7 +16,7 @@ export const on =
     <T extends (...args: never[]) => void>(channel: string) =>
     (handler: T) =>
         ipcMain.on(channel, (_event, ...args: unknown[]) =>
-            handler(...(args as Parameters<T>))
+            handler(...(args as Parameters<T>)),
         );
 
 // Invoke
@@ -30,10 +30,10 @@ export const handle =
     (
         handler:
             | ((...args: Parameters<T>) => ReturnType<T>)
-            | ((...args: Parameters<T>) => Promise<ReturnType<T>>)
+            | ((...args: Parameters<T>) => Promise<ReturnType<T>>),
     ) =>
         ipcMain.handle(channel, (_event, ...args: unknown[]) =>
-            handler(...(args as Parameters<T>))
+            handler(...(args as Parameters<T>)),
         );
 
 export const handleWithSender =
@@ -44,8 +44,8 @@ export const handleWithSender =
             | ((
                   sender: WebContents,
                   ...args: Parameters<T>
-              ) => Promise<ReturnType<T>>)
+              ) => Promise<ReturnType<T>>),
     ) =>
         ipcMain.handle(channel, ({ sender }, ...args: unknown[]) =>
-            handler(sender, ...(args as Parameters<T>))
+            handler(sender, ...(args as Parameters<T>)),
         );

package/ipc/open.ts

@@ -17,12 +17,12 @@ const channel = {
 
 // app
 export const isOpenAppOptionsDeviceSN = (
-    device: OpenAppOptionsDevice
+    device: OpenAppOptionsDevice,
 ): device is OpenAppOptionsDeviceSN =>
     (device as OpenAppOptionsDeviceSN).serialNumber !== undefined;
 
 export const isOpenAppOptionsDevicePort = (
-    device: OpenAppOptionsDevice
+    device: OpenAppOptionsDevice,
 ): device is OpenAppOptionsDevicePort =>
     (device as OpenAppOptionsDevicePort).serialPortPath !== undefined;
 

package/ipc/safeStorage.ts

@@ -14,10 +14,10 @@ const channel = {
 
 type EncryptionAvailable = () => boolean;
 const isEncryptionAvailable = invoke<EncryptionAvailable>(
-    channel.encryptionAvailable
+    channel.encryptionAvailable,
 );
 const registerEncryptionAvailable = handle<EncryptionAvailable>(
-    channel.encryptionAvailable
+    channel.encryptionAvailable,
 );
 
 type EncryptString = (plainText: string) => Buffer;

package/ipc/schema/packageJson.ts

@@ -39,7 +39,7 @@ const nrfConnectForDesktop = z.object({
 const recordOfOptionalStrings = z.record(z.string().optional());
 
 const engines = recordOfOptionalStrings.and(
-    z.object({ nrfconnect: z.string() })
+    z.object({ nrfconnect: z.string() }),
 );
 
 const packageJsonApp = packageJson.extend({

package/ipc/serialPort.ts

@@ -59,7 +59,7 @@ export type OverwriteOptions = {
 
 type Open = (
     options: SerialPortOpenOptions<AutoDetectTypes>,
-    overwriteOptions: OverwriteOptions
+    overwriteOptions: OverwriteOptions,
 ) => void;
 const open = invoke<Open>(channel.open);
 const registerOpen = handleWithSender<Open>(channel.open);
@@ -89,7 +89,7 @@ const isOpen = invoke<IsOpen>(channel.isOpen);
 const registerIsOpen = handle<IsOpen>(channel.isOpen);
 
 type GetOptions = (
-    path: string
+    path: string,
 ) => SerialPortOpenOptions<AutoDetectTypes> | undefined;
 const getOptions = invoke<GetOptions>(channel.getOptions);
 const registerGetOptions = handle<GetOptions>(channel.getOptions);

package/main/index.ts

@@ -56,3 +56,10 @@ export {
     isOpenAppOptionsDevicePort,
     isOpenAppOptionsDeviceSN,
 } from '../ipc/open';
+
+export {
+    createDisposableTempDir,
+    createDisposableTempFile,
+} from '../nrfutil/fs';
+
+export { getTriplet } from '../nrfutil/sandbox';

package/mocks/electronStoreMock.ts

@@ -11,7 +11,7 @@ export default jest.fn(() => {
     return {
         get: jest.fn(
             (key: string, defaultValue?: unknown) =>
-                cache.get(key) ?? defaultValue
+                cache.get(key) ?? defaultValue,
         ),
         set: jest.fn(cache.set.bind(cache)),
         clear: jest.fn(cache.clear.bind(cache)),

package/nrfutil/collectingResultParser.ts

@@ -21,12 +21,11 @@ export default class CollectingResultParser<Result> {
     private readonly info: Result[] = [];
     private readonly taskEnd: TaskEnd<Result>[] = [];
 
-    // eslint-disable-next-line no-useless-constructor
     constructor(
         private onLog: OnLog,
         private onProgress?: OnProgress,
         private onTaskBegin?: OnTaskBegin,
-        private onTaskEnd?: OnTaskEnd<Result>
+        private onTaskEnd?: OnTaskEnd<Result>,
     ) {}
 
     public handleData = (data: Buffer, pid?: number) => {
@@ -42,7 +41,7 @@ export default class CollectingResultParser<Result> {
                 case 'task_progress':
                     this.onProgress?.(
                         convertNrfutilProgress(item.data.progress),
-                        item.data.task
+                        item.data.task,
                     );
                     break;
                 case 'task_begin':
@@ -74,7 +73,7 @@ export default class CollectingResultParser<Result> {
         this.taskEnd
             .filter(end => end.result === 'fail' && !!end.message)
             .map(end =>
-                end.message ? `Message: ${addPunctuation(end.message)}` : ''
+                end.message ? `Message: ${addPunctuation(end.message)}` : '',
             )
             .join('\n');
 

package/nrfutil/device/batch.ts

@@ -4,9 +4,8 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import fs from 'fs';
-
 import { getModule } from '..';
+import { createDisposableTempFile } from '../fs';
 import { TaskEnd } from '../sandboxTypes';
 import { BatchOperationWrapper, Callbacks } from './batchTypes';
 import {
@@ -21,7 +20,6 @@ import { DeviceCoreInfo } from './getCoreInfo';
 import { FWInfo } from './getFwInfo';
 import { GetProtectionStatusResult } from './getProtectionStatus';
 import {
-    createTempFile,
     Firmware,
     ProgrammingOptions,
     programmingOptionsToArgs,
@@ -51,7 +49,7 @@ export class Batch {
         command: string,
         core: DeviceCore,
         callbacks?: CallbacksUnknown,
-        args: string[] = []
+        args: string[] = [],
     ) {
         const getPromise = async () => {
             const box = await getModule('device');
@@ -60,7 +58,7 @@ export class Batch {
                 await box.singleInfoOperationOptionalData<object>(
                     command,
                     undefined,
-                    ['--generate', ...coreArg(core), ...args]
+                    ['--generate', ...coreArg(core), ...args],
                 );
 
             return {
@@ -78,7 +76,7 @@ export class Batch {
         this.enqueueBatchOperationObject(
             'device-info',
             core,
-            callbacks as CallbacksUnknown
+            callbacks as CallbacksUnknown,
         );
 
         return this;
@@ -88,7 +86,7 @@ export class Batch {
         this.enqueueBatchOperationObject(
             'erase',
             core,
-            callbacks as CallbacksUnknown
+            callbacks as CallbacksUnknown,
         );
 
         return this;
@@ -111,7 +109,7 @@ export class Batch {
                     },
                     ...callbacks,
                 } as BatchOperationWrapperUnknown);
-            })
+            }),
         );
 
         return this;
@@ -133,7 +131,7 @@ export class Batch {
                     },
                     ...callbacks,
                 } as BatchOperationWrapperUnknown);
-            })
+            }),
         );
 
         return this;
@@ -155,7 +153,7 @@ export class Batch {
                     },
                     ...callbacks,
                 } as BatchOperationWrapperUnknown);
-            })
+            }),
         );
 
         return this;
@@ -164,7 +162,7 @@ export class Batch {
     public xRead(
         core: DeviceCore,
         options: XReadOptions,
-        callbacks?: Callbacks<ReadResult>
+        callbacks?: Callbacks<ReadResult>,
     ) {
         this.enqueueBatchOperationObject(
             'x-read',
@@ -188,7 +186,7 @@ export class Batch {
                     }
                 },
             } as CallbacksUnknown,
-            xReadOptionsToArgs(options)
+            xReadOptionsToArgs(options),
         );
 
         return this;
@@ -196,12 +194,12 @@ export class Batch {
 
     public getCoreInfo(
         core: DeviceCore,
-        callbacks?: Callbacks<DeviceCoreInfo>
+        callbacks?: Callbacks<DeviceCoreInfo>,
     ) {
         this.enqueueBatchOperationObject(
             'core-info',
             core,
-            callbacks as CallbacksUnknown
+            callbacks as CallbacksUnknown,
         );
 
         return this;
@@ -211,7 +209,7 @@ export class Batch {
         this.enqueueBatchOperationObject(
             'fw-info',
             core,
-            callbacks as CallbacksUnknown
+            callbacks as CallbacksUnknown,
         );
 
         return this;
@@ -219,12 +217,12 @@ export class Batch {
 
     public getProtectionStatus(
         core: DeviceCore,
-        callbacks?: Callbacks<GetProtectionStatusResult>
+        callbacks?: Callbacks<GetProtectionStatusResult>,
     ) {
         this.enqueueBatchOperationObject(
             'protection-get',
             core,
-            callbacks as CallbacksUnknown
+            callbacks as CallbacksUnknown,
         );
 
         return this;
@@ -235,7 +233,7 @@ export class Batch {
         core: DeviceCore,
         programmingOptions?: ProgrammingOptions,
         deviceTraits?: DeviceTraits,
-        callbacks?: CallbacksUnknown
+        callbacks?: CallbacksUnknown,
     ) {
         const args = [
             ...(deviceTraits ? deviceTraitsToArgs(deviceTraits) : []),
@@ -246,11 +244,15 @@ export class Batch {
         if (typeof firmware === 'string') {
             args.unshift('--firmware', firmware);
         } else {
-            const tempFilePath = createTempFile(firmware);
-            args.unshift('--firmware', tempFilePath);
+            const tempFile = createDisposableTempFile(
+                firmware.buffer,
+                firmware.type,
+            );
+            args.unshift('--firmware', tempFile.path);
 
             newCallbacks.onTaskEnd = (taskEnd: TaskEnd<unknown>) => {
-                fs.unlinkSync(tempFilePath);
+                using _ = tempFile; // Dispose the temp file at the end of this function
+
                 callbacks?.onTaskEnd?.(taskEnd);
             };
         }
@@ -264,7 +266,7 @@ export class Batch {
         this.enqueueBatchOperationObject(
             'recover',
             core,
-            callbacks as CallbacksUnknown
+            callbacks as CallbacksUnknown,
         );
 
         return this;
@@ -275,7 +277,7 @@ export class Batch {
             'reset',
             core,
             callbacks as CallbacksUnknown,
-            reset ? ['--reset-kind', reset] : undefined
+            reset ? ['--reset-kind', reset] : undefined,
         );
 
         return this;
@@ -283,7 +285,7 @@ export class Batch {
 
     public collect(
         count: number,
-        callback: (completedTasks: TaskEnd<unknown>[]) => void
+        callback: (completedTasks: TaskEnd<unknown>[]) => void,
     ) {
         this.collectOperations.push({
             callback,
@@ -296,11 +298,11 @@ export class Batch {
 
     public async run(
         device: NrfutilDevice,
-        controller?: AbortController | undefined
+        controller?: AbortController | undefined,
     ): Promise<unknown[]> {
         if (!device.serialNumber) {
             throw new Error(
-                `Device does not have a serial number, no device operation is possible`
+                `Device does not have a serial number, no device operation is possible`,
             );
         }
 
@@ -315,7 +317,7 @@ export class Batch {
 
         const promiseResults =
             await Promise.allSettled<BatchOperationWrapperUnknown>(
-                this.operationBatchGeneration
+                this.operationBatchGeneration,
             );
         promiseResults.forEach(r => {
             if (r.status === 'rejected') {
@@ -345,14 +347,14 @@ export class Batch {
                     if (task && currentOperationIndex !== -1) {
                         operations[currentOperationIndex].onProgress?.(
                             progress,
-                            task
+                            task,
                         );
                     }
                 },
                 onTaskBegin => {
                     currentOperationIndex += 1;
                     operations[currentOperationIndex].onTaskBegin?.(
-                        onTaskBegin
+                        onTaskBegin,
                     );
                 },
                 taskEnd => {
@@ -363,20 +365,20 @@ export class Batch {
                     this.collectOperations
                         .filter(
                             operation =>
-                                operation.operationId === currentOperationIndex
+                                operation.operationId === currentOperationIndex,
                         )
                         .forEach(operation => {
                             operation.callback(
                                 results.slice(
                                     results.length - operation.count,
-                                    results.length
-                                )
+                                    results.length,
+                                ),
                             );
                         });
 
                     lastCompletedOperationIndex += 1;
                 },
-                controller
+                controller,
             );
 
             const errors = results.filter(result => result.result === 'fail');
@@ -384,7 +386,7 @@ export class Batch {
                 const error = new Error(
                     `Batch failed: ${errors
                         .map(e => `error: ${e.error}, message: ${e.message}`)
-                        .join('\n')}`
+                        .join('\n')}`,
                 );
                 if (currentOperationIndex !== -1) {
                     operations[currentOperationIndex].onException?.(error);
@@ -394,7 +396,7 @@ export class Batch {
         } catch (error) {
             if (currentOperationIndex !== lastCompletedOperationIndex) {
                 operations[currentOperationIndex]?.onException?.(
-                    error as Error
+                    error as Error,
                 );
             }
             throw error;