@casual-simulation/aux-runtime 4.2.3-alpha.23548940774 → 4.2.3-alpha.23819027415

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@casual-simulation/aux-runtime",
-  "version": "4.2.3-alpha.23548940774",
+  "version": "4.2.3-alpha.23819027415",
   "description": "Runtime for AUX projects",
   "main": "index.js",
   "types": "index.d.ts",
@@ -25,8 +25,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@casual-simulation/aux-common": "^4.2.3-alpha.23548940774",
-    "@casual-simulation/aux-records": "^4.2.3-alpha.23548940774",
+    "@casual-simulation/aux-common": "^4.2.3-alpha.23819027415",
+    "@casual-simulation/aux-records": "^4.2.3-alpha.23819027415",
     "@casual-simulation/crypto": "^4.0.5",
     "@casual-simulation/engine262": "0.0.1-4de2170374e22761996e46eb1362f4496ee57f8f",
     "@casual-simulation/error-stack-parser": "^2.0.7",

package/runtime/AuxLibraryDefinitions.def

@@ -12521,6 +12521,22 @@ export interface SharedDocument extends SubscriptionLike {
      */
     onClientError: Observable<ClientError>;
 
+    /**
+     * The events that are emitted when remote clients connect or disconnect from the document.
+     *
+     * When subscribed to, this observable will emit an event whenever a remote client connects or disconnects from the document.
+     * Additionally, the current remote clients will be emitted when the subscription is first made.
+     */
+    readonly remoteClients: Observable<RemoteClientEvent>;
+
+    /**
+     * The events that are emitted when remote clients connect or disconnect from the document.
+     *
+     * When subscribed to, this observable will emit an event whenever a remote client connects or disconnects from the document.
+     * Notably, the current remote clients will NOT be emitted when the subscription is first made, so this can be used to only listen for future client connections and disconnections.
+     */
+    readonly remoteClientsRaw: Observable<RemoteClientEvent>;
+
     /**
      * Tells the document to connect to its backing store.
      */
@@ -12579,6 +12595,59 @@ export interface SharedDocument extends SubscriptionLike {
     applyUpdates(updates: string[]): void;
 }
 
+/**
+ * Information about a connection.
+ * 
+ * @dochash types/documents
+ * @docid ConnectionInfo
+ * @docname ConnectionInfo
+ */
+export interface ConnectionInfo {
+    /**
+     * The ID of the connection.
+     */
+    connectionId: string;
+
+    /**
+     * The ID of the session.
+     */
+    sessionId: string | null;
+
+    /**
+     * The ID of the user that is associated with the connection.
+     */
+    userId: string | null;
+}
+
+/**
+ * Defines an event that is emitted when a remote client connects or disconnects from a shared document.
+ *
+ * @dochash types/documents
+ * @docid RemoteClientEvent
+ * @docname RemoteClientEvent
+ */
+export interface RemoteClientEvent {
+    /**
+     * The type of the event.
+     *
+     * "client_connected" is emitted when a new client connects to the document.
+     * "client_disconnected" is emitted when a client disconnects from the document.
+     */
+    type: 'client_connected' | 'client_disconnected';
+
+    /**
+     * The connection info of the client that connected or disconnected.
+     */
+    client: ConnectionInfo;
+
+    /**
+     * Whether this event is for the current client.
+     * This will be true when `client.connectionId` is the same as the `configBot.id` and false otherwise.
+     */
+    isSelf: boolean;
+}
+
+
 export type SharedType = SharedMap | SharedArray | SharedText;
 
 export type SharedTypeChanges =