@ruck/sdk

Ruck 插件官方 SDK，为插件提供统一的 API 访问接口，并支持 Web Worker 沙箱环境。

安装

npm install @ruck/sdk

使用示例

import { ruck } from '@ruck/sdk';

// 使用 Ruck UI设计
ruck.app.useDesignSystem();

// 使用存储 API
async function saveData() {
  await ruck.storage.set('key', { value: 123 });
  const data = await ruck.storage.get('key');
  console.log(data);
}

// 文件系统操作
async function readFile() {
  const content = await ruck.fs.readFile('config.json', { encoding: 'utf8' });
  console.log(content);
}

核心特性

• 环境自适应: 自动识别是运行在 WebView 主线程还是 Web Worker 中。
• 类型安全: 完善的 TypeScript 类型定义。
• 异步优先: 所有涉及 Ruck 宿主通信的 API 均为异步 Promise 形式。
• 模块化设计: API 按照功能模块（fs, storage, clipboard, ui 等）组织。