@aiot-nexus/plugin-sdk 3.0.2 → 3.1.1

package/README.md

@@ -1,6 +1,6 @@
 # @aiot-nexus/plugin-sdk
 
-> 当前 SDK 包版本为 `3.0.2`，Framework API 为 `3.0.0`，manifest schema 保持 `1`。Framework 3 将可信插件的 `mainEntry` 直接加载到 Nexus Electron 主进程；它不是安全沙箱。PluginFrame iframe 仍保持 sandbox、无 Node/Electron 访问。宿主运行模型见 [Framework v3 架构](../docs/plugin-framework-v3-architecture.md)。
+> 当前 SDK 包版本为 `3.1.1`，Framework API 为 `3.1.0`，manifest schema 保持 `1`。Framework 3 将可信插件的 `mainEntry` 直接加载到 Nexus Electron 主进程；它不是安全沙箱。PluginFrame iframe 仍保持 sandbox、无 Node/Electron 访问。宿主运行模型见 [Framework v3 架构](../docs/plugin-framework-v3-architecture.md)。
 
 本包提供公开 TypeScript 契约、PluginFrame 浏览器客户端和 `nexus-plugin` CLI。v2 项目升级前请先阅读 [v2 到 v3 迁移说明](../docs/plugin-framework-v2-v3-migration.md)。完整开发流程见 [独立插件开发指南](../docs/standalone-plugin-development-guide.md)。
 
@@ -8,8 +8,8 @@
 
 | 项目 | 固定值 |
 | --- | --- |
-| SDK | `3.0.2` |
-| Framework API | `3.0.0` |
+| SDK | `3.1.1` |
+| Framework API | `3.1.0` |
 | Manifest schema | `1` |
 | Node 安装和构建 | `>=16.20.0 <17` |
 | Electron | `22.3.27` |
@@ -21,9 +21,10 @@
 ## CLI
 
 ```bash
-nexus-plugin info
+nexus-plugin info [--json]
 nexus-plugin validate <plugin-package-directory>
 nexus-plugin create <plugin-id> --template minimal|sqlite --output <parent-directory>
+nexus-plugin upgrade [plugin-project-directory] [--check] [--sdk-source <version-or-local-tgz>]
 nexus-plugin dev [plugin-project-directory]
 nexus-plugin dev:web [plugin-project-directory]
 nexus-plugin dev:nexus [plugin-project-directory] --host <nexus.exe-or-directory>
@@ -38,7 +39,35 @@ npm run pack:sdk
 npm run publish:sdk
 ```
 
