translime-sdk 1.0.1

package/README.md

@@ -0,0 +1,153 @@
+# Translime SDK
+
+这是 Translime 插件开发的官方 SDK。它提供了完善的类型提示 (.d.ts) 并简化了对主程序 API 的访问。
+
+## 安装
+
+```bash
+pnpm add translime-sdk
+```
+
+## 使用 Vite 插件
+
+在插件的 `vite.config.js` 中使用内置插件，可以自动处理 `electron` 等依赖的外部化：
+
+```javascript
+import { defineConfig } from 'vite';
+import { translimeSdk } from 'translime-sdk/vite';
+
+export default defineConfig({
+  plugins: [
+    translimeSdk(),
+    // ... 其他插件
+  ]
+});
+```
+
+## 代码示例
+
+### 主进程逻辑 (src/index.js)
+
+```javascript
+import { usePluginConfig } from 'translime-sdk';
+
+const config = usePluginConfig('my-plugin-id');
+const myValue = config.get('settingsKey', 'default');
+```
+
+### 渲染进程 UI (src/ui/ui.vue)
+
+```javascript
+import { useIpc, useVuetifyComponents } from 'translime-sdk';
+
+const ipc = useIpc();
+const { VBtn, VCard } = useVuetifyComponents();
+```
+
+## 核心 API
+
+### 主进程 (Main Process)
+
+- `getMainStore()`: 获取主程序的全局 Store。
+- `usePluginConfig(pluginId)`: 获取针对特定插件的配置工具。
+
+### 渲染进程 (Renderer Process)
+
+- `useIpc()`: 获取 IPC 工具。
+- `useVuetifyComponents()`: 获取所有 Vuetify 组件。
+- `useVuetifyDirectives()`: 获取所有 Vuetify 指令。
+- `useDialog()`: 获取 Electron 对话框 API。
+- `useShell()`: 获取 Shell API。
+- `getPluginSetting(...args)`: 获取插件设置。
+- `setPluginSetting(...args)`: 设置插件设置。
+- `useWindowControl()`: 获取窗口控制工具。
+- `useClipboard()`: 获取剪贴板工具。
+- `openLink(...args)`: 在浏览器中打开链接。
+- `isPreviewMode()`: 检查当前是否为 Preview 模式。
+
+### 通用 (Common)
+
+- `useLogger()`: 获取标准日志工具，支持 `log`, `info`, `warn`, `error`, `debug`。在渲染进程中会自动通过 IPC 发送到主进程记录，在主进程中则直接写入日志文件。
+
+---
+
+## Preview 模式
+
+Preview 模式允许你在普通浏览器中预览和调试插件 UI，无需依赖 Electron 环境。这使得开发过程中能够享受 Vite 的 HMR (热模块替换) 便利性。
+
+### 特性
+
+- ✅ **零配置**：插件代码无需任何修改，SDK 会自动检测 preview 模式并注入 mock 实现
+- ✅ **完整的 Vuetify 支持**：Preview Shell 自动提供 Vuetify 组件和主题
+- ✅ **API Mock**：所有 Electron 相关的 API (IPC, Dialog, Shell 等) 都有对应的 mock 实现
+- ✅ **设置持久化**：插件设置使用 localStorage 存储，刷新页面后仍然保留
+- ✅ **主题切换**：Preview 界面提供浅色/深色主题切换
+
+### 快速开始
+
+1. **在插件的 `package.json` 中添加 preview 脚本**：
+
+```json
+{
+  "scripts": {
+    "preview:ui": "vite -c ui.vite.config.mjs --mode preview"
+  }
+}
+```
+
+2. **运行 preview 模式**：
+
+```bash
+pnpm preview:ui
+```
+
+3. **访问预览页面**：在浏览器中打开 Vite 提供的地址 (通常是 `http://localhost:5173`)
+
+### Vite 插件配置
+
+`translimeSdk()` 插件会自动处理 preview 模式的配置。你可以通过 `previewComponent` 选项指定要预览的组件路径：
+
+```javascript
+import { defineConfig } from 'vite';
+import { translimeSdk } from 'translime-sdk/vite';
+
+export default defineConfig(({ mode }) => ({
+  plugins: [
+    translimeSdk({
+      // 可选：指定要预览的组件路径，默认使用 lib.entry
+      previewComponent: './src/ui/ui.vue'
+    }),
+  ],
+  // ... 其他配置
+}));
+```
+
+### Mock API 行为
+
+在 Preview 模式下，SDK 提供的 API 会有以下行为：
+
+| API | Mock 行为 |
+|-----|----------|
+| `useIpc().invoke()` | 打印调用日志，返回 `null` |
+| `useDialog().showOpenDialog()` | 使用浏览器原生文件选择器 |
+| `getPluginSetting()` | 从 localStorage 读取 |
+| `setPluginSetting()` | 保存到 localStorage |
+| `useClipboard()` | 使用浏览器 Clipboard API |
+| `openLink()` | 使用 `window.open()` 打开新窗口 |
+
+### 条件代码
+
+如果需要在 preview 模式下执行不同的逻辑，可以使用 `isPreviewMode()` 函数：
+
+```javascript
+import { isPreviewMode, useIpc } from 'translime-sdk';
+
+if (isPreviewMode()) {
+  console.log('当前运行在 Preview 模式');
+  // 执行替代逻辑
+} else {
+  const ipc = useIpc();
+  await ipc.invoke('some-api@plugin-id');
+}
+```
+

