@songloft/client-sdk

Songloft 客户端 SDK：让「在 Songloft Flutter 客户端 webview 中打开的插件页面」调用宿主客户端能力——改写正在播放队列、控制播放、订阅播放状态等。

与 @songloft/plugin-sdk 的区别：plugin-sdk 面向服务端 QuickJS 运行时（songloft.* 全局，跑在后端）；本包面向客户端 webview 页面（window.SongloftPlugin.*，跑在 Flutter 客户端里打开的插件网页中）。

适用范围

• ✅ Songloft Flutter 客户端（Android / iOS / macOS / Windows / Linux）的 webview 中打开的插件页面
• ✅ Web 端插件页（Tab 内嵌页与首页/全屏页均在宿主 iframe 内打开，走 postMessage 桥接）
• ❌ 用户通过「在浏览器中打开」将插件页在独立新标签打开时（无宿主父窗口）—— isClient() 返回 false
• ❌ 服务端 QuickJS 运行时（用 @songloft/plugin-sdk）

无论走哪条链路，调用前都请用 isClient() / host.isAvailable() 先检测——不可用时调用会抛错。

运行时能力由宿主客户端注入到 window.SongloftPlugin。本包是类型层 + 便捷封装：所有调用都委托注入的全局对象，不含独立运行时。因此新能力可能受客户端版本限制，请在 plugin.json 设置合适的 minHostVersion，并用 host.getInfo().capabilities 做能力协商。

安装

npm install @songloft/client-sdk

用法

import { player, host, isClient } from '@songloft/client-sdk';

// 调用前先 feature-detect
if (isClient()) {
  // 用歌曲 id 替换正在播放队列并从第 0 首开始播
  await player.setQueue([101, 102, 103], { startIndex: 0 });

  // 追加到队列末尾（不打断当前播放）
  await player.addToQueue([104]);

  // 读取当前状态
  const state = await player.getState();
  console.log(state.current_song?.title, state.is_playing);

  // 订阅播放状态变更（返回取消订阅函数）
  const off = player.onStateChange((s) => {
    console.log('当前第', s.current_index, '首');
  });

  // 能力协商
  const info = await host.getInfo();
  if (info.capabilities.includes('player')) {
    /* ... */
  }
}

歌曲以 id 传入（宿主权威）。插件通过服务端 songs.create 创建的远程歌曲已持久化、带 id，可直接入队。

免构建的 vanilla 插件也可直接用注入的全局对象（无需引入本包，仅少了类型提示）：

<script>
  window.SongloftPlugin.player.setQueue([101, 102]);
</script>

API

isClient(): boolean

同步检测当前是否运行在支持原生桥接的 Songloft 客户端 webview 内。

host

• host.isAvailable(): boolean —— 同 isClient()
• host.getInfo(): Promise<HostInfo> —— 宿主版本 / 平台 / 能力列表

player

方法	说明
getState()	获取播放器状态快照
setQueue(ids, { startIndex?, sourcePlaylistId? })	替换整个队列并播放
addToQueue(ids)	追加到队列末尾（去重，不播放）
insertToQueue(index, id)	指定位置插入（不播放）
removeFromQueue(index)	移除指定下标
reorderQueue(oldIndex, newIndex)	重排
clearQueue()	清空
play(id?)	播放指定歌曲 / 恢复播放
pause() / togglePlay()	暂停 / 切换
next() / prev()	下一首 / 上一首
seek(seconds)	跳转进度
setVolume(0-100)	音量
setPlayMode(mode)	order/loop/single/random/singlePlay
playPlaylistById(id)	直接播放服务端歌单
onStateChange(cb)	订阅状态变更，返回取消订阅函数

完整类型见包内 .d.ts（ClientSong / ClientPlayerState / HostInfo / PlayMode 等）。

favorite

收藏状态同步。插件自己改完收藏（如直接 POST /playlists/1/songs）后必须调一次——服务端数据是对的，但 Flutter 侧曲库的红心读的是 FavoriteNotifier 的内存缓存，不会自动跟着变。

import { favorite } from '@songloft/client-sdk';

const res = await SongloftPlugin.apiPost('/playlists/1/songs', { song_id: id });
await favorite.refresh(id, res.is_favorited);

方法	说明
refresh(songId?, isFavorited?)	带参 = 增量更新那一首；不带参 = 全量重载

能带参就带参：全量重载在曲库上千首时是一次完整往返。

invokeHost(ns, method, params?): Promise<unknown>

通用宿主调用。上面的 player / host / favorite / getCookies 都是它的 typed wrapper；公开它是因为宿主分发表在客户端侧，可能比服务端那份 common.js 更新，插件需要能触达尚未被 wrapper 覆盖的 namespace。

import { invokeHost } from '@songloft/client-sdk';

await invokeHost('favorite', 'refresh', { songId: 42, isFavorited: true });

⚠️ 没有 wrapper 那层类型约束，ns / method 拼错只会在运行时 reject。有对应 wrapper 时优先用 wrapper。

⚠️ 不要在插件里手写宿主 API 的类型声明。 用本包导出的 SongloftPluginGlobal。曾经有插件自己声明了 invokeHost?（当时它只存在于内部句柄 window.__SongloftInternal、公开对象里并没有），于是 SongloftPlugin?.invokeHost?.(...) 通过了 TS 编译、运行时被可选调用静默吞掉，整个功能一个字节都没发出去（songloft-org/songloft-plugin-miot#86）。

getCookies(origin: string): Promise<Record<string, string>>

读取宿主 WebView Cookie Store 中指定 origin 的 Cookie（含 HttpOnly）。

import { getCookies } from '@songloft/client-sdk';

const cookies = await getCookies('https://pcyear.5ddd.com');
// { 'os-access-code': '...', 'music-token': '...' }

参数	说明
origin	目标站点 origin，含协议+主机+端口，如 https://example.com

⚠️ 仅原生客户端可用（Android / iOS / macOS / Windows / Linux）。Web 端因浏览器同源策略限制无法读取跨源 Cookie，调用会 reject 并提示平台不支持。使用前建议通过 host.getInfo() 检查 platform !== 'web'。

License

Apache-2.0