@mml-io/3d-web-experience-client 0.21.6 → 0.23.0

package/build/Networked3dWebExperienceClient.d.ts

@@ -1,6 +1,7 @@
-import { AvatarConfiguration } from "@mml-io/3d-web-avatar-selection-ui";
-import { AnimationConfig, EnvironmentConfiguration, LoadingScreenConfig } from "@mml-io/3d-web-client-core";
-import { StringToHslOptions } from "@mml-io/3d-web-text-chat";
+import { AnimationConfig, EnvironmentConfiguration, LoadingScreenConfig, SpawnConfiguration } from "@mml-io/3d-web-client-core";
+import { ServerBroadcastMessage } from "@mml-io/3d-web-user-networking";
+import { AvatarConfiguration } from "./avatar-selection-ui";
+import { StringToHslOptions } from "./chat-ui";
 type MMLDocumentConfiguration = {
     url: string;
     position?: {
@@ -22,27 +23,26 @@ type MMLDocumentConfiguration = {
 export type Networked3dWebExperienceClientConfig = {
     userNetworkAddress: string;
     sessionToken: string;
-    allowOrbitalCamera?: boolean;
     chatVisibleByDefault?: boolean;
     userNameToColorOptions?: StringToHslOptions;
     animationConfig: AnimationConfig;
     voiceChatAddress?: string;
     updateURLLocation?: boolean;
-    onServerBroadcast?: (broadcast: {
-        broadcastType: string;
-        payload: any;
-    }) => void;
+    onServerBroadcast?: (broadcast: ServerBroadcastMessage) => void;
     loadingScreen?: LoadingScreenConfig;
 } & UpdatableConfig;
 export type UpdatableConfig = {
-    chatNetworkAddress?: string | null;
+    enableChat?: boolean;
     mmlDocuments?: {
         [key: string]: MMLDocumentConfiguration;
     };
     environmentConfiguration?: EnvironmentConfiguration;
+    spawnConfiguration?: SpawnConfiguration;
     avatarConfiguration?: AvatarConfiguration;
     allowCustomDisplayName?: boolean;
     enableTweakPane?: boolean;
+    allowOrbitalCamera?: boolean;
+    postProcessingEnabled?: boolean;
 };
 export declare class Networked3dWebExperienceClient {
     private holderElement;
@@ -66,27 +66,28 @@ export declare class Networked3dWebExperienceClient {
     private networkClient;
     private remoteUserStates;
     private userProfiles;
-    private networkChat;
     private textChatUI;
     private avatarSelectionUI;
-    private voiceChatManager;
     private readonly latestCharacterObject;
     private characterControllerPaneSet;
+    private spawnConfiguration;
     private initialLoadCompleted;
     private loadingProgressManager;
     private loadingScreen;
     private errorScreen?;
-    private currentRequestAnimationFrame;
     private groundPlane;
+    private respawnButton;
+    private currentRequestAnimationFrame;
     constructor(holderElement: HTMLElement, config: Networked3dWebExperienceClientConfig);
     private setGroundPlaneEnabled;
     updateConfig(config: Partial<UpdatableConfig>): void;
     static createFullscreenHolder(): HTMLDivElement;
+    private createRespawnButton;
     private resolveCharacterData;
-    private updateUserProfile;
+    private onNetworkUpdate;
     private sendIdentityUpdateToServer;
-    private connectToVoiceChat;
     private setupTweakPane;
+    private handleChatMessage;
     private connectToTextChat;
     private mountAvatarSelectionUI;
     update(): void;

package/build/avatar-selection-ui/AvatarSelectionUI.d.ts

@@ -0,0 +1,20 @@
+import { AvatarConfiguration, AvatarType } from "./AvatarType";
+export type AvatarSelectionUIProps = {
+    holderElement: HTMLElement;
+    visibleByDefault?: boolean;
+    displayName: string;
+    characterDescription: AvatarType;
+    allowCustomDisplayName: boolean;
+    sendIdentityUpdateToServer: (displayName: string, characterDescription: AvatarType) => void;
+} & AvatarConfiguration;
+export declare class AvatarSelectionUI {
+    private config;
+    private root;
+    private wrapper;
+    constructor(config: AvatarSelectionUIProps);
+    private onUpdateUserAvatar;
+    private onUpdateDisplayName;
+    updateAvatarConfig(avatarConfig: AvatarConfiguration): void;
+    updateAllowCustomDisplayName(allowCustomDisplayName: boolean): void;
+    init(): void;
+}

package/build/avatar-selection-ui/AvatarType.d.ts

@@ -0,0 +1,21 @@
+export type AvatarType = {
+    thumbnailUrl?: string;
+    name?: string;
+    isDefaultAvatar?: boolean;
+} & ({
+    meshFileUrl: string;
+    mmlCharacterString?: null;
+    mmlCharacterUrl?: null;
+} | {
+    meshFileUrl?: null;
+    mmlCharacterString: string;
+    mmlCharacterUrl?: null;
+} | {
+    meshFileUrl?: null;
+    mmlCharacterString?: null;
+    mmlCharacterUrl: string;
+});
+export type AvatarConfiguration = {
+    availableAvatars: Array<AvatarType>;
+    allowCustomAvatars?: boolean;
+};

package/build/avatar-selection-ui/components/AvatarPanel/AvatarSectionUIComponent.d.ts

@@ -0,0 +1,14 @@
+import { ForwardRefRenderFunction } from "react";
+import { AvatarType } from "../../AvatarType";
+type AvatarSelectionUIProps = {
+    onUpdateUserAvatar: (avatar: AvatarType) => void;
+    visibleByDefault?: boolean;
+    availableAvatars: AvatarType[];
+    characterDescription: AvatarType;
+    allowCustomAvatars: boolean;
+    displayName: string;
+    allowCustomDisplayName: boolean;
+    onUpdateDisplayName: (displayNameValue: string) => void;
+};
+export declare const AvatarSelectionUIComponent: ForwardRefRenderFunction<any, AvatarSelectionUIProps>;
+export {};

package/build/avatar-selection-ui/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./AvatarSelectionUI";
+export * from "./AvatarType";

package/build/chat-ui/TextChatUI.d.ts

@@ -0,0 +1,25 @@
+export type StringToHslOptions = {
+    hueThresholds?: [number, number][];
+    saturationThresholds?: [number, number][];
+    lightnessThresholds?: [number, number][];
+};
+export declare const DEFAULT_HSL_OPTIONS: StringToHslOptions;
+export type ChatUIInstance = {
+    addMessage: (username: string, message: string) => void;
+};
+export type TextChatUIProps = {
+    holderElement: HTMLElement;
+    sendMessageToServerMethod: (message: string) => void;
+    visibleByDefault?: boolean;
+    stringToHslOptions?: StringToHslOptions;
+};
+export declare class TextChatUI {
+    private config;
+    private root;
+    private appRef;
+    addTextMessage(username: string, message: string): void;
+    private wrapper;
+    constructor(config: TextChatUIProps);
+    dispose(): void;
+    init(): void;
+}

package/build/chat-ui/components/ChatPanel/TextChatUIComponent.d.ts

@@ -0,0 +1,9 @@
+import { ForwardRefRenderFunction } from "react";
+import { StringToHslOptions, type ChatUIInstance } from "../../TextChatUI";
+type ChatUIProps = {
+    sendMessageToServer: (message: string) => void;
+    visibleByDefault?: boolean;
+    stringToHslOptions?: StringToHslOptions;
+};
+export declare const ChatUIComponent: ForwardRefRenderFunction<ChatUIInstance, ChatUIProps>;
+export {};

package/build/chat-ui/components/Input/InputBox.d.ts

@@ -0,0 +1,9 @@
+type InputBoxProps = {
+    onSendMessage: (message: string) => void;
+    hide: () => void;
+    setFocus: () => void;
+};
+export declare const InputBox: import("react").ForwardRefExoticComponent<InputBoxProps & import("react").RefAttributes<{
+    focusInput: () => void;
+} | null>>;
+export {};

package/build/chat-ui/components/Message/Message.d.ts

@@ -0,0 +1,9 @@
+import { FC } from "react";
+import { StringToHslOptions } from "../../TextChatUI";
+type MessageProps = {
+    username: string;
+    message: string;
+    stringToHslOptions?: StringToHslOptions;
+};
+declare const Message: FC<MessageProps>;
+export default Message;

package/build/chat-ui/components/Messages/Messages.d.ts

@@ -0,0 +1,12 @@
+import { FC } from "react";
+import { StringToHslOptions } from "../../TextChatUI";
+type MessagesProps = {
+    messages: Array<{
+        username: string;
+        message: string;
+    }>;
+    stringToHslOptions?: StringToHslOptions;
+    shouldAutoScroll?: boolean;
+};
+export declare const Messages: FC<MessagesProps>;
+export {};

package/build/chat-ui/helpers.d.ts

@@ -0,0 +1,3 @@
+type ClickAwayCallback = (event: MouseEvent | TouchEvent) => void;
+export declare function useClickOutside(cb: ClickAwayCallback): import("react").RefObject<HTMLDivElement | null>;
+export {};

package/build/chat-ui/index.d.ts

@@ -0,0 +1 @@
+export { TextChatUI, TextChatUIProps, type StringToHslOptions } from "./TextChatUI";