feat: broadcastWithOptions ACTR-136

Author: abcxff

packages/actor-core/src/actor/action.ts

@@ -8,6 +8,20 @@ import type { SaveStateOptions } from "./instance";
 import { Actions } from "./config";
 import { ActorContext } from "./context";
 
+/**
+ * Options for the `_broadcast` method.
+ */
+interface BroadcastOptions {
+	/**
+	 * The connection IDs to be excluded from the broadcast.
+	 */
+	exclude?: ConnId[];
+	/**
+	 * Excludes the current connection from the broadcast.
+	 */
+	excludeSelf?: boolean;
+}
+
 /**
  * Context for a remote procedure call.
  *
@@ -50,6 +64,28 @@ export class ActionContext<S, CP, CS, V> {
 		this.#actorContext.broadcast(name, ...args);
 	}
 
+	/**
+	 * Broadcasts an event to all connected clients with options.
+	 */
+	broadcastWithOptions<Args extends Array<unknown>>(opts: BroadcastOptions, name: string, ...args: Args) {
+		const exclude = opts.exclude ?? [];
+
+		if (opts.excludeSelf) {
+			exclude.push(this.conn.id);
+		}
+
+		// @ts-ignore - Access protected method
+		this.#actorContext.broadcastWithOptions({ exclude }, name, ...args);
+		return;
+	}
+
+	/**
+	 * Alias for `broadcastWithOptions`
+	 */
+	broadcastWith<Args extends Array<unknown>>(opts: BroadcastOptions, name: string, ...args: Args) {
+		return this.broadcastWithOptions(opts, name, ...args);
+	}
+
 	/**
 	 * Gets the logger instance.
 	 */

packages/actor-core/src/actor/context.ts

@@ -1,6 +1,6 @@
 import { Logger } from "@/common/log";
 import { Actions } from "./config";
-import { ActorInstance, SaveStateOptions } from "./instance";
+import { ActorInstance, BroadcastInstanceOptions, SaveStateOptions } from "./instance";
 import { Conn, ConnId } from "./connection";
 import { ActorTags } from "@/common/utils";
 import { Schedule } from "./schedule";
@@ -41,6 +41,18 @@ export class ActorContext<S, CP, CS, V> {
 		return;
 	}
 
+	/**
+	 * Broadcasts an event to all connected clients with options.
+	 * @param opts - Options for the broadcast.
+	 * @param name - The name of the event.
+	 * @param args - The arguments to send with the event.
+	 */
+	broadcastWithOptions<Args extends Array<unknown>>(opts: BroadcastInstanceOptions, name: string, ...args: Args) {
+		// @ts-ignore - Access protected method
+		this.#actor._broadcastWithOptions(opts, name, ...args);
+		return;
+	}
+
 	/**
 	 * Gets the logger instance.
 	 */

packages/actor-core/src/actor/instance.ts

@@ -36,6 +36,16 @@ export interface SaveStateOptions {
 	immediate?: boolean;
 }
 
+/**
+ * Options for the `_broadcastWithOptions` method.
+ */
+export interface BroadcastInstanceOptions {
+	/**
+	 * The connection IDs to be excluded from the broadcast.
+	 */
+	exclude?: string[];
+}
+
 /** Actor type alias with all `any` types. Used for `extends` in classes referencing this actor. */
 // biome-ignore lint/suspicious/noExplicitAny: Needs to be used in `extends`
 export type AnyActorInstance = ActorInstance<any, any, any, any>;
@@ -1013,6 +1023,16 @@ export class ActorInstance<S, CP, CS, V> {
 	 * @param args - The arguments to send with the event.
 	 */
 	_broadcast<Args extends Array<unknown>>(name: string, ...args: Args) {
+		return this._broadcastWithOptions({}, name, ...args);
+	}
+
+	/**
+	 * Broadcasts an event to all connected clients with options.
+	 * @param opts - Options for the broadcast.
+	 * @param name - The name of the event.
+	 * @param args - The arguments to send with the event.
+	 */
+	_broadcastWithOptions<Args extends Array<unknown>>(opts: BroadcastInstanceOptions, name: string, ...args: Args) {
 		this.#assertReady();
 
 		// Send to all connected clients
@@ -1028,8 +1048,14 @@ export class ActorInstance<S, CP, CS, V> {
 			},
 		});
 
+		const excludeList = opts.exclude ?? [];
+
 		// Send message to clients
 		for (const connection of subscriptions) {
+			if (excludeList.includes(connection.id)) {
+				continue;
+			}
+
 			connection._sendMessage(toClientSerializer);
 		}
 	}

yarn.lock

@@ -7747,6 +7747,22 @@ __metadata:
   languageName: node
   linkType: hard
 
+"collab-document@workspace:examples/collab-document":
+  version: 0.0.0-use.local
+  resolution: "collab-document@workspace:examples/collab-document"
+  dependencies:
+    "@actor-core/cli": "workspace:*"
+    "@actor-core/react": "workspace:*"
+    "@types/react": "npm:^19"
+    "@types/react-dom": "npm:^19"
+    actor-core: "workspace:*"
+    react: "npm:^19"
+    react-dom: "npm:^19"
+    react-scripts: "npm:^5.0.1"
+    typescript: "npm:^5.5.2"
+  languageName: unknown
+  linkType: soft
+
 "collect-v8-coverage@npm:^1.0.0":
   version: 1.0.2
   resolution: "collect-v8-coverage@npm:1.0.2"