@nordicsemiconductor/pc-nrfconnect-shared 60.0.0-pre1

package/scripts/release-shared.ts

@@ -0,0 +1,207 @@
+#!/usr/bin/env ts-node
+
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+/*
+  A script to release a new version of shared.
+
+  Requirement for this script: Have [the GitHub CLI tool `gh`](https://cli.github.com)
+  installed and authenticate in it (run `gh auth login`).
+
+  Run
+     npm run release-shared -- --dry-run
+  to check whether the script thinks you can release a new version of shared.
+
+  Run
+     npm run release-shared
+  to actually do the release.
+
+  This script checks the contents in the branch `origin/main`.
+  So if locally looks everything fine, please check `origin/main`.
+*/
+import { execSync, spawnSync } from 'node:child_process';
+
+import { PackageJson } from '../src/utils/AppTypes';
+
+const logError = (message: string) => {
+    console.error(message);
+};
+
+const parseJson = <Result>(jsonString: string) =>
+    JSON.parse(jsonString) as Result;
+
+const git = (...commands) =>
+    spawnSync('git', commands, {
+        stdio: ['inherit', 'pipe', 'inherit'],
+        encoding: 'utf-8',
+    }).stdout;
+
+const getLatestReleaseName = () =>
+    parseJson<{ tagName: string }>(
+        execSync(`gh release view --json tagName`, { encoding: 'utf-8' })
+    ).tagName;
+
+export const getNextReleaseNumber = (
+    latestReleaseName = getLatestReleaseName(),
+    { log } = { log: console.log }
+) => {
+    const latestReleaseNumber = Number(
+        /^v(?<versionNumber>\d+)$/.exec(latestReleaseName)?.groups
+            ?.versionNumber
+    );
+
+    const nextReleaseNumber = latestReleaseNumber + 1;
+
+    log(
+        `The currently released version is ${latestReleaseNumber}, so the next one will be ${nextReleaseNumber}.\n`
+    );
+
+    return nextReleaseNumber;
+};
+
+const equality = <T>(
+    expected: T,
+    actual: T,
+    errorMessage: string,
+    fail: typeof logError
+) => {
+    if (expected !== actual) {
+        fail(
+            `${errorMessage}:\n  Expected: ${expected}\n  Actual:   ${actual}\n`
+        );
+    }
+
+    return expected === actual;
+};
+
+const getLatestPackageJson = () => git('show', 'origin/main:package.json');
+
+export const packageJsonIsCorrect = (
+    expectedVersionNumber: number,
+    { fail, packageJson } = {
+        fail: logError,
+        packageJson: getLatestPackageJson(),
+    }
+) => {
+    const expectedVersionString = `${expectedVersionNumber}.0.0`;
+    const actualVersionString = parseJson<PackageJson>(packageJson).version;
+
+    return equality(
+        expectedVersionString,
+        actualVersionString,
+        'Version number in `package.json` is not as expected',
+        fail
+    );
+};
+
+const getLatestChangelog = () => git('show', 'origin/main:Changelog.md');
+
+export const getLatestEntry = (changelog: string) => {
+    const latestEntry = changelog.split('\n## ')[1];
+
+    const header = latestEntry.split('\n')[0];
+    const content = latestEntry.replace(/[^\n]*/, '').trim();
+
+    return { header, content };
+};
+
+export const latestEntryIsNotEmpty = ({
+    fail,
+    changelog,
+}: {
+    fail: (message: string) => void;
+    changelog: string;
+}) => {
+    const correct = getLatestEntry(changelog).content.length > 0;
+
+    if (!correct) {
+        fail('Latest entry in `Changelog.md` does not contain anything.');
+    }
+
+    return correct;
+};
+
+const withoutTime = (date: Date) => date.toISOString().split('T')[0];
+
+export const latestHeaderIsCorrect = (
+    expectedVersionNumber: number,
+    { fail, now, changelog } = {
+        fail: logError,
+        now: new Date(),
+        changelog: getLatestChangelog(),
+    }
+) => {
+    const expectedHeaderline = `${expectedVersionNumber} - ${withoutTime(now)}`;
+    const actualHeaderline = getLatestEntry(changelog).header;
+
+    return equality(
+        expectedHeaderline,
+        actualHeaderline,
+        'Latest entry in `Changelog.md` is not as expected',
+        fail
+    );
+};
+
+export const changelogIsCorrect = (
+    expectedVersionNumber: number,
+    { fail, now, changelog } = {
+        fail: logError,
+        now: new Date(),
+        changelog: getLatestChangelog(),
+    }
+) =>
+    latestEntryIsNotEmpty({ fail, changelog }) &&
+    latestHeaderIsCorrect(expectedVersionNumber, { fail, now, changelog });
+
+const doRelease = (nextReleaseNumber: number) => {
+    const nextReleaseName = `v${nextReleaseNumber}`;
+    const latestChangelogEntry = getLatestEntry(getLatestChangelog()).content;
+
+    const dryRun = process.argv.includes('--dry-run');
+    if (dryRun) {
+        console.log(
+            `Would create a release ${nextReleaseName} now, with this description:\n${latestChangelogEntry}`
+        );
+    } else {
+        console.log(`Creating release ${nextReleaseName} now:`);
+        const result = spawnSync(
+            'gh',
+            [
+                'release',
+                'create',
+                nextReleaseName,
+                '--title',
+                nextReleaseName,
+                '--notes',
+                latestChangelogEntry,
+            ],
+            {
+                stdio: 'inherit',
+                encoding: 'utf-8',
+            }
+        );
+        process.exitCode = result.status ?? 1;
+    }
+};
+
+const main = () => {
+    console.log(git('fetch'));
+    const nextReleaseNumber = getNextReleaseNumber();
+
+    const noErrors =
+        packageJsonIsCorrect(nextReleaseNumber) &&
+        changelogIsCorrect(nextReleaseNumber);
+
+    if (noErrors) {
+        doRelease(nextReleaseNumber);
+    }
+};
+
+const runAsScript = require.main === module;
+if (runAsScript) {
+    main();
+}

