@nordicsemiconductor/pc-nrfconnect-shared 60.0.0-pre1

package/styles.scss

@@ -0,0 +1,88 @@
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+@use "sass:color";
+
+$nordic-blue: #00a9ce;
+$blue-slate: #0033a0;
+
+$white: white;
+$black: black;
+
+$primary: $nordic-blue;
+$primary-darkened: color.scale($nordic-blue, $lightness: -10%);
+$secondary: $white;
+$accent: $blue-slate;
+
+$gray-50: #eceff1;
+$gray-100: #cfd8dc;
+$gray-200: #b0bec5;
+$gray-300: #90a4ae;
+$gray-400: #78909c;
+$gray-500: #607d8b;
+$gray-600: #546e7a;
+$gray-700: #455a64;
+$gray-800: #37474f;
+$gray-900: #263238;
+
+$red: #f44336;
+$indigo: #3f51b5;
+$amber: #ffc107;
+$purple: #9c27b0;
+$green: #4caf50;
+$deep-purple: #673ab7;
+$orange: #ff9800;
+$lime: #cddc39;
+$pink: #e91e63;
+
+$brand-success: $green;
+$brand-warning: $orange;
+$brand-danger: $red;
+
+$custom-control-indicator-bg: $gray-50;
+$custom-control-indicator-checked-bg: $gray-300;
+
+$side-panel-width: 260px;
+$nav-bar-height: 40px;
+$log-viewer-height: 155px;
+$visibility-bar-height: 32px;
+
+$font-weight-light: 300;
+$font-weight-normal: 400;
+$font-weight-bold: 700;
+
+$normal-transition: 0.2s ease-in-out;
+
+$disabled-opacity: 0.38;
+
+@mixin scrollbars-helper($background-color, $scrollbar-color, $scrollbar-hover-color) {
+    &::-webkit-scrollbar, &::-webkit-scrollbar-corner {
+        width: 14px;
+        height: 14px;
+    }
+
+    &::-webkit-scrollbar-thumb {
+        background: $scrollbar-color;
+        border-radius: 14px;
+        border: 5px solid $background-color;
+    }
+
+    &::-webkit-scrollbar-thumb:hover  {
+        background: $scrollbar-hover-color;
+    }
+}
+
+@mixin scrollbars($background-color) {
+    @if $background-color == $gray-50 or
+        $background-color == $gray-100 or
+        $background-color == $white {
+        @include scrollbars-helper($background-color, $gray-500, $gray-700);
+    } @else if $background-color == $gray-900 or $background-color == $gray-700 {
+        @include scrollbars-helper($background-color, $gray-400, $gray-200);
+    } @else {
+        @error "Unable to configure scrollbars for background color #{$background-color}. You must add a configuration for it.";
+    }
+}

package/test/dispatchTo.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { Action, Reducer } from 'redux';
+
+const initAction = {
+    type: '@@INIT',
+};
+
+export default <State>(aReducer: Reducer<State>, actions: Action[] = []) => {
+    const state = [initAction, ...actions].reduce(aReducer, undefined);
+
+    if (state === undefined) {
+        throw new Error(
+            'Redux is broken, after dispatchig actions, the state must never be undefined.'
+        );
+    }
+
+    return state;
+};

package/test/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+export { testUtils } from './testUtil';

package/test/jestResolver.js

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+module.exports = (path, options) =>
+    options.defaultResolver(path, {
+        ...options,
+        packageFilter: pkg => {
+            // This is a workaround for https://github.com/uuidjs/uuid/pull/616
+            //
+            // jest-environment-jsdom 28+ tries to use browser exports instead of default exports,
+            // but uuid only offers an ESM browser export and not a CommonJS one. Jest does not yet
+            // support ESM modules natively, so this causes a Jest error related to trying to parse
+            // "export" syntax.
+            //
+            // This workaround prevents Jest from considering uuid's module-based exports at all;
+            // it falls back to uuid's CommonJS+node "main" property.
+            //
+            // Once we're able to migrate our Jest config to ESM this can go away.
+            if (pkg.name === 'uuid') {
+                delete pkg.exports;
+                delete pkg.module;
+            }
+            return pkg;
+        },
+    });

