inki-music-api 2.0.0

package/dist/source-loader.js

@@ -0,0 +1,141 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SourceLoader = exports.SourceInstance = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const vm_1 = __importDefault(require("vm"));
+const lx_runtime_1 = require("./lx-runtime");
+const parseMeta = (code) => {
+    const meta = {};
+    const lines = code.split('\n').slice(0, 40);
+    for (const line of lines) {
+        const matched = line.match(/@(name|description|version|author|homepage)\s+(.+)/);
+        if (matched)
+            meta[matched[1]] = matched[2].trim();
+    }
+    return meta;
+};
+const createSandbox = (runtime) => {
+    const sandbox = {
+        lx: runtime.lx,
+        console,
+        setTimeout,
+        clearTimeout,
+        setInterval,
+        clearInterval,
+        Promise,
+        Buffer,
+        process,
+        URL,
+        URLSearchParams,
+        TextEncoder,
+        TextDecoder,
+        isNaN,
+        isFinite,
+        parseInt,
+        parseFloat,
+        JSON,
+        Object,
+        Array,
+        Number,
+        String,
+        Boolean,
+        Math,
+        Date,
+        Error,
+        TypeError,
+        RangeError,
+        RegExp,
+        Map,
+        Set,
+        WeakMap,
+        WeakSet,
+        Symbol,
+        Proxy,
+        Reflect,
+        ArrayBuffer,
+        Uint8Array,
+        Int8Array,
+        Uint16Array,
+        Int16Array,
+        Uint32Array,
+        Int32Array,
+        Float32Array,
+        Float64Array,
+    };
+    Object.defineProperty(sandbox, 'globalThis', {
+        enumerable: true,
+        get() {
+            return sandbox;
+        },
+    });
+    return sandbox;
+};
+class SourceInstance {
+    constructor(runtime, initedData, meta) {
+        this.runtime = runtime;
+        this.meta = meta;
+        this.sources = initedData.sources || {};
+    }
+    dispatch(source, action, info) {
+        return this.runtime.dispatch(lx_runtime_1.EVENT_NAMES.request, { source, action, info });
+    }
+    getMusicUrl(source, musicInfo, quality = '128k') {
+        return this.dispatch(source, 'musicUrl', { type: quality, musicInfo });
+    }
+    getLyric(source, musicInfo) {
+        return this.dispatch(source, 'lyric', { musicInfo });
+    }
+    getPic(source, musicInfo) {
+        return this.dispatch(source, 'pic', { musicInfo });
+    }
+    search(source, keywords, page = 1, limit = 20) {
+        return this.dispatch(source, 'search', { keywords, page, limit });
+    }
+    getHot(source, page = 1, limit = 20) {
+        return this.dispatch(source, 'hot', { page, limit });
+    }
+    getRank(source, rankType, page = 1, limit = 20) {
+        return this.dispatch(source, 'rank', { rankType, page, limit });
+    }
+    dispatchAction(source, action, info) {
+        return this.dispatch(source, action, info);
+    }
+}
+exports.SourceInstance = SourceInstance;
+class SourceLoader {
+    constructor(httpClient, options) {
+        this.httpClient = httpClient;
+        this.options = options;
+    }
+    updateOptions(options) {
+        this.options = { ...this.options, ...options };
+    }
+    async loadFromFile(scriptPath) {
+        const resolved = path_1.default.resolve(scriptPath);
+        if (!fs_1.default.existsSync(resolved))
+            throw new Error(`[inki-music-api] 源脚本不存在: ${resolved}`);
+        const code = fs_1.default.readFileSync(resolved, 'utf-8');
+        return this.loadFromCode(code);
+    }
+    async loadFromCode(code) {
+        const runtime = new lx_runtime_1.LxRuntime(this.httpClient);
+        const meta = parseMeta(code);
+        meta.rawScript = code;
+        runtime.lx.currentScriptInfo = meta;
+        const sandbox = createSandbox(runtime);
+        vm_1.default.createContext(sandbox);
+        try {
+            vm_1.default.runInContext(code, sandbox, { filename: 'lx-source.js', timeout: 5000 });
+        }
+        catch (error) {
+            throw new Error(`[inki-music-api] 源脚本执行出错: ${error.message}`);
+        }
+        const initedData = await runtime.waitForInited(this.options.initTimeout);
+        return new SourceInstance(runtime, initedData, meta);
+    }
+}
+exports.SourceLoader = SourceLoader;

