@linkdesk/plugin-sdk 0.1.80 → 0.1.82

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -18,7 +18,7 @@ npm install -D @linkdesk/plugin-sdk
18
18
  > 自动生成,**勿手改**——由 `scripts/generate-api-cheatsheet.mjs` 从 `@linkdesk/contracts` 的 `linkdesk.d.ts` 现读产出,
19
19
  > `npm run check` 机械盯漂。完整签名与逐方法说明见 `linkdesk.d.ts` 本体(IDE 里可直接跳转)。
20
20
 
21
- **16 个域接口 → 47 个命名空间 / 259 个方法**,全部经 `window.linkdesk.<命名空间>.<方法>` 调用。 (plus 1 deprecated alias/es `config`, not counted twice)
21
+ **16 个域接口 → 47 个命名空间 / 260 个方法**,全部经 `window.linkdesk.<命名空间>.<方法>` 调用。 (plus 1 deprecated alias/es `config`, not counted twice)
22
22
 
23
23
  | Namespace | Methods | Method | Notes |
24
24
  |:--|:--:|:--|:--|
@@ -61,7 +61,7 @@ npm install -D @linkdesk/plugin-sdk
61
61
  | `bridge` ⚠️ | 4 | `onRequest` `respond` `broadcast` `notifyConfigChanged` | 壳↔插件通信中继——壳 preload 独有 |
62
62
  | `pool` | 32 | `pushLayout` `onReady` `toggleDevTools` `onSidebarAction` `onTabAction` `onTabBarRects` `onDragPosition` `pushAdsorbHint` `onAdsorbIndex` `pushQuickPick` `onQuickPickAction` `pushDialog` `onDialogAction` `pushFloatingPanel` `onFloatingPanelAction` `onMemoryPressure` `createWindow` `closeWindow` `onWindowClosed` `onWindowBoundsChanged` `getLayout` `onLayout` `ready` `sidebarAction` `tabAction` `tabBarRects` `dragPosition` `onAdsorbHint` `adsorbIndex` `registerBeforeClose` `unregisterBeforeClose` `beforeClose` | 池控制——壳 preload:推送布局 + 注册池→壳动作回调 |