package/test/setupTests.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+/* eslint-disable simple-import-sort/imports --
+   sorting the import order must be disabled for this file because enzyme
+   and testing-library are sensitive to the order in which they are run
+*/
+import enzyme from 'enzyme';
+import Adapter from 'enzyme-adapter-react-16';
+
+import '@testing-library/jest-dom/extend-expect';
+import { configure } from '@testing-library/dom';
+
+enzyme.configure({ adapter: new Adapter() });
+
+if (process.env.TESTING_ASYNC_TIMEOUT != null) {
+    configure({ asyncUtilTimeout: Number(process.env.TESTING_ASYNC_TIMEOUT) });
+}
+
+window.ResizeObserver = class {
+    observe() {} // eslint-disable-line class-methods-use-this -- because we just stub things here
+    disconnect() {} // eslint-disable-line class-methods-use-this
+    unobserve() {} // eslint-disable-line class-methods-use-this
+};

package/test/testUtil.ts

@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { combineReducers, Reducer } from 'redux';
+
+import { rootReducerSpec } from '../src/store';
+import dispatchTo from './dispatchTo';
+import { testRendererForApps } from './testrenderer';
+
+const rootReducer = <AppState>(appReducer?: Reducer<AppState>) =>
+    combineReducers(rootReducerSpec(appReducer));
+
+export const testUtils = {
+    dispatchTo,
+    render: testRendererForApps,
+    rootReducer,
+};

package/test/testrenderer.tsx

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import React from 'react';
+import { Provider } from 'react-redux';
+import { render } from '@testing-library/react';
+import { Action, Reducer } from 'redux';
+
+import createStore from '../src/store';
+
+const createPreparedStore = (actions: Action[], appReducer?: Reducer) => {
+    const store = createStore(appReducer);
+    actions.forEach(store.dispatch);
+
+    return store;
+};
+
+const preparedProvider =
+    (actions: Action[], appReducer?: Reducer) => (props: object) =>
+        (
+            <Provider
+                store={createPreparedStore(actions, appReducer)}
+                {...props}
+            />
+        );
+
+export const testRendererForApps =
+    (appReducer?: Reducer) =>
+    (element: React.ReactElement, actions: Action[] = []) =>
+        render(element, { wrapper: preparedProvider(actions, appReducer) });
+
+export default (
+    element: React.ReactElement,
+    actions: Action[] = [], // eslint-disable-line default-param-last -- Because we want to allow people to specify actions but no specifix reducer
+    appReducer?: Reducer
+) => render(element, { wrapper: preparedProvider(actions, appReducer) });

package/tsconfig.json

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

package/typings/externals.d.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+declare module 'prettysize' {
+    export default function pretty(n: number): string;
+}
+
+declare module '*.module.scss' {
+    const properties: {
+        [property: string]: string;
+    };
+    export = properties;
+}
+
+interface Window {
+    appDir: string;
+    appDataDir: string;
+    appLogDir: string;
+}
+
+// Let typescript compiler in `npm run lint` resolve css modules
+declare module '*.icss.scss';
+declare module '*.gif';
+
+declare module '*.png' {
+    const path: string;
+    export default path;
+}

package/typings/generated/main/index.d.ts

@@ -0,0 +1,25 @@
+export declare const SERIALPORT_CHANNEL: {
+    OPEN: string;
+    CLOSE: string;
+    WRITE: string;
+    UPDATE: string;
+    SET: string;
+    ON_CLOSED: string;
+    ON_DATA: string;
+    ON_UPDATE: string;
+    ON_SET: string;
+    ON_CHANGED: string;
+    ON_WRITE: string;
+    IS_OPEN: string;
+    GET_OPTIONS: string;
+};
+export type OverwriteOptions = {
+    overwrite?: boolean;
+    settingsLocked?: boolean;
+};
+export type OpenAppOptions = {
+    device?: {
+        serialNumber: string;
+        serialPortPath?: string;
+    };
+};

package/typings/generated/src/About/About.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import './about.scss';
+declare const _default: () => JSX.Element;
+export default _default;

package/typings/generated/src/About/AboutButton.d.ts

@@ -0,0 +1,8 @@
+import { FC } from 'react';
+interface Props {
+    onClick?: () => void;
+    url?: string;
+    label: string;
+}
+declare const AboutButton: FC<Props>;
+export default AboutButton;

package/typings/generated/src/About/ApplicationCard.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare const _default: () => JSX.Element | null;
+export default _default;

