@dimina-kit/devtools 0.3.2-dev.20260524104239 → 0.3.2-dev.20260601115343

package/README.md

@@ -2,7 +2,7 @@
 
 基于 Electron 的小程序开发者工具。提供模拟器、Chrome DevTools 面板、WXML/AppData/Storage 面板、编译配置等功能。
 
-下游 host 通过 `createWorkbenchApp()` 集成并定制 devtools。扩展模型设计见 [`docs/extension-model.md`](docs/extension-model.md)。
+下游 host 通过 [`@dimina-kit/workbench`](../workbench) 的 `workbench(config)` fluent API 集成并定制 devtools。扩展模型设计见 [`docs/workbench-model.md`](docs/workbench-model.md)。
 
 ---
 
@@ -53,10 +53,14 @@ createWorkbenchApp({
     instance.registerSimulatorApi('login', (params) => myLogin(params))
 
     // 工具栏：整表替换，随 host 状态（如登录态）重算时再 set 一次
-    const refreshToolbar = () => instance.toolbar.set([
-      { id: 'deploy', label: '发布', handler: () => deploy() },
-      { id: 'preview', label: '预览', handler: () => preview() },
-    ])
+    const refreshToolbar = () => {
+      const currentUser = getCurrentUser()
+      instance.toolbar.set([
+        { id: 'account', label: '当前用户', kind: 'avatar', placement: 'leading', displayInitial: currentUser?.name, avatarUrl: currentUser?.avatar, handler: () => showAccount() },
+        { id: 'preview', label: '预览', placement: 'primary', handler: () => preview() },
+        { id: 'deploy', label: '发布', placement: 'trailing', handler: () => deploy() },
+      ])
+    }
     refreshToolbar()
 
     // 自定义 IPC：经 gated 的 IpcRegistry，不再裸 ipcMain.handle
@@ -66,6 +70,12 @@ createWorkbenchApp({
     // const win = createDialogWindow(/* ... */)
     // instance.registerTrustedWindow(win)
   },
+  onBeforeOpenProject: async ({ projectPath, instance }) => {
+    const ok = await canOpenProject(projectPath)
+    return ok
+      ? { allow: true }
+      : { allow: false, reason: '当前账号没有项目权限' }
+  },
   onBeforeClose: ({ context }) => {
     // 窗口关闭前的自定义清理；session 关闭和 view 销毁由框架自动处理
   },
@@ -203,8 +213,9 @@ src/
 | `rendererDir`   | `string`                                    | 内置        | 自定义 renderer HTML 目录                         |
 | `icon`          | `string`                                    | —           | 窗口/任务栏图标路径（macOS 使用 app bundle 图标） |
 | `menuBuilder`   | `(mainWindow, menuContext: MenuContext) => void` | 内置菜单 | 自定义菜单构建器；`menuContext` 为收窄后的 `MenuContext`，不含 `registry`/`senderPolicy` 等内部管线 |
-| `onSetup`       | `(instance) => void`                        | —           | 窗口和 context 创建后的回调，用于注册 Contribution（见下文）|
-| `onBeforeClose` | `(instance) => void`                        | —           | 窗口关闭前的回调，session 关闭由框架自动处理      |
+| `onSetup`       | `(instance) => void \| Promise<void>`       | —           | 窗口和 context 创建后的回调，用于注册 Contribution（见下文）|
+| `onBeforeOpenProject` | `({ projectPath, instance }) => BeforeOpenProjectResult \| Promise<BeforeOpenProjectResult>` | — | 项目目录校验通过后、关闭当前 session 和编译新项目之前的宿主准入钩子 |
+| `onBeforeClose` | `(instance) => void \| Promise<void>`       | —           | 窗口关闭前的回调，session 关闭由框架自动处理      |
 | `window`        | `WorkbenchWindowConfig`                     | —           | 窗口尺寸覆盖                                      |
 | `updateChecker` | `UpdateChecker`                             | —           | 自定义更新检查器；提供后启用"检查更新"功能        |
 | `updateOptions` | `{ checkInterval?, initialDelay?, getCurrentVersion? }` | —  | 仅当 `updateChecker` 提供时生效，默认 1h / 5s     |
@@ -220,6 +231,8 @@ src/
 | `instance.ipc` | `IpcRegistry` 实例，`instance.ipc.handle(channel, fn)` 注册自定义 IPC；已绑定 `senderPolicy` 网关 |
 | `instance.registerTrustedWindow(win)` | 把 host 自有弹窗 `BrowserWindow` 加入受信 sender 集，否则其发起的 `instance.ipc` 调用会被网关拒绝。窗口关闭即移除 |
 
+`onSetup` 可以返回 Promise；`createWorkbenchApp().start()` 会等待 `onSetup` 解析完成后才继续后续启动流程，因此宿主在 `onSetup` 内注册的 simulator API 会早于 simulator `<webview>` 首次枚举自定义 API。
+
 ### 内置面板 ID
 
 `'wxml'` \| `'console'` \| `'appdata'` \| `'storage'`

package/dist/main/api.d.ts

@@ -15,5 +15,5 @@ export { IpcRegistry } from './utils/ipc-registry.js';
 export type { SenderPolicy } from './utils/ipc-registry.js';
 export { UpdateManager, createGitHubReleaseChecker } from './services/update/index.js';
 export type { UpdateManagerOptions, GitHubReleaseCheckerOptions, PickAssetContext, VersionScheme, } from './services/update/index.js';
-export type { WorkbenchConfig, WorkbenchAppConfig, CompilationAdapter, ProjectSession, ToolbarAction, BuiltinPanelId, BuiltinModuleId, UpdateChecker, UpdateInfo, } from '../shared/types.js';
+export type { BeforeOpenProjectHook, BeforeOpenProjectResult, WorkbenchConfig, WorkbenchAppConfig, CompilationAdapter, ProjectSession, ToolbarAction, ToolbarActionInput, ToolbarActionKind, ToolbarActionPlacement, BuiltinPanelId, BuiltinModuleId, UpdateChecker, UpdateInfo, } from '../shared/types.js';
 //# sourceMappingURL=api.d.ts.map

package/dist/main/app/app.js

@@ -1,5 +1,6 @@
-import { setupCdpPort } from './bootstrap.js';
-import { app, BrowserWindow, nativeImage } from 'electron';
+import { setupCdpPort, registerDifileScheme } from './bootstrap.js';
+import { registerProjectFsIpc } from '../ipc/project-fs.js';
+import { app, BrowserWindow, nativeImage, session } from 'electron';
 import fs from 'fs';
 import path from 'path';
 import { rendererDir as defaultRendererDir, defaultPreloadPath } from '../utils/paths.js';
@@ -13,6 +14,7 @@ import { registerAppIpc, popoverModule, projectsModule, sessionModule, settingsM
 import { startAutomationServer } from '../services/automation/index.js';
 import { startMcpServer } from '../services/mcp/index.js';
 import { setupSimulatorStorage } from '../services/simulator-storage/index.js';
+import { setupSimulatorTempFiles } from '../services/simulator-temp-files/index.js';
 import { UpdateManager } from '../services/update/index.js';
 import { toDisposable } from '../utils/disposable.js';
 import { IpcRegistry } from '../utils/ipc-registry.js';
@@ -258,7 +260,21 @@ function enableDevRendererAutoReload(rendererDir) {
 export function createWorkbenchApp(config = {}) {
     let setupPromise = null;
     let appEventsRegistered = false;
+    // Lock the visible app name BEFORE app.whenReady so the dock label,
+    // ⌘-Tab card and macOS app-menu first item all read "Dimina DevTools"
+    // in both dev (unpackaged Electron) and packaged builds. `app.setName`
+    // overrides the unpackaged process name ("Electron") and is harmless
+    // when the packaged Info.plist already says the same thing.
+    // Host integrators that brand the app differently can still override
+    // `config.appName`; we keep our default consistent with `electron-builder.yml#productName`.
+    try {
+        app.setName(config.appName ?? 'Dimina DevTools');
+    }
+    catch { /* electron stub in tests */ }
     setupCdpPort();
+    // Privileged scheme registration must run before `app.whenReady` —
+    // registering it later throws.
+    registerDifileScheme();
     async function setup() {
         if (setupPromise)
             return setupPromise;
@@ -268,11 +284,20 @@ export function createWorkbenchApp(config = {}) {
             const mainWindow = createConfiguredMainWindow(config, rendererDir);
             const context = createContext(config, mainWindow, rendererDir);
             context.registry.add(registerAppIpc(context));
+            // Sandboxed project file-system IPC for the in-renderer Monaco editor.
+            context.registry.add(registerProjectFsIpc(context));
             // One process-wide listener that re-syncs every window's native
             // backgroundColor on theme change — windows otherwise keep the stale
             // creation-time color (see installThemeBackgroundSync).
             context.registry.add(installThemeBackgroundSync());
             registerBuiltinModules(config, context);
+            // Wire the simulator-side difile:// protocol handler + temp-file IPC
+            // before host onSetup so any host-driven simulator boot sees the
+            // protocol live. The module installs its own narrow sender-policy
+            // (simulator-session-only) — see file header — because the default
+            // workbench policy intentionally rejects the simulator <webview>.
+            const simSession = session.fromPartition('persist:simulator');
+            context.registry.add(setupSimulatorTempFiles(simSession));
             installMenu(config, mainWindow, context);
             // Gated custom-IPC surface for the host. Bound to ctx.senderPolicy so
             // host channels go through the same gateway as built-in IPC, and
@@ -300,6 +325,9 @@ export function createWorkbenchApp(config = {}) {
                 },
                 dispose: () => disposeContext(context),
             };
+            if (config.onBeforeOpenProject) {
+                context.beforeOpenProject = (projectPath) => config.onBeforeOpenProject({ projectPath, instance });
+            }
             if (config.onSetup) {
                 await config.onSetup(instance);
             }

package/dist/main/app/bootstrap.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Register `difile://` as a privileged scheme so `simSession.protocol.handle`
+ * can serve `difile://devtools/{uuid}` URLs from the simulator webview without
+ * tripping CSP / fetch-API restrictions. Must be called before `app.whenReady`.
+ *
+ * Idempotent — subsequent calls are no-ops because Electron throws if the same
+ * scheme is registered twice.
+ */
+export declare function registerDifileScheme(): void;
 /**
  * Suppress EPIPE errors on stdout/stderr.
  * Call at the very top of your entry file, before any imports that may write.

package/dist/main/app/bootstrap.js

@@ -1,6 +1,33 @@
-import { app } from 'electron';
+import { app, protocol } from 'electron';
 import { DEFAULT_CDP_PORT } from '../../shared/constants.js';
 import { loadWorkbenchSettings } from '../services/settings/index.js';
+let difileSchemeRegistered = false;
+/**
+ * Register `difile://` as a privileged scheme so `simSession.protocol.handle`
+ * can serve `difile://devtools/{uuid}` URLs from the simulator webview without
+ * tripping CSP / fetch-API restrictions. Must be called before `app.whenReady`.
+ *
+ * Idempotent — subsequent calls are no-ops because Electron throws if the same
+ * scheme is registered twice.
+ */
+export function registerDifileScheme() {
+    if (difileSchemeRegistered)
+        return;
+    difileSchemeRegistered = true;
+    protocol.registerSchemesAsPrivileged([
+        {
+            scheme: 'difile',
+            privileges: {
+                standard: true,
+                secure: true,
+                supportFetchAPI: true,
+                stream: true,
+                bypassCSP: true,
+                corsEnabled: true,
+            },
+        },
+    ]);
+}
 /**
  * Suppress EPIPE errors on stdout/stderr.
  * Call at the very top of your entry file, before any imports that may write.