63
63
  | `window` | 11 | `minimize` `maximize` `unmaximize` `close` `setZoom` `toggleDevTools` `isMaximized` `onMaximizeChange` `setAlwaysOnTop` `isAlwaysOnTop` `onAlwaysOnTopChange` | 窗口控制——TitleBar 按钮映射,双端注入(11 方法同通道,共享模块 electron/window-name… |
64
- | `shell` | 6 | `showItemInFolder` `openInTerminal` `pluginLocation` `openPluginFolder` `startDrag` `relaunch`° | 壳级命令——revealInOS / openInTerminal / startDrag / relaunch,双端… |
64
+ | `shell` | 7 | `showItemInFolder` `openInTerminal` `pluginLocation` `openPluginFolder` `startDrag` `relaunch`° `openExternal` | 壳级命令——revealInOS / openInTerminal / startDrag / relaunch,双端… |
65
65
  | `hotExit` ⚠️ | 3 | `save` `load` `clear` | 热退出暂存——编辑器未保存内容落盘 |
66
66
  | `getFilePath` | 0 | (top-level function)`getFilePath: (file: File) => string;` | OS 拖入文件路径获取——双端注入 |
67
67
  | `panel` | 3 | `reveal` `revealFloating` `setFloatingBounds` | —— |
@@ -355,6 +355,7 @@ export const linkdeskMock: Record<string, unknown> = {
355
355
  openPluginFolder: async (..._args: unknown[]) => { console.info("[linkdesk-mock] shell.openPluginFolder", ..._args); },
356
356
  startDrag: (..._args: unknown[]) => { console.info("[linkdesk-mock] shell.startDrag", ..._args); },
357
357
  relaunch: async (..._args: unknown[]) => { console.info("[linkdesk-mock] shell.relaunch", ..._args); },
358
+ openExternal: async (..._args: unknown[]) => { console.info("[linkdesk-mock] shell.openExternal", ..._args); },
358
359
  },
359
360
  hotExit: {
360
361
  save: async (..._args: unknown[]) => { console.info("[linkdesk-mock] hotExit.save", ..._args); },
package/dist/index.d.ts CHANGED
@@ -1,12 +1,18 @@
1
1
  /**
2
- * @linkdesk/plugin-sdk 公共出口(barrel)。
2
+ * @linkdesk/plugin-sdk 公共出口(barrel)——**构建面**(vite.config.ts / 校验脚本用)。
3
3
  *
4
4
  * 运行面:`defineLinkdeskPluginConfig()`(构建)+ validate 家族(plugin.json / 主题数据 / 图标主题数据;
5
5
  * E6#60 起主题/图标作者也走 npm 通道——validateThemeJson / validateIconThemeJson);
6
- * 宿主命令面:`SHELL_COMMANDS` + `openWith()`(插件调用宿主命令的唯一合法写法,见 shell-commands.ts);
7
6
  * 类型面经 types.js 全量转发 @linkdesk/contracts(window.linkdesk.* 全局声明随契约进 program,E6#2b)。
8
7
  * validate 的内部 helper(collectI18nDecls/derivePluginId/SAFE_PLUGIN_ID 等)供 vite-config/packager
9
8
  * 跨模块复用,但**不进 barrel**——公共 API 面保持最小(对标 @types/vscode 只给类型+工具)。
9
+ *
10
+ * 🔴 **插件运行时代码(src/**)不许 import 本入口**——宿主命令面在子路径 `shell-commands.ts`
11
+ * (`import { SHELL_COMMANDS, openWith } from "@linkdesk/plugin-sdk/shell-commands"`)。
12
+ * 为什么:本入口 re-export `vite-config.js`,它静态 import `vite` / `@vitejs/plugin-react`——
13
+ * 插件源码一旦从本入口取值,整条构建链会被**打进插件 zip**(实测:rollup 的 node-entry 要解析
14
+ * 仅 macOS 有的 `fsevents` ⇒ Windows 上 build 直接红,且即使侥幸过了也是几 MB 的死代码)。
15
+ * 子路径只出「一个常量对象 + 一个 helper」,零重依赖。
10
16
  */
11
17
  export { defineLinkdeskPluginConfig } from "./vite-config.js";
12
18
  export type { LinkdeskPluginOptions } from "./vite-config.js";
@@ -15,6 +21,5 @@ export { validateThemeJson, validateIconThemeJson } from "./validate.js";
15
21
  export type { ValidationResult } from "./validate.js";
16
22
  export { packPluginData } from "./pack.js";
17
23
  export type { PackResult } from "./pack.js";
18
- export { SHELL_COMMANDS, openWith } from "./shell-commands.js";
19
24
  export type * from "./types.js";
20
25
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAC9D,YAAY,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACzE,YAAY,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,YAAY,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/D,mBAAmB,YAAY,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAC9D,YAAY,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACzE,YAAY,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,YAAY,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,mBAAmB,YAAY,CAAC"}
package/dist/index.js CHANGED
@@ -1,16 +1,21 @@
1
1
  /**
2
- * @linkdesk/plugin-sdk 公共出口(barrel)。
2
+ * @linkdesk/plugin-sdk 公共出口(barrel)——**构建面**(vite.config.ts / 校验脚本用)。
3
3
  *
4
4
  * 运行面:`defineLinkdeskPluginConfig()`(构建)+ validate 家族(plugin.json / 主题数据 / 图标主题数据;
5
5
  * E6#60 起主题/图标作者也走 npm 通道——validateThemeJson / validateIconThemeJson);
6
- * 宿主命令面:`SHELL_COMMANDS` + `openWith()`(插件调用宿主命令的唯一合法写法,见 shell-commands.ts);
7
6
  * 类型面经 types.js 全量转发 @linkdesk/contracts(window.linkdesk.* 全局声明随契约进 program,E6#2b)。
8
7
  * validate 的内部 helper(collectI18nDecls/derivePluginId/SAFE_PLUGIN_ID 等)供 vite-config/packager
9
8
  * 跨模块复用,但**不进 barrel**——公共 API 面保持最小(对标 @types/vscode 只给类型+工具)。
9
+ *
10
+ * 🔴 **插件运行时代码(src/**)不许 import 本入口**——宿主命令面在子路径 `shell-commands.ts`
11
+ * (`import { SHELL_COMMANDS, openWith } from "@linkdesk/plugin-sdk/shell-commands"`)。
12
+ * 为什么:本入口 re-export `vite-config.js`,它静态 import `vite` / `@vitejs/plugin-react`——
13
+ * 插件源码一旦从本入口取值,整条构建链会被**打进插件 zip**(实测:rollup 的 node-entry 要解析
14
+ * 仅 macOS 有的 `fsevents` ⇒ Windows 上 build 直接红,且即使侥幸过了也是几 MB 的死代码)。
15
+ * 子路径只出「一个常量对象 + 一个 helper」,零重依赖。
10
16
  */
11
17
  export { defineLinkdeskPluginConfig } from "./vite-config.js";
12
18
  export { validatePluginJson } from "./validate.js";
13
19
  export { validateThemeJson, validateIconThemeJson } from "./validate.js";
14
20
  export { packPluginData } from "./pack.js";
15
- export { SHELL_COMMANDS, openWith } from "./shell-commands.js";
16
21
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAEzE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3C,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAEzE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@linkdesk/plugin-sdk",
3
- "version": "0.1.80",
3
+ "version": "0.1.82",
4
4
  "description": "@linkdesk/plugin-sdk——LinkDesk 插件作者 SDK(对标 @types/vscode):window.linkdesk.* 类型 + 一键 build(.linkdesk-plugin) + dev 宿主 + plugin.json 验证 + eslint 门禁(E6#54d)。作者 npm i 后零壳源码依赖。",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -10,6 +10,10 @@
10
10
  "types": "./dist/index.d.ts",
11
11
  "default": "./dist/index.js"
12
12
  },
13
+ "./shell-commands": {
14
+ "types": "./dist/shell-commands.d.ts",
15
+ "default": "./dist/shell-commands.js"
16
+ },
13
17
  "./eslint": {
14
18
  "types": "./dist/eslint/index.d.ts",
15
19
  "default": "./dist/eslint/index.js"
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "$comment": "宿主保留面账(生成式·E6#111b/1.32 定稿,1.49 补 version)——插件不得占用这些名字。消费方有**两条腿,互不覆盖**:① **壳腿** = 壳仓 `scripts/audit-plugin-scope.mjs`(跨容器普查,读本账 + 反向核对实况)与 `src/core/registry/host-reserved.generated.ts`(壳**运行时**仲裁读的生成副本);② **SDK 腿** = `@linkdesk/plugin-sdk` 的四个 `check-*-ownership`(随包下发本账的副本 `schemas/host-reserved.json`,在**插件仓 CI** 判红)。为什么必须两条腿:壳腿看不见插件仓的源码,SDK 腿看不见壳的运行时——各自的射程都到不了对面。**改本表 = 一次公共面决策**:动手前先问「**这是公共面,还是漏网的借用?**」——公共面(多人正当读写、按约定共享)该进本账的设计里单列,借用(某插件用了宿主的名字)一律判红、不许宽恕;**新增条目要在这一段或对应家族的 why 里写明判据**,别只加一个名字。改完必须重跑生成器 `npm run audit:plugin-scope:regen`(scripts/gen-host-reserved.mjs)——账 + SDK 副本 + 运行时副本**三份同源**,手改任一份都会被判漂。**双向对账门禁在哪**:`node scripts/gen-host-reserved.mjs --check`(四向:实况→账 / 账→实况 / SDK 副本逐字节 / 运行时副本逐元素),已接在 `npm run check` 里;实况多一条报 `ledger-missing`、账多一条报 `ledger-stale`、家族整段缺失/为空另有专门的报警。`version` = 本账**形状**的修订号(见生成器 `LEDGER_VERSION` 的抬版规则),不是 settings 迁移版本。⚠️ configKeys 含**退役键**(曾被宿主使用、现已不再写入的键):退役键**不腾出保留面**——老 settings.json 里可能还留着值,插件此刻占它 = 顶掉的是宿主的历史数据(且迁移代码仍会读它)。📌 **`retired[]` = 退役登记栏**(E6#116/本账 version 2 起):**人工栏**——生成器**原样携带**(不扫描、不由实况推)。每条 = { name, kind, since, why, replacedBy, landing, approvedBy }:谁批的(必须**用户本人**签的日期)、为什么、替身是谁、还剩哪个活口。**退役 ≠ 删除**:退役名**不腾位**(同上——老值还在),所以它照旧留在本账对应家族里,只是不再是对插件许过的面。🔴 它**不是黑名单**:只供人读与作者侧提示,⛔ 不许任何门禁拿它去拦插件;「有登记即放行」的唯一出口在`scripts/check-api-surface-additive.mjs`(面被拿走 + 有登记 ⇒ 放行),本栏自身的自洽对账在 `scripts/check-retired-ledger.mjs`。⚠️ 运行时副本**不下发** `retired`(`renderRuntimeModule` 只渲染显式家族常量,运行时对它没有可执行判断);SDK 副本随本账**逐字节**含它——「要不要给作者侧提示退役名」= 格 6 的取舍点。",
3
- "version": 3,
3
+ "version": 4,
4
4
  "commandPrefixes": [
5
5
  "app.",
6
6
  "core.",
@@ -97,6 +97,12 @@
97
97
  "protocolIds": [
98
98
  "bracket"
99
99
  ],
100
+ "externalProtocols": [
101
+ "http",
102
+ "https",
103
+ "mailto",
104
+ "vscode"
105
+ ],
100
106
  "retired": [
101
107
  {
102
108
  "name": "app.themeColorMode",