package/typings/generated/src/About/DeviceCard.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare const _default: () => JSX.Element;
+export default _default;

package/typings/generated/src/About/DocumentationCard.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare const _default: () => JSX.Element | null;
+export default _default;

package/typings/generated/src/About/DocumentationSection.d.ts

@@ -0,0 +1,9 @@
+import { ReactNode } from 'react';
+interface Props {
+    title?: string;
+    link?: string;
+    linkLabel?: string;
+    children?: ReactNode;
+}
+declare const _default: ({ title, link, linkLabel, children }: Props) => JSX.Element;
+export default _default;

package/typings/generated/src/About/Section.d.ts

@@ -0,0 +1,8 @@
+import { ReactNode } from 'react';
+import './section.scss';
+interface Props {
+    title?: string;
+    children?: ReactNode;
+}
+declare const _default: ({ children, title }: Props) => JSX.Element;
+export default _default;

package/typings/generated/src/About/ShortcutButton.d.ts

@@ -0,0 +1,6 @@
+import { FC } from 'react';
+interface Props {
+    label: string;
+}
+declare const ShortcutButton: FC<Props>;
+export default ShortcutButton;

package/typings/generated/src/About/SupportCard.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+declare const _default: () => JSX.Element;
+export default _default;

package/typings/generated/src/About/documentationSlice.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+interface DocumentationSectionProps {
+    title?: string;
+    linkLabel?: string;
+    link?: string;
+}
+export interface DocumentationState {
+    sections: React.Component<DocumentationSectionProps>[];
+}
+export declare const reducer: import("redux").Reducer<DocumentationState, import("redux").AnyAction>, setDocumentationSections: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "documentation/setDocumentationSections">;
+export declare const documentationSections: ({ documentation }: any) => any;
+export {};

package/typings/generated/src/About/shortcutSlice.d.ts

@@ -0,0 +1,11 @@
+import type { RootState } from '../store';
+export interface Shortcut {
+    hotKey: string[] | string;
+    title: string;
+    isGlobal: boolean;
+    action: () => void;
+}
+export type ShortcutState = Set<Shortcut>;
+export declare const reducer: import("redux").Reducer<ShortcutState, import("redux").AnyAction>, addShortcut: import("@reduxjs/toolkit").ActionCreatorWithPayload<Shortcut, "shortcuts/addShortcut">, removeShortcut: import("@reduxjs/toolkit").ActionCreatorWithPayload<Shortcut, "shortcuts/removeShortcut">;
+export declare const globalShortcuts: (state: RootState) => Shortcut[];
+export declare const localShortcuts: (state: RootState) => Shortcut[];

package/typings/generated/src/Alert/Alert.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+type Variant = 'info' | 'warning' | 'success' | 'danger';
+export interface AlertProps {
+    variant: Variant;
+    label?: React.ReactNode;
+    dismissable?: boolean;
+    onClose?: () => void;
+}
+export declare const Alert: React.FC<AlertProps>;
+export {};

package/typings/generated/src/App/App.d.ts

@@ -0,0 +1,27 @@
+import 'focus-visible';
+import { FC, ReactNode } from 'react';
+import { Reducer } from 'redux';
+import './app.scss';
+import './shared.scss';
+export interface PaneProps {
+    active: boolean;
+}
+export interface Pane {
+    name: string;
+    Main: FC<PaneProps>;
+    SidePanel?: FC;
+}
+interface ConnectedAppProps {
+    deviceSelect?: ReactNode;
+    panes: Pane[];
+    sidePanel?: ReactNode;
+    showLogByDefault?: boolean;
+    reportUsageData?: boolean;
+    documentation?: ReactNode[];
+    children?: ReactNode;
+    autoReselectByDefault?: boolean;
+}
+declare const _default: ({ appReducer, ...props }: {
+    appReducer?: Reducer<any, import("redux").AnyAction> | undefined;
+} & ConnectedAppProps) => JSX.Element;
+export default _default;

package/typings/generated/src/App/App.test.d.ts

@@ -0,0 +1 @@
+export {};

package/typings/generated/src/App/ConnectedToStore.d.ts

@@ -0,0 +1,7 @@
+import { ReactNode } from 'react';
+import { Reducer } from 'redux';
+declare const _default: ({ appReducer, children, }: {
+    appReducer?: Reducer<any, import("redux").AnyAction> | undefined;
+    children: ReactNode;
+}) => JSX.Element;
+export default _default;