package/src/About/About.tsx

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import React from 'react';
+
+import ApplicationCard from './ApplicationCard';
+import DeviceCard from './DeviceCard';
+import DocumentationCard from './DocumentationCard';
+import SupportCard from './SupportCard';
+
+import './about.scss';
+
+export default () => (
+    <div className="about">
+        <div className="about-inner">
+            <ApplicationCard />
+            <DeviceCard />
+            <DocumentationCard />
+            <SupportCard />
+        </div>
+    </div>
+);

package/src/About/AboutButton.tsx

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import React, { FC } from 'react';
+
+import Button from '../Button/Button';
+import { openUrl } from '../utils/open';
+
+interface Props {
+    onClick?: () => void;
+    url?: string;
+    label: string;
+}
+
+const AboutButton: FC<Props> = ({ url, label, onClick }) => (
+    <Button
+        disabled={!url && !onClick}
+        onClick={onClick || (() => openUrl(url as string))}
+        variant="secondary"
+    >
+        {label}
+    </Button>
+);
+
+export default AboutButton;

package/src/About/ApplicationCard.tsx

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import React, { useEffect, useState } from 'react';
+import { ipcRenderer } from 'electron';
+
+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>();
+
+    useEffect(() => {
+        ipcRenderer.once('app-details', (_, details: DetailsFromLauncher) => {
+            setAppInfo(details);
+        });
+        ipcRenderer.send('get-app-details');
+    }, [setAppInfo]);
+
+    if (appInfo == null) return null;
+
+    return (
+        <Card title="Application">
+            <Section title="Title">{appInfo.displayName}</Section>
+            <Section title="Purpose">{appInfo.description}</Section>
+            <Section title="Version">{appInfo.currentVersion}</Section>
+            <Section title="Source">{appInfo.source || 'local'}</Section>
+            <Section title="Supported engines">
+                nRF Connect {appInfo.engineVersion}
+            </Section>
+            <Section title="Current engine">
+                nRF Connect {appInfo.coreVersion}
+            </Section>
+            <Section>
+                <AboutButton
+                    url={appInfo.repositoryUrl}
+                    label="Get source code"
+                />
+            </Section>
+            <Section>
+                <FactoryResetButton label="Restore defaults..." />
+            </Section>
+            <Section>
+                <ShortcutButton label="Show shortcuts" />
+            </Section>
+        </Card>
+    );
+};

