@zhin.js/plugin-music 1.0.25 → 1.1.0

package/package.json

@@ -1,24 +1,28 @@
 {
   "name": "@zhin.js/plugin-music",
-  "version": "1.0.25",
-  "description": "Music search and sharing plugin for Zhin.js",
+  "version": "1.1.0",
+  "description": "Music search and sharing plugin for Zhin.js (Plugin Runtime)",
   "type": "module",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "exports": {
     ".": {
       "types": "./lib/index.d.ts",
-      "development": "./src/index.tsx",
+      "development": "./src/index.ts",
       "import": "./lib/index.js"
     },
     "./package.json": "./package.json"
   },
   "files": [
+    "plugin.js",
+    "schema.json",
+    "commands",
+    "middlewares",
+    "components",
+    "tools",
     "src",
     "lib",
-    "client",
-    "dist",
-    "skills",
+    "agent",
     "README.md"
   ],
   "keywords": [
@@ -38,19 +42,34 @@
     "url": "https://github.com/lc-cn"
   },
   "license": "MIT",
-  "dependencies": {},
+  "dependencies": {
+    "@zhin.js/core": "1.1.35",
+    "@zhin.js/tool": "1.1.0"
+  },
   "devDependencies": {
     "typescript": "^6.0.3",
-    "zhin.js": "1.0.80",
-    "@zhin.js/adapter-icqq": "2.0.25"
+    "vitest": "^4.1.10",
+    "zhin.js": "1.1.0"
   },
   "peerDependencies": {
-    "@zhin.js/adapter-icqq": "2.0.25",
-    "zhin.js": "1.0.80"
+    "@zhin.js/adapter-icqq": "^1.1.0",
+    "@zhin.js/command": "^1.1.0",
+    "@zhin.js/component": "^1.1.0",
+    "@zhin.js/middleware": "^1.1.0",
+    "zhin.js": "^1.1.0"
   },
   "peerDependenciesMeta": {
     "@zhin.js/adapter-icqq": {
       "optional": true
+    },
+    "@zhin.js/command": {
+      "optional": true
+    },
+    "@zhin.js/component": {
+      "optional": true
+    },
+    "@zhin.js/middleware": {
+      "optional": true
     }
   },
   "repository": {
@@ -62,8 +81,38 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "zhin": {
+    "protocol": 1,
+    "type": "plugin",
+    "entry": "./plugin.js",
+    "engine": "^1.0.0",
+    "runtime": "trusted",
+    "features": [
+      {
+        "package": "@zhin.js/command",
+        "api": "^1.0.0"
+      },
+      {
+        "package": "@zhin.js/middleware",
+        "api": "^1.0.0"
+      },
+      {
+        "package": "@zhin.js/component",
+        "api": "^1.0.0"
+      },
+      {
+        "package": "@zhin.js/tool",
+        "api": "^1.0.0"
+      }
+    ],
+    "plugins": []
+  },
   "scripts": {
-    "build": "tsc --build",
-    "clean": "rimraf lib"
+    "build": "tsc",
+    "clean": "rimraf lib",
+    "test": "NODE_OPTIONS=--experimental-strip-types vitest run --root ../../.. plugins/utils/music/tests"
   }
 }

package/plugin.js

@@ -0,0 +1,31 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { definePlugin, databaseHostToken } from 'zhin.js';
+import { cleanExpired } from "./lib/session.js";
+import { cleanExpiredLogins } from "./lib/login/index.js";
+import { MUSIC_CREDENTIALS_TABLE, provideCredentialDb, } from "./lib/credential-store.js";
+function defineCredentialTable(db) {
+    db.define(MUSIC_CREDENTIALS_TABLE, {
+        source: { type: 'text', nullable: false },
+        key: { type: 'text', nullable: false },
+        value: { type: 'text', nullable: false },
+        updated_at: { type: 'text', default: '' },
+    });
+}
+export default definePlugin({
+    name: 'music',
+    metadata: {
+        displayName: 'Music',
+    },
+    setup(context) {
+        if (context.resources.has(databaseHostToken)) {
+            const host = context.resources.use(databaseHostToken);
+            defineCredentialTable(host);
+            provideCredentialDb(context, host);
+        }
+        const timer = setInterval(() => {
+            cleanExpired();
+            cleanExpiredLogins();
+        }, 60_000);
+        return () => clearInterval(timer);
+    },
+});

package/schema.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {}
+}