package/dist/index.cjs

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const previewMock = require("./preview-mock.cjs");
+if (typeof window !== "undefined" && previewMock.isPreviewMode()) {
+  previewMock.initPreviewMock();
+}
+function isPreviewMode() {
+  return previewMock.isPreviewMode();
+}
+function getMainStore() {
+  if (typeof global !== "undefined" && global.mainStore) {
+    return global.mainStore;
+  }
+  return null;
+}
+function usePluginConfig(pluginId) {
+  const store = getMainStore();
+  return {
+    get(key, defaultValue) {
+      return store?.config?.get(`plugin.${pluginId}.settings.${key}`, defaultValue);
+    },
+    set(key, value) {
+      store?.config?.set(`plugin.${pluginId}.settings.${key}`, value);
+    }
+  };
+}
+function useIpc() {
+  if (typeof window !== "undefined" && window.electron?.useIpc) {
+    return window.electron.useIpc();
+  }
+  return null;
+}
+function useVuetify() {
+  if (typeof window !== "undefined" && window.vuetify$) {
+    return window.vuetify$;
+  }
+  return {};
+}
+function useVuetifyComponents() {
+  return useVuetify().components || {};
+}
+function useVuetifyDirectives() {
+  return useVuetify().directives || {};
+}
+function useDialog() {
+  if (typeof window !== "undefined" && window.electron?.dialog) {
+    return window.electron.dialog;
+  }
+  return null;
+}
+function useShell() {
+  if (typeof window !== "undefined" && window.electron?.shell) {
+    return window.electron.shell;
+  }
+  return null;
+}
+async function getPluginSetting(...args) {
+  if (typeof window !== "undefined" && window.ts?.getPluginSetting) {
+    return window.ts.getPluginSetting(...args);
+  }
+  return null;
+}
+async function setPluginSetting(...args) {
+  if (typeof window !== "undefined" && window.ts?.setPluginSetting) {
+    return window.ts.setPluginSetting(...args);
+  }
+  return null;
+}
+function useWindowControl() {
+  if (typeof window !== "undefined" && window.ts?.windowControl) {
+    return window.ts.windowControl;
+  }
+  return null;
+}
+function useClipboard() {
+  if (typeof window !== "undefined" && window.electron?.clipboard) {
+    return window.electron.clipboard;
+  }
+  return null;
+}
+async function openLink(...args) {
+  if (typeof window !== "undefined" && window.electron?.openLink) {
+    return window.electron.openLink(...args);
+  }
+  return null;
+}
+function useLogger() {
+  if (typeof global !== "undefined" && global.mainStore) {
+    return global.mainStore?.logger || console;
+  }
+  if (typeof window !== "undefined") {
+    return window.ts?.logger || console;
+  }
+  return console;
+}
+exports.getMainStore = getMainStore;
+exports.getPluginSetting = getPluginSetting;
+exports.isPreviewMode = isPreviewMode;
+exports.openLink = openLink;
+exports.setPluginSetting = setPluginSetting;
+exports.useClipboard = useClipboard;
+exports.useDialog = useDialog;
+exports.useIpc = useIpc;
+exports.useLogger = useLogger;
+exports.usePluginConfig = usePluginConfig;
+exports.useShell = useShell;
+exports.useVuetify = useVuetify;
+exports.useVuetifyComponents = useVuetifyComponents;
+exports.useVuetifyDirectives = useVuetifyDirectives;
+exports.useWindowControl = useWindowControl;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/index.js"],"sourcesContent":["/**\n * Translime SDK\n * 提供插件开发所需的标准 API 和类型提示。\n * 包含主进程 (Main Process) 和渲染进程 (Renderer Process) 的通用接口。\n */\n\nimport {\n  isPreviewMode as checkPreviewMode,\n  initPreviewMock,\n} from './preview-mock.js';\n\n// ----------------------------------------------------------------------\n// Initialization (Side Effect)\n// ----------------------------------------------------------------------\n\n// 在模块加载时检测并初始化 Preview Mock 环境\n// 确保在 Preview 模式下直接导入 SDK 也能获得 Mock 支持\nif (typeof window !== 'undefined' && checkPreviewMode()) {\n  initPreviewMock();\n}\n\n// ----------------------------------------------------------------------\n// Core / Store APIs (Main Process Only)\n// ----------------------------------------------------------------------\n\n/**\n * 检查当前是否为 Preview 模式\n * @returns {boolean}\n */\nexport function isPreviewMode() {\n  return checkPreviewMode();\n}\n\n/**\n * @typedef {Object} MainStore\n * @property {Object} config\n * @property {function(string, *): *} config.get\n * @property {function(string, *): void} config.set\n * @property {Object} [logger]\n */\n\n/**\n * 获取主程序 Store\n * @description 仅在 **主进程 (Main Process)** 环境可用\n * @returns {MainStore|null} 若在非主进程环境调用，返回 null\n */\nexport function getMainStore() {\n  if (typeof global !== 'undefined' && global.mainStore) {\n    return global.mainStore;\n  }\n  return null;\n}\n\n/**\n * 使用插件配置代理\n * @description 获取针对特定插件的配置读写对象\n * @param {string} pluginId 插件 ID (通常与 package.json 中的 name 一致)\n * @returns {{ get: function(string, *): *, set: function(string, *): void }}\n */\nexport function usePluginConfig(pluginId) {\n  const store = getMainStore();\n  return {\n    get(key, defaultValue) {\n      return store?.config?.get(`plugin.${pluginId}.settings.${key}`, defaultValue);\n    },\n    set(key, value) {\n      store?.config?.set(`plugin.${pluginId}.settings.${key}`, value);\n    },\n  };\n}\n\n// ----------------------------------------------------------------------\n// UI & Renderer APIs (Renderer Process Only)\n// ----------------------------------------------------------------------\n\n/**\n * 获取 IPC 通信工具\n * @description 仅在 **渲染进程 (Renderer Process)** 环境可用\n * @returns {Object|null} 包含 invoke, send, on 等方法的对象\n */\nexport function useIpc() {\n  if (typeof window !== 'undefined' && window.electron?.useIpc) {\n    return window.electron.useIpc();\n  }\n  return null;\n}\n\n/**\n * 获取 Vuetify 实例\n * @description 仅在 **渲染进程** 环境可用，用于访问 Vuetify 的全局配置\n * @returns {Object} Vuetify 实例对象\n */\nexport function useVuetify() {\n  if (typeof window !== 'undefined' && window.vuetify$) {\n    return window.vuetify$;\n  }\n  return {};\n}\n\n/**\n * 获取全局注册的 Vuetify 组件\n * @returns {Record<string, any>}\n */\nexport function useVuetifyComponents() {\n  return useVuetify().components || {};\n}\n\n/**\n * 获取全局注册的 Vuetify 指令\n * @returns {Record<string, any>}\n */\nexport function useVuetifyDirectives() {\n  return useVuetify().directives || {};\n}\n\n/**\n * 获取 Dialog API\n * @description 类似于 Electron 的 dialog 模块 (showOpenDialog, showSaveDialog 等)\n * @returns {Object|null}\n */\nexport function useDialog() {\n  if (typeof window !== 'undefined' && window.electron?.dialog) {\n    return window.electron.dialog;\n  }\n  return null;\n}\n\n/**\n * 获取 Shell API\n * @description 类似于 Electron 的 shell 模块 (openExternal, showItemInFolder 等)\n * @returns {Object|null}\n */\nexport function useShell() {\n  if (typeof window !== 'undefined' && window.electron?.shell) {\n    return window.electron.shell;\n  }\n  return null;\n}\n\n/**\n * 获取插件自身设置 (IPC 封装)\n * @description 仅在 **渲染进程** 环境可用。这是 `plugin.settings` 的前端读取接口。\n * @param {...any} args\n * @returns {Promise<any>}\n */\nexport async function getPluginSetting(...args) {\n  if (typeof window !== 'undefined' && window.ts?.getPluginSetting) {\n    return window.ts.getPluginSetting(...args);\n  }\n  return null;\n}\n\n/**\n * 更新插件自身设置 (IPC 封装)\n * @description 仅在 **渲染进程** 环境可用。\n * @param {...any} args\n * @returns {Promise<any>}\n */\nexport async function setPluginSetting(...args) {\n  if (typeof window !== 'undefined' && window.ts?.setPluginSetting) {\n    return window.ts.setPluginSetting(...args);\n  }\n  return null;\n}\n\n/**\n * 获取窗口控制工具\n * @description 包含 minimize, maximize, close 等窗口操作\n * @returns {Object|null}\n */\nexport function useWindowControl() {\n  if (typeof window !== 'undefined' && window.ts?.windowControl) {\n    return window.ts.windowControl;\n  }\n  return null;\n}\n\n// ----------------------------------------------------------------------\n// Utilities (Shared)\n// ----------------------------------------------------------------------\n\n/**\n * 获取剪贴板工具\n * @returns {Object|null}\n */\nexport function useClipboard() {\n  if (typeof window !== 'undefined' && window.electron?.clipboard) {\n    return window.electron.clipboard;\n  }\n  return null;\n}\n\n/**\n * 在默认浏览器中打开链接\n * @param {string} url 要打开的链接\n * @returns {Promise<void>}\n */\nexport async function openLink(...args) {\n  if (typeof window !== 'undefined' && window.electron?.openLink) {\n    return window.electron.openLink(...args);\n  }\n  return null;\n}\n\n/**\n * 获取日志工具\n * @description 自动适配 Node.js 环境 (Main) 或浏览器环境 (Renderer)\n * @returns {Record<'log'|'info'|'warn'|'error'|'debug', Function>} Console-like logger\n */\nexport function useLogger() {\n  if (typeof global !== 'undefined' && global.mainStore) {\n    return global.mainStore?.logger || console;\n  }\n  if (typeof window !== 'undefined') {\n    return window.ts?.logger || console;\n  }\n  return console;\n}\n\n"],"names":["checkPreviewMode","initPreviewMock"],"mappings":";;;AAiBA,IAAI,OAAO,WAAW,eAAeA,YAAAA,iBAAoB;AACvDC,8BAAe;AACjB;AAUO,SAAS,gBAAgB;AAC9B,SAAOD,0BAAgB;AACzB;AAeO,SAAS,eAAe;AAC7B,MAAI,OAAO,WAAW,eAAe,OAAO,WAAW;AACrD,WAAO,OAAO;AAAA,EAChB;AACA,SAAO;AACT;AAQO,SAAS,gBAAgB,UAAU;AACxC,QAAM,QAAQ,aAAY;AAC1B,SAAO;AAAA,IACL,IAAI,KAAK,cAAc;AACrB,aAAO,OAAO,QAAQ,IAAI,UAAU,QAAQ,aAAa,GAAG,IAAI,YAAY;AAAA,IAC9E;AAAA,IACA,IAAI,KAAK,OAAO;AACd,aAAO,QAAQ,IAAI,UAAU,QAAQ,aAAa,GAAG,IAAI,KAAK;AAAA,IAChE;AAAA,EACJ;AACA;AAWO,SAAS,SAAS;AACvB,MAAI,OAAO,WAAW,eAAe,OAAO,UAAU,QAAQ;AAC5D,WAAO,OAAO,SAAS,OAAM;AAAA,EAC/B;AACA,SAAO;AACT;AAOO,SAAS,aAAa;AAC3B,MAAI,OAAO,WAAW,eAAe,OAAO,UAAU;AACpD,WAAO,OAAO;AAAA,EAChB;AACA,SAAO,CAAA;AACT;AAMO,SAAS,uBAAuB;AACrC,SAAO,WAAU,EAAG,cAAc,CAAA;AACpC;AAMO,SAAS,uBAAuB;AACrC,SAAO,WAAU,EAAG,cAAc,CAAA;AACpC;AAOO,SAAS,YAAY;AAC1B,MAAI,OAAO,WAAW,eAAe,OAAO,UAAU,QAAQ;AAC5D,WAAO,OAAO,SAAS;AAAA,EACzB;AACA,SAAO;AACT;AAOO,SAAS,WAAW;AACzB,MAAI,OAAO,WAAW,eAAe,OAAO,UAAU,OAAO;AAC3D,WAAO,OAAO,SAAS;AAAA,EACzB;AACA,SAAO;AACT;AAQO,eAAe,oBAAoB,MAAM;AAC9C,MAAI,OAAO,WAAW,eAAe,OAAO,IAAI,kBAAkB;AAChE,WAAO,OAAO,GAAG,iBAAiB,GAAG,IAAI;AAAA,EAC3C;AACA,SAAO;AACT;AAQO,eAAe,oBAAoB,MAAM;AAC9C,MAAI,OAAO,WAAW,eAAe,OAAO,IAAI,kBAAkB;AAChE,WAAO,OAAO,GAAG,iBAAiB,GAAG,IAAI;AAAA,EAC3C;AACA,SAAO;AACT;AAOO,SAAS,mBAAmB;AACjC,MAAI,OAAO,WAAW,eAAe,OAAO,IAAI,eAAe;AAC7D,WAAO,OAAO,GAAG;AAAA,EACnB;AACA,SAAO;AACT;AAUO,SAAS,eAAe;AAC7B,MAAI,OAAO,WAAW,eAAe,OAAO,UAAU,WAAW;AAC/D,WAAO,OAAO,SAAS;AAAA,EACzB;AACA,SAAO;AACT;AAOO,eAAe,YAAY,MAAM;AACtC,MAAI,OAAO,WAAW,eAAe,OAAO,UAAU,UAAU;AAC9D,WAAO,OAAO,SAAS,SAAS,GAAG,IAAI;AAAA,EACzC;AACA,SAAO;AACT;AAOO,SAAS,YAAY;AAC1B,MAAI,OAAO,WAAW,eAAe,OAAO,WAAW;AACrD,WAAO,OAAO,WAAW,UAAU;AAAA,EACrC;AACA,MAAI,OAAO,WAAW,aAAa;AACjC,WAAO,OAAO,IAAI,UAAU;AAAA,EAC9B;AACA,SAAO;AACT;;;;;;;;;;;;;;;;"}

