@nordicsemiconductor/pc-nrfconnect-shared 117.0.0 → 118.0.0

package/scripts/check-app-properties.ts

@@ -10,7 +10,7 @@ import { execSync } from 'child_process';
 import { existsSync, readdirSync, readFileSync } from 'fs';
 import property from 'lodash/property';
 
-import { PackageJson } from '../ipc/MetaFiles';
+import { PackageJson, parsePackageJson } from '../ipc/schema/packageJson';
 
 const format = (strings: string[]) =>
     strings.map(string => `\`${string}\``).join(', ');
@@ -61,43 +61,6 @@ const mustContainOneOf = (
     }
 };
 
-const checkMandatoryProperties = (packageJson: PackageJson) => {
-    const mandatoryProperties = [
-        `name`,
-        `version`,
-        `description`,
-        `displayName`,
-        `engines.nrfconnect`,
-    ];
-
-    const missingProperties = mandatoryProperties.filter(
-        propertyIsMissing(packageJson)
-    );
-
-    mustBeEmpty(
-        missingProperties,
-        'package.json is missing these mandatory properties'
-    );
-};
-
-const checkNrfutilProperties = (packageJson: PackageJson) => {
-    const nrfutilModules = packageJson.nrfConnectForDesktop?.nrfutil;
-    if (nrfutilModules != null) {
-        Object.entries(nrfutilModules).forEach(
-            ([moduleName, moduleVersions]) => {
-                if (
-                    !Array.isArray(moduleVersions) ||
-                    moduleVersions.length === 0
-                ) {
-                    fail(
-                        `For each module in \`nrfConnectForDesktop.nrfutil\` in package.json at least one version must be specified, but for \`${moduleName}\` none was specified.`
-                    );
-                }
-            }
-        );
-    }
-};
-
 const checkRepoUrl = (packageJson: PackageJson) => {
     if (!existsSync('./.git')) {
         return;
@@ -130,14 +93,6 @@ const checkOptionalProperties = (packageJson: PackageJson) => {
         warn('Please provide a property `homepage` in package.json.');
     }
 
-    if (propertyIsMissing(packageJson)('nrfConnectForDesktop')) {
-        warn(
-            'Please provide a property `nrfConnectForDesktop.html` in package.json'
-        );
-    } else {
-        checkNrfutilProperties(packageJson);
-    }
-
     if (propertyIsMissing(packageJson)('repository.url')) {
         warn('Please provide a property `repository.url` in package.json.');
     } else {
@@ -159,6 +114,24 @@ const checkFileProperty = (packageJson: PackageJson) => {
     );
 };
 
+const readAndCheckPackageJson = () => {
+    const packageJsonResult = parsePackageJson(
+        readFileSync('./package.json', 'utf8')
+    );
+
+    if (!packageJsonResult.success) {
+        console.error(packageJsonResult.error.message);
+        process.exit(1);
+    }
+
+    const packageJson = packageJsonResult.data;
+
+    checkOptionalProperties(packageJson);
+    checkFileProperty(packageJson);
+
+    return packageJson;
+};
+
 const changelogEntryRegexp = (version?: string) =>
     new RegExp(`^## ${version}`, 'mi');
 
@@ -211,13 +184,8 @@ const runChecks = ({
 }: {
     checkChangelogHasCurrentEntry: boolean;
 }) => {
-    const packageJson = <PackageJson>(
-        JSON.parse(readFileSync('./package.json', 'utf8'))
-    );
+    const packageJson = readAndCheckPackageJson();
 
-    checkMandatoryProperties(packageJson);
-    checkOptionalProperties(packageJson);
-    checkFileProperty(packageJson);
     checkChangelog(packageJson, checkChangelogHasCurrentEntry);
     checkMandatoryResources();
 };

package/scripts/{esbuild-renderer.js → esbuild-renderer.ts}

@@ -4,21 +4,18 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-const fs = require('fs');
-const join = require('path').join;
-const { sassPlugin, postcssModules } = require('esbuild-sass-plugin');
-const esbuild = require('esbuild');
-const svgr = require('@svgr/core').transform;
-const builtinModules = require('module').builtinModules;
-const postCssPlugin = require('esbuild-style-plugin');
-const tailwindcss = require('tailwindcss');
-const autoprefixer = require('autoprefixer');
-const path = require('path');
+import { transform as svgr } from '@svgr/core';
+import autoprefixer from 'autoprefixer';
+import esbuild, { BuildOptions } from 'esbuild';
+import { postcssModules, sassPlugin } from 'esbuild-sass-plugin';
+import postCssPlugin from 'esbuild-style-plugin';
+import * as fs from 'node:fs';
+import * as module from 'node:module';
+import * as path from 'node:path';
+import tailwindcss from 'tailwindcss';
+
+const packageJson = JSON.parse(fs.readFileSync('package.json', 'utf8'));
 
-const packageJsonOfApp = fs.readFileSync(
-    path.join(process.cwd(), 'package.json'),
-    'utf8'
-);
 const projectSpecificTailwindConfigPath = path.join(
     process.cwd(),
     'tailwind.config.js'
@@ -30,26 +27,21 @@ const tailwindConfig = () =>
               '@nordicsemiconductor/pc-nrfconnect-shared/config/tailwind.config.js'
           );
 
-function options(additionalOptions) {
-    const { dependencies, nrfConnectForDesktop } = JSON.parse(
-        fs.readFileSync('package.json', 'utf8')
-    );
-
-    const outfile =
-        additionalOptions.entryPoints.length === 1
-            ? './dist/bundle.js'
-            : undefined;
-    const outdir = outfile ? undefined : './dist';
+type AdditionalOptions = Required<Pick<BuildOptions, 'entryPoints'>> &
+    Partial<BuildOptions>;
 
-    const appHasOwnHtml = nrfConnectForDesktop?.html !== undefined;
+const outfileOrDir = (additionalOptions: AdditionalOptions) =>
+    additionalOptions.entryPoints.length === 1
+        ? { outfile: './dist/bundle.js' }
+        : { outdir: './dist' };
 
-    return {
-        define: {
-            'process.env.PACKAGE_JSON_OF_APP': JSON.stringify(packageJsonOfApp),
-        },
-        format: appHasOwnHtml ? 'iife' : 'cjs',
-        outfile,
-        outdir,
+const options = (
+    additionalOptions: AdditionalOptions,
+    externalReact: boolean
+) =>
+    ({
+        format: 'iife',
+        ...outfileOrDir(additionalOptions),
         target: 'chrome89',
         sourcemap: true,
         metafile: false,
@@ -57,16 +49,16 @@ function options(additionalOptions) {
         bundle: true,
         logLevel: 'info',
         external: [
-            ...builtinModules,
+            ...module.builtinModules,
 
             // launcher includes
             'electron',
             'serialport',
             '@electron/remote',
-            ...(appHasOwnHtml ? [] : ['react']),
+            ...(externalReact ? ['react', 'react-dom'] : []),
 
             // App dependencies
-            ...Object.keys(dependencies ?? {}),
+            ...Object.keys(packageJson.dependencies ?? {}),
         ],
         loader: {
             '.json': 'json',
@@ -103,8 +95,8 @@ function options(additionalOptions) {
 
                     builder.onResolve({ filter }, args => {
                         // Rename file to .svgr to let this plugin handle it.
-                        const [, shortpath] = filter.exec(args.path);
-                        const resolvedPath = `${join(
+                        const [, shortpath] = filter.exec(args.path)!; // eslint-disable-line @typescript-eslint/no-non-null-assertion
+                        const resolvedPath = `${path.join(
                             args.resolveDir,
                             shortpath
                         )}r`;
@@ -118,7 +110,7 @@ function options(additionalOptions) {
                             'utf8'
                         );
                         const plugins = ['@svgr/plugin-jsx'];
-                        const contents = await svgr(svg, { filePath, plugins });
+                        const contents = await svgr(svg, { plugins });
                         return {
                             contents,
                             loader: 'jsx',
@@ -128,22 +120,20 @@ function options(additionalOptions) {
             },
         ],
         ...additionalOptions,
-    };
-}
-
-const build = additionalOptions => esbuild.build(options(additionalOptions));
+    } satisfies BuildOptions);
 
-const watch = async additionalOptions => {
-    const context = await esbuild.context(options(additionalOptions));
-
-    await context.rebuild();
-    await context.watch();
-};
-
-module.exports.build = additionalOptions => {
+export const build = async (
+    additionalOptions: AdditionalOptions,
+    { externalReact = false } = {}
+) => {
     if (process.argv.includes('--watch')) {
-        watch(additionalOptions);
+        const context = await esbuild.context(
+            options(additionalOptions, externalReact)
+        );
+
+        await context.rebuild();
+        await context.watch();
     } else {
-        build(additionalOptions);
+        esbuild.build(options(additionalOptions, externalReact));
     }
 };

package/scripts/esbuild.ts

@@ -0,0 +1,79 @@
+#!/usr/bin/env ts-node
+/*
+ * Copyright (c) 2015 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+
+import { parsePackageJson } from '../ipc/schema/packageJson';
+import { build } from './esbuild-renderer';
+
+const validate = (packageJson: string) => {
+    const result = parsePackageJson(packageJson);
+
+    if (!result.success) {
+        console.log(result.error.message);
+        process.exit(1);
+    }
+};
+
+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');
+
+    validate(packageJson);
+
+    build({
+        define: {
+            'process.env.PACKAGE_JSON_OF_APP': JSON.stringify(packageJson),
+        },
+        entryPoints: [entry()],
+    });
+};
+
+const fileInShared = (file: string) =>
+    require.resolve(`@nordicsemiconductor/pc-nrfconnect-shared/${file}`);
+
+const fileInDist = (file: string) => path.join('dist', path.basename(file));
+
+const copyFileToDist = (file: string) =>
+    fs.copyFileSync(fileInShared(file), fileInDist(file));
+
+const copyFiles = () => {
+    fs.mkdirSync('dist', { recursive: true });
+
+    copyFileToDist('scripts/nordic-publish.js');
+    copyFileToDist('dist/bootstrap.css');
+    copyFileToDist('src/index.html');
+
+    if (process.argv.includes('--include-bootloader')) {
+        fs.mkdirSync('fw', { recursive: true });
+
+        fs.copyFileSync(
+            fileInShared(
+                'fw/bootloader/graviton_bootloader_v1.0.1-[nRF5_SDK_15.0.1-1.alpha_f76d012].zip'
+            ),
+            './fw/graviton_bootloader_v1.0.1-[nRF5_SDK_15.0.1-1.alpha_f76d012].zip'
+        );
+    }
+};
+
+bundle();
+copyFiles();