@nordicsemiconductor/pc-nrfconnect-shared 60.0.0-pre2 → 76.0.0

package/config/colors.js

@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+const flattenedColors = require('../src/utils/colors').colors;
+
+const paletteColorsKeys = [
+    'nordicBlue',
+    'gray',
+    'red',
+    'indigo',
+    'amber',
+    'purple',
+    'green',
+    'deepPurple',
+    'orange',
+    'lime',
+    'lightGreen',
+    'lightBlue',
+    'pink',
+];
+
+const paletteColors = {};
+
+paletteColorsKeys.forEach(color => {
+    const colorList = Object.entries(flattenedColors)
+        .filter(([key]) => key.startsWith(color))
+        .map(([key, value]) => {
+            if (key === color) {
+                return ['DEFAULT', value];
+            }
+            return [key.replace(color, ''), value];
+        });
+
+    paletteColors[color] = Object.fromEntries(colorList);
+});
+
+const colors = Object.entries(flattenedColors).filter(
+    ([key]) => !paletteColorsKeys.find(c => key.startsWith(c))
+);
+
+module.exports = {
+    ...Object.fromEntries(colors),
+    ...paletteColors,
+};

package/config/eslintrc.js

@@ -0,0 +1,190 @@
+/*
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+const fs = require('fs');
+
+const entriesInGitignore = fs
+    .readFileSync('.gitignore', 'utf8')
+    .split('\n')
+    .filter(Boolean);
+
+module.exports = {
+    reportUnusedDisableDirectives: true,
+    parser: '@typescript-eslint/parser',
+    extends: [
+        'eslint:recommended',
+        'airbnb',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:import/recommended',
+        'plugin:import/typescript',
+        'prettier',
+    ],
+    ignorePatterns: [
+        'package-lock.json',
+        'scripts/nordic-publish.js',
+        'typings/generated',
+        ...entriesInGitignore,
+    ],
+    rules: {
+        'prefer-destructuring': 'off',
+        '@typescript-eslint/ban-ts-comment': [
+            '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',
+        'import/no-extraneous-dependencies': 'off',
+        'import/no-unresolved': [
+            'error',
+            {
+                ignore: [
+                    'serialport',
+                    'electron',
+                    'pc-nrfconnect-shared',
+                    '@electron/remote',
+                ],
+            },
+        ],
+        'import/prefer-default-export': 'off',
+        'jsx-a11y/control-has-associated-label': 'off',
+        'linebreak-style': 'off',
+        'lines-between-class-members': 'off',
+        'md/remark': [
+            'error',
+            {
+                plugins: [
+                    'preset-lint-markdown-style-guide',
+                    'frontmatter',
+                    ['lint-no-duplicate-headings', false],
+                    ['lint-list-item-indent', false],
+                    ['lint-emphasis-marker', false],
+                    ['lint-list-item-spacing', false],
+                    ['lint-no-literal-urls', false],
+                ],
+            },
+        ],
+        'no-console': 'off',
+        'no-param-reassign': 'off',
+        'no-shadow': 'off',
+        'no-undef': 'error',
+        'no-unused-expressions': 'off',
+        'no-use-before-define': 'off',
+        'prettier/prettier': 'error',
+        'react-hooks/exhaustive-deps': 'error',
+        'react-hooks/rules-of-hooks': 'error',
+        'react/function-component-definition': [
+            'error',
+            {
+                namedComponents: 'arrow-function',
+                unnamedComponents: 'arrow-function',
+            },
+        ],
+        'react/jsx-filename-extension': [
+            'error',
+            { extensions: ['.jsx', '.tsx'] },
+        ],
+        'react/jsx-key': ['error', { checkFragmentShorthand: true }],
+        'react/jsx-no-useless-fragment': ['error', { allowExpression: true }],
+        'react/jsx-one-expression-per-line': 'off',
+        'react/jsx-props-no-spreading': 'off',
+        'react/require-default-props': 'off',
+        'require-await': 'error',
+        'simple-import-sort/imports': [
+            'error',
+            {
+                /* This configures the order of the imports.
+                   The obscure format using regexps is described at
+                   https://github.com/lydell/eslint-plugin-simple-import-sort#custom-grouping
+                   and there are examples at
+                   https://github.com/lydell/eslint-plugin-simple-import-sort/blob/main/examples/.eslintrc.js
+                */
+                groups: [
+                    // First all side effect imports. That strange token is
+                    // described in the eslint-plugin-simple-import-sort docs
+                    ['^\\u0000'],
+
+                    // All package imports (starting with a letter, optionally
+                    // prepended by an '@'), with React packages coming first.
+                    ['^react', '^@?\\w'],
+
+                    // All relative imports (starting with a '.')
+                    ['^\\.'],
+
+                    // All styles imports (ending with '.css' or '.scss')
+                    ['^.+\\.s?css$'],
+                ],
+            },
+        ],
+        'valid-jsdoc': ['error', { prefer: { return: 'returns' } }],
+    },
+    overrides: [
+        {
+            files: ['*.d.ts'],
+            rules: {
+                'max-classes-per-file': 'off',
+                'react/prefer-stateless-function': 'off',
+                '@typescript-eslint/no-explicit-any': 'off',
+            },
+        },
+        {
+            files: ['*.ts', '*.tsx'],
+            rules: {
+                'default-case': 'off',
+                'consistent-return': 'off',
+                'react/prop-types': 'off',
+            },
+        },
+        {
+            files: ['*.md'],
+            parser: 'markdown-eslint-parser',
+            rules: {
+                'prettier/prettier': ['error', { parser: 'markdown' }],
+            },
+        },
+        {
+            files: ['*.test.*'],
+            rules: {
+                '@typescript-eslint/no-non-null-assertion': 'off',
+            },
+        },
+        {
+            files: ['*.json'],
+            rules: {
+                'no-template-curly-in-string': 'off',
+            },
+        },
+        {
+            files: [
+                '**/__tests__/**/*.[jt]s?(x)',
+                '**/?(*.)+(spec|test).[jt]s?(x)',
+            ],
+            extends: ['plugin:testing-library/react'],
+        },
+    ],
+    plugins: [
+        'react',
+        'import',
+        'react-hooks',
+        'prettier',
+        'simple-import-sort',
+        'md',
+    ],
+    env: {
+        es6: true,
+        browser: true,
+        node: true,
+        jasmine: true,
+        jest: true,
+    },
+    globals: {
+        NodeJS: true,
+        React: true,
+    },
+};