package/src/config.ts

@@ -1,7 +1,5 @@
-// plugins/utils/music/src/config.ts
-import type { MusicSourceConfig,MusicSource } from './types.js'
+import type { MusicSourceConfig, MusicSource } from './types.js';
 
-/** 音乐源配置映射 */
 export const sourceConfigMap: Record<MusicSource, MusicSourceConfig> = {
   qq: {
     appid: 100497308,
@@ -17,38 +15,64 @@ export const sourceConfigMap: Record<MusicSource, MusicSourceConfig> = {
     sign: 'da6b069da1e2982db3e386233f68d76d',
     version: '9.1.92',
   },
+  kuwo: {
+    appid: 100243533,
+    package: 'cn.kuwo.player',
+    icon: 'https://p.qpic.cn/qqconnect/0/app_100243533_1636498875/100?max-age=2592000&t=0',
+    sign: 'bf9ff4ffb4c558a34ee3fd52c223ebf5',
+    version: '10.1.3.5',
+  },
+  kugou: {
+    appid: 205141,
+    package: 'com.kugou.android',
+    icon: 'https://open.gtimg.cn/open/app_icon/00/20/51/41/205141_100_m.png',
+    sign: '5a84ee451a90ca88a1ea0ad2bef9e69c',
+    version: '12.2.8',
+  },
+};
+
+export const SOURCE_ALIASES: Record<string, MusicSource> = {
+  'qq': 'qq',
+  'QQ': 'qq',
+  'QQ音乐': 'qq',
+  'qq音乐': 'qq',
+  '网易': 'netease',
+  '网易云': 'netease',
+  '163': 'netease',
+  '酷我': 'kuwo',
+  '酷狗': 'kugou',
+};
+
+export const SOURCE_DISPLAY_NAME: Record<MusicSource, string> = {
+  qq: 'QQ音乐',
+  netease: '网易云',
+  kuwo: '酷我',
+  kugou: '酷狗',
+};
+
+export function resolveSourceAlias(input: string): MusicSource | undefined {
+  return SOURCE_ALIASES[input.trim()];
 }
 
-/** 格式化时长 */
 export function formatDuration(seconds?: number): string {
-  if (!seconds) return '未知'
-  
-  const minutes = Math.floor(seconds / 60)
-  const secs = seconds % 60
-  return `${minutes}:${secs.toString().padStart(2, '0')}`
+  if (!seconds) return '未知';
+  const minutes = Math.floor(seconds / 60);
+  const secs = seconds % 60;
+  return `${minutes}:${secs.toString().padStart(2, '0')}`;
 }
 
-/** 格式化音乐信息 */
 export function formatMusicInfo(music: {
-  title: string
-  artist?: string
-  album?: string
-  duration?: number
-  source: string
+  title: string;
+  artist?: string;
+  album?: string;
+  duration?: number;
+  source: string;
 }): string {
-  const parts = [music.title]
-  
-  if (music.artist) {
-    parts.push(music.artist)
-  }
-  
-  if (music.album) {
-    parts.push(music.album)
-  }
-  
-  const info = parts.join(' - ')
-  const duration = formatDuration(music.duration)
-  const source = music.source.toUpperCase()
-  
-  return `${info} [${duration}] [${source}]`
+  const parts = [music.title];
+  if (music.artist) parts.push(music.artist);
+  if (music.album) parts.push(music.album);
+  const info = parts.join(' - ');
+  const duration = formatDuration(music.duration);
+  const source = music.source.toUpperCase();
+  return `${info} [${duration}] [${source}]`;
 }

package/src/credential-store.ts

@@ -0,0 +1,169 @@
+import {
+  createGenerationStore,
+  type Dispose,
+  type GenerationStoreContext,
+} from 'zhin.js';
+import type { MusicSource } from './types.js';
+
+export const MUSIC_CREDENTIALS_TABLE = 'music_credentials';
+
+export interface CredentialRow {
+  source: MusicSource;
+  key: string;
+  value: string;
+  updated_at: string;
+}
+
+export interface CredentialModel {
+  select(...fields: string[]): {
+    where(query: Record<string, unknown>): PromiseLike<Record<string, unknown>[]>;
+    then<TResult1 = Record<string, unknown>[], TResult2 = never>(
+      onfulfilled?:
+        | ((value: Record<string, unknown>[]) => TResult1 | PromiseLike<TResult1>)
+        | null,
+      onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null,
+    ): Promise<TResult1 | TResult2>;
+  };
+  insert(row: Record<string, unknown>): Promise<unknown>;
+  delete(): { where(query: Record<string, unknown>): Promise<unknown> };
+  update(patch: Record<string, unknown>): {
+    where(query: Record<string, unknown>): Promise<unknown>;
+  };
+}
+
+export interface CredentialDb {
+  models: { get(name: string): CredentialModel | undefined };
+}
+
+function createMemoryModel(): CredentialModel {
+  const rows: Record<string, unknown>[] = [];
+
+  function matches(
+    row: Record<string, unknown>,
+    query: Record<string, unknown>,
+  ): boolean {
+    return Object.entries(query).every(([k, v]) => row[k] === v);
+  }
+
+  return {
+    select: () => {
+      const all = rows.map((r) => ({ ...r }));
+      return {
+        where: async (query) =>
+          rows.filter((r) => matches(r, query)).map((r) => ({ ...r })),
+        then: (onfulfilled, onrejected) =>
+          Promise.resolve(all).then(onfulfilled, onrejected),
+      };
+    },
+    insert: async (row) => {
+      rows.push({ ...row });
+    },
+    delete: () => ({
+      where: async (query) => {
+        for (let i = rows.length - 1; i >= 0; i--) {
+          if (matches(rows[i]!, query)) rows.splice(i, 1);
+        }
+      },
+    }),
+    update: (patch) => ({
+      where: async (query) => {
+        for (const row of rows) {
+          if (matches(row, query)) Object.assign(row, patch);
+        }
+      },
+    }),
+  };
+}
+
+const credentialDbStore = createGenerationStore<CredentialDb>('music/credential-db');
+let _memoryDb: CredentialDb | null = null;
+
+export function provideCredentialDb(
+  context: GenerationStoreContext,
+  db: CredentialDb,
+): Dispose {
+  return credentialDbStore.provide(context, db);
+}
+
+function getDb(): CredentialDb {
+  const provided = credentialDbStore.tryUse();
+  if (provided) return provided;
+  if (!_memoryDb) {
+    _memoryDb = {
+      models: {
+        get: (name) =>
+          name === MUSIC_CREDENTIALS_TABLE ? memoryModel : undefined,
+      },
+    };
+  }
+  return _memoryDb;
+}
+
+const memoryModel = createMemoryModel();
+
+function getModel(): CredentialModel | null {
+  return getDb().models.get(MUSIC_CREDENTIALS_TABLE) ?? null;
+}
+
+export async function getCredential(
+  source: MusicSource,
+  key: string,
+): Promise<string | null> {
+  const model = getModel();
+  if (!model) return null;
+  const rows = await model.select().where({ source, key });
+  if (rows.length === 0) return null;
+  return String(rows[0]!.value ?? '');
+}
+
+export async function setCredential(
+  source: MusicSource,
+  key: string,
+  value: string,
+): Promise<void> {
+  const model = getModel();
+  if (!model) return;
+  const existing = await model.select().where({ source, key });
+  if (existing.length > 0) {
+    await model
+      .update({ value, updated_at: new Date().toISOString() })
+      .where({ source, key });
+  } else {
+    await model.insert({
+      source,
+      key,
+      value,
+      updated_at: new Date().toISOString(),
+    });
+  }
+}
+
+export async function deleteCredential(
+  source: MusicSource,
+  key: string,
+): Promise<void> {
+  const model = getModel();
+  if (!model) return;
+  await model.delete().where({ source, key });
+}
+
+export async function listCredentials(
+  source?: MusicSource,
+): Promise<CredentialRow[]> {
+  const model = getModel();
+  if (!model) return [];
+  const rows = source
+    ? await model.select().where({ source })
+    : await model.select();
+  return rows.map((r) => ({
+    source: String(r.source) as MusicSource,
+    key: String(r.key),
+    value: String(r.value),
+    updated_at: String(r.updated_at ?? ''),
+  }));
+}
+
+export function resetCredentialDb(): void {
+  credentialDbStore.clear();
+  _memoryDb = null;
+}

package/src/index.ts

@@ -0,0 +1,45 @@
+export {
+  formatDuration,
+  formatMusicInfo,
+  sourceConfigMap,
+  SOURCE_ALIASES,
+  SOURCE_DISPLAY_NAME,
+  resolveSourceAlias,
+} from './config.js';
+export {
+  searchMusic,
+  shareMusicDetail,
+  formatSearchResults,
+  buildMusicShareSegment,
+} from './music-lib.js';
+export { musicServices } from './sources/index.js';
+export {
+  sessionKey,
+  resolveMessageIds,
+  setPending,
+  getPending,
+  clearPending,
+  cleanExpired,
+  type PendingSearch,
+} from './session.js';
+export {
+  getCredential,
+  setCredential,
+  deleteCredential,
+  listCredentials,
+  MUSIC_CREDENTIALS_TABLE,
+  provideCredentialDb,
+  resetCredentialDb,
+} from './credential-store.js';
+export {
+  startLogin,
+  pollLogin,
+  cancelLogin,
+  getActiveLogin,
+  loginSessionKey,
+  cleanExpiredLogins,
+  type QrLoginSource,
+  type QrLoginSession,
+  type QrPollResult,
+} from './login/index.js';
+export type { MusicDetail, MusicInfo, MusicSource, MusicSourceConfig } from './types.js';

package/src/login/index.ts

@@ -0,0 +1,135 @@
+import type { QrLoginProvider, QrLoginSource, QrPollResult } from './types.js';
+import { QQLoginProvider } from './qq.js';
+import { NeteaseLoginProvider } from './netease.js';
+import { setCredential } from '../credential-store.js';
+
+export type { QrLoginSource, QrPollResult, QrLoginProvider } from './types.js';
+
+const providers: Record<QrLoginSource, QrLoginProvider> = {
+  qq: new QQLoginProvider(),
+  netease: new NeteaseLoginProvider(),
+};
+
+export interface QrLoginSession {
+  source: QrLoginSource;
+  pollData: Record<string, string>;
+  timestamp: number;
+  aborted: boolean;
+}
+
+const LOGIN_TIMEOUT_MS = 2 * 60 * 1000;
+const POLL_INTERVAL_MS = 3_000;
+const MAX_POLLS = Math.ceil(LOGIN_TIMEOUT_MS / POLL_INTERVAL_MS);
+
+const activeLogins = new Map<string, QrLoginSession>();
+
+export function loginSessionKey(
+  endpointId: string,
+  conversationId: string,
+  senderId: string,
+): string {
+  return `login:${endpointId}:${conversationId}:${senderId}`;
+}
+
+export function getActiveLogin(key: string): QrLoginSession | undefined {
+  const session = activeLogins.get(key);
+  if (!session) return undefined;
+  if (Date.now() - session.timestamp > LOGIN_TIMEOUT_MS) {
+    activeLogins.delete(key);
+    return undefined;
+  }
+  return session;
+}
+
+export function cancelLogin(key: string): boolean {
+  const session = activeLogins.get(key);
+  if (!session) return false;
+  session.aborted = true;
+  activeLogins.delete(key);
+  return true;
+}
+
+export async function startLogin(
+  source: QrLoginSource,
+  key: string,
+): Promise<{ imageSegment: { type: 'image'; data: Record<string, unknown> } }> {
+  const existing = activeLogins.get(key);
+  if (existing && !existing.aborted) {
+    existing.aborted = true;
+  }
+
+  const provider = providers[source];
+  const result = await provider.createQr();
+
+  activeLogins.set(key, {
+    source,
+    pollData: result.pollData,
+    timestamp: Date.now(),
+    aborted: false,
+  });
+
+  return { imageSegment: result.imageSegment };
+}
+
+export async function pollLogin(
+  key: string,
+  onStatus: (result: QrPollResult) => Promise<void>,
+): Promise<QrPollResult> {
+  const session = activeLogins.get(key);
+  if (!session) {
+    return { status: 'error', message: '没有进行中的登录会话' };
+  }
+
+  const provider = providers[session.source];
+  let lastStatus = '';
+
+  try {
+    for (let i = 0; i < MAX_POLLS; i++) {
+      if (session.aborted) {
+        activeLogins.delete(key);
+        return { status: 'error', message: '登录已取消' };
+      }
+
+      const result = await provider.pollQr(session.pollData);
+
+      if (result.status !== lastStatus) {
+        lastStatus = result.status;
+        await onStatus(result);
+      }
+
+      if (result.status === 'confirmed') {
+        activeLogins.delete(key);
+        if (result.cookie) {
+          await setCredential(session.source, 'cookie', result.cookie);
+        }
+        return result;
+      }
+      if (result.status === 'expired' || result.status === 'error') {
+        activeLogins.delete(key);
+        return result;
+      }
+
+      await new Promise<void>((r) => setTimeout(r, POLL_INTERVAL_MS));
+    }
+  } catch (err) {
+    console.error('[music-login] poll error:', err);
+    activeLogins.delete(key);
+    return {
+      status: 'error',
+      message: `轮询异常：${err instanceof Error ? err.message : String(err)}`,
+    };
+  }
+
+  activeLogins.delete(key);
+  return { status: 'expired', message: '登录超时，请重试' };
+}
+
+export function cleanExpiredLogins(): void {
+  const now = Date.now();
+  for (const [key, session] of activeLogins) {
+    if (now - session.timestamp > LOGIN_TIMEOUT_MS) {
+      session.aborted = true;
+      activeLogins.delete(key);
+    }
+  }
+}

package/src/login/netease.ts

@@ -0,0 +1,69 @@
+import type { QrLoginProvider, QrCreateResult, QrPollResult } from './types.js';
+import { extractSetCookies } from './types.js';
+
+const QR_IMAGE_API = 'https://api.qrserver.com/v1/create-qr-code/';
+
+export class NeteaseLoginProvider implements QrLoginProvider {
+  async createQr(): Promise<QrCreateResult> {
+    const timestampMs = Date.now();
+    const keyResp = await fetch(
+      `https://music.163.com/api/login/qrcode/unikey?type=1&timestamp=${timestampMs}`,
+      {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+        body: `type=1&timestamp=${timestampMs}`,
+      },
+    );
+    const keyData = (await keyResp.json()) as { code: number; unikey?: string };
+    if (keyData.code !== 200 || !keyData.unikey) {
+      throw new Error('获取网易云登录二维码失败');
+    }
+
+    const loginUrl = `https://music.163.com/login?codekey=${keyData.unikey}`;
+    const imageUrl = `${QR_IMAGE_API}?size=300x300&data=${encodeURIComponent(loginUrl)}`;
+
+    return {
+      imageSegment: { type: 'image', data: { url: imageUrl } },
+      pollData: { unikey: keyData.unikey },
+    };
+  }
+
+  async pollQr(pollData: Record<string, string>): Promise<QrPollResult> {
+    const { unikey } = pollData;
+    try {
+      const response = await fetch(
+        'https://music.163.com/api/login/qrcode/client/login',
+        {
+          method: 'POST',
+          headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+          body: `key=${unikey}&type=1`,
+        },
+      );
+      const data = (await response.json()) as { code: number; message?: string };
+
+      switch (data.code) {
+        case 801:
+          return { status: 'waiting', message: '等待扫码...' };
+        case 802:
+          return { status: 'scanned', message: '已扫码，请在手机上确认登录' };
+        case 800:
+          return { status: 'expired', message: '二维码已过期，请重新发起登录' };
+        case 803: {
+          const cookie = extractSetCookies(response.headers);
+          return {
+            status: 'confirmed',
+            message: '登录成功',
+            cookie: cookie || undefined,
+          };
+        }
+        default:
+          return { status: 'error', message: data.message ?? '未知状态' };
+      }
+    } catch (err) {
+      return {
+        status: 'error',
+        message: `轮询失败：${err instanceof Error ? err.message : String(err)}`,
+      };
+    }
+  }
+}