@nordicsemiconductor/pc-nrfconnect-shared 240.0.0 → 242.0.0

package/nrfutil/device/getBoardControllerVersion.ts

@@ -5,7 +5,7 @@
  */
 
 import { type OnProgress } from '../sandboxTypes';
-import { deviceSingleTaskEndOperation, NrfutilDevice } from './common';
+import { deviceSingleTaskEndOperation, type NrfutilDevice } from './common';
 
 export interface BoardControllerVersionResponse {
     data: BoardControllerVersion;

package/nrfutil/device/getCoreInfo.ts

@@ -7,9 +7,9 @@
 import { type OnProgress } from '../sandboxTypes';
 import {
     coreArg,
-    DeviceCore,
+    type DeviceCore,
     deviceSingleTaskEndOperation,
-    NrfutilDevice,
+    type NrfutilDevice,
 } from './common';
 
 export type DeviceCoreInfo = {

package/nrfutil/device/getFwInfo.ts

@@ -7,9 +7,9 @@
 import { type OnProgress } from '../sandboxTypes';
 import {
     coreArg,
-    DeviceCore,
+    type DeviceCore,
     deviceSingleTaskEndOperation,
-    NrfutilDevice,
+    type NrfutilDevice,
 } from './common';
 
 type BootloaderType =

package/nrfutil/device/getProtectionStatus.ts

@@ -7,10 +7,10 @@
 import { type OnProgress } from '../sandboxTypes';
 import {
     coreArg,
-    DeviceCore,
+    type DeviceCore,
     deviceSingleTaskEndOperation,
-    NrfutilDevice,
-    ProtectionStatus,
+    type NrfutilDevice,
+    type ProtectionStatus,
 } from './common';
 
 type DeviceFamily =

package/nrfutil/device/list.ts

@@ -5,7 +5,11 @@
  */
 
 import { getModule } from '..';
-import { DeviceTraits, deviceTraitsToArgs, NrfutilDevice } from './common';
+import {
+    type DeviceTraits,
+    deviceTraitsToArgs,
+    type NrfutilDevice,
+} from './common';
 
 export interface HotplugEvent {
     id: number;

package/nrfutil/device/program.ts

@@ -8,11 +8,11 @@ import { createDisposableTempFile } from '../fs';
 import { type OnProgress } from '../sandboxTypes';
 import {
     coreArg,
-    DeviceCore,
+    type DeviceCore,
     deviceSingleTaskEndOperationVoid,
     deviceTraitsToArgs,
-    NrfutilDevice,
-    ResetKind,
+    type NrfutilDevice,
+    type ResetKind,
 } from './common';
 
 export type FileExtension = 'zip' | 'hex';

package/nrfutil/device/recover.ts

@@ -7,9 +7,9 @@
 import { type OnProgress } from '../sandboxTypes';
 import {
     coreArg,
-    DeviceCore,
+    type DeviceCore,
     deviceSingleTaskEndOperationVoid,
-    NrfutilDevice,
+    type NrfutilDevice,
 } from './common';
 
 export default (

package/nrfutil/device/reset.ts

@@ -7,10 +7,10 @@
 import { type OnProgress } from '../sandboxTypes';
 import {
     coreArg,
-    DeviceCore,
+    type DeviceCore,
     deviceSingleTaskEndOperationVoid,
-    NrfutilDevice,
-    ResetKind,
+    type NrfutilDevice,
+    type ResetKind,
 } from './common';
 
 export default async (

package/nrfutil/device/setMcuState.ts

@@ -5,7 +5,7 @@
  */
 
 import { type OnProgress } from '../sandboxTypes';
-import { deviceSingleTaskEndOperationVoid, NrfutilDevice } from './common';
+import { deviceSingleTaskEndOperationVoid, type NrfutilDevice } from './common';
 
 export type McuState = 'Application' | 'Programming';
 

package/nrfutil/device/setProtectionStatus.ts

@@ -7,9 +7,9 @@
 import { type OnProgress } from '../sandboxTypes';
 import {
     coreArg,
-    DeviceCore,
+    type DeviceCore,
     deviceSingleTaskEndOperationVoid,
-    NrfutilDevice,
+    type NrfutilDevice,
 } from './common';
 
 export default (

package/nrfutil/device/xRead.ts

@@ -8,9 +8,9 @@
 import { type OnProgress } from '../sandboxTypes';
 import {
     coreArg,
-    DeviceCore,
+    type DeviceCore,
     deviceSingleTaskEndOperation,
-    NrfutilDevice,
+    type NrfutilDevice,
 } from './common';
 
 export interface MemoryData {

package/nrfutil/modules.ts

@@ -10,7 +10,7 @@ import { getIsLoggingVerbose } from '../src/utils/persistentStore';
 import logLibVersions from './device/logLibVersions';
 import { getNrfutilLogger } from './nrfutilLogger';
 import { NrfutilSandbox } from './sandbox';
-import { LogLevel } from './sandboxTypes';
+import { type LogLevel } from './sandboxTypes';
 import { describeVersion } from './version/moduleVersion';
 
 const fallbackLevel = process.env.NODE_ENV === 'production' ? 'off' : 'error';

package/nrfutil/nrfutilLogger.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import winston from 'winston';
+import type winston from 'winston';
 
 let nrfutilLogger: winston.Logger | undefined;
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nordicsemiconductor/pc-nrfconnect-shared",
-    "version": "240.0.0",
+    "version": "242.0.0",
     "description": "Shared commodities for developing pc-nrfconnect-* packages",
     "repository": {
         "type": "git",
@@ -12,7 +12,7 @@
         "check-for-typescript": "scripts/check-for-typescript.ts",
         "check-app-properties": "scripts/check-app-properties.ts",
         "nrfconnect-license": "scripts/nrfconnect-license.ts",
-        "run-esbuild": "scripts/esbuild.ts"
+        "run-esbuild": "scripts/build-app.ts"
     },
     "main": "src",
     "scripts": {
@@ -22,11 +22,9 @@
         "check:types": "tsc --noEmit",
         "check:license": "tsx scripts/nrfconnect-license.ts check",
         "create-source": "tsx scripts/create-source.ts",
-        "generate-types": "tsc --emitDeclarationOnly --declaration --declarationMap --outDir ./typings/generated --rootDir .",
-        "prepare": "tsx scripts/installHusky.ts",
+        "prepare": "tsx scripts/installHusky.ts && tsx scripts/build-shared.ts",
         "prepare-shared-release": "tsx scripts/prepare-shared-release.ts",
-        "clean": "rimraf dist typings/generated scripts/nordic-publish.js",
-        "postinstall": "tsx scripts/postinstall.ts"
+        "clean": "rimraf dist"
     },
     "dependencies": {
         "@electron/remote": "^2.1.2",
@@ -128,6 +126,6 @@
     "devDependencies": {
         "@commander-js/extra-typings": "^10.0.3"
     },
-    "typings": "./typings/generated/src/index.d.ts",
+    "typings": "./dist/typings/src/index.d.ts",
     "prettier": "./config/prettier.config.js"
 }

package/release_notes.md

@@ -1,7 +1,19 @@
+### Added
+
+- Export types `Range`, `RangeOrValues`, and `Values`, used by `Slider`.
+
 ### Changed
 
-- Duplicate Tailwind classes and surrounding whitespaces are now removed.
+- Build scripts:
+    - Moved artifact generation from `postinstall` to `prepare` so that
+      generated artifacts are included in the published package.
+    - Simplified build script for apps.
+    - Place all generated files in `dist/`.
+- Enabled the ESLint rule `@typescript-eslint/consistent-type-imports` to assert
+  that type imports are always marked as such.
 
-### Fixed
+### Steps to upgrade when using this package
 
-- Checking the order of Tailwind classes was not done anymore.
+- The additional linting rule will most likely show that some type imports are
+  not marked as such. Those should be fixable by running
+  `npm run lint -- --fix`.

package/scripts/{esbuild.ts → build-app.ts}

@@ -20,21 +20,6 @@ const validate = (packageJson: string) => {
     }
 };
 
-const entry = () => {
-    const result = [
-        './src/index.jsx',
-        './lib/index.jsx',
-        './index.jsx',
-        './src/index.tsx',
-    ].find(fs.existsSync);
-
-    if (result == null) {
-        throw new Error('Found no entry point file');
-    }
-
-    return result;
-};
-
 const bundle = () => {
     const packageJson = fs.readFileSync('package.json', 'utf8');
 
@@ -43,9 +28,9 @@ const bundle = () => {
     build({
         define: {
             'process.env.PACKAGE_JSON': JSON.stringify(packageJson),
-            'process.env.APPLICATIONINSIGHTS_CONFIGURATION_CONTENT': '"{}"', // Needed because of https://github.com/microsoft/ApplicationInsights-node.js/issues/1226
         },
-        entryPoints: [entry()],
+        entryPoints: ['./src/index.tsx'],
+        outfile: './dist/bundle.js',
     });
 };
 
@@ -60,7 +45,7 @@ const copyFileToDist = (file: string) =>
 const copyFiles = () => {
     fs.mkdirSync('dist', { recursive: true });
 
-    copyFileToDist('scripts/nordic-publish.js');
+    copyFileToDist('dist/scripts/nordic-publish.js');
     copyFileToDist('dist/bootstrap.css');
     copyFileToDist('src/index.html');
 

package/scripts/build-shared.ts

@@ -0,0 +1,42 @@
+#!/usr/bin/env tsx
+
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { build } from 'esbuild';
+import { execSync } from 'node:child_process';
+
+import { build as esbuildRenderer } from './esbuild-renderer';
+
+const main = async () => {
+    console.log('Generate types');
+    execSync(
+        'tsc --emitDeclarationOnly --declaration --declarationMap --outDir ./dist/typings --rootDir .',
+        { encoding: 'utf-8', stdio: 'inherit' },
+    );
+
+    console.log('Build bootstrap.css');
+    await esbuildRenderer({
+        logLevel: 'warning',
+        entryPoints: ['./src/bootstrap.scss'],
+        outfile: 'dist/bootstrap.css',
+        sourcemap: false,
+    });
+
+    console.log('Build nordic-publish.js');
+    await build({
+        entryPoints: ['scripts/nordic-publish.ts'],
+        outdir: 'dist/scripts/',
+        bundle: true,
+        platform: 'node',
+        logLevel: 'warning',
+        minify: true,
+    });
+};
+
+main().catch(() => {
+    process.exit(1);
+});

package/scripts/check-app-properties.ts

@@ -10,7 +10,10 @@ import { execSync } from 'child_process';
 import { existsSync, readdirSync, readFileSync } from 'fs';
 import property from 'lodash/property';
 
-import { PackageJsonApp, parsePackageJsonApp } from '../ipc/schema/packageJson';
+import {
+    type PackageJsonApp,
+    parsePackageJsonApp,
+} from '../ipc/schema/packageJson';
 import { getLatestEntry } from './latest-changelog-entry';
 
 const format = (strings: string[]) =>

package/scripts/create-source.ts

@@ -8,7 +8,7 @@
 
 import { Command, Option } from '@commander-js/extra-typings';
 
-import { SourceJson } from '../ipc/MetaFiles';
+import { type SourceJson } from '../ipc/MetaFiles';
 
 const fail = (message: string) => {
     console.error(message);

package/scripts/esbuild-renderer.ts

@@ -6,7 +6,7 @@
 
 import { transform as svgr } from '@svgr/core';
 import autoprefixer from 'autoprefixer';
-import esbuild, { BuildOptions } from 'esbuild';
+import esbuild, { type BuildOptions } from 'esbuild';
 import { postcssModules, sassPlugin } from 'esbuild-sass-plugin';
 import postCssPlugin from 'esbuild-style-plugin';
 import * as fs from 'node:fs';
@@ -29,13 +29,7 @@ const tailwindConfig = () =>
               '@nordicsemiconductor/pc-nrfconnect-shared/config/tailwind.config.js',
           );
 
-type AdditionalOptions = Required<Pick<BuildOptions, 'entryPoints'>> &
-    Partial<BuildOptions>;
-
-const outfileOrDir = (additionalOptions: AdditionalOptions) =>
-    additionalOptions.entryPoints.length === 1
-        ? { outfile: './dist/bundle.js' }
-        : { outdir: './dist' };
+type AdditionalOptions = Partial<BuildOptions>;
 
 const options = (
     additionalOptions: AdditionalOptions,
@@ -43,7 +37,6 @@ const options = (
 ) =>
     ({
         format: 'iife',
-        ...outfileOrDir(additionalOptions),
         target: `chrome${chromeWithoutBuild}`,
         sourcemap: true,
         metafile: false,
@@ -136,6 +129,6 @@ export const build = async (
         await context.rebuild();
         await context.watch();
     } else {
-        esbuild.build(options(additionalOptions, externalReact));
+        return esbuild.build(options(additionalOptions, externalReact));
     }
 };

package/scripts/nordic-publish.ts

@@ -15,8 +15,8 @@ import LowlevelFtpClient from 'ftp';
 import semver from 'semver';
 import calculateShasum from 'shasum';
 
-import { AppInfo, SourceJson } from '../ipc/MetaFiles';
-import { PackageJsonApp } from '../ipc/schema/packageJson';
+import { type AppInfo, type SourceJson } from '../ipc/MetaFiles';
+import { type PackageJsonApp } from '../ipc/schema/packageJson';
 import checkAppProperties from './check-app-properties';
 
 interface App {

package/scripts/nrfconnect-license.ts

@@ -146,12 +146,7 @@ const allSourceFiles = () =>
             '*.sass',
         ],
         {
-            ignore: [
-                ...entriesInGitignore,
-                'scripts/nordic-publish.js',
-                'typings/generated',
-                '.git',
-            ],
+            ignore: [...entriesInGitignore, 'dist/', '.git'],
             baseNameMatch: true,
         },
     );

package/src/About/About.tsx

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import React, { ReactNode } from 'react';
+import React, { type ReactNode } from 'react';
 
 import ApplicationCard from './ApplicationCard';
 import DeviceCard from './DeviceCard';

package/src/About/AboutButton.tsx

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import React, { FC } from 'react';
+import React, { type FC } from 'react';
 
 import Button from '../Button/Button';
 import { openUrl } from '../utils/open';

package/src/About/ApplicationCard.tsx

@@ -6,7 +6,7 @@
 
 import React, { useEffect, useState } from 'react';
 
-import { AppDetailsFromLauncher } from '../../ipc/appDetails';
+import { type AppDetailsFromLauncher } from '../../ipc/appDetails';
 import Card from '../Card/Card';
 import FactoryResetButton from '../FactoryReset/FactoryResetButton';
 import appDetails from '../utils/appDetails';

package/src/About/DocumentationCard.tsx

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import React, { ReactNode } from 'react';
+import React, { type ReactNode } from 'react';
 
 import Card from '../Card/Card';
 

package/src/About/DocumentationSection.tsx

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import React, { ReactNode } from 'react';
+import React, { type ReactNode } from 'react';
 
 import AboutButton from './AboutButton';
 import Section from './Section';

package/src/About/Feedback.tsx

@@ -7,7 +7,7 @@
 import React, { useMemo, useState } from 'react';
 
 import { DialogButton, GenericDialog } from '../Dialog/Dialog';
-import Dropdown, { DropdownItem } from '../Dropdown/Dropdown';
+import Dropdown, { type DropdownItem } from '../Dropdown/Dropdown';
 import logger from '../logging';
 import describeError from '../logging/describeError';
 import AboutButton from './AboutButton';

package/src/About/Section.tsx

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import React, { ReactNode } from 'react';
+import React, { type ReactNode } from 'react';
 
 interface Props {
     title?: string;

package/src/About/ShortcutButton.tsx

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import React, { FC, useState } from 'react';
+import React, { type FC, useState } from 'react';
 
 import Button from '../Button/Button';
 import ShortcutModal from '../Shortcuts/ShortcutModal';

package/src/About/shortcutSlice.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { createSlice, PayloadAction } from '@reduxjs/toolkit';
+import { createSlice, type PayloadAction } from '@reduxjs/toolkit';
 import { enableMapSet } from 'immer';
 
 import type { RootState } from '../store';

package/src/App/App.test.tsx

@@ -10,7 +10,7 @@ import { act, screen } from '@testing-library/react';
 import { OFFICIAL } from '../../ipc/sources';
 import packageJsonFromShared from '../../package.json';
 import render from '../../test/testrenderer';
-import App, { Pane } from './App';
+import App, { type Pane } from './App';
 
 jest.mock('../Log/LogViewer', () => ({
     __esModule: true,

package/src/App/App.tsx

@@ -6,11 +6,17 @@
 
 import 'focus-visible';
 
-import React, { FC, ReactNode, useEffect, useMemo, useRef } from 'react';
+import React, {
+    type FC,
+    type ReactNode,
+    useEffect,
+    useMemo,
+    useRef,
+} from 'react';
 import Carousel from 'react-bootstrap/Carousel';
 import { createRoot } from 'react-dom/client';
 import { useDispatch, useSelector } from 'react-redux';
-import { Reducer } from 'redux';
+import { type Reducer } from 'redux';
 
 import { inMain as open } from '../../ipc/open';
 import { setNrfutilLogger } from '../../nrfutil/nrfutilLogger';

package/src/App/ConnectedToStore.tsx

@@ -4,9 +4,9 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import React, { ReactNode } from 'react';
+import React, { type ReactNode } from 'react';
 import { Provider } from 'react-redux';
-import { Reducer } from 'redux';
+import { type Reducer } from 'redux';
 
 import store from '../store';
 

package/src/App/appLayout.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { createSlice, PayloadAction } from '@reduxjs/toolkit';
+import { createSlice, type PayloadAction } from '@reduxjs/toolkit';
 
 import type { RootState } from '../store';
 import {

package/src/ConfirmBeforeClose/ConfirmCloseDialog.tsx

@@ -9,11 +9,11 @@ import { useDispatch, useSelector } from 'react-redux';
 import { getCurrentWindow } from '@electron/remote';
 
 import { ConfirmationDialog } from '../Dialog/Dialog';
-import { AppThunk } from '../store';
+import { type AppThunk } from '../store';
 import {
     addConfirmBeforeClose,
     clearConfirmBeforeClose,
-    ConfirmBeforeCloseApp,
+    type ConfirmBeforeCloseApp,
     getNextConfirmDialog,
     getShowConfirmCloseDialog,
     setShowCloseDialog,

package/src/ConfirmBeforeClose/confirmBeforeCloseSlice.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import { createSlice, PayloadAction } from '@reduxjs/toolkit';
+import { createSlice, type PayloadAction } from '@reduxjs/toolkit';
 import { v4 as uuid } from 'uuid';
 
 import type { AppThunk, RootState } from '../store';

package/src/Device/DeviceSelector/BasicDeviceInfo.tsx

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import React, { ReactNode, useEffect, useState } from 'react';
+import React, { type ReactNode, useEffect, useState } from 'react';
 import { useDispatch, useSelector } from 'react-redux';
 
 import InlineInput from '../../InlineInput/InlineInput';
@@ -14,7 +14,11 @@ import {
     getWaitingToAutoReselect,
 } from '../deviceAutoSelectSlice';
 import { displayedDeviceName } from '../deviceInfo/deviceInfo';
-import { Device, resetDeviceNickname, setDeviceNickname } from '../deviceSlice';
+import {
+    type Device,
+    resetDeviceNickname,
+    setDeviceNickname,
+} from '../deviceSlice';
 import DeviceIcon from './DeviceIcon';
 
 import './basic-device-info.scss';

package/src/Device/DeviceSelector/DeviceIcon.tsx

@@ -4,10 +4,10 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import React, { FC } from 'react';
+import React, { type FC } from 'react';
 
 import { deviceInfo } from '../deviceInfo/deviceInfo';
-import { Device } from '../deviceSlice';
+import { type Device } from '../deviceSlice';
 
 import './device-icon.scss';
 

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

@@ -4,10 +4,10 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import React, { FC, ReactNode } from 'react';
+import React, { type FC, type ReactNode } from 'react';
 import { Flipped, Flipper, spring } from 'react-flip-toolkit';
 
-import { Device } from '../../deviceSlice';
+import { type Device } from '../../deviceSlice';
 
 const changesOnReorder = (devices: Device[]) =>
     devices.map(device => device.serialNumber).join('\n');

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

@@ -9,7 +9,7 @@ import { useDispatch } from 'react-redux';
 
 import PseudoButton from '../../../PseudoButton/PseudoButton';
 import { showDialog } from '../../BrokenDeviceDialog/brokenDeviceDialogSlice';
-import { Device as DeviceProps } from '../../deviceSlice';
+import { type Device as DeviceProps } from '../../deviceSlice';
 import BasicDeviceInfo from '../BasicDeviceInfo';
 
 import './broken-device.scss';

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

@@ -8,7 +8,7 @@ import React, { useRef, useState } from 'react';
 
 import PseudoButton from '../../../PseudoButton/PseudoButton';
 import classNames from '../../../utils/classNames';
-import { Device as DeviceProps } from '../../deviceSlice';
+import { type Device as DeviceProps } from '../../deviceSlice';
 import BasicDeviceInfo from '../BasicDeviceInfo';
 import { FavoriteIndicator } from '../Favorite';
 import EditDeviceButtons from './EditDeviceButtons';