package/typings/generated/src/App/VisibilityBar.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import './visibility-bar.scss';
+declare const _default: ({ isSidePanelEnabled }: {
+    isSidePanelEnabled: boolean;
+}) => JSX.Element;
+export default _default;

package/typings/generated/src/App/appLayout.d.ts

@@ -0,0 +1,17 @@
+import type { RootState } from '../store';
+export interface AppLayout {
+    isSidePanelVisible: boolean;
+    isLogVisible: boolean;
+    currentPane: number;
+    paneNames: string[];
+}
+interface PaneSpec {
+    name: string;
+    Main: unknown;
+}
+export declare const reducer: import("redux").Reducer<AppLayout, import("redux").AnyAction>, setCurrentPane: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "appLayout/setCurrentPane">, setPanes: import("@reduxjs/toolkit").ActionCreatorWithPayload<PaneSpec[], "appLayout/setPanes">, toggleLogVisible: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"appLayout/toggleLogVisible">, toggleSidePanelVisible: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"appLayout/toggleSidePanelVisible">, switchToNextPane: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"appLayout/switchToNextPane">, switchToPreviousPane: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"appLayout/switchToPreviousPane">;
+export declare const isSidePanelVisible: (state: RootState) => boolean;
+export declare const isLogVisible: (state: RootState) => boolean;
+export declare const paneNames: (state: RootState) => string[];
+export declare const currentPane: ({ appLayout }: RootState) => number;
+export {};

package/typings/generated/src/Button/Button.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+export type ButtonVariants = 'primary' | 'secondary' | 'success' | 'info' | 'warning' | 'danger' | 'link' | 'custom';
+type ButtonProps = {
+    id?: string;
+    variant: ButtonVariants;
+    className?: string;
+    onClick: React.MouseEventHandler<HTMLButtonElement>;
+    disabled?: boolean;
+    title?: string;
+    large?: boolean;
+};
+declare const Button: React.FC<ButtonProps>;
+export default Button;

package/typings/generated/src/Card/Card.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+type NrfCardProps = {
+    children: React.ReactNode;
+    title: React.ReactNode;
+};
+declare const _default: ({ children, title }: NrfCardProps) => JSX.Element;
+export default _default;

package/typings/generated/src/Device/BrokenDeviceDialog/BrokenDeviceDialog.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import './broken-device-dialog.scss';
+declare const BrokenDeviceDialog: () => JSX.Element;
+export default BrokenDeviceDialog;

package/typings/generated/src/Device/BrokenDeviceDialog/brokenDeviceDialogSlice.d.ts

@@ -0,0 +1,12 @@
+import type { RootState } from '../../store';
+export interface BrokenDeviceDialog {
+    isVisible: boolean;
+    description: string;
+    url: string;
+}
+export declare const reducer: import("redux").Reducer<BrokenDeviceDialog, import("redux").AnyAction>, hideDialog: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"brokenDeviceDialog/hideDialog">, showDialog: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, "brokenDeviceDialog/showDialog">;
+export declare const isVisible: (state: RootState) => boolean;
+export declare const info: (state: RootState) => {
+    description: string;
+    url: string;
+};

package/typings/generated/src/Device/DeviceSelector/BasicDeviceInfo.d.ts

@@ -0,0 +1,11 @@
+import React, { ReactNode } from 'react';
+import { Device } from '../deviceSlice';
+import './basic-device-info.scss';
+interface BasicDeviceProps {
+    device: Device;
+    deviceNameInputRef?: React.Ref<HTMLInputElement>;
+    toggles?: ReactNode;
+    showWaitingStatus?: boolean;
+}
+declare const _default: ({ device, deviceNameInputRef, toggles, showWaitingStatus, }: BasicDeviceProps) => JSX.Element;
+export default _default;

package/typings/generated/src/Device/DeviceSelector/DeviceIcon.d.ts

@@ -0,0 +1,7 @@
+import { FC } from 'react';
+import { Device } from '../deviceSlice';
+import './device-icon.scss';
+declare const DeviceIcon: FC<{
+    device: Device;
+}>;
+export default DeviceIcon;

package/typings/generated/src/Device/DeviceSelector/DeviceList/AnimatedList.d.ts

