@nordicsemiconductor/nrf-jlink-js 0.9.1 → 0.10.0

package/README.md

@@ -1,19 +1,19 @@
 # nrf-jlink-js
 
-`nrf-jlink-js` is a Node.js module to handle jlink installer and bundle by Nordic Semiconductor ASA.
+`nrf-jlink-js` is a Node.js module to check and install the recommended JLink version used by some products of Nordic Semiconductor ASA.
 
 ## Installation
 
 ```bash
-npm install nrf-jlink-js
+npm install @nordicsemiconductor/nrf-jlink-js
 ```
 
 ## Usage
 
 ```js
-const jlink = new Jlink();
-const remoteJlinkList = await jlink.listRemote();
-const localJlinkList = await jlink.listLocalInstalled();
-```
+const { outdated, versionToBeInstalled } = await getVersionToInstall()
 
-For more usage, see [`examples`](./examples)
+if (outdated) {
+    downloadAndInstallJlink(console.log)
+}
+```

package/dist/jlink.d.ts

@@ -9,7 +9,10 @@ interface JLinkState {
     versionToBeInstalled?: string;
     installedVersion?: string;
 }
-export declare const getVersionToInstall: (fallbackVersion?: string) => Promise<JLinkState>;
+export declare const getVersionToInstall: ({ fallbackVersion, checkOnline, }?: {
+    fallbackVersion?: string;
+    checkOnline?: boolean;
+}) => Promise<JLinkState>;
 export declare const downloadAndSaveJLink: (destinationDir: string, destinationFileName?: string, onUpdate?: (update: Update) => void) => Promise<string>;
 export declare const downloadAndInstallJLink: (onUpdate?: (update: Update) => void) => Promise<void>;
 export {};

package/dist/jlink.js

@@ -219,30 +219,46 @@ var convertToSemverVersion = function (version) {
 var isValidVersion = function (installedVersion, expectedVersion) {
     return semver_1.default.gte(convertToSemverVersion(installedVersion), convertToSemverVersion(expectedVersion));
 };
-var getVersionToInstall = function (fallbackVersion) { return __awaiter(void 0, void 0, void 0, function () {
-    var versionToBeInstalled, installedVersion, installed, outdated;
-    var _a, _b;
-    return __generator(this, function (_c) {
-        switch (_c.label) {
-            case 0: return [4 /*yield*/, (0, common_1.fetchIndex)().catch(function () { return undefined; })];
-            case 1:
-                versionToBeInstalled = (_b = (_a = (_c.sent())) === null || _a === void 0 ? void 0 : _a.version) !== null && _b !== void 0 ? _b : fallbackVersion;
-                return [4 /*yield*/, getInstalledJLinkVersion().catch(function () { return undefined; })];
-            case 2:
-                installedVersion = _c.sent();
-                installed = !!installedVersion;
-                outdated = !installed ||
-                    !versionToBeInstalled ||
-                    !isValidVersion(installedVersion, versionToBeInstalled);
-                return [2 /*return*/, {
-                        outdated: outdated,
-                        installedVersion: installedVersion,
-                        installed: installed,
-                        versionToBeInstalled: versionToBeInstalled,
-                    }];
-        }
+var getVersionToInstall = function () {
+    var args_1 = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args_1[_i] = arguments[_i];
+    }
+    return __awaiter(void 0, __spreadArray([], args_1, true), void 0, function (_a) {
+        var onlineRecommendedVersion, _b, versionToBeInstalled, installedVersion, installed, outdated;
+        var _c;
+        var _d = _a === void 0 ? {} : _a, fallbackVersion = _d.fallbackVersion, _e = _d.checkOnline, checkOnline = _e === void 0 ? true : _e;
+        return __generator(this, function (_f) {
+            switch (_f.label) {
+                case 0:
+                    if (!checkOnline) return [3 /*break*/, 2];
+                    return [4 /*yield*/, (0, common_1.fetchIndex)().catch(function () { return undefined; })];
+                case 1:
+                    _b = (_c = (_f.sent())) === null || _c === void 0 ? void 0 : _c.version;
+                    return [3 /*break*/, 3];
+                case 2:
+                    _b = undefined;
+                    _f.label = 3;
+                case 3:
+                    onlineRecommendedVersion = _b;
+                    versionToBeInstalled = onlineRecommendedVersion !== null && onlineRecommendedVersion !== void 0 ? onlineRecommendedVersion : fallbackVersion;
+                    return [4 /*yield*/, getInstalledJLinkVersion().catch(function () { return undefined; })];
+                case 4:
+                    installedVersion = _f.sent();
+                    installed = !!installedVersion;
+                    outdated = !installed ||
+                        !versionToBeInstalled ||
+                        !isValidVersion(installedVersion, versionToBeInstalled);
+                    return [2 /*return*/, {
+                            outdated: outdated,
+                            installedVersion: installedVersion,
+                            installed: installed,
+                            versionToBeInstalled: versionToBeInstalled,
+                        }];
+            }
+        });
     });
-}); };
+};
 exports.getVersionToInstall = getVersionToInstall;
 var downloadAndSaveJLink = function (destinationDir, destinationFileName, onUpdate) {
     return (0, common_1.fetchIndex)().then(function (v) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nordicsemiconductor/nrf-jlink-js",
-    "version": "0.9.1",
+    "version": "0.10.0",
     "main": "dist",
     "types": "dist",
     "files": [