lx-source-type 2.0.3 → 2.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 筱莱Ceale
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lx-source-type",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "type": "module",
   "author": "Ceale",
   "license": "MIT",

package/type.d.ts

@@ -1,13 +1,30 @@
 import type { WithImplicitCoercion } from "node:buffer"
+import type { BinaryLike } from "node:crypto"
 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 type NetAction = "musicUrl" | "lyric" | "pic"
+    export type Quality = "128k" | "320k" | "flac" | "flac24bit"
+
+    /** 当前脚本信息 */
+    export interface ScriptInfo {
+        name: string
+        description: string
+        version: string
+        author: string
+        homepage: string
+        rawScript: string
+    }
+
+    export interface EVENT_NAMES {
+        inited: "inited"
+        request: "request"
+        updateAlert: "updateAlert"
+    }
 
     export interface MusicInfo {
         name: string
@@ -28,30 +45,30 @@ export declare namespace LX {
         [key: string]: any
     }
 
+    export interface ProviderParams {
+        source: SupportPlatform
+        action: NetAction
+        info: {
+            type?:  Quality | null
+            musicInfo: MusicInfo
+        }
+    }
+
     export interface LyricResult {
         lyric: string
         tlyric?: string | null
         rlyric?: string | null
         lxlyric?: string | null
     }
+    
+    export type ProviderResult = string | LyricResult
 
-    export interface RequestOptions {
-        /** 默认为 Get */
-        method?: string
-        headers?: Record<string, string>
-        body?: any
-        form?: Record<string, any>
-        formData?: Record<string, any>
-        timeout?: number
+    export interface Provider {
+        (params: ProviderParams): Promise<ProviderResult>
     }
 
-    export interface RequestResponse {
-        statusCode: number
-        statusMessage: string
-        headers: Record<string, string | string[] | undefined>
-        bytes?: number,
-        raw?: Uint8Array,
-        body: any
+    export interface OnEvent {
+        (eventName: EVENT_NAMES["request"], handler: Provider): Promise<void>
     }
 
     export interface SourceInfo {
@@ -71,30 +88,44 @@ export declare namespace LX {
         updateUrl?: string
     }
 
-    export interface Provider {
-        (params: ProviderParams): Promise<ProviderResult>
+    export interface EventPayloadMap {
+        "inited": InitedPayload
+        "updateAlert": UpdateAlertPayload
     }
 
-    export interface ProviderParams {
-        source: SupportPlatform
-        action: NetAction
-        info: {
-            type?:  Quality | null
-            musicInfo: MusicInfo
-        }
+    export interface SendEvent {
+        <K extends keyof EventPayloadMap>(eventName: K, payload: EventPayloadMap[K]): Promise<void>
     }
-    
-    export type ProviderResult = string | {
-        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 EVENT_NAMES {
-        inited: "inited"
-        request: "request"
-        updateAlert: "updateAlert"
+    export interface RequestResponse {
+        statusCode: number
+        statusMessage: string
+        headers: Record<string, string | string[] | undefined>
+        bytes?: number,
+        raw?: Uint8Array,
+        body: any
+    }
+
+    export interface RequestCallback {
+        (err: any, resp: RequestResponse | null, body: any): void
+    }
+
+    export interface Request {
+        (
+            url: string,
+            options: RequestOptions,
+            callback: RequestCallback
+        ): () => void
     }
 
     export interface Utils {
@@ -115,37 +146,6 @@ export declare namespace LX {
         }
     }
 
-    /** 当前脚本信息 */
-    export interface ScriptInfo {
-        name: string
-        description: string
-        version: string
-        author: string
-        homepage: string
-        rawScript: string
-    }
-
-    export interface RequestCallback {
-        (err: any, 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"
@@ -163,4 +163,15 @@ export declare namespace LX {
         /** 工具方法 */
         utils: Utils
     }
-}
+}
+
+const a = {} as LX.SendEvent
+
+a("inited", {
+    
+})
+
+a("updateAlert", {
+    log: "log",
+    updateUrl: "updateUrl"
+})