mioku-plugin-music 1.1.0

package/runtime.ts

@@ -0,0 +1,24 @@
+import type { MusicPluginRuntime } from "./runtime-core/service";
+import {
+  getPluginRuntimeState,
+  resetPluginRuntimeState,
+  setPluginRuntimeState,
+} from "../../src";
+
+export interface MusicRuntimeState {
+  runtime?: MusicPluginRuntime;
+}
+
+const MUSIC_PLUGIN_NAME = "music";
+
+export function getMusicRuntimeState(): MusicRuntimeState {
+  return getPluginRuntimeState<MusicRuntimeState>(MUSIC_PLUGIN_NAME);
+}
+
+export function setMusicRuntimeState(nextState: MusicRuntimeState): MusicRuntimeState {
+  return setPluginRuntimeState<MusicRuntimeState>(MUSIC_PLUGIN_NAME, nextState);
+}
+
+export function resetMusicRuntimeState(): void {
+  resetPluginRuntimeState(MUSIC_PLUGIN_NAME);
+}

package/skills.ts

@@ -0,0 +1,115 @@
+import type { AISkill, AITool } from "../../src";
+import { getMusicRuntimeState } from "./runtime";
+
+const musicSkills: AISkill[] = [
+  {
+    name: "music",
+    description:
+      "搜索音乐/歌曲/专辑/歌手，并可发送歌曲，注意，当用户想让你唱歌时，通常使用该技能而不是发送语音。",
+    permission: "member",
+    tools: [
+      {
+        name: "search_music",
+        description: "按关键词搜索歌曲",
+        parameters: {
+          type: "object",
+          properties: {
+            query: {
+              type: "string",
+              description: "搜索关键词，可是歌曲名、歌手或专辑名",
+            },
+          },
+          required: ["query"],
+        },
+        handler: async (args: any, runtimeCtx?: any) => {
+          const runtime = getMusicRuntimeState().runtime;
+          const ctx = runtimeCtx?.ctx;
+          const event = runtimeCtx?.event || runtimeCtx?.rawEvent;
+          if (!runtime || !event) {
+            return "music 插件尚未初始化";
+          }
+          const query = String(args?.query || "").trim();
+          if (!query) {
+            return "query 不能为空";
+          }
+          try {
+            const result = await runtime.searchSongs(event, query);
+            if (!result.tracks.length) {
+              return `没有找到「${query}」的歌曲`;
+            }
+            const list = result.tracks
+              .slice(0, 10)
+              .map(
+                (item, index) =>
+                  `${index + 1}. ${item.title} - ${item.artist} (${item.album}) [${item.id}]`,
+              )
+              .join("\n");
+            return `已找到 ${result.tracks.length} 首：\n${list}`;
+          } catch (error) {
+            if (ctx) {
+              await runtime.notifyFailure(
+                ctx,
+                event,
+                `AI 发起音乐搜索失败。错误：${String(error)}。请简短告知稍后再试。`,
+                `搜索失败：${String(error)}`,
+              );
+            }
+            return `搜索失败：${String(error)}`;
+          }
+        },
+      } as AITool,
+      {
+        name: "send_music_song",
+        description: "发送歌曲语音（通过 song_id 或 query）",
+        parameters: {
+          type: "object",
+          properties: {
+            song_id: {
+              type: "string",
+              description: "歌曲 ID，优先使用",
+            },
+            query: {
+              type: "string",
+              description: "关键词，内部会搜索后发送第一首",
+            },
+          },
+          required: [],
+        },
+        handler: async (args: any, runtimeCtx?: any) => {
+          const runtime = getMusicRuntimeState().runtime;
+          const ctx = runtimeCtx?.ctx;
+          const event = runtimeCtx?.event || runtimeCtx?.rawEvent;
+          if (!runtime || !ctx || !event) {
+            return "当前上下文不支持发送歌曲";
+          }
+
+          const songId = String(args?.song_id || "").trim();
+          const query = String(args?.query || "").trim();
+          if (!songId && !query) {
+            return "必须提供 song_id 或 query";
+          }
+
+          try {
+            if (songId) {
+              await runtime.sendSongById(ctx, event, songId);
+              return "已发送歌曲";
+            }
+
+            await runtime.sendSongByQuery(ctx, event, query);
+            return "已按关键词发送歌曲";
+          } catch (error) {
+            await runtime.notifyFailure(
+              ctx,
+              event,
+              `AI 发送歌曲失败。错误：${String(error)}。请简短提示稍后重试。`,
+              `发送失败：${String(error)}`,
+            );
+            return `发送失败：${String(error)}`;
+          }
+        },
+      } as AITool,
+    ],
+  },
+];
+
+export default musicSkills;

package/types.ts

@@ -0,0 +1,85 @@
+export type MusicProviderName = "applemusic";
+
+export const MUSIC_PROVIDER_NAMES: MusicProviderName[] = ["applemusic"];
+
+export interface MusicBaseConfig {
+  searchLimit: number;
+  defaultProvider?: MusicProviderName | string;
+  applemusic: {
+    storefront: string;
+    language: string;
+    defaultMediaUserToken?: string;
+  };
+}
+
+export interface MusicTrack {
+  id: string;
+  provider: MusicProviderName;
+  title: string;
+  artist: string;
+  album: string;
+  coverUrl?: string;
+  durationMs?: number;
+  previewUrl?: string;
+}
+
+export interface MusicSongDetail {
+  id: string;
+  provider: MusicProviderName;
+  title: string;
+  artist: string;
+  album: string;
+  coverUrl?: string;
+  releaseDate?: string;
+  durationMs?: number;
+  previewUrl?: string;
+  audioTraits?: string[];
+}
+
+export interface MusicAlbumDetail {
+  id: string;
+  provider: MusicProviderName;
+  title: string;
+  artist: string;
+  coverUrl?: string;
+  releaseDate?: string;
+  tracks: Array<{
+    id: string;
+    title: string;
+    artist: string;
+    durationMs?: number;
+  }>;
+}
+
+export interface MusicSearchResult {
+  query: string;
+  provider: MusicProviderName;
+  tracks: MusicTrack[];
+}
+
+export interface DownloadSongResult {
+  filePath: string;
+  sourceType: "hls" | "preview";
+}
+
+export interface MusicProviderClientOptions {
+  mediaUserToken?: string;
+  storefront?: string;
+  language?: string;
+}
+
+export interface MusicProvider {
+  readonly name: MusicProviderName;
+  searchSongs(query: string, limit?: number): Promise<MusicSearchResult>;
+  getSongDetail(songId: string): Promise<MusicSongDetail>;
+  getAlbumDetail(albumId: string): Promise<MusicAlbumDetail>;
+  downloadSong(songId: string): Promise<DownloadSongResult>;
+  downloadCover(coverUrl: string, fileName?: string): Promise<string>;
+}
+
+export interface MusicSessionState {
+  provider: MusicProviderName;
+  mediaUserToken?: string;
+  lastSearch?: MusicSearchResult;
+  updatedAt: number;
+}