-`pack:sdk` 把离线 tgz 写入 `plugin-sdk/package/`。`publish:sdk` 的 `prepack` 会运行测试、构建和公开文件清单验证。安装阶段和 CLI 启动阶段会非阻塞检查 SDK 更新；设置 `NEXUS_PLUGIN_SDK_UPDATE_CHECK=0` 或 `NO_UPDATE_NOTIFIER=1` 可关闭检查。检查失败不会阻断安装、构建或调试，也不会自动修改依赖。
+`pack:sdk` 把离线 tgz 写入 `plugin-sdk/package/`。`publish:sdk` 的 `prepack` 会运行测试、构建和公开文件清单验证。安装阶段和 CLI 启动阶段会非阻塞检查 SDK 更新；设置 `NEXUS_PLUGIN_SDK_UPDATE_CHECK=0` 或 `NO_UPDATE_NOTIFIER=1` 可关闭检查。检查失败不会阻断安装、构建或调试，版本通知本身不会修改依赖；只有显式执行 `upgrade` 才会进入升级事务。
+
+## 升级插件工程 SDK
+
+标准插件工程的 `nexus-plugin` 来自本地 `@aiot-nexus/plugin-sdk`，因此 CLI 和工程 SDK 是同一个依赖。旧工程应由目标版本的 CLI 执行升级，不能只手工修改 `package.json`，因为 lockfile 和 `node_modules` 仍可能保留旧版本。
+
+registry 升级与只读预检：
+
+```bash
+npx --package=@aiot-nexus/plugin-sdk@3.1.1 nexus-plugin upgrade . --check
+npx --package=@aiot-nexus/plugin-sdk@3.1.1 nexus-plugin upgrade .
+```
+
+发布前或本地 tgz：
+
+```bash
+npx --package=./aiot-nexus-plugin-sdk-3.1.1.tgz nexus-plugin upgrade . \
+  --sdk-source ./aiot-nexus-plugin-sdk-3.1.1.tgz
+```
+
+CI 可以追加 `--json` 获得 `up-to-date`、`upgrade-available`、`upgraded`、`rolled-back` 或 `blocked`。`--allow-major` 只解除 major 保护，不会改写业务源码；跨 major 必须先阅读迁移指南。`--skip-project-checks` 只跳过项目 typecheck/build，安装后的 SDK、package 和 lockfile 一致性仍会验证。
+
+升级器直接修改的范围只有 SDK 依赖、`package-lock.json`、`node_modules` 和命令管理的 SDK tgz。本地包会保存为 `vendor/aiot-nexus-plugin-sdk-<version>.tgz`，下一次本地升级会安全清理上一份由命令管理的版本化归档。Electron、TypeScript、`@types/node` 和 Node engine 只检查不修改；manifest、模板、README、构建脚本和业务依赖不会被覆盖。
+
+修改前，命令会在项目根目录创建 `.nexus-plugin-upgrade-recovery/`，持久备份 package、lock、受管 tgz 和标准 `dist/<pluginId>`，并写入 `recovery.json` 阶段记录。成功或确定性回滚后该目录自动删除；硬中断、回滚重装失败或清理失败时保留，后续 upgrade 会停止并要求先按 journal 恢复。不要在项目恢复并完成验证前删除它。
+
+安装或项目验证失败时恢复备份，并在原 lockfile 存在时运行 `npm ci`。没有原 lockfile 时会运行 `npm install` 并恢复原 SDK，但无法证明完整传递依赖树与升级前一致，因此返回 `blocked` 并保留恢复数据。标准脚手架 build 的 `dist/<pluginId>` 在回滚范围内；自定义 typecheck/build 若修改其他路径，这些副作用不属于升级事务，项目必须自行管理。
+
+SDK `3.0.2` 或 `3.1.0` 升级到 `3.1.1` 后，原有 `hostApiVersion: 3.0.0` 可以保持不变。只有实际使用 `showHostStatusBar` 等 3.1 专属字段时，才把 manifest 声明提升到 `3.1.0`。SDK 3.1.1 修复了 registry 升级时把裸版本号误传给 `npm install` 的问题；全局安装 3.1.0 的用户应先把全局 CLI 更新到 3.1.1。
 
 ## 创建插件
 
@@ -61,10 +90,32 @@ nexus-plugin create my-frame-plugin \
 
 ```bash
 npm run pack:sdk
-nexus-plugin create my-frame-plugin --sdk-source ./package/aiot-nexus-plugin-sdk-3.0.2.tgz --install
+nexus-plugin create my-frame-plugin --sdk-source ./package/aiot-nexus-plugin-sdk-3.1.1.tgz --install
 ```
 
-## 3.0 mainEntry
+生成插件后，可以在 `src/manifest.json` 的业务入口中静态控制 Nexus 宿主状态栏。相关 manifest 片段如下，其余必填字段沿用脚手架生成值：
+
+```json
+{
+  "hostApiVersion": "3.1.0",
+  "businessEntries": [
+    {
+      "businessId": "my-frame-plugin",
+      "titleKey": "plugin.displayName",
+      "iconKey": "extension",
+      "section": "home.main",
+      "order": 50,
+      "component": "PluginFrame",
+      "pageRoute": "my-frame-plugin",
+      "showHostStatusBar": false
+    }
+  ]
+}
+```
+
+仅显式设置为 `false` 时隐藏。字段省略或设置为 `true` 时显示；离开该业务入口后，宿主状态栏自动恢复。该字段要求 `hostApiVersion >= 3.1.0`。
+
+## Framework 3.1 mainEntry
 
 `mainEntry` 是可信 Electron 主进程代码，可直接导入 Electron、Node 内置模块和插件本地依赖：
 