package/src/About/DeviceCard.tsx

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import React from 'react';
+import { useSelector } from 'react-redux';
+
+import Card from '../Card/Card';
+import {
+    buyOnlineUrl,
+    deviceInfo,
+    productPageUrl,
+} from '../Device/deviceInfo/deviceInfo';
+import { selectedDevice } from '../Device/deviceSlice';
+import AboutButton from './AboutButton';
+import Section from './Section';
+
+const memorySize = (memoryInBytes: number) => {
+    if (memoryInBytes == null) {
+        return 'Unknown';
+    }
+
+    return `${memoryInBytes / 1024}KiB`;
+};
+
+export default () => {
+    const device = useSelector(selectedDevice);
+
+    if (device == null) {
+        return (
+            <Card title="Device">
+                <Section title="No device selected" />
+            </Card>
+        );
+    }
+
+    const pca = device.boardVersion;
+    const { name, cores } = deviceInfo(device);
+
+    return (
+        <Card title="Device">
+            <Section title="Name">{name || 'Unknown'}</Section>
+            <Section title="ID">{device.serialNumber}</Section>
+            <Section title="PCA">{pca || 'Unknown'}</Section>
+            <Section title="Cores">{cores || 'Unknown'}</Section>
+
+            {device.hwInfo && (
+                <>
+                    <Section title="RAM">
+                        {memorySize(device.hwInfo.ramSize)}
+                    </Section>
+                    <Section title="Flash">
+                        {memorySize(device.hwInfo.romSize)}
+                    </Section>
+                </>
+            )}
+
+            <Section>
+                <AboutButton
+                    url={buyOnlineUrl(device)}
+                    label="Find distributor"
+                />
+            </Section>
+            <Section>
+                <AboutButton
+                    url={productPageUrl(device)}
+                    label="Go to product page"
+                />
+            </Section>
+        </Card>
+    );
+};

package/src/About/DocumentationCard.tsx

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import React from 'react';
+import { useSelector } from 'react-redux';
+
+import Card from '../Card/Card';
+import { documentationSections } from './documentationSlice';
+
+export default () => {
+    const sections = useSelector(documentationSections);
+    if (sections.length === 0) return null;
+
+    return <Card title="Documentation">{sections}</Card>;
+};

package/src/About/DocumentationSection.tsx

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import React, { ReactNode } from 'react';
+
+import AboutButton from './AboutButton';
+import Section from './Section';
+
+interface Props {
+    title?: string;
+    link?: string;
+    linkLabel?: string;
+    children?: ReactNode;
+}
+
+export default ({ title, link, linkLabel, children }: Props) => (
+    <Section title={title}>
+        <p>{children}</p>
+        {link && <AboutButton url={link} label={linkLabel as string} />}
+    </Section>
+);

package/src/About/Section.tsx

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import React, { ReactNode } from 'react';
+
+import './section.scss';
+
+interface Props {
+    title?: string;
+    children?: ReactNode;
+}
+
+export default ({ children, title }: Props) => (
+    <div className="about-section">
+        {title != null && <h3 className="about-section-title">{title}</h3>}
+        {children}
+    </div>
+);

package/src/About/ShortcutButton.tsx

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import React, { FC, useState } from 'react';
+
+import Button from '../Button/Button';
+import ShortcutModal from '../Shortcuts/ShortcutModal';
+import useHotKey from '../utils/useHotKey';
+
+interface Props {
+    label: string;
+}
+
+const ShortcutButton: FC<Props> = ({ label }) => {
+    const [isModalVisible, setIsModalVisible] = useState(false);
+    const toggleModalVisible = () => setIsModalVisible(!isModalVisible);
+
+    useHotKey({
+        hotKey: '?',
+        title: 'Open shortcut overview',
+        isGlobal: true,
+        action: () => toggleModalVisible(),
+    });
+
+    return (
+        <>
+            <Button variant="secondary" onClick={toggleModalVisible}>
+                {label}
+            </Button>
+            <ShortcutModal
+                isVisible={isModalVisible}
+                onCancel={toggleModalVisible}
+            />
+        </>
+    );
+};
+
+export default ShortcutButton;

