lx-source-type 2.0.0 → 2.0.2

package/define.d.ts

@@ -1,5 +1,5 @@
-import type { LX } from "./type"
-
-declare global {
-    var lx: LX.API
+import type { LX } from "./type"
+
+declare global {
+    var lx: LX.API
 }

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "lx-source-type",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "type": "module",
   "author": "Ceale",
   "license": "MIT",
+  "repository": "https://github.com/Ceale/lx-source-type.git",
   "exports": {
     ".": {
       "types": "./type.d.ts"
@@ -14,7 +15,7 @@
   },
   "files": [
     "README.md",
-    "index.d.ts",
+    "type.d.ts",
     "define.d.ts"
   ],
   "peerDependencies": {

package/type.d.ts

@@ -0,0 +1,166 @@
+import type { WithImplicitCoercion } from "node:buffer"
+import type Zlib from "node:zlib"
+
+/**
+ * LX Music 自定义源 API 类型定义
+ */
+export declare namespace LX {
+    export type Quality = "128k" | "320k" | "flac" | "flac24bit"
+    export type NetAction = "musicUrl" | "lyric" | "pic"
+    export type SupportPlatform = "kw" | "kg" | "tx" | "wy" | "mg" | "local"
+
+    export interface MusicInfo {
+        name: string
+        singer: string
+        interval: string
+
+        source: SupportPlatform
+        songmid: string
+
+        img: string
+        albumName: string
+
+        /** 仅限酷狗 */
+        hash?: string
+        /** 仅限咪咕 */
+        copyrightId?: string
+        
+        [key: string]: any
+    }
+
+    export interface LyricResult {
+        lyric: string
+        tlyric?: string | null
+        rlyric?: string | null
+        lxlyric?: string | null
+    }
+
+    export interface RequestOptions {
+        /** 默认为 Get */
+        method?: string
+        headers?: Record<string, string>
+        body?: any
+        form?: Record<string, any>
+        formData?: Record<string, any>
+        timeout?: number
+    }
+
+    export interface RequestResponse {
+        statusCode: number
+        statusMessage: string
+        headers: Record<string, string | string[] | undefined>
+        bytes?: number,
+        raw?: Uint8Array,
+        body: any
+    }
+
+    export interface SourceInfo {
+        name: string
+        type: "music"
+        actions: NetAction[]
+        qualitys: Quality[]
+    }
+
+    export interface InitedPayload {
+        sources: Partial<Record<SupportPlatform, SourceInfo>>
+        openDevTools?: boolean
+    }
+
+    export interface UpdateAlertPayload {
+        log: string
+        updateUrl?: string
+    }
+
+    export interface Provider {
+        (params: ProviderParams): Promise<ProviderResult>
+    }
+
+    export interface ProviderParams {
+        source: SupportPlatform
+        action: NetAction
+        info: {
+            type?:  Quality | null
+            musicInfo: MusicInfo
+        }
+    }
+    
+    export type ProviderResult = string | {
+        lyric: string,
+        tlyric: string | null
+        rlyric: string | null
+        lxlyric: string | null
+    }
+
+    export interface EVENT_NAMES {
+        inited: "inited"
+        request: "request"
+        updateAlert: "updateAlert"
+    }
+
+    export interface Utils {
+        buffer: {
+            from: typeof Buffer.from
+            bufToString(buffer: WithImplicitCoercion<ArrayLike<number> | string>, format: BufferEncoding): string
+        }
+        crypto: {
+            aesEncrypt(buffer: BinaryLike, mode: string, key: string, iv: string): Buffer
+            rsaEncrypt(buffer: any, key: string): Buffer
+            randomBytes(size: number): Uint8Array
+            /** 返回 hex 字符串 */
+            md5(str: string): string
+        }
+        zlib: {
+            inflate(buffer: Zlib.InputType): Promise<NonSharedBuffer>
+            deflate(buffer: Zlib.InputType): Promise<NonSharedBuffer>
+        }
+    }
+
+    /** 当前脚本信息 */
+    export interface ScriptInfo {
+        name: string
+        description: string
+        version: string
+        author: string
+        homepage: string
+        rawScript: string
+    }
+
+    export interface RequestCallback {
+        (err: null, resp: RequestResponse | null, body: any): void
+    }
+
+    export interface OnEvent {
+        (eventName: EVENT_NAMES["request"], handler: Provider): Promise<void>
+    }
+
+    export interface SendEvent {
+        (eventName: EVENT_NAMES["inited"], data: InitedPayload): Promise<void>
+        (eventName: EVENT_NAMES["updateAlert"], data: UpdateAlertPayload): Promise<void>
+    }
+
+    export interface Request {
+        (
+            url: string,
+            options: RequestOptions,
+            callback: RequestCallback
+        ): () => void
+    }
+
+    export interface API {
+        /** API 版本号 */
+        version: "2.0.0"
+        /** 运行环境 */
+        env: "desktop" | "mobile"
+        currentScriptInfo: ScriptInfo
+        /** 常量事件名 */
+        EVENT_NAMES: EVENT_NAMES
+        /** 注册事件监听 */
+        on: OnEvent
+        /** 发送事件 */
+        send: SendEvent
+        /** HTTP 请求方法 */
+        request: Request
+        /** 工具方法 */
+        utils: Utils
+    }
+}