@naviedu/room-platform-react 0.0.18 → 0.0.20

package/README.md

@@ -85,7 +85,6 @@ layout that allows the room to occupy the viewport.
 | `launchToken`            | Yes      | Initial server-issued launch ticket.                                                 |
 | `onLaunchTicketRequired` | Yes      | Returns `{ launchToken }` when the current ticket or access session must be renewed. |
 | `extensions`             | No       | Host-provided top-bar, workspace, sidebar, monitor, and participant extensions.      |
-| `integrations`           | No       | Chat and whiteboard configuration.                                                   |
 | `isPracticeMode`         | No       | Enables practice-room presentation behavior.                                         |
 | `onError`                | No       | Receives connection, media, and action errors.                                       |
 | `onLifecycleEvent`       | No       | Receives exchange, renewal, and reconnect lifecycle events.                          |
@@ -121,39 +120,33 @@ Lifecycle events are `exchange.succeeded`, `exchange.failed`,
 `renewal.succeeded`, `renewal.failed`, `reconnect.succeeded`, and
 `reconnect.failed`.
 
-## Chat and whiteboard integrations
-
-Integrations are optional. The host supplies already-authorized configuration;
-the room package does not issue chat or whiteboard credentials.
-
-```tsx
-<RoomPlatformRoom
-    // ...required props
-    integrations={{
-        chat: {
-            endpoint: 'https://api.example.com/chat',
-            realtimeEndpoint: 'wss://realtime.example.com/chat',
-            token: chatToken,
-            tokenExpiresAt: chatTokenExpiresAt,
-            refreshToken: refreshChatToken,
-            refreshTokenExpiresAt: refreshChatTokenExpiresAt,
-            rooms: chatRooms,
-            currentRoomId: roomId,
-        },
-        whiteboard: {
-            joinState: whiteboardJoinState,
-            runtime: {
-                realtimeEndpoint: whiteboardRealtimeEndpoint,
-                recoveryPort: whiteboardRecoveryPort,
-            },
-        },
-    }}
-/>
-```
-
-When chat is configured, the default sidebar includes the chat tab and unread
-badge. When whiteboard access is available, a shared screen can display the
-whiteboard surface. Omit either integration when the host does not use it.
+## Chat and whiteboard boundary
+
+Chat and Whiteboard are owned by the Room Platform exchange. The host only
+passes the launch ticket and public Room Platform API base URL shown above;
+there is no public `integrations` prop.
+
+After the launch ticket exchange succeeds and LiveKit connects, the package
+hydrates the Chat and Whiteboard projection returned by Room Platform. The
+projection contains only the short-lived, already-authorized runtime data
+needed by the package. On renewal, the complete projection is replaced.
+
+Each integration degrades independently. An `available: false` Chat or
+Whiteboard projection disables only that surface; LiveKit, the other
+integration, and private-room invite, accept, and media flows remain usable.
+LiveKit exchange/connection failure is the only fatal case for mounting the
+room integrations.
+
+Consumers must not provide or derive Chat/Whiteboard credentials, internal or
+service endpoints, integration room IDs, or permission objects. Do not expose
+app/HMAC secrets or call Chat/Whiteboard services directly from the host. The
+Room Platform exchange is the trust boundary and supplies the public runtime
+projection after server-side authorization.
+
+Whiteboard uses the exchanged Room Platform `roomId` for its room context and
+is created lazily only when Whiteboard is available and a screen share starts.
+Stopping a share deactivates its board; every new share receives a new
+`shareSessionKey`. No board is mounted before sharing begins.
 
 ## Extensions
 

package/index.d.ts

@@ -18,90 +18,6 @@ declare const buttonVariants: (props?: {
     size?: "xs" | "sm" | "lg" | "default" | "xl" | "icon" | "icon-xs" | "icon-sm" | "icon-lg" | "icon-xl";
 } & ClassProp) => string;
 
