@naviedu/room-platform-react 0.0.1

package/room-platform-types.d.ts

@@ -0,0 +1,154 @@
+import type { ChatProviderProps } from '@navi/chat-react';
+import type { RoomActionName, RoomLaunchTicketRenewalReason, RoomPlatformCapabilityName } from '@navi/feature-room-platform';
+import type { WhiteboardJoinState } from '@navi/whiteboard-core';
+import type { WhiteboardRuntimeOptions } from '@navi/whiteboard-react';
+import type { ComponentType, ReactNode } from 'react';
+export type { RoomLaunchTicketRenewalReason };
+export declare const RoomPlatformGatewayErrorCode: {
+    readonly ACCESS_SESSION_INVALID: "ROOM_PLATFORM_ACCESS_SESSION_INVALID";
+    readonly LAUNCH_TICKET_INVALID: "ROOM_PLATFORM_LAUNCH_TICKET_INVALID";
+};
+export declare const RoomPlatformRuntimeErrorCode: {
+    readonly LIVEKIT_TOKEN_EXPIRED: "LIVEKIT_TOKEN_EXPIRED";
+};
+export type RoomPlatformConnectionStatus = 'connecting' | 'connected' | 'reconnecting' | 'error';
+export type RoomPlatformLocalMediaKind = 'microphone' | 'camera' | 'screenShare';
+export type RoomPlatformDeviceKind = 'audioinput' | 'audiooutput' | 'videoinput';
+export type RoomPlatformActiveDevices = Record<RoomPlatformDeviceKind, string | undefined>;
+export type RoomPlatformActionName = RoomActionName;
+export type RoomPlatformErrorScope = 'action' | 'connection' | 'media';
+export type RoomPlatformErrorEvent = {
+    error: Error;
+    recoverable: boolean;
+    scope: RoomPlatformErrorScope;
+};
+export type RoomPlatformPresentation = {
+    kind: 'empty';
+} | {
+    kind: 'participant';
+    participantIdentity: string;
+} | {
+    kind: 'screen-share';
+    participantIdentity: string;
+} | {
+    kind: 'whiteboard';
+} | {
+    kind: 'workspace';
+    placement: 'overlay' | 'alongside-stage';
+};
+export type RoomPlatformActions = {
+    hasCapability: (capability: RoomPlatformCapabilityName) => boolean;
+    isPending: (name: RoomPlatformActionName, payload?: Record<string, string>) => boolean;
+    perform: (name: RoomPlatformActionName, payload?: Record<string, string>) => Promise<void>;
+};
+export type RoomPlatformIntegrations = {
+    chat?: Pick<ChatProviderProps, 'endpoint' | 'realtimeEndpoint' | 'token' | 'tokenExpiresAt' | 'refreshToken' | 'refreshTokenExpiresAt' | 'rooms' | 'currentRoomId'>;
+    whiteboard?: {
+        joinState: WhiteboardJoinState;
+        runtime: Pick<WhiteboardRuntimeOptions, 'realtimeEndpoint' | 'recoveryPort'>;
+    };
+};
+export type RoomParticipantPresence = {
+    canPublishAudio: boolean;
+    canPublishVideo: boolean;
+    participantIdentity: string;
+    externalActorId?: string;
+    handRaisedAt?: string;
+    hasAudio: boolean;
+    hasVideo: boolean;
+    isActiveSpeaker: boolean;
+    isHandRaised: boolean;
+    isLocal: boolean;
+    isSpeaking: boolean;
+    name?: string;
+};
+export type RoomParticipantPresenceState = {
+    isActiveSpeaker?: boolean;
+    isHandRaised?: boolean;
+    isLocal?: boolean;
+    online: boolean;
+    participantIdentity?: string;
+};
+export type RoomParticipantRowSupplementProps = RoomPlatformExtensionProps & {
+    participant: RoomParticipantRosterEntry;
+    presence: RoomParticipantPresenceState;
+};
+export type RoomParticipantRosterEntry = {
+    externalActorId: string;
+    displayName: string;
+    avatarUrl?: string;
+    subtitle?: string;
+    supplement?: ComponentType<RoomParticipantRowSupplementProps>;
+};
+export type RoomPlatformExtensionProps = {
+    actions: RoomPlatformActions;
+    capabilities: readonly RoomPlatformCapabilityName[];
+    connectionStatus: RoomPlatformConnectionStatus;
+    currentParticipant?: RoomParticipantPresence;
+    presentation: RoomPlatformPresentation;
+    roomId?: string;
+};
+export type RoomPlatformExtensions = {
+    topBarLeading?: ComponentType<RoomPlatformExtensionProps>;
+    topBarTrailing?: ComponentType<RoomPlatformExtensionProps>;
+    monitor?: {
+        roster: readonly RoomParticipantRosterEntry[];
+        roomEligible: boolean;
+    };
+    mainWorkspace?: {
+        placement: 'overlay' | 'alongside-stage';
+        component: ComponentType<RoomPlatformExtensionProps>;
+    };
+    sidebarTabs?: readonly {
+        id: string;
+        title: string;
+        component: ComponentType<RoomPlatformExtensionProps>;
+    }[];
+    participantTab?: {
+        mode: 'default';
+        roster?: readonly RoomParticipantRosterEntry[];
+    } | {
+        mode: 'replace';
+        title?: string;
+        component: ComponentType<RoomPlatformExtensionProps>;
+    };
+};
+export type RoomPlatformRoomProps = {
+    apiBaseUrl: string;
+    extensions?: RoomPlatformExtensions;
+    integrations?: RoomPlatformIntegrations;
+    launchToken: string;
+    isPracticeMode?: boolean;
+    primaryCameraSelector?: (cameraTracks: readonly import('@livekit/components-react').TrackReference[], activeSpeakerParticipantIdentity?: string) => import('@livekit/components-react').TrackReference | null;
+    showLocalPreview?: boolean;
+    onError?: (event: RoomPlatformErrorEvent) => void;
+    onLifecycleEvent?: (event: RoomPlatformLifecycleEvent) => void;
+    onExit?: () => void;
+    onLaunchTicketRequired: (reason: RoomLaunchTicketRenewalReason) => Promise<{
+        launchToken: string;
+    }>;
+    children?: ReactNode;
+};
+export type RoomPlatformLifecycleEvent = 'exchange.succeeded' | 'exchange.failed' | 'renewal.succeeded' | 'renewal.failed' | 'reconnect.succeeded' | 'reconnect.failed';
+export type RoomPlatformEvent = {
+    type: 'connected';
+    roomId: string;
+} | {
+    type: 'reconnecting';
+    reason: RoomLaunchTicketRenewalReason;
+} | {
+    type: 'error';
+    error: Error;
+};
+export type RoomPlatformGatewayAccess = {
+    accessSessionExpiresAt: string;
+    accessSessionToken: string;
+    capabilities: RoomPlatformCapabilityName[];
+    liveKit: {
+        participantIdentity: string;
+        roomName: string;
+        token: string;
+        wsUrl: string;
+    };
+    roomId: string;
+};