package/config/jest.config.js

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+const path = require('path');
+
+const mockDir = path.join(__dirname, '..', 'mocks');
+
+module.exports = (disabledMocks = []) => ({
+    testEnvironment: 'jsdom',
+    moduleNameMapper: {
+        '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2)$': `${mockDir}/fileMock.ts`,
+        '\\.(css|scss)$': `${mockDir}/emptyMock.ts`,
+        'pc-nrfjprog-js|nrf-device-setup|usb': `${mockDir}/emptyMock.ts`,
+        '^electron$': `${mockDir}/electronMock.ts`,
+        '^electron-store$': `${mockDir}/electronStoreMock.ts`,
+        '@nordicsemiconductor/nrf-device-lib-js': `${mockDir}/deviceLibMock.ts`,
+        '@electron/remote': `${mockDir}/remoteMock.ts`,
+        ...(disabledMocks.includes('packageJson')
+            ? {}
+            : {
+                  packageJson$: `${mockDir}/packageJsonMock.ts`,
+              }),
+        ...(disabledMocks.includes('react-ga')
+            ? {}
+            : { '^react-ga$': `${mockDir}/gaMock.ts` }),
+        ...(disabledMocks.includes('serialport')
+            ? {}
+            : { serialport: `${mockDir}/emptyMock.ts` }),
+    },
+    transform: {
+        '^.+\\.[jt]sx?$': '@swc/jest',
+    },
+    transformIgnorePatterns: ['node_modules/(?!(pc-nrfconnect-shared)/)'],
+    setupFilesAfterEnv: [`${__dirname}/../test/setupTests.ts`],
+    snapshotSerializers: ['enzyme-to-json/serializer'],
+    resolver: `${__dirname}/../test/jestResolver.js`,
+    modulePathIgnorePatterns: ['dist'],
+});

package/config/prettier.config.js

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+module.exports = {
+    singleQuote: true,
+    tabWidth: 4,
+    arrowParens: 'avoid',
+    endOfLine: 'auto',
+    proseWrap: 'always',
+};

package/config/tailwind.config.js

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+const colors = require('./colors');
+
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+    important: true,
+    prefix: 'tw-',
+    content: [
+        './src/**/*.{html,jsx,tsx}',
+        './node_modules/pc-nrfconnect-shared/src/**/*.tsx',
+    ],
+    theme: {
+        colors,
+        extend: {},
+    },
+    corePlugins: {
+        preflight: false,
+    },
+    plugins: [],
+};

