@live-game/sdk 0.5.0 → 2.0.0-dev.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +24 -0
- package/README.md +96 -19
- package/UPGRADING.md +36 -0
- package/dist/app/client.d.ts +112 -0
- package/dist/app/client.js +324 -0
- package/dist/app/contracts.d.ts +180 -0
- package/dist/app/contracts.js +41 -0
- package/dist/app/define-app.d.ts +99 -0
- package/dist/app/define-app.js +19 -0
- package/dist/app/images.d.ts +7 -0
- package/dist/app/images.js +61 -0
- package/dist/app/index.d.ts +7 -0
- package/dist/app/index.js +6 -0
- package/dist/app/live-events.d.ts +161 -0
- package/dist/app/live-events.js +15 -0
- package/dist/app/react.d.ts +101 -0
- package/dist/app/react.js +39 -0
- package/dist/app/types.d.ts +55 -0
- package/dist/app/types.js +1 -0
- package/dist/index.d.ts +1 -6
- package/dist/index.js +1 -5
- package/dist/room-snapshot.d.ts +33 -0
- package/dist/room-snapshot.js +1 -0
- package/package.json +45 -43
- package/dist/createSDK.d.ts +0 -9
- package/dist/createSDK.js +0 -17
- package/dist/mock/index.d.ts +0 -19
- package/dist/mock/index.js +0 -95
- package/dist/mock/platform.d.ts +0 -6
- package/dist/mock/platform.js +0 -45
- package/dist/react/index.d.ts +0 -6
- package/dist/react/index.js +0 -30
- package/dist/types.d.ts +0 -155
- package/dist/types.js +0 -11
package/dist/types.d.ts
DELETED
|
@@ -1,155 +0,0 @@
|
|
|
1
|
-
export interface BaseUserMessage {
|
|
2
|
-
id: string;
|
|
3
|
-
userId: string;
|
|
4
|
-
nickname: string;
|
|
5
|
-
avatar?: string;
|
|
6
|
-
timestamp: number;
|
|
7
|
-
}
|
|
8
|
-
export interface DanmakuMessage extends BaseUserMessage {
|
|
9
|
-
content: string;
|
|
10
|
-
similarity?: number;
|
|
11
|
-
}
|
|
12
|
-
export type CommentMessage = DanmakuMessage;
|
|
13
|
-
export interface GiftMessage extends BaseUserMessage {
|
|
14
|
-
giftId: string;
|
|
15
|
-
giftName?: string;
|
|
16
|
-
count: number;
|
|
17
|
-
diamondValue: number;
|
|
18
|
-
comboId?: string;
|
|
19
|
-
}
|
|
20
|
-
export interface LikeMessage extends BaseUserMessage {
|
|
21
|
-
count: number;
|
|
22
|
-
}
|
|
23
|
-
export type SocialMessage = BaseUserMessage & {
|
|
24
|
-
type: "enter" | "follow" | "share" | "fansclub";
|
|
25
|
-
target?: string;
|
|
26
|
-
count?: number;
|
|
27
|
-
action?: number;
|
|
28
|
-
content?: string;
|
|
29
|
-
};
|
|
30
|
-
export type RoomStatsMessage = {
|
|
31
|
-
id: string;
|
|
32
|
-
roomId: string;
|
|
33
|
-
online: number;
|
|
34
|
-
totalViewers?: number;
|
|
35
|
-
timestamp: number;
|
|
36
|
-
};
|
|
37
|
-
export interface RoomInfo {
|
|
38
|
-
roomId: string;
|
|
39
|
-
title: string;
|
|
40
|
-
streamerNickname: string;
|
|
41
|
-
onlineCount: number;
|
|
42
|
-
}
|
|
43
|
-
export type EventHandler<T> = (data: T) => void;
|
|
44
|
-
export interface StorageAPI {
|
|
45
|
-
get(key: string): Promise<string | null>;
|
|
46
|
-
set(key: string, value: string): Promise<void>;
|
|
47
|
-
delete(key: string): Promise<void>;
|
|
48
|
-
}
|
|
49
|
-
export type GameConfig = Record<string, unknown>;
|
|
50
|
-
export type ConfigSchema = Record<string, {
|
|
51
|
-
type: string;
|
|
52
|
-
label?: string;
|
|
53
|
-
description?: string;
|
|
54
|
-
default?: unknown;
|
|
55
|
-
required?: boolean;
|
|
56
|
-
enum?: unknown[];
|
|
57
|
-
[key: string]: unknown;
|
|
58
|
-
}>;
|
|
59
|
-
export interface ConfigAPI {
|
|
60
|
-
get(): Promise<GameConfig>;
|
|
61
|
-
/** @deprecated 平台只有一份当前有效配置,请使用 get()。 */
|
|
62
|
-
getDefault(): Promise<GameConfig>;
|
|
63
|
-
update(config: GameConfig): Promise<void>;
|
|
64
|
-
}
|
|
65
|
-
export interface GameCommand {
|
|
66
|
-
type: string;
|
|
67
|
-
payload?: unknown;
|
|
68
|
-
}
|
|
69
|
-
export interface CommandAPI {
|
|
70
|
-
send(cmd: GameCommand): Promise<void>;
|
|
71
|
-
}
|
|
72
|
-
export interface SettleResult {
|
|
73
|
-
playerId: string;
|
|
74
|
-
score: number;
|
|
75
|
-
rank?: number;
|
|
76
|
-
}
|
|
77
|
-
export interface ReportAPI {
|
|
78
|
-
score(playerId: string, score: number): Promise<void>;
|
|
79
|
-
settle(results: SettleResult[]): Promise<void>;
|
|
80
|
-
}
|
|
81
|
-
export interface RoomAPI {
|
|
82
|
-
getInfo(): Promise<RoomInfo>;
|
|
83
|
-
}
|
|
84
|
-
export interface StateAPI {
|
|
85
|
-
/** 发布当前游戏状态,供控制端 useGameState() 读取 */
|
|
86
|
-
publish(state: unknown): Promise<void>;
|
|
87
|
-
}
|
|
88
|
-
/** 定时器事件 */
|
|
89
|
-
export interface TimerEvent {
|
|
90
|
-
key: string;
|
|
91
|
-
}
|
|
92
|
-
/** 自定义广播事件 */
|
|
93
|
-
export interface BroadcastEvent {
|
|
94
|
-
type: string;
|
|
95
|
-
data: unknown;
|
|
96
|
-
}
|
|
97
|
-
export interface PlatformAPI {
|
|
98
|
-
/** 语义相似度(0~1),调用平台 AI 模型 */
|
|
99
|
-
similarity(text1: string, text2: string): Promise<number>;
|
|
100
|
-
/** 平台级精确定时器(不受浏览器节流),到期后触发 timer 事件 */
|
|
101
|
-
timer(key: string, durationMs: number): Promise<void>;
|
|
102
|
-
/** TTS 语音播报 */
|
|
103
|
-
tts(text: string, options?: {
|
|
104
|
-
priority?: "high" | "normal";
|
|
105
|
-
}): Promise<void>;
|
|
106
|
-
/** 动态能力调用(平台新增能力时,老 SDK 无需升级) */
|
|
107
|
-
call(method: string, ...args: unknown[]): Promise<unknown>;
|
|
108
|
-
}
|
|
109
|
-
/** 平台连接就绪时触发(connect 成功后) */
|
|
110
|
-
export type ReadyHandler = () => void;
|
|
111
|
-
/** 与平台断开连接时触发 */
|
|
112
|
-
export type DisconnectHandler = (reason?: string) => void;
|
|
113
|
-
/** 平台错误 */
|
|
114
|
-
export type ErrorHandler = (error: PlatformError) => void;
|
|
115
|
-
export declare class PlatformError extends Error {
|
|
116
|
-
code: "TIMEOUT" | "RATE_LIMIT" | "AUTH_EXPIRED" | "CAPABILITY_DISABLED" | "NETWORK_ERROR" | "UNKNOWN";
|
|
117
|
-
statusCode?: number;
|
|
118
|
-
constructor(message: string, code: PlatformError["code"], statusCode?: number);
|
|
119
|
-
}
|
|
120
|
-
export interface LiveGameSDK {
|
|
121
|
-
/** SDK 版本号 */
|
|
122
|
-
readonly version: string;
|
|
123
|
-
/** 稳定的宿主通信协议版本;同一主版本内只做兼容性扩展。 */
|
|
124
|
-
readonly apiVersion: string;
|
|
125
|
-
/** 检测平台是否支持指定能力 */
|
|
126
|
-
supports(capability: string): boolean;
|
|
127
|
-
/** SDK 就绪回调 */
|
|
128
|
-
onReady(handler: ReadyHandler): void;
|
|
129
|
-
/** 断开连接回调 */
|
|
130
|
-
onDisconnect(handler: DisconnectHandler): void;
|
|
131
|
-
/** 错误回调 */
|
|
132
|
-
onError(handler: ErrorHandler): void;
|
|
133
|
-
on(event: 'danmaku' | 'comment', handler: EventHandler<DanmakuMessage>): void;
|
|
134
|
-
on(event: 'gift', handler: EventHandler<GiftMessage>): void;
|
|
135
|
-
on(event: 'like', handler: EventHandler<LikeMessage>): void;
|
|
136
|
-
on(event: 'roomInfo', handler: EventHandler<RoomInfo>): void;
|
|
137
|
-
on(event: 'room_stats', handler: EventHandler<RoomStatsMessage>): void;
|
|
138
|
-
on(event: 'enter' | 'follow' | 'share' | 'fansclub', handler: EventHandler<SocialMessage>): void;
|
|
139
|
-
on(event: 'live_event' | 'theme_change' | 'game_state' | 'config' | 'command', handler: EventHandler<unknown>): void;
|
|
140
|
-
on(event: 'timer', handler: EventHandler<TimerEvent>): void;
|
|
141
|
-
on(event: 'broadcast', handler: EventHandler<BroadcastEvent>): void;
|
|
142
|
-
on<T = unknown>(event: string, handler: EventHandler<T>): void;
|
|
143
|
-
off(event: string, handler: EventHandler<any>): void;
|
|
144
|
-
storage: StorageAPI;
|
|
145
|
-
config: ConfigAPI;
|
|
146
|
-
command: CommandAPI;
|
|
147
|
-
report: ReportAPI;
|
|
148
|
-
room: RoomAPI;
|
|
149
|
-
state: StateAPI;
|
|
150
|
-
platform: PlatformAPI;
|
|
151
|
-
/** 广播自定义事件给所有客户端 */
|
|
152
|
-
broadcast(type: string, data?: unknown): Promise<void>;
|
|
153
|
-
/** 连接直播事件流 */
|
|
154
|
-
connect(): Promise<void>;
|
|
155
|
-
}
|
package/dist/types.js
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
// ===== 事件类型 =====
|
|
2
|
-
// ===== 标准错误 =====
|
|
3
|
-
export class PlatformError extends Error {
|
|
4
|
-
constructor(message, code, statusCode) {
|
|
5
|
-
super(message);
|
|
6
|
-
this.name = "PlatformError";
|
|
7
|
-
this.code = code;
|
|
8
|
-
this.statusCode = statusCode;
|
|
9
|
-
}
|
|
10
|
-
}
|
|
11
|
-
// CreateSDKOptions 已移除 —— createSDK() 不再接受参数,Mock 使用 createMockSDK()
|