package/src/About/SupportCard.tsx

@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import React from 'react';
+import { useDispatch, useSelector } from 'react-redux';
+import { getCurrentWindow } from '@electron/remote';
+
+import Button from '../Button/Button';
+import Card from '../Card/Card';
+import { setVerboseDeviceLibLogging } from '../Device/deviceLibWrapper';
+import {
+    deviceInfo,
+    getDevices,
+    selectedSerialNumber,
+} from '../Device/deviceSlice';
+import {
+    isLoggingVerboseSelector,
+    toggleIsLoggingVerbose,
+} from '../Log/logSlice';
+import { Toggle } from '../Toggle/Toggle';
+import { persistIsLoggingVerbose } from '../utils/persistentStore';
+import systemReport from '../utils/systemReport';
+import AboutButton from './AboutButton';
+import Section from './Section';
+
+export default () => {
+    const dispatch = useDispatch();
+    const devices = useSelector(getDevices);
+    const currentSerialNumber = useSelector(selectedSerialNumber);
+    const verboseLogging = useSelector(isLoggingVerboseSelector);
+    const currentDevice = useSelector(deviceInfo);
+
+    return (
+        <Card title="Support">
+            <Section title="DevZone">
+                <p>
+                    All support requests must be sent through our developer
+                    portal DevZone.
+                </p>
+                <AboutButton
+                    url="https://devzone.nordicsemi.com"
+                    label="Go to DevZone"
+                />
+            </Section>
+            <Section title="System report">
+                <p>
+                    In order to get the best support it is helpful for our
+                    employees to know details about your operating system and
+                    related software. Create a system report and add to your
+                    support request.
+                </p>
+                <AboutButton
+                    onClick={() =>
+                        systemReport(
+                            [...devices.values()],
+                            currentSerialNumber as string,
+                            currentDevice
+                        )
+                    }
+                    label="Create system report"
+                />
+            </Section>
+            <Section title="Verbose Logging">
+                <p>
+                    Aid our support team with additional log information. Enable
+                    this only when necessary as the log will grow quickly.
+                </p>
+                <Toggle
+                    id="enableVerboseLoggin"
+                    label="VERBOSE LOGGING"
+                    onToggle={() => {
+                        setVerboseDeviceLibLogging(!verboseLogging);
+                        dispatch(toggleIsLoggingVerbose());
+                    }}
+                    isToggled={verboseLogging}
+                    variant="primary"
+                />
+                <Section>
+                    <Button
+                        variant="secondary"
+                        onClick={() => {
+                            persistIsLoggingVerbose(true);
+                            getCurrentWindow().reload();
+                        }}
+                        title="Restart application with verbose logging turned on to get log messages from initial enumeration"
+                        disabled={!verboseLogging}
+                    >
+                        Restart with verbose logging
+                    </Button>
+                </Section>
+            </Section>
+        </Card>
+    );
+};

package/src/About/about.scss

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+@import '../variables';
+
+.about {
+    display: flex;
+    align-items: center;
+    height: 100%;
+
+    .about-inner {
+        display: flex;
+        flex-direction: row;
+        justify-content: center;
+        flex-wrap: wrap;
+        width: 100%;
+        margin: auto;
+        padding-bottom: 16px;
+        padding-right: 16px;
+        .card {
+            min-width: 230px;
+            max-width: 20em;
+            margin-left: 8px;
+            margin-bottom: 8px;
+        }
+        .card-body {
+            margin-bottom: 1em;
+        }
+        .factory-reset-button {
+            height: 24px;
+            padding: 0;
+        }
+    }
+    button {
+        width: 100%;
+    }
+}