package/config/tsconfig.json

@@ -0,0 +1,16 @@
+{
+    "ts-node": { "swc": true },
+
+    "compilerOptions": {
+        "target": "ES2020",
+        "moduleResolution": "node",
+        "esModuleInterop": true,
+        "jsx": "react",
+
+        "strict": true,
+        "isolatedModules": true,
+        "forceConsistentCasingInFileNames": true,
+        "resolveJsonModule": true,
+        "skipLibCheck": true
+    }
+}

package/dist/bootstrap.css

@@ -1,6 +1,6 @@
 @charset "UTF-8";
 
-/* src/bootstrap.scss */
+/* stylePlugin:/home/vsts/work/1/s/src/bootstrap.scss */
 :root {
   --blue: #007bff;
   --indigo: #3f51b5;

package/main/index.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * 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',
+
+    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',
+
+    IS_OPEN: 'serialport:is-open',
+    GET_OPTIONS: 'serialport:get-options',
+};
+
+export type OverwriteOptions = {
+    overwrite?: boolean;
+    settingsLocked?: boolean;
+};
+
+export type OpenAppOptions = {
+    device?: { serialNumber: string; serialPortPath?: string };
+};

package/mocks/deviceLibMock.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+export const createContext = jest.fn().mockReturnValue(1);
+export const setTimeoutConfig = jest.fn();
+export const startLogEvents = jest.fn();
+export const stopLogEvents = jest.fn();
+export const setLogLevel = jest.fn();
+export const setLogPattern = jest.fn();
+
+export default {
+    createContext,
+    setTimeoutConfig,
+    startLogEvents,
+    stopLogEvents,
+    setLogLevel,
+    setLogPattern,
+};

package/mocks/electronMock.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+// Allows jest to test files that import the electron package.
+
+export const match = jest.fn();
+export const app = jest.fn();
+export const dialog = jest.fn();
+export const ipcRenderer = {
+    once: jest.fn(),
+    send: jest.fn(),
+};

package/mocks/electronStoreMock.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+// Allows jest to test files that import the electron-store package.
+
+export default jest.fn(() => {
+    const cache = new Map();
+    return {
+        get: jest.fn(
+            (key: string, defaultValue?: unknown) =>
+                cache.get(key) ?? defaultValue
+        ),
+        set: jest.fn(cache.set.bind(cache)),
+        clear: jest.fn(cache.clear.bind(cache)),
+    };
+});

package/mocks/emptyMock.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+export default {};

package/mocks/fileMock.ts

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+// Allows jest to test files that import images, fonts, etc. Jest cannot
+// parse things like this, so we have to mock them. This mock just returns
+// 'test-file-stub' for files that match the moduleNameMapper expression
+// in package.json.
+// Ref: https://facebook.github.io/jest/docs/tutorial-webpack.html
+
+export default 'test-file-stub';

package/mocks/gaMock.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+export default jest.fn(() => ({
+    initialize: jest.fn(),
+}));

package/mocks/mockTests.test.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2023 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+test('electron-store', () => {
+    const Store = jest.requireMock('electron-store').default;
+    const store = new Store();
+    expect(store.get('test', 'default')).toEqual('default');
+    store.set('test', 'newValue');
+    expect(store.get('test', 'default')).toEqual('newValue');
+    store.clear();
+    expect(store.get('test', 'default')).toEqual('default');
+});

package/mocks/packageJsonMock.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+export default () => ({
+    name: 'mocked-test-app',
+    version: '27.6.72',
+});

