@nordicsemiconductor/pc-nrfconnect-shared 90.0.0 → 91.0.0

package/Changelog.md

@@ -7,6 +7,32 @@ This project does _not_ adhere to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html) but contrary to it
 every new version is a new major version.
 
+## 91 - 2023-08-23
+
+### Changed
+
+-   Assert that the properties of objects in `nrfConnectForDesktop.nrfutil` in
+    `package.json` are really arrays with at least one entry. So e.g. all of
+    these entries would be rejected:
+
+```json
+{
+    "nrfConnectForDesktop": {
+        "nrfutil": {
+            "device": [], // Wrong: Empty array
+            "legacy": null, // Wrong: null
+            "toolchain-manager": "1.0.0" // Wrong: Not an array
+        }
+    }
+}
+```
+
+### Removed
+
+-   Exported, obsolete function `getDeviceLibContext()`.
+-   Peer dependency and any remaining support for
+    `@nordicsemiconductor/nrf-device-lib-js`.
+
 ## 90 - 2023-08-21
 
 ### Changed

package/config/jest.config.js

@@ -16,7 +16,6 @@ module.exports = (disabledMocks = []) => ({
         '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')
             ? {}

package/coverage/cobertura-coverage.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" ?>
 <!DOCTYPE coverage SYSTEM "http://cobertura.sourceforge.net/xml/coverage-04.dtd">
-<coverage lines-valid="2992" lines-covered="1665" line-rate="0.5564" branches-valid="1465" branches-covered="394" branch-rate="0.26890000000000003" timestamp="1692610533087" complexity="0" version="0.1">
+<coverage lines-valid="2964" lines-covered="1644" line-rate="0.5546" branches-valid="1446" branches-covered="381" branch-rate="0.2634" timestamp="1692780987528" complexity="0" version="0.1">
   <sources>
     <source>/home/vsts/work/1/s</source>
   </sources>
@@ -299,21 +299,8 @@
         </class>
       </classes>
     </package>
-    <package name="mocks" line-rate="0.9129999999999999" branch-rate="1">
+    <package name="mocks" line-rate="0.875" branch-rate="1">
       <classes>
-        <class name="deviceLibMock.ts" filename="mocks/deviceLibMock.ts" line-rate="1" branch-rate="1">
-          <methods>
-          </methods>
-          <lines>
-            <line number="7" hits="1" branch="false"/>
-            <line number="8" hits="1" branch="false"/>
-            <line number="9" hits="1" branch="false"/>
-            <line number="10" hits="1" branch="false"/>
-            <line number="11" hits="1" branch="false"/>
-            <line number="12" hits="1" branch="false"/>
-            <line number="14" hits="1" branch="false"/>
-          </lines>
-        </class>
         <class name="electronMock.ts" filename="mocks/electronMock.ts" line-rate="1" branch-rate="1">
           <methods>
           </methods>
@@ -389,10 +376,10 @@
             </method>
           </methods>
           <lines>
-            <line number="9" hits="13" branch="false"/>
-            <line number="10" hits="13" branch="false"/>
+            <line number="9" hits="12" branch="false"/>
+            <line number="10" hits="12" branch="false"/>
             <line number="13" hits="0" branch="false"/>
-            <line number="15" hits="13" branch="false"/>
+            <line number="15" hits="12" branch="false"/>
             <line number="16" hits="0" branch="false"/>
           </lines>
         </class>
@@ -2542,7 +2529,7 @@
         </class>
       </classes>
     </package>
-    <package name="src.Device" line-rate="0.3824" branch-rate="0.1961">
+    <package name="src.Device" line-rate="0.3734" branch-rate="0.16949999999999998">
       <classes>
         <class name="deviceAutoSelectSlice.ts" filename="src/Device/deviceAutoSelectSlice.ts" line-rate="0.62" branch-rate="0.44439999999999996">
           <methods>
@@ -2685,68 +2672,6 @@
             <line number="150" hits="0" branch="false"/>
           </lines>
         </class>
-        <class name="deviceLibWrapper.ts" filename="src/Device/deviceLibWrapper.ts" line-rate="0.6666" branch-rate="0.6842">
-          <methods>
-            <method name="(anonymous_4)" hits="0" signature="()V">
-              <lines>
-                <line number="16" hits="0"/>
-              </lines>
-            </method>
-            <method name="(anonymous_5)" hits="0" signature="()V">
-              <lines>
-                <line number="22" hits="0"/>
-              </lines>
-            </method>
-            <method name="(anonymous_6)" hits="5" signature="()V">
-              <lines>
-                <line number="47" hits="5"/>
-              </lines>
-            </method>
-            <method name="(anonymous_7)" hits="7" signature="()V">
-              <lines>
-                <line number="48" hits="7"/>
-              </lines>
-            </method>
-            <method name="(anonymous_8)" hits="3" signature="()V">
-              <lines>
-                <line number="50" hits="3"/>
-              </lines>
-            </method>
-            <method name="(anonymous_9)" hits="4" signature="()V">
-              <lines>
-                <line number="54" hits="4"/>
-              </lines>
-            </method>
-            <method name="(anonymous_10)" hits="5" signature="()V">
-              <lines>
-                <line number="62" hits="5"/>
-              </lines>
-            </method>
-          </methods>
-          <lines>
-            <line number="7" hits="1" branch="false"/>
-            <line number="12" hits="1" branch="false"/>
-            <line number="13" hits="1" branch="false"/>
-            <line number="15" hits="1" branch="false"/>
-            <line number="16" hits="1" branch="false"/>
-            <line number="17" hits="0" branch="true" condition-coverage="0% (0/1)"/>
-            <line number="19" hits="0" branch="false"/>
-            <line number="22" hits="1" branch="false"/>
-            <line number="23" hits="0" branch="true" condition-coverage="0% (0/2)"/>
-            <line number="24" hits="0" branch="true" condition-coverage="0% (0/2)"/>
-            <line number="27" hits="0" branch="false"/>
-            <line number="37" hits="0" branch="false"/>
-            <line number="40" hits="0" branch="false"/>
-            <line number="47" hits="1" branch="false"/>
-            <line number="48" hits="7" branch="false"/>
-            <line number="50" hits="1" branch="false"/>
-            <line number="51" hits="3" branch="true" condition-coverage="100% (1/1)"/>
-            <line number="52" hits="3" branch="false"/>
-            <line number="54" hits="4" branch="false"/>
-            <line number="62" hits="2" branch="false"/>
-            <line number="66" hits="5" branch="true" condition-coverage="100% (4/4)"/>
-          </lines>
-        </class>
         <class name="deviceLister.ts" filename="src/Device/deviceLister.ts" line-rate="0.3333" branch-rate="0.0925">
           <methods>
             <method name="(anonymous_8)" hits="0" signature="()V">

package/ipc/MetaFiles.ts

@@ -20,7 +20,7 @@ export type AppVersions = {
 export type AppVersion = {
     shasum?: string;
     tarballUrl: UrlString;
-    nrfutilModules?: nrfutilModules;
+    nrfutilModules?: NrfutilModules;
 };
 
 export interface AppInfo {
@@ -42,18 +42,26 @@ interface ObjectContainingOptionalStrings {
     [index: string]: string | undefined;
 }
 
-interface nrfConnectForDesktop {
-    nrfutil?: nrfutilModules;
+interface NrfConnectForDesktop {
+    nrfutil?: NrfutilModules;
     html?: string;
 }
 
-interface nrfutilModules {
-    [index: string]: string[] | undefined;
+type SemverString = string;
+
+export type NrfutilModuleName = string;
+export type NrfutilModuleVersion = SemverString;
+
+export interface NrfutilModules {
+    [name: NrfutilModuleName]: [
+        NrfutilModuleVersion,
+        ...NrfutilModuleVersion[]
+    ];
 }
 
 export interface PackageJson {
     name: string;
-    version: string;
+    version: SemverString;
 
     // Several optional properties
     author?: string;
@@ -64,7 +72,7 @@ export interface PackageJson {
     devDependencies?: ObjectContainingOptionalStrings;
     displayName?: string;
     engines?: ObjectContainingOptionalStrings;
-    nrfConnectForDesktop?: nrfConnectForDesktop;
+    nrfConnectForDesktop?: NrfConnectForDesktop;
     files?: readonly string[];
     license?: string;
     main?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nordicsemiconductor/pc-nrfconnect-shared",
-    "version": "90.0.0",
+    "version": "91.0.0",
     "description": "Shared commodities for developing pc-nrfconnect-* packages",
     "repository": {
         "type": "git",
@@ -28,9 +28,6 @@
         "clean": "rimraf dist typings/generated dist scripts/nordic-publish.js",
         "postinstall": "ts-node scripts/postinstall.ts"
     },
-    "peerDependencies": {
-        "@nordicsemiconductor/nrf-device-lib-js": ">=0.7.1"
-    },
     "dependencies": {
         "@electron/remote": "^2.0.4",
         "@mdi/font": "7.2.96",

package/scripts/check-app-properties.ts

@@ -80,6 +80,51 @@ const checkMandatoryProperties = (packageJson: PackageJson) => {
     );
 };
 
+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;
+    }
+
+    const realGitUrl = execSync('git remote get-url origin', {
+        encoding: 'utf-8',
+    }).trimEnd();
+    const declaredGitUrl = packageJson.repository?.url;
+
+    const withoutPostfix = (gitUrl?: string) => gitUrl?.replace(/\.git$/, '');
+
+    const withoutProtocol = (gitUrl?: string) =>
+        gitUrl
+            ?.replace(/^git@github\.com:/, 'github.com/')
+            .replace(/^https:\/\//, '');
+
+    const stripped = (gitUrl?: string) =>
+        withoutProtocol(withoutPostfix(gitUrl));
+
+    if (stripped(realGitUrl) !== stripped(declaredGitUrl)) {
+        fail(
+            `package.json says the repository is located at \`${declaredGitUrl}\` but \`git remote get-url origin\` says it is at \`${realGitUrl}\`.`
+        );
+    }
+};
+
 const checkOptionalProperties = (packageJson: PackageJson) => {
     if (propertyIsMissing(packageJson)('homepage')) {
         warn('Please provide a property `homepage` in package.json.');
@@ -89,32 +134,14 @@ const checkOptionalProperties = (packageJson: PackageJson) => {
         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 if (existsSync('./.git')) {
-        const realGitUrl = execSync('git remote get-url origin', {
-            encoding: 'utf-8',
-        }).trimEnd();
-        const declaredGitUrl = packageJson.repository?.url;
-
-        const withoutPostfix = (gitUrl?: string) =>
-            gitUrl?.replace(/\.git$/, '');
-
-        const withoutProtocol = (gitUrl?: string) =>
-            gitUrl
-                ?.replace(/^git@github\.com:/, 'github.com/')
-                .replace(/^https:\/\//, '');
-
-        const stripped = (gitUrl?: string) =>
-            withoutProtocol(withoutPostfix(gitUrl));
-
-        if (stripped(realGitUrl) !== stripped(declaredGitUrl)) {
-            fail(
-                `package.json says the repository is located at \`${declaredGitUrl}\` but \`git remote get-url origin\` says it is at \`${realGitUrl}\`.`
-            );
-        }
+    } else {
+        checkRepoUrl(packageJson);
     }
 };
 

package/scripts/esbuild-renderer.js

@@ -56,7 +56,6 @@ function options(additionalOptions) {
             'electron',
             'serialport',
             '@electron/remote',
-            '@nordicsemiconductor/nrf-device-lib-js',
             ...(appHasOwnHtml ? [] : ['react']),
 
             // App dependencies