package/room-platform-ui-primitives.d.ts

@@ -0,0 +1,60 @@
+import { Dialog as DialogPrimitive, Select as SelectPrimitive, Tabs as TabsPrimitive, Tooltip as TooltipPrimitive } from 'radix-ui';
+import * as React from 'react';
+type ClassName = string | false | null | undefined;
+export declare const cn: (...classes: ClassName[]) => string;
+export type RoomPlatformSurfaceProps = React.PropsWithChildren<React.HTMLAttributes<HTMLElement>>;
+export declare function RoomPlatformSurface({ children, className, ...props }: RoomPlatformSurfaceProps): import("react/jsx-runtime").JSX.Element;
+export type RoomPlatformPanelProps = React.PropsWithChildren<React.HTMLAttributes<HTMLDivElement>>;
+export declare function RoomPlatformPanel({ children, className, ...props }: RoomPlatformPanelProps): import("react/jsx-runtime").JSX.Element;
+export type RoomPlatformButtonProps = React.ButtonHTMLAttributes<HTMLButtonElement> & {
+    tone?: 'default' | 'quiet' | 'danger';
+};
+export declare function RoomPlatformButton({ className, tone, type, ...props }: RoomPlatformButtonProps): import("react/jsx-runtime").JSX.Element;
+type ButtonVariant = 'default' | 'outline' | 'secondary' | 'ghost' | 'destructive' | 'link';
+type ButtonSize = 'default' | 'xs' | 'sm' | 'lg' | 'xl' | 'icon' | 'icon-xs' | 'icon-sm' | 'icon-lg' | 'icon-xl';
+export declare function Button({ className, variant, size, asChild, type, ...props }: React.ComponentProps<'button'> & {
+    asChild?: boolean;
+    size?: ButtonSize;
+    variant?: ButtonVariant;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function Dialog(props: React.ComponentProps<typeof DialogPrimitive.Root>): import("react/jsx-runtime").JSX.Element;
+export declare function DialogTrigger(props: React.ComponentProps<typeof DialogPrimitive.Trigger>): import("react/jsx-runtime").JSX.Element;
+export declare function DialogPortal(props: React.ComponentProps<typeof DialogPrimitive.Portal>): import("react/jsx-runtime").JSX.Element;
+export declare function DialogClose(props: React.ComponentProps<typeof DialogPrimitive.Close>): import("react/jsx-runtime").JSX.Element;
+export declare function DialogOverlay({ className, ...props }: React.ComponentProps<typeof DialogPrimitive.Overlay>): import("react/jsx-runtime").JSX.Element;
+export declare function DialogContent({ className, children, showCloseButton, maximizable, ...props }: React.ComponentProps<typeof DialogPrimitive.Content> & {
+    maximizable?: boolean;
+    showCloseButton?: boolean;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function DialogHeader({ className, ...props }: React.ComponentProps<'div'>): import("react/jsx-runtime").JSX.Element;
+export declare function DialogFooter({ className, showCloseButton, children, ...props }: React.ComponentProps<'div'> & {
+    showCloseButton?: boolean;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function DialogTitle({ className, ...props }: React.ComponentProps<typeof DialogPrimitive.Title>): import("react/jsx-runtime").JSX.Element;
+export declare function DialogDescription({ className, ...props }: React.ComponentProps<typeof DialogPrimitive.Description>): import("react/jsx-runtime").JSX.Element;
+export declare function Tabs({ className, orientation, ...props }: React.ComponentProps<typeof TabsPrimitive.Root>): import("react/jsx-runtime").JSX.Element;
+type TabsListVariant = 'default' | 'line';
+export declare const tabsListVariants: (variant?: TabsListVariant) => string;
+export declare function TabsList({ className, variant, ...props }: React.ComponentProps<typeof TabsPrimitive.List> & {
+    variant?: TabsListVariant;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function TabsTrigger({ className, ...props }: React.ComponentProps<typeof TabsPrimitive.Trigger>): import("react/jsx-runtime").JSX.Element;
+export declare function TabsContent({ className, ...props }: React.ComponentProps<typeof TabsPrimitive.Content>): import("react/jsx-runtime").JSX.Element;
+export declare function Select(props: React.ComponentProps<typeof SelectPrimitive.Root>): import("react/jsx-runtime").JSX.Element;
+export declare function SelectGroup({ className, ...props }: React.ComponentProps<typeof SelectPrimitive.Group>): import("react/jsx-runtime").JSX.Element;
+export declare function SelectValue(props: React.ComponentProps<typeof SelectPrimitive.Value>): import("react/jsx-runtime").JSX.Element;
+export declare function SelectTrigger({ className, size, children, ...props }: React.ComponentProps<typeof SelectPrimitive.Trigger> & {
+    size?: 'default' | 'sm';
+}): import("react/jsx-runtime").JSX.Element;
+export declare function SelectContent({ className, children, position, align, ...props }: React.ComponentProps<typeof SelectPrimitive.Content>): import("react/jsx-runtime").JSX.Element;
+export declare function SelectLabel({ className, ...props }: React.ComponentProps<typeof SelectPrimitive.Label>): import("react/jsx-runtime").JSX.Element;
+export declare function SelectItem({ className, children, ...props }: React.ComponentProps<typeof SelectPrimitive.Item>): import("react/jsx-runtime").JSX.Element;
+export declare function SelectSeparator({ className, ...props }: React.ComponentProps<typeof SelectPrimitive.Separator>): import("react/jsx-runtime").JSX.Element;
+export declare function SelectScrollUpButton({ className, ...props }: React.ComponentProps<typeof SelectPrimitive.ScrollUpButton>): import("react/jsx-runtime").JSX.Element;
+export declare function SelectScrollDownButton({ className, ...props }: React.ComponentProps<typeof SelectPrimitive.ScrollDownButton>): import("react/jsx-runtime").JSX.Element;
+export declare function TooltipProvider({ delayDuration, ...props }: React.ComponentProps<typeof TooltipPrimitive.Provider>): import("react/jsx-runtime").JSX.Element;
+export declare function Tooltip(props: React.ComponentProps<typeof TooltipPrimitive.Root>): import("react/jsx-runtime").JSX.Element;
+export declare function TooltipTrigger(props: React.ComponentProps<typeof TooltipPrimitive.Trigger>): import("react/jsx-runtime").JSX.Element;
+export declare function TooltipContent({ className, sideOffset, children, ...props }: React.ComponentProps<typeof TooltipPrimitive.Content>): import("react/jsx-runtime").JSX.Element;
+export declare function Spinner({ className, ...props }: React.ComponentProps<'svg'>): import("react/jsx-runtime").JSX.Element;
+export {};

package/room-platform-video-tile.d.ts

@@ -0,0 +1,13 @@
+import { type TrackReference } from '@livekit/components-react';
+import type { ReactNode } from 'react';
+export type RoomPlatformVideoTileKind = 'active-speaker' | 'overlay' | 'preview' | 'stage';
+export type RoomPlatformVideoTileProps = {
+    kind: RoomPlatformVideoTileKind;
+    label?: string;
+    trackRef?: TrackReference;
+    className?: string;
+    media?: ReactNode;
+    mediaClassName?: string;
+    labelPosition?: 'bottom-left' | 'top-left';
+};
+export declare function RoomPlatformVideoTile({ kind, label, trackRef, className, media, mediaClassName, labelPosition, }: RoomPlatformVideoTileProps): import("react/jsx-runtime").JSX.Element;

package/room-platform-video-tracks.d.ts

@@ -0,0 +1,6 @@
+import type { RoomPlatformConnectionStatus } from './room-platform-types';
+type RoomPlatformVideoTracksProps = {
+    status?: RoomPlatformConnectionStatus;
+};
+export declare function RoomPlatformVideoTracks({ status }: RoomPlatformVideoTracksProps): import("react/jsx-runtime").JSX.Element;
+export {};