@fraqjs/fraq 0.10.2 → 0.11.0

package/dist/index.d.mts

@@ -405,7 +405,7 @@ declare namespace types_d_exports {
   };
 }
 declare const milkyVersion = '1.3';
-declare const milkyPackageVersion = '1.3.0-rc.1';
+declare const milkyPackageVersion = '1.3.0-rc.2';
 /** 机器人离线事件 */
 interface BotOfflineEvent {
   /** 数据类型区分字段，表示自身为机器人离线事件 */
@@ -2846,7 +2846,7 @@ interface GetImplInfoOutput {
     | 'iphone'
     | 'harmony'
     | 'watch';
-  /** 协议端实现的 Milky 协议版本，目前为 "1.2" */
+  /** 协议端实现的 Milky 协议版本，目前为 "1.3" */
   milky_version: string;
 }
 /** 获取协议端信息 API 响应数据 */
@@ -2868,7 +2868,7 @@ interface GetImplInfoOutput_ZodInput {
     | 'iphone'
     | 'harmony'
     | 'watch';
-  /** 协议端实现的 Milky 协议版本，目前为 "1.2" */
+  /** 协议端实现的 Milky 协议版本，目前为 "1.3" */
   milky_version: string;
 }
 /** 获取用户个人信息 API 请求参数 */
@@ -4151,6 +4151,8 @@ interface GetPrivateFileDownloadUrlInput {
   file_id: string;
   /** 文件的 TriSHA1 哈希值 */
   file_hash: string;
+  /** 是否为自己发送的文件 */
+  is_self_send: boolean;
 }
 /** 获取私聊文件下载链接 API 请求参数 */
 interface GetPrivateFileDownloadUrlInput_ZodInput {
@@ -4160,6 +4162,8 @@ interface GetPrivateFileDownloadUrlInput_ZodInput {
   file_id: string;
   /** 文件的 TriSHA1 哈希值 */
   file_hash: string;
+  /** 是否为自己发送的文件 */
+  is_self_send?: boolean | null | undefined;
 }
 /** 获取私聊文件下载链接 API 响应数据 */
 interface GetPrivateFileDownloadUrlOutput {
@@ -5396,13 +5400,7 @@ type EventMap = {
 };
 //#endregion
 //#region src/protocol/client.d.ts
-interface MilkyEventSubscription {
-  closed: Promise<void>;
-  stop(): void | Promise<void>;
-}
-interface MilkyClient extends ApiEndpoints {
-  startEvents(onEvent: (event: Event) => void | Promise<void>): Promise<MilkyEventSubscription>;
-}
+interface MilkyClient extends ApiEndpoints {}
 declare class MilkyClientBase {
   readonly baseUrl: string;
   readonly wsBaseUrl: string;
@@ -5415,10 +5413,26 @@ declare class MilkyClientBase {
     },
   );
   callApi(endpoint: string, params?: unknown): Promise<unknown>;
-  startEvents(onEvent: (event: Event) => void | Promise<void>): Promise<MilkyEventSubscription>;
 }
 declare function createMilkyClient(...params: ConstructorParameters<typeof MilkyClientBase>): MilkyClient;
 //#endregion
+//#region src/protocol/event.d.ts
+interface MilkyEventSubscription {
+  closed: Promise<void>;
+  stop(): void | Promise<void>;
+}
+interface MilkyEventSource {
+  readonly name?: string;
+  start(onEvent: (event: Event) => void | Promise<void>): Promise<MilkyEventSubscription>;
+}
+interface MilkyWebSocketEventSourceOptions {
+  accessToken?: string;
+}
+declare function createMilkyWebSocketEventSource(
+  baseUrl: string | URL,
+  options?: MilkyWebSocketEventSourceOptions,
+): MilkyEventSource;
+//#endregion
 //#region src/routing/tokenizer.d.ts
 type Token =
   | string
@@ -5486,6 +5500,8 @@ declare class Parameter<T> {
   description?: string;
   constructor(capturer: Capturer<T>);
   describe(description: string): this;
+  refine<U extends T>(predicate: (value: T) => value is U): Parameter<U>;
+  refine(predicate: (value: T) => boolean): Parameter<T>;
 }
 declare namespace param {
   function literal<T extends string>(literal: T): Parameter<T>;
@@ -5527,6 +5543,7 @@ interface SessionReplyOptions {
   withMention?: boolean;
 }
 interface Session {
+  selfId: number;
   raw: IncomingMessage;
   reply(
     textOrSegments: string | OutgoingSegment_ZodInput[],
@@ -5717,6 +5734,7 @@ interface ContextOptions {
 }
 interface ContextUrlOptions {
   accessToken?: string;
+  installEventSource?: boolean;
 }
 declare class Context {
   readonly client: MilkyClient;
@@ -5729,6 +5747,7 @@ declare class Context {
   private readonly plugins;
   private readonly services;
   private readonly subContexts;
+  private readonly eventSourceRuntimes;
   private readonly parentEventForwarder?;
   private readonly timers;
   private readonly initialReconnectDelayMs;
@@ -5737,16 +5756,13 @@ declare class Context {
   private state;
   private startPromise?;
   private stopPromise?;
-  private eventSubscription?;
-  private eventStreamTask?;
-  private reconnectTimer?;
-  private resolveReconnectTimer?;
   private constructor();
   on<K extends keyof EventMap>(type: K, handler: (event: EventMap[K]) => void | Promise<void>): () => void;
   install<T extends ParameterList, I extends Injection | undefined, OI extends Injection | undefined>(
     plugin: Plugin<T, I, OI>,
     ...args: T
   ): void;
+  installEventSource(eventSource: MilkyEventSource): void;
   provide<T extends object>(service: ServiceClass<T>, instance: T): void;
   resolve<T extends object>(service: ServiceClass<T>): T;
   tryResolve<T extends object>(service: ServiceClass<T>): T | undefined;
@@ -5754,7 +5770,7 @@ declare class Context {
   fork(name: string, filter?: Filter): Context;
   timeout(delayMs: number, callback: () => void | Promise<void>): NodeJS.Timeout;
   interval(intervalMs: number, callback: () => void | Promise<void>): NodeJS.Timeout;
-  createSession(message: IncomingMessage): Session;
+  createSession(selfId: number, message: IncomingMessage): Session;
   start(): Promise<void>;
   stop(): Promise<void>;
   private startInternal;
@@ -5763,7 +5779,7 @@ declare class Context {
   private assertCanScheduleTimer;
   private runTimerCallback;
   private clearTimers;
-  private stopEventStream;
+  private stopEventSources;
   private acceptsParentEvent;
   private applyPlugins;
   private recursiveApplyPlugins;
@@ -5777,7 +5793,8 @@ declare class Context {
   private createUnresolvablePluginError;
   private getPluginContext;
   private createProxyContextForPlugin;
-  private runEventStream;
+  private startEventSource;
+  private runEventSource;
   private waitForReconnectDelay;
   private resolveReconnectDelay;
   static fromUrl(baseUrl: string | URL, options?: ContextOptions & ContextUrlOptions): Context;
@@ -5842,7 +5859,9 @@ export {
   LogMessage,
   Logger,
   MilkyClient,
+  MilkyEventSource,
   MilkyEventSubscription,
+  MilkyWebSocketEventSourceOptions,
   Parameter,
   ParameterList,
   ParamsOf,
@@ -5860,6 +5879,7 @@ export {
   TypeInstruction,
   combineLogHandlers,
   createMilkyClient,
+  createMilkyWebSocketEventSource,
   definePlugin,
   filter,
   implementsESNextDisposable,

package/dist/index.mjs

@@ -24,37 +24,6 @@ var MilkyClientBase = class {
 		if (json.status === "failed") throw new Error(`API call ${endpoint} failed with retcode ${json.retcode}: ${json.message}`);
 		return json.data;
 	}
-	async startEvents(onEvent) {
-		const ws = new WebSocket(`${this.wsBaseUrl}/event${this.accessToken ? `?access_token=${this.accessToken}` : ""}`);
-		let closeSubscription = () => {};
-		const closed = new Promise((resolve, reject) => {
-			closeSubscription = (error) => {
-				if (error) reject(error);
-				else resolve();
-			};
-		});
-		ws.addEventListener("message", async (event) => {
-			try {
-				if (typeof event.data !== "string") throw new Error(`Expected text frame, got ${typeof event.data}`);
-				await onEvent(JSON.parse(event.data));
-			} catch (error) {
-				closeSubscription(error);
-				ws.close();
-			}
-		});
-		await new Promise((resolve, reject) => {
-			ws.addEventListener("open", () => resolve(), { once: true });
-			ws.addEventListener("error", (event) => reject(/* @__PURE__ */ new Error(`WebSocket error: ${event}`)));
-		});
-		ws.addEventListener("error", (event) => closeSubscription(/* @__PURE__ */ new Error(`WebSocket error: ${event}`)));
-		ws.addEventListener("close", () => closeSubscription(), { once: true });
-		return {
-			closed,
-			stop() {
-				ws.close();
-			}
-		};
-	}
 };
 function createMilkyClient(...params) {
 	const base = new MilkyClientBase(...params);
@@ -64,6 +33,46 @@ function createMilkyClient(...params) {
 	} });
 }
 //#endregion
+//#region src/protocol/event.ts
+function createMilkyWebSocketEventSource(baseUrl, options) {
+	const normalizedBaseUrl = baseUrl.toString();
+	const wsBaseUrl = normalizedBaseUrl.endsWith("/") ? normalizedBaseUrl.slice(0, -1).replace(/^http/, "ws") : normalizedBaseUrl.replace(/^http/, "ws");
+	return {
+		name: "websocket",
+		async start(onEvent) {
+			const ws = new WebSocket(`${wsBaseUrl}/event${options?.accessToken ? `?access_token=${options.accessToken}` : ""}`);
+			let closeSubscription = () => {};
+			const closed = new Promise((resolve, reject) => {
+				closeSubscription = (error) => {
+					if (error) reject(error);
+					else resolve();
+				};
+			});
+			ws.addEventListener("message", async (event) => {
+				try {
+					if (typeof event.data !== "string") throw new Error(`Expected text frame, got ${typeof event.data}`);
+					await onEvent(JSON.parse(event.data));
+				} catch (error) {
+					closeSubscription(error);
+					ws.close();
+				}
+			});
+			await new Promise((resolve, reject) => {
+				ws.addEventListener("open", () => resolve(), { once: true });
+				ws.addEventListener("error", (event) => reject(/* @__PURE__ */ new Error(`WebSocket error: ${event}`)));
+			});
+			ws.addEventListener("error", (event) => closeSubscription(/* @__PURE__ */ new Error(`WebSocket error: ${event}`)));
+			ws.addEventListener("close", () => closeSubscription(), { once: true });
+			return {
+				closed,
+				stop() {
+					ws.close();
+				}
+			};
+		}
+	};
+}
+//#endregion
 //#region src/protocol/segment.ts
 function msg(strings, ...values) {
 	let buffer = "";
@@ -628,6 +637,7 @@ var Context = class Context {
 	plugins = [];
 	services = /* @__PURE__ */ new Map();
 	subContexts = /* @__PURE__ */ new Map();
+	eventSourceRuntimes = /* @__PURE__ */ new Map();
 	parentEventForwarder;
 	timers = /* @__PURE__ */ new Set();
 	initialReconnectDelayMs;
@@ -636,10 +646,6 @@ var Context = class Context {
 	state = "idle";
 	startPromise;
 	stopPromise;
-	eventSubscription;
-	eventStreamTask;
-	reconnectTimer;
-	resolveReconnectTimer;
 	constructor(client, options, name, parent, filter) {
 		this.client = client;
 		this.initialReconnectDelayMs = options?.reconnect?.initialDelayMs ?? DEFAULT_INITIAL_RECONNECT_DELAY_MS;
@@ -656,10 +662,10 @@ var Context = class Context {
 			};
 			parent.eventBus.on("*", this.parentEventForwarder);
 		}
-		this.eventBus.on("message_receive", async ({ data: message }) => {
+		this.eventBus.on("message_receive", async ({ self_id, data: message }) => {
 			try {
 				if (this.state === "stopping" || this.state === "stopped") return;
-				await this.router.dispatch(this.createSession(message), message);
+				await this.router.dispatch(this.createSession(self_id, message), message);
 			} catch (error) {
 				this.logger.error(`Error routing command (scene=${message.message_scene} peer=${message.peer_id} sender=${message.sender_id} seq=${message.message_seq})`, error);
 			}
@@ -685,6 +691,11 @@ var Context = class Context {
 			args
 		});
 	}
+	installEventSource(eventSource) {
+		if (this.eventSourceRuntimes.has(eventSource)) return;
+		this.eventSourceRuntimes.set(eventSource, {});
+		if (this.state === "started") this.startEventSource(eventSource);
+	}
 	provide(service, instance) {
 		if (this.services.has(service)) throw new Error(`Service ${service.name} has already been provided in this context.`);
 		if (implementsESNextDisposable(instance) && !isDisposable(instance)) throw new Error(`
@@ -735,8 +746,9 @@ and implement the dispose method to clean up resources when the context stops.
 		this.timers.add(interval);
 		return interval;
 	}
-	createSession(message) {
+	createSession(selfId, message) {
 		return {
+			selfId,
 			raw: message,
 			reply: async (textOrSegments, options) => {
 				const actualSegments = [];
@@ -819,8 +831,10 @@ and implement the dispose method to clean up resources when the context stops.
 			for (const context of startingContexts) if (context.state === "starting") context.state = "idle";
 			throw error;
 		}
-		for (const { context } of appliedContextPlugins) context.state = "started";
-		if (!this.parent) this.eventStreamTask = this.runEventStream();
+		for (const { context } of appliedContextPlugins) {
+			context.state = "started";
+			for (const eventSource of context.eventSourceRuntimes.keys()) context.startEventSource(eventSource);
+		}
 	}
 	getState() {
 		return this.state;
@@ -833,7 +847,7 @@ and implement the dispose method to clean up resources when the context stops.
 		} catch (error) {
 			errors.push(error);
 		}
-		await this.stopEventStream(errors);
+		await this.stopEventSources(errors);
 		if (this.parent && this.parentEventForwarder) this.parent.eventBus.off("*", this.parentEventForwarder);
 		for (const service of [...this.services.values()].reverse()) {
 			if (!isDisposable(service)) continue;
@@ -862,20 +876,27 @@ and implement the dispose method to clean up resources when the context stops.
 		for (const timer of this.timers) clearTimeout(timer);
 		this.timers.clear();
 	}
-	async stopEventStream(errors) {
-		this.resolveReconnectDelay();
-		const subscription = this.eventSubscription;
-		if (subscription) try {
-			await subscription.stop();
-		} catch (error) {
-			errors.push(error);
+	async stopEventSources(errors) {
+		for (const [_, runtime] of this.eventSourceRuntimes) {
+			this.resolveReconnectDelay(runtime);
+			const subscription = runtime.subscription;
+			if (!subscription) continue;
+			try {
+				await subscription.stop();
+			} catch (error) {
+				errors.push(error);
+			}
+			runtime.subscription = void 0;
 		}
-		if (this.eventStreamTask) try {
-			await this.eventStreamTask;
-		} catch (error) {
-			errors.push(error);
-		} finally {
-			this.eventStreamTask = void 0;
+		for (const runtime of this.eventSourceRuntimes.values()) {
+			if (!runtime.task) continue;
+			try {
+				await runtime.task;
+			} catch (error) {
+				errors.push(error);
+			} finally {
+				runtime.task = void 0;
+			}
 		}
 	}
 	acceptsParentEvent(type, event) {
@@ -1009,13 +1030,18 @@ and implement the dispose method to clean up resources when the context stops.
 			else return Reflect.get(target, prop, receiver);
 		} });
 	}
-	async runEventStream() {
+	startEventSource(eventSource) {
+		const runtime = this.eventSourceRuntimes.get(eventSource);
+		if (!runtime) return;
+		runtime.task = this.runEventSource(eventSource, runtime);
+	}
+	async runEventSource(eventSource, runtime) {
 		let reconnectDelay = this.initialReconnectDelayMs;
 		let reconnectAttempt = 1;
 		while (this.state === "started") {
 			try {
-				this.logger.debug(`Connecting event stream (attempt=${reconnectAttempt})`);
-				const subscription = await this.client.startEvents((event) => {
+				this.logger.debug(`Connecting ${eventSource.name ?? "event source"} (attempt=${reconnectAttempt})`);
+				const subscription = await eventSource.start((event) => {
 					try {
 						if (this.state !== "started") return;
 						this.eventBus.emit(event.event_type, event);
@@ -1027,48 +1053,52 @@ and implement the dispose method to clean up resources when the context stops.
 					await subscription.stop();
 					break;
 				}
-				this.eventSubscription = subscription;
-				this.logger.info("Event stream connected");
+				runtime.subscription = subscription;
+				this.logger.info(`${eventSource.name ?? "Event source"} connected`);
 				reconnectDelay = this.initialReconnectDelayMs;
 				reconnectAttempt = 1;
 				await subscription.closed;
-				this.eventSubscription = void 0;
+				if (runtime.subscription === subscription) runtime.subscription = void 0;
 				if (this.state !== "started") break;
-				this.logger.warn(`Event stream disconnected; reconnecting in ${reconnectDelay}ms`);
+				this.logger.warn(`${eventSource.name ?? "Event source"} disconnected; reconnecting in ${reconnectDelay}ms`);
 			} catch (error) {
-				this.eventSubscription = void 0;
 				if (this.state !== "started") break;
-				this.logger.error(`Error connecting event stream; reconnecting in ${reconnectDelay}ms`, error);
+				this.logger.error(`Error connecting ${eventSource.name ?? "event source"}; reconnecting in ${reconnectDelay}ms`, error);
 			}
-			await this.waitForReconnectDelay(reconnectDelay);
+			await this.waitForReconnectDelay(runtime, reconnectDelay);
 			reconnectDelay = Math.min(reconnectDelay * 2, this.maxReconnectDelayMs);
 			reconnectAttempt += 1;
 		}
 	}
-	waitForReconnectDelay(delay) {
+	waitForReconnectDelay(runtime, delay) {
 		return new Promise((resolve) => {
-			this.resolveReconnectTimer = resolve;
-			this.reconnectTimer = setTimeout(() => {
-				this.reconnectTimer = void 0;
-				this.resolveReconnectTimer = void 0;
+			runtime.resolveReconnectTimer = resolve;
+			runtime.reconnectTimer = setTimeout(() => {
+				runtime.reconnectTimer = void 0;
+				runtime.resolveReconnectTimer = void 0;
 				resolve();
 			}, delay);
 		});
 	}
-	resolveReconnectDelay() {
-		if (this.reconnectTimer) {
-			clearTimeout(this.reconnectTimer);
-			this.reconnectTimer = void 0;
+	resolveReconnectDelay(runtime) {
+		if (runtime.reconnectTimer) {
+			clearTimeout(runtime.reconnectTimer);
+			runtime.reconnectTimer = void 0;
 		}
-		const resolve = this.resolveReconnectTimer;
-		this.resolveReconnectTimer = void 0;
+		const resolve = runtime.resolveReconnectTimer;
+		runtime.resolveReconnectTimer = void 0;
 		resolve?.();
 	}
 	static fromUrl(baseUrl, options) {
-		return new Context(createMilkyClient(baseUrl, { accessToken: options?.accessToken }), options);
+		const context = new Context(createMilkyClient(baseUrl, { accessToken: options?.accessToken }), options);
+		if (options?.installEventSource ?? true) context.installEventSource(createMilkyWebSocketEventSource(baseUrl, { accessToken: options?.accessToken }));
+		return context;
 	}
 	static fromClient(client, options) {
-		return new Context(client, options);
+		const context = new Context(client, options);
+		const eventSourceLike = client;
+		if (typeof eventSourceLike.start === "function") context.installEventSource(eventSourceLike);
+		return context;
 	}
 };
 //#endregion
@@ -1226,10 +1256,10 @@ function definePlugin(plugin) {
 //#endregion
 //#region src/protocol/types.ts
 const milkyVersion = "1.3";
-const milkyPackageVersion = "1.3.0-rc.1";
+const milkyPackageVersion = "1.3.0-rc.2";
 //#endregion
 //#region src/routing/parameter.ts
-var Parameter = class {
+var Parameter = class Parameter {
 	capturer;
 	description;
 	constructor(capturer) {
@@ -1239,6 +1269,18 @@ var Parameter = class {
 		this.description = description;
 		return this;
 	}
+	refine(predicate) {
+		const capturer = this.capturer;
+		const refined = new Parameter({
+			typeInstruction: capturer.typeInstruction,
+			capture(tokenizer) {
+				const value = capturer.capture(tokenizer);
+				if (value === void 0 || predicate(value)) return value;
+			}
+		});
+		refined.description = this.description;
+		return refined;
+	}
 };
 let param;
 (function(_param) {
@@ -1340,4 +1382,4 @@ let param;
 	_param.segment = segment;
 })(param || (param = {}));
 //#endregion
-export { CommandBuilder, Context, Logger, Parameter, Router, combineLogHandlers, createMilkyClient, definePlugin, filter, implementsESNextDisposable, isDisposable, milkyPackageVersion, milkyVersion, msg, param, seg };
+export { CommandBuilder, Context, Logger, Parameter, Router, combineLogHandlers, createMilkyClient, createMilkyWebSocketEventSource, definePlugin, filter, implementsESNextDisposable, isDisposable, milkyPackageVersion, milkyVersion, msg, param, seg };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fraqjs/fraq",
   "type": "module",
-  "version": "0.10.2",
+  "version": "0.11.0",
   "description": "Milky Bot framework",
   "files": [
     "dist"