@@ -0,0 +1,10 @@
+import { FC, ReactNode } from 'react';
+import { Device } from '../../deviceSlice';
+export declare const AnimatedList: FC<{
+    children: ReactNode;
+    devices: Device[];
+}>;
+export declare const AnimatedItem: FC<{
+    itemKey: string;
+    children: ReactNode;
+}>;

package/typings/generated/src/Device/DeviceSelector/DeviceList/BrokenDevice.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { Device as DeviceProps } from '../../deviceSlice';
+import './broken-device.scss';
+declare const _default: ({ device }: {
+    device: DeviceProps;
+}) => JSX.Element;
+export default _default;

package/typings/generated/src/Device/DeviceSelector/DeviceList/Device.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { Device as DeviceProps } from '../../deviceSlice';
+import './device.scss';
+interface Props {
+    device: DeviceProps;
+    doSelectDevice: (device: DeviceProps, autoReselected: boolean) => void;
+    allowMoreInfoVisible: boolean;
+}
+declare const _default: ({ device, doSelectDevice, allowMoreInfoVisible }: Props) => JSX.Element;
+export default _default;

package/typings/generated/src/Device/DeviceSelector/DeviceList/DeviceList.d.ts

@@ -0,0 +1,10 @@
+import { FC } from 'react';
+import { Device as DeviceProps } from '../../deviceSlice';
+import './device-list.scss';
+interface Props {
+    doSelectDevice: (device: DeviceProps, autoReselected: boolean) => void;
+    isVisible: boolean;
+    deviceFilter?: (device: DeviceProps) => boolean;
+}
+declare const DeviceList: FC<Props>;
+export default DeviceList;

package/typings/generated/src/Device/DeviceSelector/DeviceList/EditDeviceButtons.d.ts

@@ -0,0 +1,9 @@
+import { FC } from 'react';
+import { Device } from '../../deviceSlice';
+import './edit-device-buttons.scss';
+interface Props {
+    device: Device;
+    startEditingDeviceName: () => void;
+}
+declare const EditDeviceButtons: FC<Props>;
+export default EditDeviceButtons;

package/typings/generated/src/Device/DeviceSelector/DeviceList/MoreDeviceInfo.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { Device } from '../../deviceSlice';
+import './more-device-info.scss';
+declare const _default: ({ device }: {
+    device: Device;
+}) => JSX.Element;
+export default _default;

package/typings/generated/src/Device/DeviceSelector/DeviceList/RenameDevice.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import './rename-device.scss';
+declare const _default: ({ startEditingDeviceName, }: {
+    startEditingDeviceName: () => void;
+}) => JSX.Element;
+export default _default;

package/typings/generated/src/Device/DeviceSelector/DeviceSelector.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import { DeviceTraits } from '@nordicsemiconductor/nrf-device-lib-js';
+import { DeviceSetupConfig } from '../deviceSetup';
+import { Device } from '../deviceSlice';
+interface OutdatedDeviceTraits {
+    serialPort?: boolean;
+    serialport?: boolean;
+}
+export interface Props {
+    deviceListing: DeviceTraits & OutdatedDeviceTraits;
+    deviceSetupConfig?: DeviceSetupConfig;
+    onDeviceSelected?: (device: Device, autoReselected: boolean) => void;
+    onDeviceDeselected?: () => void;
+    onDeviceConnected?: (device: Device) => void;
+    onDeviceDisconnected?: (device: Device) => void;
+    onDeviceIsReady?: (device: Device) => void;
+    deviceFilter?: (device: Device) => boolean;
+}
+declare const _default: ({ deviceListing, deviceSetupConfig, onDeviceSelected, onDeviceDeselected, onDeviceConnected, onDeviceDisconnected, onDeviceIsReady, deviceFilter, }: Props) => JSX.Element;
+export default _default;

package/typings/generated/src/Device/DeviceSelector/DeviceSelector.test.d.ts

@@ -0,0 +1 @@
+export {};

package/typings/generated/src/Device/DeviceSelector/Favorite.d.ts

@@ -0,0 +1,9 @@
+import { FC } from 'react';
+import { Device } from '../deviceSlice';
+import './favorite.scss';
+export declare const MakeDeviceFavorite: FC<{
+    device: Device;
+}>;
+export declare const FavoriteIndicator: FC<{
+    device: Device;
+}>;