package/dist/types.d.ts

@@ -0,0 +1,330 @@
+export type SourceKey = 'kw' | 'kg' | 'tx' | 'wy' | 'mg' | string;
+export type ApiErrorCode = 'E_SOURCE_INIT' | 'E_SOURCE_UNSUPPORTED' | 'E_REQUEST_FAILED' | 'E_REMOTE_SOURCE_INVALID' | 'E_TIMEOUT' | 'E_RATE_LIMIT' | 'E_UPSTREAM';
+export declare const SUPPORTED_PLATFORMS: readonly ["kg", "kw", "tx", "wy", "mg"];
+export type SupportedPlatform = (typeof SUPPORTED_PLATFORMS)[number];
+export type MusicQuality = '128k' | '320k' | 'flac' | 'flac24bit' | string;
+export interface RequestOptions {
+    /** 请求方法，如 GET / POST */
+    method?: string;
+    /** 请求头 */
+    headers?: Record<string, string | number>;
+    /** JSON 请求体 */
+    body?: unknown;
+    /** form 请求体 */
+    form?: Record<string, unknown>;
+    /** 超时时间（毫秒） */
+    timeout?: number;
+    /** 最大重定向次数 */
+    follow_max?: number;
+    /** 是否校验证书 */
+    rejectUnauthorized?: boolean;
+}
+export interface RetryConfig {
+    /** 最大重试次数 */
+    retries?: number;
+    /** 初始重试延时（毫秒） */
+    retryDelayMs?: number;
+    /** 触发重试的 HTTP 状态码 */
+    retryStatusCodes?: number[];
+    /** 触发重试的错误码 */
+    retryErrorCodes?: string[];
+}
+export interface CacheConfig {
+    /** 是否启用内存缓存 */
+    enabled?: boolean;
+    /** 默认缓存时长（毫秒） */
+    ttlMs?: number;
+    /** 最大缓存键数量 */
+    maxEntries?: number;
+}
+export interface RequestResponse<T = unknown> {
+    /** HTTP 状态码 */
+    statusCode: number;
+    /** 响应头 */
+    headers: Record<string, unknown>;
+    /** 响应体 */
+    body: T;
+}
+export interface SourceScriptMeta {
+    /** 源脚本名称 */
+    name?: string;
+    /** 源脚本描述 */
+    description?: string;
+    /** 源脚本版本 */
+    version?: string;
+    /** 作者 */
+    author?: string;
+    /** 项目主页 */
+    homepage?: string;
+    /** 原始脚本文本 */
+    rawScript?: string;
+}
+export interface SourceInfo {
+    /** 源展示名称 */
+    name?: string;
+    /** 源类型，一般为 music */
+    type?: string;
+    /** 支持的动作列表，如 musicUrl/search */
+    actions?: string[];
+    /** 支持的音质列表 */
+    qualitys?: MusicQuality[];
+}
+export interface SourceInitData {
+    /** 源能力映射表 */
+    sources?: Record<string, SourceInfo>;
+    /** 其它扩展字段 */
+    [key: string]: unknown;
+}
+export interface MusicTypeInfo {
+    /** 音质类型 */
+    type: MusicQuality;
+    /** 体积描述（如 4.5MB） */
+    size: string | null;
+    /** 对应音质的 hash（部分源需要） */
+    hash?: string;
+}
+export interface MusicLyric {
+    /** 原文歌词 */
+    lyric: string;
+    /** 翻译歌词 */
+    tlyric: string;
+    /** 音译歌词 */
+    rlyric: string;
+    /** LX 扩展歌词 */
+    lxlyric: string;
+}
+export interface MusicInfo {
+    /** 榜单中的排名 */
+    rank?: number;
+    /** 歌曲主键（跨平台唯一性由 source + songmid 决定） */
+    songmid: string;
+    /** 平台来源 */
+    source: SourceKey;
+    /** 歌曲名 */
+    name: string;
+    /** 歌手名 */
+    singer: string;
+    /** 专辑名 */
+    albumName: string;
+    /** 专辑 ID */
+    albumId?: string;
+    /** 时长，格式 mm:ss */
+    interval: string;
+    /** 封面链接 */
+    img: string | null;
+    /** 兼容字段，歌词链接或内容 */
+    lrc?: string | null;
+    /** 当前歌曲可用音质列表 */
+    types: MusicTypeInfo[];
+    /** 音质索引映射 */
+    _types: Record<string, {
+        size: string | null;
+        hash?: string;
+    }>;
+    /** 不同音质的已解析直链缓存 */
+    typeUrl: Record<string, string>;
+    /** 平台哈希（如 kg） */
+    hash?: string;
+    /** 秒级时长（用于歌词接口） */
+    _interval?: number;
+    /** 平台歌曲数字 ID（如 tx） */
+    songId?: number;
+    /** 专辑 mid（如 tx） */
+    albumMid?: string;
+    /** 媒体 mid（如 tx） */
+    strMediaMid?: string;
+    /** 平台版权 ID（如 mg） */
+    copyrightId?: string;
+    /** 原文歌词链接 */
+    lrcUrl?: string;
+    /** 逐字歌词链接 */
+    mrcUrl?: string;
+    /** 翻译歌词链接 */
+    trcUrl?: string;
+}
+export interface SearchResult {
+    /** 当前页歌曲列表 */
+    list: MusicInfo[];
+    /** 总页数 */
+    allPage: number;
+    /** 总条数 */
+    total: number;
+    /** 每页条数 */
+    limit: number;
+    /** 平台来源 */
+    source: SourceKey;
+}
+export interface RankResult {
+    /** 榜单类型 */
+    rankType: string;
+    /** 总条数 */
+    total: number;
+    /** 当前榜单歌曲 */
+    list: MusicInfo[];
+    /** 页码 */
+    page: number;
+    /** 每页条数 */
+    limit: number;
+    /** 平台来源 */
+    source: SourceKey;
+}
+export interface SongListItem {
+    /** 歌单 ID */
+    id: string;
+    /** 歌单名 */
+    name: string;
+    /** 作者 */
+    author: string;
+    /** 封面 */
+    img: string;
+    /** 描述 */
+    desc: string;
+    /** 播放量文本 */
+    play_count: string;
+    /** 歌曲总数 */
+    total?: number;
+    /** 更新时间 */
+    time?: string;
+    /** 平台 */
+    source: SourceKey;
+}
+export interface SongListTag {
+    /** 标签 ID */
+    id: string;
+    /** 标签名 */
+    name: string;
+    /** 父级 ID */
+    parent_id?: string;
+    /** 父级名称 */
+    parent_name?: string;
+    /** 平台 */
+    source: SourceKey;
+}
+export interface SongListTagGroup {
+    /** 分组名 */
+    name: string;
+    /** 分组标签 */
+    list: SongListTag[];
+}
+export interface SongListTagResult {
+    /** 全量标签分组 */
+    tags: SongListTagGroup[];
+    /** 热门标签 */
+    hotTag: SongListTag[];
+    /** 平台 */
+    source: SourceKey;
+}
+export interface SongListResult {
+    /** 当前页歌单 */
+    list: SongListItem[];
+    /** 总条数 */
+    total: number;
+    /** 页码 */
+    page: number;
+    /** 每页条数 */
+    limit: number;
+    /** 平台 */
+    source: SourceKey;
+}
+export interface SongListDetailInfo {
+    /** 歌单名 */
+    name: string;
+    /** 封面 */
+    img: string;
+    /** 描述 */
+    desc: string;
+    /** 创建者 */
+    author: string;
+    /** 播放量 */
+    play_count: string;
+}
+export interface SongListDetailResult {
+    /** 歌单内歌曲 */
+    list: MusicInfo[];
+    /** 页码 */
+    page: number;
+    /** 每页条数 */
+    limit: number;
+    /** 歌曲总数 */
+    total: number;
+    /** 平台 */
+    source: SourceKey;
+    /** 歌单信息 */
+    info: SongListDetailInfo;
+}
+export interface CommentItem {
+    /** 评论 ID */
+    id: string;
+    /** 评论正文 */
+    text: string;
+    /** 时间戳 */
+    time: number;
+    /** 时间文本 */
+    timeStr: string;
+    /** 用户昵称 */
+    userName: string;
+    /** 用户头像 */
+    avatar: string;
+    /** 用户 ID */
+    userId: string;
+    /** 点赞数 */
+    likedCount: number;
+}
+export interface CommentResult {
+    /** 平台 */
+    source: SourceKey;
+    /** 评论列表 */
+    comments: CommentItem[];
+    /** 总条数 */
+    total: number;
+    /** 页码 */
+    page: number;
+    /** 每页条数 */
+    limit: number;
+    /** 总页数 */
+    maxPage: number;
+}
+export interface MusicApiConfig {
+    /** 源初始化超时（毫秒） */
+    initTimeout?: number;
+    /** 请求超时（毫秒） */
+    requestTimeout?: number;
+    /** 最大重定向次数 */
+    followMaxRedirects?: number;
+    /** 是否校验证书 */
+    rejectUnauthorized?: boolean;
+    /** HTTP 重试配置 */
+    retry?: RetryConfig;
+    /** 内存缓存配置 */
+    cache?: CacheConfig;
+}
+export interface SearchOptions {
+    /** 页码 */
+    page?: number;
+    /** 每页条数 */
+    limit?: number;
+}
+export interface RemoteSourceOptions {
+    /** 请求头 */
+    headers?: Record<string, string | number>;
+    /** 超时（毫秒） */
+    timeout?: number;
+    /** 是否校验证书 */
+    rejectUnauthorized?: boolean;
+}
+export interface SourceCapabilities {
+    search: boolean;
+    musicUrl: boolean;
+    lyric: boolean;
+    pic: boolean;
+    hot: boolean;
+    rank: boolean;
+    songListTags: boolean;
+    songList: boolean;
+    songListDetail: boolean;
+    comment: boolean;
+    hotComment: boolean;
+    searchMusic: boolean;
+    findMusic: boolean;
+    dispatch: boolean;
+}