package/dist/index.d.cts

@@ -0,0 +1,93 @@
+export interface Config {
+  get(key: string, defaultValue?: any): any;
+  set(key: string, value: any): void;
+}
+
+export interface MainStore {
+  config: Config;
+}
+
+/**
+ * 检查当前是否为 Preview 模式
+ */
+export function isPreviewMode(): boolean;
+
+/**
+ * 获取主程序 Store (仅在主进程环境可用)
+ */
+export function getMainStore(): MainStore | null;
+
+/**
+ * 获取插件配置代理
+ * @param pluginId 插件 ID
+ */
+export function usePluginConfig(pluginId: string): Config;
+
+/**
+ * 获取 IPC 工具 (仅在渲染进程环境可用)
+ */
+export function useIpc(): any;
+
+/**
+ * 获取 Vuetify 实例
+ */
+export function useVuetify(): any;
+
+/**
+ * 获取所有 Vuetify 组件
+ */
+export function useVuetifyComponents(): Record<string, any>;
+export function useVuetifyDirectives(): Record<string, any>;
+
+/**
+ * 助手函数：获取 Electron 提供的对话框 API
+ */
+export function useDialog(): any;
+
+/**
+ * 获取 Shell API
+ */
+export function useShell(): any;
+
+/**
+ * 获取插件设置 (仅在渲染进程环境可用)
+ */
+export function getPluginSetting(...args: any[]): Promise<any>;
+
+/**
+ * 设置插件设置 (仅在渲染进程环境可用)
+ */
+export function setPluginSetting(...args: any[]): Promise<any>;
+
+/**
+ * 获取窗口控制工具 (仅在渲染进程环境可用)
+ */
+export function useWindowControl(): {
+  devtools(win?: any): Promise<any>;
+  maximize(win?: any): Promise<any>;
+  unmaximize(win?: any): Promise<any>;
+  minimize(win?: any): Promise<any>;
+  close(win?: any): Promise<any>;
+} | null;
+
+/**
+ * 获取剪贴板工具 (仅在渲染进程环境可用)
+ */
+export function useClipboard(): any;
+
+/**
+ * 在浏览器中打开链接 (仅在渲染进程环境可用)
+ */
+export function openLink(...args: any[]): Promise<any>;
+
+/**
+ * 获取日志工具
+ */
+export function useLogger(): {
+  log(...args: any[]): void;
+  info(...args: any[]): void;
+  warn(...args: any[]): void;
+  error(...args: any[]): void;
+  debug(...args: any[]): void;
+};
+