-declare type ChatClassNames = {
-    root?: string;
-    roomList?: string;
-    roomTab?: string;
-    panel?: string;
-    messageList?: string;
-    messageItem?: string;
-    composer?: string;
-    forwardDialog?: string;
-    connectionStatus?: string;
-};
-
-declare interface ChatForwardedFromDto {
-    sourceAppId: string;
-    sourceWorkspaceId: string;
-    sourceRoomId: string;
-    sourceMessageId: string;
-    sourceAuthorSnapshot: {
-        subject: string;
-        displayName?: string;
-    };
-    sourceCreatedAt: string;
-}
-
-declare interface ChatMessageDto {
-    id: string;
-    appId: string;
-    workspaceId: string;
-    roomId: string;
-    authorSubject: string;
-    authorDisplayName?: string;
-    text: string;
-    status: 'active' | 'deleted' | 'hidden';
-    createdAt: string;
-    updatedAt?: string;
-    forwardedFrom?: ChatForwardedFromDto;
-}
-
-declare type ChatPermission = (typeof chatPermissions)[number];
-
-declare const chatPermissions: readonly ["read", "send", "delete_own", "edit_own", "moderate", "forward", "manage_room"];
-
-declare type ChatProviderProps = {
-    endpoint: string;
-    realtimeEndpoint: string;
-    token: string;
-    tokenExpiresAt?: string;
-    refreshToken: string;
-    refreshTokenExpiresAt?: string;
-    rooms: ChatRoomDescriptor[];
-    currentRoomId?: string;
-    mode?: 'tabs' | 'compact' | 'full_panel' | 'readonly';
-    className?: string;
-    classNames?: ChatClassNames;
-    tokens?: ChatThemeTokens;
-    historyPageSize?: number;
-    isVisible?: boolean;
-    initialMessages?: Record<string, ChatMessageDto[]>;
-    messageActionWindowMs?: number;
-    now?: () => Date;
-    onError?: (error: Error) => void;
-    children?: ReactNode;
-};
-
-declare interface ChatRoomDescriptor {
-    roomId: string;
-    roomType: ChatRoomType;
-    label?: string;
-    permissions: ChatPermission[];
-}
-
-declare type ChatRoomType = (typeof chatRoomTypes)[number];
-
-declare const chatRoomTypes: readonly ["group", "direct", "staff", "system"];
-
-declare type ChatThemeTokens = {
-    colorPrimary?: string;
-    colorSurface?: string;
-    colorBorder?: string;
-    colorText?: string;
-    radius?: string | number;
-    fontFamily?: string;
-};
-
 declare type ClassProp = {
     class: ClassValue;
     className?: never;
@@ -136,12 +52,6 @@ export declare const monitorCameraVideoClassName = "h-full w-full object-cover -
 
 declare type OmitUndefined<T> = T extends undefined ? never : T;
 
-declare interface OperationCommittedEvent {
-    boardId: string;
-    revision: number;
-    operation: WhiteboardCommittedOperation;
-}
-
 export declare function RoomActionButton({ icon, state, ...props }: ComponentProps<typeof Button> & {
     icon: ReactNode;
     state: RoomActionState;
@@ -295,11 +205,45 @@ declare const RoomPlatformCapability: {
     readonly PRIVATE_ROOM_INVITE: "private_room:invite";
     readonly PRIVATE_ROOM_RESPOND: "private_room:respond";
     readonly PRIVATE_ROOM_CLOSE: "private_room:close";
+    readonly WHITEBOARD_WRITE: "whiteboard:write";
     readonly WHITEBOARD_CLEAR: "whiteboard:clear";
 };
 
 declare type RoomPlatformCapabilityName = (typeof RoomPlatformCapability)[keyof typeof RoomPlatformCapability];
 
+declare type RoomPlatformChatIntegration = {
+    available: true;
+    apiEndpoint: string;
+    realtimeEndpoint: string;
+    token: string;
+    tokenExpiresAt: string;
+    refreshToken: string;
+    refreshTokenExpiresAt: string;
+    rooms: readonly RoomPlatformChatRoom[];
+    currentRoomId: string;
+} | {
+    available: false;
+    unavailableReason: 'CHAT_TOKEN_EXCHANGE_FAILED';
+};
+
+declare interface RoomPlatformChatRoom {
+    roomId: string;
+    roomType: 'group';
+    label?: string;
+    permissions: string[];
+}
+
+export declare type RoomPlatformCompletionActionConfig = {
+    onConfirm: () => Promise<void>;
+    disabled?: boolean;
+    disabledReason?: string;
+    label?: string;
+    confirmationTitle?: string;
+    confirmationDescription?: string;
+    confirmationActionLabel?: string;
+    errorMessage?: string;
+};
+
 export declare type RoomPlatformConnectionStatus = 'connecting' | 'connected' | 'reconnecting' | 'error';
 
 declare type RoomPlatformContextValue = {
@@ -424,6 +368,7 @@ export declare type RoomPlatformGatewayAccess = {
     accessSessionExpiresAt: string;
     accessSessionToken: string;
     capabilities: RoomPlatformCapabilityName[];
+    integrations?: RoomPlatformIntegrations;
     liveKit: {
         participantIdentity: string;
         roomName: string;
@@ -438,13 +383,10 @@ export declare const RoomPlatformGatewayErrorCode: {
     readonly LAUNCH_TICKET_INVALID: "ROOM_PLATFORM_LAUNCH_TICKET_INVALID";
 };
 
-export declare type RoomPlatformIntegrations = {
-    chat?: Pick<ChatProviderProps, 'endpoint' | 'realtimeEndpoint' | 'token' | 'tokenExpiresAt' | 'refreshToken' | 'refreshTokenExpiresAt' | 'rooms' | 'currentRoomId'>;
-    whiteboard?: {
-        joinState: WhiteboardJoinState;
-        runtime: Pick<WhiteboardRuntimeOptions, 'realtimeEndpoint' | 'recoveryPort'>;
-    };
-};
+export declare interface RoomPlatformIntegrations {
+    chat: RoomPlatformChatIntegration;
+    whiteboard: RoomPlatformWhiteboardIntegration;
+}
 
 export declare type RoomPlatformLifecycleEvent = 'exchange.succeeded' | 'exchange.failed' | 'renewal.succeeded' | 'renewal.failed' | 'reconnect.succeeded' | 'reconnect.failed';
 
@@ -620,8 +562,8 @@ export declare function RoomPlatformRoom(props: RoomPlatformRoomProps): JSX.Elem
 
 export declare type RoomPlatformRoomProps = {
     apiBaseUrl: string;
+    completionAction?: RoomPlatformCompletionActionConfig;
     extensions?: RoomPlatformExtensions;
-    integrations?: RoomPlatformIntegrations;
     launchToken: string;
     isPracticeMode?: boolean;
     sizing?: RoomPlatformSizing;
@@ -674,10 +616,11 @@ export declare function RoomPlatformSpeakQueue({ activeSpeakerParticipantIdentit
     raisedHandParticipantIdentities: readonly string[];
 }): JSX.Element;
 
-export declare function RoomPlatformTopBar({ monitorSelector, topBarLeading, topBarTrailing }: RoomPlatformTopBarProps): JSX.Element;
+export declare function RoomPlatformTopBar({ monitorSelector, completionAction, topBarLeading, topBarTrailing, }: RoomPlatformTopBarProps): JSX.Element;
 
 export declare type RoomPlatformTopBarProps = {
     monitorSelector?: ReactNode;
+    completionAction?: ReactNode;
     topBarLeading?: ReactNode;
     topBarTrailing?: ReactNode;
 };
@@ -702,6 +645,16 @@ declare type RoomPlatformVideoTracksProps = {
     status?: RoomPlatformConnectionStatus;
 };
 
+declare type RoomPlatformWhiteboardIntegration = {
+    available: true;
+    apiEndpoint: string;
+    realtimeEndpoint: string;
+    auth: WhiteboardJoinAuth;
+} | {
+    available: false;
+    unavailableReason: 'TOKEN_EXCHANGE_FAILED' | 'WHITEBOARD_UNAVAILABLE';
+};
+
 declare interface RoomPrivateRoomConnection {
     roomName: string;
     token: string;
@@ -727,14 +680,6 @@ declare interface RoomPrivateRoomState {
 
 declare type RoomPrivateRoomStatus = 'ringing' | 'active';
 
-declare interface SocketLike {
-    auth?: unknown;
-    connect: () => void;
-    disconnect: () => void;
-    emit: (event: string, payload?: unknown, acknowledgement?: (response: unknown) => void) => void;
-    on: (event: string, handler: (payload: unknown) => void) => void;
-}
-
 export declare function useRoomPlatform(): RoomPlatformContextValue;
 
 declare function useRoomPlatformCameraBackground({ localVideoTrack }: UseRoomPlatformCameraBackgroundInput): {
@@ -794,249 +739,14 @@ export declare function useRoomPresence(): RoomParticipantPresence[];
 
 declare type VariantProps<Component extends (...args: any) => any> = Omit<OmitUndefined<Parameters<Component>[0]>, "class" | "className">;
 
-declare const WHITEBOARD_ANNOTATION_ERASE_OPERATION: "annotation.object.erase";
-
-declare const WHITEBOARD_ANNOTATION_UPSERT_OPERATION: "annotation.object.upsert";
-
-declare const WHITEBOARD_CLEAR_OPERATION: "clear";
-
-declare const WHITEBOARD_RESTORE_CLEAR_OPERATION: "restore_clear";
-
-declare interface WhiteboardAnnotationEraseOperation extends WhiteboardOperationEnvelope {
-    type: typeof WHITEBOARD_ANNOTATION_ERASE_OPERATION;
-    payload: WhiteboardAnnotationErasePayload;
-}
-
-declare interface WhiteboardAnnotationErasePayload extends Record<string, unknown> {
-    objectId: string;
-}
-
-declare type WhiteboardAnnotationSceneObject = WhiteboardAnnotationStrokeSceneObject | WhiteboardAnnotationShapeSceneObject;
-
-declare type WhiteboardAnnotationShapeSceneObject = WhiteboardSceneObject & {
-    objectType: 'annotation.shape';
-    payload: WhiteboardShapeObjectPayload;
-};
-
-declare type WhiteboardAnnotationStrokeSceneObject = WhiteboardSceneObject & {
-    objectType: 'annotation.stroke';
-    payload: WhiteboardStrokeObjectPayload;
-};
-
-declare interface WhiteboardAnnotationUpsertOperation extends WhiteboardOperationEnvelope {
-    type: typeof WHITEBOARD_ANNOTATION_UPSERT_OPERATION;
-    payload: WhiteboardAnnotationUpsertPayload;
-}
-
-declare interface WhiteboardAnnotationUpsertPayload extends Record<string, unknown> {
-    object: WhiteboardAnnotationSceneObject;
-}
-
-declare interface WhiteboardBootstrapRequest {
-    token: string;
-    boardId: string;
-}
-
-declare interface WhiteboardBootstrapResponse {
-    boardId: string;
-    shareSessionKey: string;
-    headRevision: number;
-    objects: WhiteboardSceneObject[];
-}
-
-declare interface WhiteboardClearOperation extends WhiteboardOperationEnvelope {
-    type: typeof WHITEBOARD_CLEAR_OPERATION;
-    payload?: undefined;
-}
-
-declare type WhiteboardCommittedOperation = WhiteboardAnnotationUpsertOperation | WhiteboardAnnotationEraseOperation | WhiteboardClearOperation | WhiteboardRestoreClearOperation;
-
-declare interface WhiteboardDeltaItem {
-    revision: number;
-    createdAt: string;
-    actorSubject?: string | null;
-    operation: WhiteboardCommittedOperation;
-}
-
-declare interface WhiteboardDeltaRequest {
-    token: string;
-    boardId: string;
-    afterRevision: number;
-    limit?: number;
-}
-
-declare interface WhiteboardDeltaResponse {
-    boardId: string;
-    fromRevision: number;
-    toRevision: number;
-    headRevision: number;
-    hasMore: boolean;
-    operations: WhiteboardDeltaItem[];
-}
-
-declare type WhiteboardFreehandKind = (typeof whiteboardFreehandKinds)[number];
-
-declare const whiteboardFreehandKinds: readonly ["pen", "highlighter", "marker"];
-
 declare interface WhiteboardJoinAuth {
     permissions: WhiteboardPermission[];
     token: string;
     tokenExpiresAt: string;
 }
 
-declare type WhiteboardJoinState = {
-    available: true;
-    auth: WhiteboardJoinAuth;
-} | {
-    available: false;
-    unavailableReason: WhiteboardUnavailableReason;
-};
-
-declare interface WhiteboardNormalizedPoint {
-    x: number;
-    y: number;
-}
-
-declare interface WhiteboardOperationEnvelope {
-    operationId: string;
-    type: string;
-    payload?: Record<string, unknown>;
-}
-
 declare type WhiteboardPermission = (typeof whiteboardPermissions)[number];
 
 declare const whiteboardPermissions: readonly ["whiteboard:view", "whiteboard:write", "whiteboard:clear"];
 
-declare interface WhiteboardRecoveryPort {
-    bootstrap: (request: WhiteboardBootstrapRequest, signal: AbortSignal) => Promise<WhiteboardBootstrapResponse>;
-    delta: (request: WhiteboardDeltaRequest, signal: AbortSignal) => Promise<WhiteboardDeltaResponse>;
-}
-
-declare interface WhiteboardRecoveryState {
-    bootstrap: WhiteboardBootstrapResponse;
-    deltas: WhiteboardDeltaResponse[];
-    discardLocalHistory?: boolean;
-    mode?: 'incremental' | 'replace';
-    settledOperationIds?: string[];
-}
-
-declare interface WhiteboardRestoreClearOperation extends WhiteboardOperationEnvelope {
-    type: typeof WHITEBOARD_RESTORE_CLEAR_OPERATION;
-    payload: {
-        clearOperationId: string;
-        objects: WhiteboardAnnotationSceneObject[];
-    };
-}
-
-declare interface WhiteboardRuntimeBoardState {
-    activeShareSessionKey?: string;
-    boardId?: string;
-    confirmedRevision: number;
-    headRevision: number;
-    pendingOperationCount: number;
-}
-
-declare interface WhiteboardRuntimeCommittedEvent extends OperationCommittedEvent {
-    reconcileStrategy: 'replayable';
-}
-
-declare type WhiteboardRuntimeDiagnostic = {
-    type: 'submit_ack';
-    operationId: string;
-    revision: number;
-    latencyMs: number;
-    queueDepth: number;
-} | {
-    type: 'relay_echo';
-    operationId: string;
-    revision: number;
-    latencyMs: number;
-} | {
-    type: 'delta_request';
-    reason: 'initial_gap' | 'reconnect' | 'runtime_gap';
-    afterRevision: number;
-} | {
-    type: 'queue_depth';
-    depth: number;
-} | {
-    type: 'terminal_rollback';
-    operationCount: number;
-};
-
-declare interface WhiteboardRuntimeOptions {
-    onBoardStateChange?: (state: WhiteboardRuntimeBoardState) => void;
-    onCommittedEvent?: (event: WhiteboardRuntimeCommittedEvent) => void;
-    onDiagnostic?: (diagnostic: WhiteboardRuntimeDiagnostic) => void;
-    onRecoveryStateChange?: (recovery: WhiteboardRecoveryState | undefined) => void;
-    onRecoveryStatusChange?: (status: 'idle' | 'restoring' | 'recovered' | 'failed') => void;
-    onSubmitStatusChange?: (status: WhiteboardSubmitStatus) => void;
-    realtimeEndpoint?: string;
-    recoveryPort?: WhiteboardRecoveryPort;
-    socketFactory?: (endpoint: string, options: {
-        auth: {
-            token: string;
-        };
-        path: string;
-    }) => SocketLike;
-}
-
-declare interface WhiteboardSceneObject {
-    objectId: string;
-    objectType: string;
-    latestRevision: number;
-    payload: Record<string, unknown>;
-}
-
-declare type WhiteboardShapeKind = (typeof whiteboardShapeKinds)[number];
-
-declare const whiteboardShapeKinds: readonly ["line", "arrow", "double-arrow", "rectangle", "shaded-rectangle", "filled-rectangle", "circle", "shaded-circle", "filled-circle", "diamond", "shaded-diamond", "filled-diamond"];
-
-declare interface WhiteboardShapeObjectPayload extends Record<string, unknown> {
-    kind: WhiteboardShapeKind;
-    color: string;
-    widthPreset: WhiteboardStrokeWidthPreset;
-    start: WhiteboardNormalizedPoint;
-    end: WhiteboardNormalizedPoint;
-}
-
-declare interface WhiteboardStrokeObjectPayload extends Record<string, unknown> {
-    kind: WhiteboardFreehandKind;
-    color: string;
-    widthPreset: WhiteboardStrokeWidthPreset;
-    points: WhiteboardNormalizedPoint[];
-    vanishAt?: string;
-}
-
-declare type WhiteboardStrokeWidthPreset = (typeof whiteboardStrokeWidthPresets)[number];
-
-declare const whiteboardStrokeWidthPresets: readonly ["xs", "sm", "md", "lg"];
-
-declare type WhiteboardSubmitStatus = {
-    state: 'idle';
-} | {
-    state: 'submitting';
-    operationId: string;
-} | {
-    state: 'accepted';
-    operationId: string;
-} | {
-    state: 'conflict';
-    operationId: string;
-    expectedBaseRevision: number;
-} | {
-    state: 'forbidden';
-    operationId: string;
-} | {
-    state: 'board_not_ready';
-    operationId: string;
-} | {
-    state: 'unavailable';
-    operationId: string;
-    retryAfterMs?: number;
-};
-
-declare type WhiteboardUnavailableReason = (typeof whiteboardUnavailableReasons)[number];
-
-declare const whiteboardUnavailableReasons: readonly ["TOKEN_EXCHANGE_FAILED", "WHITEBOARD_UNAVAILABLE"];
-
 export { }