package/dist/types.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUPPORTED_PLATFORMS = void 0;
+exports.SUPPORTED_PLATFORMS = ['kg', 'kw', 'tx', 'wy', 'mg'];

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "inki-music-api",
+  "version": "2.0.0",
+  "description": "lx-music 自定义源 TypeScript + axios 封装，支持 MusicApi class 与外部源加载",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint": "eslint \"src/**/*.ts\"",
+    "format": "prettier --write \"src/**/*.{ts,js}\" \"test/**/*.{ts,js}\" README.md",
+    "format:check": "prettier --check \"src/**/*.{ts,js}\" \"test/**/*.{ts,js}\" README.md",
+    "test": "ts-node test/demo.ts",
+    "prepublishOnly": "npm run format:check && npm run lint && npm run typecheck && npm run build",
+    "publish:dry": "npm publish --dry-run",
+    "publish:latest": "npm publish --access public",
+    "release:patch": "npm version patch && npm run publish:latest",
+    "release:minor": "npm version minor && npm run publish:latest",
+    "release:major": "npm version major && npm run publish:latest"
+  },
+  "files": [
+    "dist",
+    "src/sources",
+    "README.md"
+  ],
+  "dependencies": {
+    "axios": "^1.11.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.18.8",
+    "@typescript-eslint/eslint-plugin": "^8.30.1",
+    "@typescript-eslint/parser": "^8.30.1",
+    "eslint": "^8.57.1",
+    "prettier": "^3.6.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  },
+  "keywords": [
+    "lx-music",
+    "music",
+    "api",
+    "custom-source"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT"
+}