package/dist/index.d.ts

@@ -0,0 +1,93 @@
+export interface Config {
+  get(key: string, defaultValue?: any): any;
+  set(key: string, value: any): void;
+}
+
+export interface MainStore {
+  config: Config;
+}
+
+/**
+ * 检查当前是否为 Preview 模式
+ */
+export function isPreviewMode(): boolean;
+
+/**
+ * 获取主程序 Store (仅在主进程环境可用)
+ */
+export function getMainStore(): MainStore | null;
+
+/**
+ * 获取插件配置代理
+ * @param pluginId 插件 ID
+ */
+export function usePluginConfig(pluginId: string): Config;
+
+/**
+ * 获取 IPC 工具 (仅在渲染进程环境可用)
+ */
+export function useIpc(): any;
+
+/**
+ * 获取 Vuetify 实例
+ */
+export function useVuetify(): any;
+
+/**
+ * 获取所有 Vuetify 组件
+ */
+export function useVuetifyComponents(): Record<string, any>;
+export function useVuetifyDirectives(): Record<string, any>;
+
+/**
+ * 助手函数：获取 Electron 提供的对话框 API
+ */
+export function useDialog(): any;
+
+/**
+ * 获取 Shell API
+ */
+export function useShell(): any;
+
+/**
+ * 获取插件设置 (仅在渲染进程环境可用)
+ */
+export function getPluginSetting(...args: any[]): Promise<any>;
+
+/**
+ * 设置插件设置 (仅在渲染进程环境可用)
+ */
+export function setPluginSetting(...args: any[]): Promise<any>;
+
+/**
+ * 获取窗口控制工具 (仅在渲染进程环境可用)
+ */
+export function useWindowControl(): {
+  devtools(win?: any): Promise<any>;
+  maximize(win?: any): Promise<any>;
+  unmaximize(win?: any): Promise<any>;
+  minimize(win?: any): Promise<any>;
+  close(win?: any): Promise<any>;
+} | null;
+
+/**
+ * 获取剪贴板工具 (仅在渲染进程环境可用)
+ */
+export function useClipboard(): any;
+
+/**
+ * 在浏览器中打开链接 (仅在渲染进程环境可用)
+ */
+export function openLink(...args: any[]): Promise<any>;
+
+/**
+ * 获取日志工具
+ */
+export function useLogger(): {
+  log(...args: any[]): void;
+  info(...args: any[]): void;
+  warn(...args: any[]): void;
+  error(...args: any[]): void;
+  debug(...args: any[]): void;
+};
+