package/mocks/remoteMock.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+// Allows jest to test files that import the electron package.
+
+export const dialog = jest.fn();
+export const getCurrentWindow = () => ({
+    reload: jest.fn(),
+
+    getTitle: () => 'Not launcher',
+});
+export const app = {
+    getAppPath: () => process.cwd(),
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nordicsemiconductor/pc-nrfconnect-shared",
-    "version": "60.0.0-pre2",
+    "version": "76.0.0",
     "description": "Shared commodities for developing pc-nrfconnect-* packages",
     "repository": {
         "type": "git",
@@ -8,11 +8,6 @@
     },
     "author": "Nordic Semiconductor ASA",
     "license": "ISC",
-    "files": [
-        "./typings",
-        "./dist",
-        "./tsconfig.json"
-    ],
     "bin": {
         "check-for-typescript": "./scripts/check-for-typescript.ts",
         "check-app-properties": "./scripts/check-app-properties.ts",
@@ -20,6 +15,21 @@
         "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",
@@ -27,14 +37,10 @@
         "check:lint": "eslint --color .",
         "check:types": "tsc --noEmit",
         "check:license": "ts-node scripts/nrfconnect-license.ts check",
-        "generate-types": "tsc --emitDeclarationOnly --declaration --outDir ./typings/generated",
+        "generate-types": "tsc --emitDeclarationOnly --declaration --declarationMap --outDir ./typings/generated --rootDir .",
         "prepare": "ts-node scripts/installHusky.ts",
-        "compile:publish": "esbuild scripts/nordic-publish.ts --bundle --outfile=scripts/nordic-publish.js --platform=node --log-level=warning --minify",
-        "compile:bootstrap": "node scripts/esbuild-bootstrap.js",
         "release-shared": "ts-node scripts/release-shared.ts",
-        "prepare-shared-release": "ts-node scripts/prepare-shared-release.ts",
-        "postinstall": "run-p compile:*",
-        "compile": "./scripts/esbuild-shared.mjs"
+        "prepare-shared-release": "ts-node scripts/prepare-shared-release.ts"
     },
     "peerDependencies": {
         "@nordicsemiconductor/nrf-device-lib-js": "*"
@@ -42,6 +48,9 @@
     "dependencies": {
         "@electron/remote": "^2.0.4",
         "@mdi/font": "7.2.96",
+        "@mdi/js": "^7.2.96",
+        "@mdi/react": "^1.6.1",
+        "@microsoft/applicationinsights-web": "^3.0.2",
         "@reduxjs/toolkit": "1.9.3",
         "@svgr/core": "^7.0.0",
         "@svgr/plugin-jsx": "7.0.0",
@@ -67,7 +76,7 @@
         "@typescript-eslint/eslint-plugin": "5.57.1",
         "@typescript-eslint/parser": "5.57.1",
         "adm-zip": "^0.5.5",
-        "assert": "2.0.0",
+        "autoprefixer": "10.4.14",
         "bootstrap": "4.6.2",
         "commander": "10.0.0",
         "date-fns": "2.29.3",
@@ -76,8 +85,9 @@
         "enzyme": "3.11.0",
         "enzyme-adapter-react-16": "1.15.7",
         "enzyme-to-json": "3.6.2",
-        "esbuild": "^0.17.18",
-        "esbuild-sass-plugin": "^2.9.0",
+        "esbuild": "0.17.18",
+        "esbuild-sass-plugin": "2.9.0",
+        "esbuild-style-plugin": "1.6.2",
         "eslint": "8.37.0",
         "eslint-config-airbnb": "19.0.4",
         "eslint-config-prettier": "8.8.0",
@@ -102,15 +112,16 @@
         "mousetrap": "1.6.5",
         "npm-run-all2": "6.0.5",
         "nrf-intel-hex": "^1.3.0",
+        "postcss": "8.4.24",
         "postcss-modules": "^6.0.0",
         "prettier": "2.8.8",
+        "prettier-plugin-tailwindcss": "^0.3.0",
         "prettysize": "2.0.0",
         "protobufjs": "^7.0.0",
         "react": "16.14.0",
         "react-bootstrap": "1.6.6",
         "react-dom": "16.14.0",
         "react-flip-toolkit": "7.0.17",
-        "react-ga": "2.7.0",
         "react-markdown": "4.3.1",
         "react-redux": "7.2.9",
         "react-resize-detector": "6.7.8",
@@ -124,6 +135,7 @@
         "serialport": "^10.5.0",
         "shasum": "1.0.2",
         "systeminformation": "5.17.12",
+        "tailwindcss": "3.3.2",
         "ts-node": "10.9.1",
         "typescript": "4.9.5",
         "util": "0.12.5",
@@ -134,8 +146,5 @@
     "eslintConfig": {
         "extends": "./config/eslintrc"
     },
-    "prettier": "./config/prettier.config.js",
-    "devDependencies": {
-        "esbuild-plugin-svgr": "^2.0.0"
-    }
+    "prettier": "./config/prettier.config.js"
 }

package/scripts/esbuild-bootstrap.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+const { build } = require('./esbuild-renderer');
+
+build({
+    logLevel: 'warning',
+    entryPoints: ['./src/bootstrap.scss'],
+    outfile: 'dist/bootstrap.css',
+    sourcemap: false,
+});