@@ -196,11 +247,12 @@ VS Code 模板提供 `Debug Nexus plugin` 和 `Attach Nexus plugin main process
 
 ## 发布前检查
 
-1. `hostApiVersion` 为 `3.0.0`，manifest schema 仍为 `1`。
-2. `activate/deactivate` 同步，operation handler 才使用异步。
-3. Renderer 只使用窄口径 operation，所有输入在 mainEntry 再校验。
-4. 窗口保持 `contextIsolation: true`、`sandbox: true`、`nodeIntegration: false`、`webSecurity: true`。
-5. IPC、protocol、快捷键、菜单和文件路径使用插件命名空间并检测冲突。
-6. `deactivate` 关闭窗口、Session 监听、IPC、protocol、快捷键、定时器、数据库和子进程。
-7. 没有同步长任务、无限载荷、任意命令/SQL/路径透传或日志敏感信息。
-8. 运行 `npm test`、插件构建、正式 Nexus 集成和 Windows 7 真机验收。
+1. `hostApiVersion` 为 `3.1.0`，manifest schema 仍为 `1`。
+2. 业务入口的 `showHostStatusBar` 可静态声明是否保留宿主状态栏；省略时默认保留，显式使用时要求 `hostApiVersion >= 3.1.0`。
+3. `activate/deactivate` 同步，operation handler 才使用异步。
+4. Renderer 只使用窄口径 operation，所有输入在 mainEntry 再校验。
+5. 窗口保持 `contextIsolation: true`、`sandbox: true`、`nodeIntegration: false`、`webSecurity: true`。
+6. IPC、protocol、快捷键、菜单和文件路径使用插件命名空间并检测冲突。
+7. `deactivate` 关闭窗口、Session 监听、IPC、protocol、快捷键、定时器、数据库和子进程。
+8. 没有同步长任务、无限载荷、任意命令/SQL/路径透传或日志敏感信息。
+9. 运行 `npm test`、插件构建、正式 Nexus 集成和 Windows 7 真机验收。

package/dev-host/main.js

@@ -191,13 +191,13 @@ function activatePluginMainEntry() {
         throw new Error("Plugin activate export must be a function.");
       }
       if (isAsyncFunction(activate)) {
-        throw new Error("Plugin activate must complete synchronously in Framework API 3.0.0.");
+        throw new Error("Plugin activate must complete synchronously in Framework API 3.1.0.");
       }
       activationStarted = true;
       const result = activate(createActivationContext());
       if (isPromiseLike(result)) {
         observeRejectedLifecyclePromise(result, "activate");
-        throw new Error("Plugin activate must complete synchronously in Framework API 3.0.0.");
+        throw new Error("Plugin activate must complete synchronously in Framework API 3.1.0.");
       }
     }
     pluginActivated = true;
@@ -265,13 +265,13 @@ function deactivatePluginMainEntry(reason) {
       return;
     }
     if (typeof deactivate !== "function" || isAsyncFunction(deactivate)) {
-      process.stderr.write("[nexus-plugin-dev] plugin deactivate must complete synchronously in Framework API 3.0.0.\n");
+      process.stderr.write("[nexus-plugin-dev] plugin deactivate must complete synchronously in Framework API 3.1.0.\n");
       return;
     }
     const result = deactivate(reason);
     if (isPromiseLike(result)) {
       observeRejectedLifecyclePromise(result, "deactivate");
-      process.stderr.write("[nexus-plugin-dev] plugin deactivate must complete synchronously in Framework API 3.0.0.\n");
+      process.stderr.write("[nexus-plugin-dev] plugin deactivate must complete synchronously in Framework API 3.1.0.\n");
     }
   } catch (error) {
     process.stderr.write("[nexus-plugin-dev] plugin deactivation failed: " + errorMessage(error) + "\n");
@@ -440,7 +440,10 @@ async function verifyRendererContextSmoke() {
   if (!frame) {
     throw new Error("Plugin renderer frame was not found.");
   }
-  if (configuration.manifest.hostApiVersion !== sdk.PLUGIN_FRAMEWORK_VERSION
+  if (!sdk.isPluginFrameworkVersionCompatible(
+    configuration.manifest.hostApiVersion,
+    sdk.PLUGIN_FRAMEWORK_VERSION
+  )
     || (configuration.manifest.mainEntry && !pluginActivated)
     || configuration.manifest.minHostVersion === undefined) {
     throw new Error("Development Host API version contract is inconsistent.");

package/dist/.generated/plugin-framework-version.d.ts

@@ -1,4 +1,4 @@
-export declare const PLUGIN_FRAMEWORK_VERSION = "3.0.0";
+export declare const PLUGIN_FRAMEWORK_VERSION = "3.1.0";
 export declare const PLUGIN_MANIFEST_SCHEMA_VERSION = 1;
 export declare const PLUGIN_COMPATIBLE_VERSION_PATTERN = "^(0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*))?(\\.(0|[1-9][0-9]*))?$";
 export interface ParsedPluginVersion {

package/dist/.generated/plugin-framework-version.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isPluginFrameworkVersionCompatible = exports.comparePluginVersions = exports.parsePluginCompatibleVersion = exports.PLUGIN_COMPATIBLE_VERSION_PATTERN = exports.PLUGIN_MANIFEST_SCHEMA_VERSION = exports.PLUGIN_FRAMEWORK_VERSION = void 0;
-exports.PLUGIN_FRAMEWORK_VERSION = "3.0.0";
+exports.PLUGIN_FRAMEWORK_VERSION = "3.1.0";
 exports.PLUGIN_MANIFEST_SCHEMA_VERSION = 1;
 exports.PLUGIN_COMPATIBLE_VERSION_PATTERN = "^(0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*))?(\\.(0|[1-9][0-9]*))?$";
 function parsePluginCompatibleVersion(value) {

package/dist/.generated/plugin-manifest.schema.json

@@ -73,7 +73,8 @@
                 "component": { "type": "string", "minLength": 1 },
                 "pageRoute": { "type": "string", "minLength": 1 },
                 "isFullBleed": { "type": "boolean" },
-                "showBusinessLogToggle": { "type": "boolean" }
+                "showBusinessLogToggle": { "type": "boolean" },
+                "showHostStatusBar": { "type": "boolean" }
             }
         },
         "tool": {

package/dist/src/cli/run.js

@@ -30,7 +30,7 @@ const scaffold_1 = require("../scaffold");
 const dev_1 = require("../dev");
 const web_dev_1 = require("../web-dev");
 const nexus_dev_1 = require("../nexus-dev");
-const nodeEngine = ">=16.20.0 <17";
+const upgrade_1 = require("../upgrade");
 function runCli(args, io) {
     const command = args[0];
     if (command === "--help" || command === "-h") {
@@ -38,14 +38,21 @@ function runCli(args, io) {
         return 0;
     }
     if (command === "info") {
+        if (args.length === 2 && args[1] === "--json") {
+            io.stdout(JSON.stringify((0, index_1.getPluginSdkInfo)(), null, 2));
+            return 0;
+        }
         if (args.length !== 1) {
-            return usageError(io, "info does not accept arguments.");
+            return usageError(io, "info only accepts --json.");
         }
         io.stdout([
             "SDK version: " + index_1.PLUGIN_SDK_VERSION,
             "Plugin Framework API: " + index_1.PLUGIN_FRAMEWORK_VERSION,
             "Manifest schema: " + index_1.PLUGIN_MANIFEST_SCHEMA_VERSION,
-            "Node engine: " + nodeEngine
+            "Node engine: " + index_1.PLUGIN_SDK_NODE_ENGINE,
+            "npm engine: " + index_1.PLUGIN_SDK_NPM_ENGINE,
+            "Electron: " + index_1.PLUGIN_SDK_ELECTRON_VERSION,
+            "TypeScript: " + index_1.PLUGIN_SDK_TYPESCRIPT_VERSION
         ].join("\n"));
         return 0;
     }
@@ -65,6 +72,9 @@ function runCli(args, io) {
     if (command === "create") {
         return runCreate(args.slice(1), io);
     }
+    if (command === "upgrade") {
+        return runUpgrade(args.slice(1), io);
+    }
     if (command === "dev") {
         return runDev(args.slice(1), io);
     }
@@ -80,10 +90,12 @@ exports.runCli = runCli;
 function usage() {
     return [
         "Usage:",
-        "  nexus-plugin info",
+        "  nexus-plugin info [--json]",
         "  nexus-plugin validate <plugin-package-directory>",
         "  nexus-plugin create <plugin-id> [--template minimal|sqlite] [--output <parent-directory>]",
         "    [--display-name <name>] [--sdk-source <version-or-local-tgz>] [--install]",
+        "  nexus-plugin upgrade [plugin-project-directory] [--check] [--sdk-source <version-or-local-tgz>]",
+        "    [--allow-major] [--skip-project-checks] [--json]",
         "  nexus-plugin dev [plugin-project-directory] [--no-build] [--inspect[=<port>] | --inspect-brk[=<port>]]",
         "    [--host-version <X.Y.Z>] [--language <culture>] [--theme system|light|dark] [--surface business|tool|settings]",
         "    [--contribution-id <id>] [--no-devtools]",
@@ -97,6 +109,69 @@ function usage() {
     ].join("\n");
 }
 exports.usage = usage;
+function runUpgrade(args, io) {
+    if (args.length === 1 && (args[0] === "--help" || args[0] === "-h")) {
+        io.stdout(usage());
+        return 0;
+    }
+    let projectDirectory = io.cwd();
+    let index = 0;
+    if (args[0] && !args[0].startsWith("--")) {
+        projectDirectory = path.resolve(io.cwd(), args[0]);
+        index = 1;
+    }
+    let sdkSource;
+    let checkOnly = false;
+    let allowMajor = false;
+    let skipProjectChecks = false;
+    let json = false;
+    const seen = new Set();
+    for (; index < args.length; index += 1) {
+        const option = args[index];
+        if (["--check", "--allow-major", "--skip-project-checks", "--json"].includes(option)) {
+            if (seen.has(option)) {
+                return usageError(io, "Duplicate option: " + option);
+            }
+            seen.add(option);
+            if (option === "--check") {
+                checkOnly = true;
+            }
+            else if (option === "--allow-major") {
+                allowMajor = true;
+            }
+            else if (option === "--skip-project-checks") {
+                skipProjectChecks = true;
+            }
+            else {
+                json = true;
+            }
+            continue;
+        }
+        if (option !== "--sdk-source") {
+            return usageError(io, "Unknown upgrade option: " + option);
+        }
+        if (seen.has(option)) {
+            return usageError(io, "Duplicate option: " + option);
+        }
+        seen.add(option);
+        const value = args[index + 1];
+        if (value === undefined || value.startsWith("--")) {
+            return usageError(io, option + " requires a value.");
+        }
+        sdkSource = value;
+        index += 1;
+    }
+    const result = (0, upgrade_1.runPluginSdkUpgrade)({
+        projectDirectory,
+        workingDirectory: io.cwd(),
+        sdkSource,
+        checkOnly,
+        allowMajor,
+        skipProjectChecks
+    });
+    io.stdout(json ? JSON.stringify(result, null, 2) : (0, upgrade_1.formatPluginSdkUpgradeResult)(result));
+    return result.status === "blocked" || result.status === "rolled-back" ? 1 : 0;
+}
 function runNexusDev(args, io) {
     if (args.length === 1 && (args[0] === "--help" || args[0] === "-h")) {
         io.stdout(usage());

package/dist/src/cli/update-notice.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.showSdkUpdateNotice = void 0;
 function showSdkUpdateNotice(args, stdout, updateCheck, currentVersion) {
-    if (args.includes("--help") || args.includes("-h") || updateCheck.isDisabled(process.env)) {
+    if (args.includes("--help") || args.includes("-h") || args.includes("--json") || updateCheck.isDisabled(process.env)) {
         return;
     }
     const cached = updateCheck.readCachedSdkUpdate({ currentVersion });

package/dist/src/index.d.ts

@@ -1,7 +1,7 @@
 import pluginManifestSchema from "../.generated/plugin-manifest.schema.json";
-export declare const PLUGIN_SDK_VERSION = "3.0.2";
 export { pluginManifestSchema };
 export * from "../.generated/plugin-framework-version";
+export * from "./sdk-info";
 export * from "./types";
 export * from "./electron-namespaces";
 export * from "./browser/frame-client";

package/dist/src/index.js

@@ -17,11 +17,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pluginManifestSchema = exports.PLUGIN_SDK_VERSION = void 0;
+exports.pluginManifestSchema = void 0;
 const plugin_manifest_schema_json_1 = __importDefault(require("../.generated/plugin-manifest.schema.json"));
 exports.pluginManifestSchema = plugin_manifest_schema_json_1.default;
-exports.PLUGIN_SDK_VERSION = "3.0.2";
 __exportStar(require("../.generated/plugin-framework-version"), exports);
+__exportStar(require("./sdk-info"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./electron-namespaces"), exports);
 __exportStar(require("./browser/frame-client"), exports);

package/dist/src/scaffold.js

@@ -29,6 +29,7 @@ const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const url_1 = require("url");
 const index_1 = require("./index");
+const sdk_info_1 = require("./sdk-info");
 class PluginScaffoldError extends Error {
     constructor(message, exitCode) {
         super(message);
@@ -209,9 +210,9 @@ function createPackageJson(options, sdkSource) {
     };
     const devDependencies = {
         [sdkPackageName]: sdkSource,
-        "@types/node": "16.18.126",
-        electron: "22.3.27",
-        typescript: "4.9.4"
+        "@types/node": sdk_info_1.PLUGIN_SDK_TYPES_NODE_VERSION,
+        electron: sdk_info_1.PLUGIN_SDK_ELECTRON_VERSION,
+        typescript: sdk_info_1.PLUGIN_SDK_TYPESCRIPT_VERSION
     };
     const packageJson = {
         name: options.pluginId,
@@ -222,12 +223,12 @@ function createPackageJson(options, sdkSource) {
     };
     if (options.template === "sqlite") {
         scripts.build = "npm run rebuild:native && node scripts/build.js && npm run validate";
-        scripts["rebuild:native"] = "electron-rebuild -v 22.3.27 -m . -w better-sqlite3";
+        scripts["rebuild:native"] = "electron-rebuild -v " + sdk_info_1.PLUGIN_SDK_ELECTRON_VERSION + " -m . -w better-sqlite3";
         packageJson.dependencies = { "better-sqlite3": "8.7.0" };
         devDependencies["@electron/rebuild"] = "3.7.2";
     }
     packageJson.devDependencies = devDependencies;
-    packageJson.engines = { node: ">=16.20.0 <17" };
+    packageJson.engines = { node: sdk_info_1.PLUGIN_SDK_NODE_ENGINE };
     return packageJson;
 }
 function createManifest(options) {

package/dist/src/sdk-info.d.ts

@@ -0,0 +1,17 @@
+export declare const PLUGIN_SDK_VERSION = "3.1.1";
+export declare const PLUGIN_SDK_NODE_ENGINE = ">=16.20.0 <17";
+export declare const PLUGIN_SDK_NPM_ENGINE = ">=6.13.4";
+export declare const PLUGIN_SDK_ELECTRON_VERSION = "22.3.27";
+export declare const PLUGIN_SDK_TYPESCRIPT_VERSION = "4.9.4";
+export declare const PLUGIN_SDK_TYPES_NODE_VERSION = "16.18.126";
+export interface PluginSdkInfo {
+    sdkVersion: string;
+    frameworkApiVersion: string;
+    manifestSchemaVersion: number;
+    nodeEngine: string;
+    npmEngine: string;
+    electronVersion: string;
+    typescriptVersion: string;
+    typesNodeVersion: string;
+}
+export declare function getPluginSdkInfo(): PluginSdkInfo;

package/dist/src/sdk-info.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPluginSdkInfo = exports.PLUGIN_SDK_TYPES_NODE_VERSION = exports.PLUGIN_SDK_TYPESCRIPT_VERSION = exports.PLUGIN_SDK_ELECTRON_VERSION = exports.PLUGIN_SDK_NPM_ENGINE = exports.PLUGIN_SDK_NODE_ENGINE = exports.PLUGIN_SDK_VERSION = void 0;
+const plugin_framework_version_1 = require("../.generated/plugin-framework-version");
+exports.PLUGIN_SDK_VERSION = "3.1.1";
+exports.PLUGIN_SDK_NODE_ENGINE = ">=16.20.0 <17";
+exports.PLUGIN_SDK_NPM_ENGINE = ">=6.13.4";
+exports.PLUGIN_SDK_ELECTRON_VERSION = "22.3.27";
+exports.PLUGIN_SDK_TYPESCRIPT_VERSION = "4.9.4";
+exports.PLUGIN_SDK_TYPES_NODE_VERSION = "16.18.126";
+function getPluginSdkInfo() {
+    return {
+        sdkVersion: exports.PLUGIN_SDK_VERSION,
+        frameworkApiVersion: plugin_framework_version_1.PLUGIN_FRAMEWORK_VERSION,
+        manifestSchemaVersion: plugin_framework_version_1.PLUGIN_MANIFEST_SCHEMA_VERSION,
+        nodeEngine: exports.PLUGIN_SDK_NODE_ENGINE,
+        npmEngine: exports.PLUGIN_SDK_NPM_ENGINE,
+        electronVersion: exports.PLUGIN_SDK_ELECTRON_VERSION,
+        typescriptVersion: exports.PLUGIN_SDK_TYPESCRIPT_VERSION,
+        typesNodeVersion: exports.PLUGIN_SDK_TYPES_NODE_VERSION
+    };
+}
+exports.getPluginSdkInfo = getPluginSdkInfo;

package/dist/src/types.d.ts

@@ -30,6 +30,7 @@ export interface BusinessDescriptor {
     pageRoute?: string;
     isFullBleed?: boolean;
     showBusinessLogToggle?: boolean;
+    showHostStatusBar?: boolean;
 }
 export interface ToolDescriptor {
     toolId: string;

package/dist/src/upgrade.d.ts

@@ -0,0 +1,44 @@
+export type PluginSdkUpgradeStatus = "up-to-date" | "upgrade-available" | "upgraded" | "rolled-back" | "blocked";
+export type PluginSdkUpgradeCheckStatus = "passed" | "warning" | "skipped" | "failed";
+export interface PluginSdkUpgradeCheck {
+    name: string;
+    status: PluginSdkUpgradeCheckStatus;
+    detail: string;
+}
+export interface PluginSdkUpgradeRollback {
+    attempted: boolean;
+    succeeded: boolean;
+    detail: string;
+}
+export interface PluginSdkUpgradeResult {
+    status: PluginSdkUpgradeStatus;
+    projectDirectory: string;
+    currentVersion: string | null;
+    targetVersion: string;
+    source: string;
+    dependencySection: "dependencies" | "devDependencies" | null;
+    changedFiles: string[];
+    checks: PluginSdkUpgradeCheck[];
+    rollback: PluginSdkUpgradeRollback | null;
+}
+export interface PluginSdkUpgradeOptions {
+    projectDirectory: string;
+    workingDirectory: string;
+    sdkSource?: string;
+    checkOnly: boolean;
+    allowMajor: boolean;
+    skipProjectChecks: boolean;
+}
+export interface PluginSdkUpgradeCommandResult {
+    status: number | null;
+    stdout: string;
+    stderr: string;
+    error?: Error;
+}
+export interface PluginSdkUpgradeRuntime {
+    nodeVersion: string;
+    runNpm(args: string[], cwd: string): PluginSdkUpgradeCommandResult;
+    runNode(args: string[], cwd: string): PluginSdkUpgradeCommandResult;
+}
+export declare function runPluginSdkUpgrade(options: PluginSdkUpgradeOptions, runtime?: PluginSdkUpgradeRuntime): PluginSdkUpgradeResult;
+export declare function formatPluginSdkUpgradeResult(result: PluginSdkUpgradeResult): string;