package/dist/index.js

@@ -0,0 +1,111 @@
+import { isPreviewMode as isPreviewMode$1, initPreviewMock } from "./preview-mock.js";
+if (typeof window !== "undefined" && isPreviewMode$1()) {
+  initPreviewMock();
+}
+function isPreviewMode() {
+  return isPreviewMode$1();
+}
+function getMainStore() {
+  if (typeof global !== "undefined" && global.mainStore) {
+    return global.mainStore;
+  }
+  return null;
+}
+function usePluginConfig(pluginId) {
+  const store = getMainStore();
+  return {
+    get(key, defaultValue) {
+      return store?.config?.get(`plugin.${pluginId}.settings.${key}`, defaultValue);
+    },
+    set(key, value) {
+      store?.config?.set(`plugin.${pluginId}.settings.${key}`, value);
+    }
+  };
+}
+function useIpc() {
+  if (typeof window !== "undefined" && window.electron?.useIpc) {
+    return window.electron.useIpc();
+  }
+  return null;
+}
+function useVuetify() {
+  if (typeof window !== "undefined" && window.vuetify$) {
+    return window.vuetify$;
+  }
+  return {};
+}
+function useVuetifyComponents() {
+  return useVuetify().components || {};
+}
+function useVuetifyDirectives() {
+  return useVuetify().directives || {};
+}
+function useDialog() {
+  if (typeof window !== "undefined" && window.electron?.dialog) {
+    return window.electron.dialog;
+  }
+  return null;
+}
+function useShell() {
+  if (typeof window !== "undefined" && window.electron?.shell) {
+    return window.electron.shell;
+  }
+  return null;
+}
+async function getPluginSetting(...args) {
+  if (typeof window !== "undefined" && window.ts?.getPluginSetting) {
+    return window.ts.getPluginSetting(...args);
+  }
+  return null;
+}
+async function setPluginSetting(...args) {
+  if (typeof window !== "undefined" && window.ts?.setPluginSetting) {
+    return window.ts.setPluginSetting(...args);
+  }
+  return null;
+}
+function useWindowControl() {
+  if (typeof window !== "undefined" && window.ts?.windowControl) {
+    return window.ts.windowControl;
+  }
+  return null;
+}
+function useClipboard() {
+  if (typeof window !== "undefined" && window.electron?.clipboard) {
+    return window.electron.clipboard;
+  }
+  return null;
+}
+async function openLink(...args) {
+  if (typeof window !== "undefined" && window.electron?.openLink) {
+    return window.electron.openLink(...args);
+  }
+  return null;
+}
+function useLogger() {
+  if (typeof global !== "undefined" && global.mainStore) {
+    return global.mainStore?.logger || console;
+  }
+  if (typeof window !== "undefined") {
+    return window.ts?.logger || console;
+  }
+  return console;
+}
+export {
+  getMainStore,
+  getPluginSetting,
+  isPreviewMode,
+  openLink,
+  setPluginSetting,
+  useClipboard,
+  useDialog,
+  useIpc,
+  useLogger,
+  usePluginConfig,
+  useShell,
+  useVuetify,
+  useVuetifyComponents,
+  useVuetifyDirectives,
+  useWindowControl
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.js"],"sourcesContent":["/**\n * Translime SDK\n * 提供插件开发所需的标准 API 和类型提示。\n * 包含主进程 (Main Process) 和渲染进程 (Renderer Process) 的通用接口。\n */\n\nimport {\n  isPreviewMode as checkPreviewMode,\n  initPreviewMock,\n} from './preview-mock.js';\n\n// ----------------------------------------------------------------------\n// Initialization (Side Effect)\n// ----------------------------------------------------------------------\n\n// 在模块加载时检测并初始化 Preview Mock 环境\n// 确保在 Preview 模式下直接导入 SDK 也能获得 Mock 支持\nif (typeof window !== 'undefined' && checkPreviewMode()) {\n  initPreviewMock();\n}\n\n// ----------------------------------------------------------------------\n// Core / Store APIs (Main Process Only)\n// ----------------------------------------------------------------------\n\n/**\n * 检查当前是否为 Preview 模式\n * @returns {boolean}\n */\nexport function isPreviewMode() {\n  return checkPreviewMode();\n}\n\n/**\n * @typedef {Object} MainStore\n * @property {Object} config\n * @property {function(string, *): *} config.get\n * @property {function(string, *): void} config.set\n * @property {Object} [logger]\n */\n\n/**\n * 获取主程序 Store\n * @description 仅在 **主进程 (Main Process)** 环境可用\n * @returns {MainStore|null} 若在非主进程环境调用，返回 null\n */\nexport function getMainStore() {\n  if (typeof global !== 'undefined' && global.mainStore) {\n    return global.mainStore;\n  }\n  return null;\n}\n\n/**\n * 使用插件配置代理\n * @description 获取针对特定插件的配置读写对象\n * @param {string} pluginId 插件 ID (通常与 package.json 中的 name 一致)\n * @returns {{ get: function(string, *): *, set: function(string, *): void }}\n */\nexport function usePluginConfig(pluginId) {\n  const store = getMainStore();\n  return {\n    get(key, defaultValue) {\n      return store?.config?.get(`plugin.${pluginId}.settings.${key}`, defaultValue);\n    },\n    set(key, value) {\n      store?.config?.set(`plugin.${pluginId}.settings.${key}`, value);\n    },\n  };\n}\n\n// ----------------------------------------------------------------------\n// UI & Renderer APIs (Renderer Process Only)\n// ----------------------------------------------------------------------\n\n/**\n * 获取 IPC 通信工具\n * @description 仅在 **渲染进程 (Renderer Process)** 环境可用\n * @returns {Object|null} 包含 invoke, send, on 等方法的对象\n */\nexport function useIpc() {\n  if (typeof window !== 'undefined' && window.electron?.useIpc) {\n    return window.electron.useIpc();\n  }\n  return null;\n}\n\n/**\n * 获取 Vuetify 实例\n * @description 仅在 **渲染进程** 环境可用，用于访问 Vuetify 的全局配置\n * @returns {Object} Vuetify 实例对象\n */\nexport function useVuetify() {\n  if (typeof window !== 'undefined' && window.vuetify$) {\n    return window.vuetify$;\n  }\n  return {};\n}\n\n/**\n * 获取全局注册的 Vuetify 组件\n * @returns {Record<string, any>}\n */\nexport function useVuetifyComponents() {\n  return useVuetify().components || {};\n}\n\n/**\n * 获取全局注册的 Vuetify 指令\n * @returns {Record<string, any>}\n */\nexport function useVuetifyDirectives() {\n  return useVuetify().directives || {};\n}\n\n/**\n * 获取 Dialog API\n * @description 类似于 Electron 的 dialog 模块 (showOpenDialog, showSaveDialog 等)\n * @returns {Object|null}\n */\nexport function useDialog() {\n  if (typeof window !== 'undefined' && window.electron?.dialog) {\n    return window.electron.dialog;\n  }\n  return null;\n}\n\n/**\n * 获取 Shell API\n * @description 类似于 Electron 的 shell 模块 (openExternal, showItemInFolder 等)\n * @returns {Object|null}\n */\nexport function useShell() {\n  if (typeof window !== 'undefined' && window.electron?.shell) {\n    return window.electron.shell;\n  }\n  return null;\n}\n\n/**\n * 获取插件自身设置 (IPC 封装)\n * @description 仅在 **渲染进程** 环境可用。这是 `plugin.settings` 的前端读取接口。\n * @param {...any} args\n * @returns {Promise<any>}\n */\nexport async function getPluginSetting(...args) {\n  if (typeof window !== 'undefined' && window.ts?.getPluginSetting) {\n    return window.ts.getPluginSetting(...args);\n  }\n  return null;\n}\n\n/**\n * 更新插件自身设置 (IPC 封装)\n * @description 仅在 **渲染进程** 环境可用。\n * @param {...any} args\n * @returns {Promise<any>}\n */\nexport async function setPluginSetting(...args) {\n  if (typeof window !== 'undefined' && window.ts?.setPluginSetting) {\n    return window.ts.setPluginSetting(...args);\n  }\n  return null;\n}\n\n/**\n * 获取窗口控制工具\n * @description 包含 minimize, maximize, close 等窗口操作\n * @returns {Object|null}\n */\nexport function useWindowControl() {\n  if (typeof window !== 'undefined' && window.ts?.windowControl) {\n    return window.ts.windowControl;\n  }\n  return null;\n}\n\n// ----------------------------------------------------------------------\n// Utilities (Shared)\n// ----------------------------------------------------------------------\n\n/**\n * 获取剪贴板工具\n * @returns {Object|null}\n */\nexport function useClipboard() {\n  if (typeof window !== 'undefined' && window.electron?.clipboard) {\n    return window.electron.clipboard;\n  }\n  return null;\n}\n\n/**\n * 在默认浏览器中打开链接\n * @param {string} url 要打开的链接\n * @returns {Promise<void>}\n */\nexport async function openLink(...args) {\n  if (typeof window !== 'undefined' && window.electron?.openLink) {\n    return window.electron.openLink(...args);\n  }\n  return null;\n}\n\n/**\n * 获取日志工具\n * @description 自动适配 Node.js 环境 (Main) 或浏览器环境 (Renderer)\n * @returns {Record<'log'|'info'|'warn'|'error'|'debug', Function>} Console-like logger\n */\nexport function useLogger() {\n  if (typeof global !== 'undefined' && global.mainStore) {\n    return global.mainStore?.logger || console;\n  }\n  if (typeof window !== 'undefined') {\n    return window.ts?.logger || console;\n  }\n  return console;\n}\n\n"],"names":["checkPreviewMode"],"mappings":";AAiBA,IAAI,OAAO,WAAW,eAAeA,mBAAoB;AACvD,kBAAe;AACjB;AAUO,SAAS,gBAAgB;AAC9B,SAAOA,gBAAgB;AACzB;AAeO,SAAS,eAAe;AAC7B,MAAI,OAAO,WAAW,eAAe,OAAO,WAAW;AACrD,WAAO,OAAO;AAAA,EAChB;AACA,SAAO;AACT;AAQO,SAAS,gBAAgB,UAAU;AACxC,QAAM,QAAQ,aAAY;AAC1B,SAAO;AAAA,IACL,IAAI,KAAK,cAAc;AACrB,aAAO,OAAO,QAAQ,IAAI,UAAU,QAAQ,aAAa,GAAG,IAAI,YAAY;AAAA,IAC9E;AAAA,IACA,IAAI,KAAK,OAAO;AACd,aAAO,QAAQ,IAAI,UAAU,QAAQ,aAAa,GAAG,IAAI,KAAK;AAAA,IAChE;AAAA,EACJ;AACA;AAWO,SAAS,SAAS;AACvB,MAAI,OAAO,WAAW,eAAe,OAAO,UAAU,QAAQ;AAC5D,WAAO,OAAO,SAAS,OAAM;AAAA,EAC/B;AACA,SAAO;AACT;AAOO,SAAS,aAAa;AAC3B,MAAI,OAAO,WAAW,eAAe,OAAO,UAAU;AACpD,WAAO,OAAO;AAAA,EAChB;AACA,SAAO,CAAA;AACT;AAMO,SAAS,uBAAuB;AACrC,SAAO,WAAU,EAAG,cAAc,CAAA;AACpC;AAMO,SAAS,uBAAuB;AACrC,SAAO,WAAU,EAAG,cAAc,CAAA;AACpC;AAOO,SAAS,YAAY;AAC1B,MAAI,OAAO,WAAW,eAAe,OAAO,UAAU,QAAQ;AAC5D,WAAO,OAAO,SAAS;AAAA,EACzB;AACA,SAAO;AACT;AAOO,SAAS,WAAW;AACzB,MAAI,OAAO,WAAW,eAAe,OAAO,UAAU,OAAO;AAC3D,WAAO,OAAO,SAAS;AAAA,EACzB;AACA,SAAO;AACT;AAQO,eAAe,oBAAoB,MAAM;AAC9C,MAAI,OAAO,WAAW,eAAe,OAAO,IAAI,kBAAkB;AAChE,WAAO,OAAO,GAAG,iBAAiB,GAAG,IAAI;AAAA,EAC3C;AACA,SAAO;AACT;AAQO,eAAe,oBAAoB,MAAM;AAC9C,MAAI,OAAO,WAAW,eAAe,OAAO,IAAI,kBAAkB;AAChE,WAAO,OAAO,GAAG,iBAAiB,GAAG,IAAI;AAAA,EAC3C;AACA,SAAO;AACT;AAOO,SAAS,mBAAmB;AACjC,MAAI,OAAO,WAAW,eAAe,OAAO,IAAI,eAAe;AAC7D,WAAO,OAAO,GAAG;AAAA,EACnB;AACA,SAAO;AACT;AAUO,SAAS,eAAe;AAC7B,MAAI,OAAO,WAAW,eAAe,OAAO,UAAU,WAAW;AAC/D,WAAO,OAAO,SAAS;AAAA,EACzB;AACA,SAAO;AACT;AAOO,eAAe,YAAY,MAAM;AACtC,MAAI,OAAO,WAAW,eAAe,OAAO,UAAU,UAAU;AAC9D,WAAO,OAAO,SAAS,SAAS,GAAG,IAAI;AAAA,EACzC;AACA,SAAO;AACT;AAOO,SAAS,YAAY;AAC1B,MAAI,OAAO,WAAW,eAAe,OAAO,WAAW;AACrD,WAAO,OAAO,WAAW,UAAU;AAAA,EACrC;AACA,MAAI,OAAO,WAAW,aAAa;AACjC,WAAO,OAAO,IAAI,UAAU;AAAA,EAC9B;AACA,SAAO;AACT;"}

package/dist/preview/settings.scss

@@ -0,0 +1,86 @@
+/**
+ * src/preview/settings.scss
+ * Preview 模式的 Vuetify 设置，与主程序保持一致
+ */
+
+@forward 'vuetify/settings' with (
+  $utilities: (
+    'align-content': false,
+    'align-items': false,
+    'align-self': false,
+    'border-bottom': false,
+    'border-current': false,
+    'border-end': false,
+    'border-opacity': false,
+    'border-start': false,
+    'border-style': false,
+    'border-top': false,
+    'border': false,
+    'bottom': false,
+    'cursor': false,
+    'display': false,
+    'fill-height': false,
+    'flex-direction': false,
+    'flex-grow': false,
+    'flex-shrink': false,
+    'flex-wrap': false,
+    'flex': false,
+    'font-italic': false,
+    'font-weight': false,
+    'gap-column': false,
+    'gap-row': false,
+    'gap': false,
+    'height-screen': false,
+    'height': false,
+    'justify-content': false,
+    'justify-items': false,
+    'left': false,
+    'margin-bottom': false,
+    'margin-end': false,
+    'margin-left': false,
+    'margin-right': false,
+    'margin-start': false,
+    'margin-top': false,
+    'margin-x': false,
+    'margin-y': false,
+    'margin': false,
+    'negative-margin-bottom': false,
+    'negative-margin-end': false,
+    'negative-margin-left': false,
+    'negative-margin-right': false,
+    'negative-margin-start': false,
+    'negative-margin-top': false,
+    'negative-margin-x': false,
+    'negative-margin-y': false,
+    'negative-margin': false,
+    'opacity': false,
+    'order': false,
+    'overflow-wrap': false,
+    'overflow-x': false,
+    'overflow-y': false,
+    'overflow': false,
+    'padding-bottom': false,
+    'padding-end': false,
+    'padding-left': false,
+    'padding-right': false,
+    'padding-start': false,
+    'padding-top': false,
+    'padding-x': false,
+    'padding-y': false,
+    'padding': false,
+    'position': false,
+    'right': false,
+    'text-align': false,
+    'text-decoration': false,
+    'text-mono': false,
+    'text-opacity': false,
+    'text-overflow': false,
+    'text-transform': false,
+    'top': false,
+    'typography': false,
+    'white-space': false,
+    'width': false,
+  ),
+  $layers: true,
+  $body-font-family: ('Roboto', 'Noto Sans SC', 'Microsoft YaHei', '微软雅黑', sans-serif),
+);