playhtml 2.2.1 → 2.4.0

package/dist/main.d.ts

@@ -12,6 +12,84 @@ import { RegisteredPlayEvent } from '../../common/src';
 import { TagType } from '../../common/src';
 import * as Y from 'yjs';
 
+declare class CursorClientAwareness {
+    private provider;
+    private options;
+    private cursors;
+    private spatialGrid;
+    private proximityUsers;
+    private currentCursor;
+    private playerIdentity;
+    private updateThrottled;
+    private lastUpdate;
+    private visibilityThreshold;
+    private isStylesAdded;
+    private globalApiListeners;
+    private allPlayerColors;
+    private chat;
+    private currentMessage;
+    private otherUsersWithMessages;
+    constructor(provider: default_2, options?: CursorOptions);
+    private initialize;
+    private setupAwarenessHandling;
+    private syncExistingAwareness;
+    private handleAwarenessChange;
+    private rebuildSpatialGrid;
+    private checkProximityOptimized;
+    private addCursorStyles;
+    private setupCursorTracking;
+    private throttledUpdateCursorAwareness;
+    private updateCursorAwareness;
+    private updateCursor;
+    private createCursorElement;
+    private getMouseCursorSVG;
+    private getTouchCursorSVG;
+    private getCustomCursorSVG;
+    private removeCursor;
+    private setupGlobalAPI;
+    private emitGlobalEvent;
+    private updateGlobalColors;
+    private updateChatCTA;
+    private updateCursorMessage;
+    private updateCursorName;
+    private opacifyColor;
+    private hslToRgb;
+    private getLuminance;
+    private getContrastColor;
+    private updateAllCursorVisibility;
+    private showAllCursors;
+    configure(options: Partial<CursorOptions>): void;
+    hideCursor(connectionId: string): void;
+    showCursor(connectionId: string): void;
+    destroy(): void;
+    getDebugInfo(): {
+        totalCursors: number;
+        gridCells: number;
+        avgCursorsPerCell: number;
+    };
+}
+
+export declare interface CursorOptions {
+    enabled?: boolean;
+    playerIdentity?: any;
+    proximityThreshold?: number;
+    visibilityThreshold?: number;
+    cursorStyle?: string;
+    onProximityEntered?: (playerIdentity?: any, positions?: {
+        ours: {
+            x: number;
+            y: number;
+        };
+        theirs: {
+            x: number;
+            y: number;
+        };
+    }, angle?: number) => void;
+    onProximityLeft?: (connectionId: string) => void;
+    onCustomCursorRender?: (connectionId: string, element: HTMLElement) => HTMLElement | null;
+    enableChat?: boolean;
+}
+
 declare function dispatchPlayEvent(message: EventMessage): void;
 
 declare class ElementHandler<T = any, U = any, V = any> {
@@ -123,9 +201,13 @@ export declare interface InitOptions<T = any> {
      * If true, will render some helpful development UI.
      */
     developmentMode?: boolean;
+    /**
+     * Cursor tracking and proximity detection configuration
+     */
+    cursors?: CursorOptions;
 }
 
-declare function initPlayHTML({ host, extraCapabilities, events, defaultRoomOptions, room: inputRoom, onError, developmentMode, }?: InitOptions): Promise<default_2 | undefined>;
+declare function initPlayHTML({ host, extraCapabilities, events, defaultRoomOptions, room: inputRoom, onError, developmentMode, cursors, }?: InitOptions): Promise<default_2 | undefined>;
 
 export declare const playhtml: PlayHTMLComponents;
 
@@ -142,6 +224,7 @@ declare interface PlayHTMLComponents {
     dispatchPlayEvent: typeof dispatchPlayEvent;
     registerPlayEventListener: typeof registerPlayEventListener;
     removePlayEventListener: typeof removePlayEventListener;
+    cursorClient: CursorClientAwareness | null;
 }
 
 /**
@@ -181,3 +264,20 @@ declare type StoreShape = {
 };
 
 export { }
+
+
+declare global {
+    interface Window {
+        cursors?: {
+            color: string;
+            name: string;
+            allColors: string[];
+            count: number;
+            setColor?: (color: string) => void;
+            setName?: (name: string) => void;
+            on: CursorEventEmitter["on"];
+            off: CursorEventEmitter["off"];
+        };
+    }
+}
+