Class HiyveStore

Framework-agnostic state store for Hiyve WebRTC client.

Exposes subscribe/getSnapshot for universal framework integration:

React: useSyncExternalStore
Vue: watch + ref
Svelte: readable store
Vanilla: direct subscribe

Index

Constructors

Methods

addStoredRoom admitUser advertiseRoom clearActiveRoomsError clearRecordingError clearStoredRooms clearStoredRoomsError clearStreamingError clearUnread clearUserFiles clearUserFilesError closeNoVideoRoom connectActiveRooms createNoVideoRoom createRoom createUserFolder deleteStoredRoom deleteUserFile deleteUserFolder destroy disableCoaching disconnectActiveRooms dismissHint enableCoaching enrichTranscription fetchActiveRooms fetchStoredRooms fetchUserFiles getClient getRoomInfoFromToken getSlice getState getStoredRoom getStreamingUrls getUserFileUrl joinNoVideoRoom joinRoom joinRoomWithToken leaveRoom loadChatHistory lowerAllHands moveUserFile muteRemoteOutput rejectUser remoteMuteAudio remoteMuteVideo removeAdvertisedRoom renameUserFile resetLightweightClient sendDataMessage sendMessage setActiveRoom setAiChatMessages setAudioInputDevice setAudioOutputDevice setDominant setGain setVideoDevice shareUserFile startRecording startScreenShare startStreaming startTranscription stopRecording stopScreenShare stopStreaming stopTranscription subscribe subscribeToSlice switchStreamingUser toggleAudio toggleHandRaised toggleOutputMute toggleVideo transcribeRecording updateAdvertisedRoom updateCoachingData updateStoredRoom updateUserFileAppData uploadUserFile

Constructors

constructor

new HiyveStore(options?: HiyveStoreOptions): HiyveStore
Parameters
- options: HiyveStoreOptions = {}
Returns HiyveStore
- Defined in packages/core/src/store.ts:263

Methods

addStoredRoom

addStoredRoom(
options: CreateStoredRoomOptions,
userId: string,
): Promise<StoredRoom | null>
Create a new stored room.
Parameters
- options: CreateStoredRoomOptions
- userId: string
Returns Promise<StoredRoom | null>
- Defined in packages/core/src/store.ts:1910

admitUser

admitUser(userId: string): Promise<void>
Admit a user from the waiting room (owner only).
Parameters
- userId: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:1666

advertiseRoom

advertiseRoom(
    cloudClient: {
        advertiseRoom(options: AdvertiseRoomOptions): Promise<void>;
    },
    options: AdvertiseRoomOptions,
): Promise<void>
Advertise a room for discovery (owner action).
Parameters
- cloudClient: { advertiseRoom(options: AdvertiseRoomOptions): Promise<void> }
- options: AdvertiseRoomOptions
Returns Promise<void>
- Defined in packages/core/src/store.ts:2277

clearActiveRoomsError

clearActiveRoomsError(): void
Clear the active rooms error.

Returns void
- Defined in packages/core/src/store.ts:2302

clearRecordingError

clearRecordingError(): void
Clear recording error.

Returns void
- Defined in packages/core/src/store.ts:1482

clearStoredRooms

clearStoredRooms(): void
Reset stored rooms to initial state (e.g. on user change / logout).

Returns void
- Defined in packages/core/src/store.ts:2024

clearStoredRoomsError

clearStoredRoomsError(): void
Clear the stored rooms error.

Returns void
- Defined in packages/core/src/store.ts:2019

clearStreamingError

clearStreamingError(): void
Clear streaming error.

Returns void
- Defined in packages/core/src/store.ts:1513

clearUnread

clearUnread(): void
Clear the unread message counter.

Returns void
- Defined in packages/core/src/store.ts:1626

clearUserFiles

clearUserFiles(): void
Reset user files to initial state (e.g. on user change / logout).

Returns void
- Defined in packages/core/src/store.ts:2071

clearUserFilesError

clearUserFilesError(): void
Clear the user files error.

Returns void
- Defined in packages/core/src/store.ts:2066

closeNoVideoRoom

closeNoVideoRoom(): Promise<void>
Close the current no-video room and disconnect.

Returns Promise<void>
- Defined in packages/core/src/store.ts:1388

connectActiveRooms

connectActiveRooms(streamUrl: string): void
Connect to the active rooms SSE stream for real-time room discovery. The stream delivers snapshot, room-added, room-removed, and room-updated events.
Parameters
- streamUrl: string
  Full SSE endpoint URL (obtained from cloudClient.getActiveRoomsStreamUrl())
Returns void
- Defined in packages/core/src/store.ts:2173

createNoVideoRoom

createNoVideoRoom(roomName: string, userId: string): Promise<void>
Create a no-video (offline/signaling-only) room as the owner. Connects via signaling for chat, files, whiteboard, etc. — no WebRTC media.
Parameters
- roomName: string
- userId: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:1294

createRoom

createRoom(
    roomName: string,
    userId: string,
    options?: CreateRoomOptions,
): Promise<void>
Create a new room as the owner/host.
Parameters
- roomName: string
- userId: string
- Optionaloptions: CreateRoomOptions
Returns Promise<void>
- Defined in packages/core/src/store.ts:1099

createUserFolder

createUserFolder(location: string, roomName?: string): Promise<void>
Create a new folder at the given location.
Parameters
- location: string
- OptionalroomName: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:2144

deleteStoredRoom

deleteStoredRoom(roomName: string, userId: string): Promise<boolean>
Delete a stored room by roomName.
Parameters
- roomName: string
- userId: string
Returns Promise<boolean>
- Defined in packages/core/src/store.ts:1979

deleteUserFile

deleteUserFile(fileId: string): Promise<void>
Delete a user file by ID.
Parameters
- fileId: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:2095

deleteUserFolder

deleteUserFolder(location: string): Promise<void>
Delete a folder at the given location.
Parameters
- location: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:2151

destroy

destroy(): void
Destroy the store, clean up all resources.

Returns void
- Defined in packages/core/src/store.ts:2307

disableCoaching

disableCoaching(): void
Disable real-time coaching.

Returns void
- Defined in packages/core/src/store.ts:1823

disconnectActiveRooms

disconnectActiveRooms(): void
Disconnect from the active rooms SSE stream.

Returns void
- Defined in packages/core/src/store.ts:2251

dismissHint

dismissHint(hintId: string): void
Dismiss a coaching hint by ID.
Parameters
- hintId: string
Returns void
- Defined in packages/core/src/store.ts:1855

enableCoaching

enableCoaching(variant?: CoachingVariant): void
Enable real-time coaching with a specific variant.
Parameters
- variant: CoachingVariant = 'general'
Returns void
- Defined in packages/core/src/store.ts:1812

enrichTranscription

enrichTranscription(userId: string, moodData: TranscriptionMoodData): void
Enrich recent transcriptions with mood/sentiment data.
Parameters
- userId: string
- moodData: TranscriptionMoodData
Returns void
- Defined in packages/core/src/store.ts:1574

fetchActiveRooms

fetchActiveRooms(
cloudClient: { getActiveRooms(userId?: string): Promise<ActiveRoom[]> },
userId?: string,
): Promise<ActiveRoom[]>
Fetch active rooms (one-shot query for late joiners).
Parameters
- cloudClient: { getActiveRooms(userId?: string): Promise<ActiveRoom[]> }
- OptionaluserId: string
Returns Promise<ActiveRoom[]>
- Defined in packages/core/src/store.ts:2260

fetchStoredRooms

fetchStoredRooms(
    userId: string,
    options?: {
        consumerOnly?: boolean;
        enabledOnly?: boolean;
        offlineOnly?: boolean;
    },
): Promise<StoredRoom[]>
Fetch all stored rooms for a user.
Parameters
- userId: string
- Optionaloptions: { consumerOnly?: boolean; enabledOnly?: boolean; offlineOnly?: boolean }
Returns Promise<StoredRoom[]>
- Defined in packages/core/src/store.ts:1882

fetchUserFiles

fetchUserFiles(userId: string): Promise<UserFile[]>
Fetch all files across all rooms for a user (room owners only).
Parameters
- userId: string
Returns Promise<UserFile[]>
- Defined in packages/core/src/store.ts:2045

getClient

getClient(): Client | null
Get the raw Client instance (for advanced usage).

Returns Client | null
- Defined in packages/core/src/store.ts:304

getRoomInfoFromToken

getRoomInfoFromToken(
options: GetRoomInfoFromTokenOptions,
): Promise<RoomInfoFromToken>
Get room information from a join token without joining.
Parameters
- options: GetRoomInfoFromTokenOptions
Returns Promise<RoomInfoFromToken>
- Defined in packages/core/src/store.ts:1253

getSlice

getSlice<K extends keyof HiyveStoreState>(slice: K): HiyveStoreState[K]
Get a specific state slice (immutable snapshot).
Type Parameters
- K extends keyof HiyveStoreState
Parameters
- slice: K
Returns HiyveStoreState[K]
- Defined in packages/core/src/store.ts:299

getState

getState(): HiyveStoreState
Get the full current state (immutable snapshot).

Returns HiyveStoreState
- Defined in packages/core/src/store.ts:294

getStoredRoom

getStoredRoom(roomName: string, userId: string): Promise<StoredRoom | null>
Get a single stored room by roomName.
Parameters
- roomName: string
- userId: string
Returns Promise<StoredRoom | null>
- Defined in packages/core/src/store.ts:2008

getStreamingUrls

getStreamingUrls(): Promise<string | null>
Get the streaming URLs for the current stream.

Returns Promise<string | null>
- Defined in packages/core/src/store.ts:1524

getUserFileUrl

getUserFileUrl(fileId: string): Promise<string>
Get a presigned download URL for a file.
Parameters
- fileId: string
Returns Promise<string>
- Defined in packages/core/src/store.ts:2158

joinNoVideoRoom

joinNoVideoRoom(roomName: string, userId: string): Promise<void>
Join an existing no-video (offline/signaling-only) room as a participant. Connects via signaling for chat, files, whiteboard, etc. — no WebRTC media.
Parameters
- roomName: string
- userId: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:1337

joinRoom

joinRoom(roomName: string, userId: string): Promise<void>
Join an existing room as a participant.
Parameters
- roomName: string
- userId: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:1145

joinRoomWithToken

joinRoomWithToken(options: JoinRoomWithTokenOptions): Promise<void>
Join a room using a join token (from an invite link).
Parameters
- options: JoinRoomWithTokenOptions
Returns Promise<void>
- Defined in packages/core/src/store.ts:1196

leaveRoom

leaveRoom(): void
Leave the current room and disconnect.

Returns void
- Defined in packages/core/src/store.ts:1273

loadChatHistory

loadChatHistory(cursor?: string | null): Promise<{ hasMore: boolean }>
Load chat history from the server.
Parameters
- Optionalcursor: string | null
Returns Promise<{ hasMore: boolean }>
- Defined in packages/core/src/store.ts:1631

lowerAllHands

lowerAllHands(): Promise<void>
Lower all raised hands in the room (host only).

Returns Promise<void>
- Defined in packages/core/src/store.ts:1791

moveUserFile

moveUserFile(fileId: string, newLocation: string): Promise<void>
Move a user file to a new location/folder.
Parameters
- fileId: string
- newLocation: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:2109

muteRemoteOutput

muteRemoteOutput(userId: string, muted: boolean): Promise<void>
Mute/unmute a remote participant's audio output locally (owner only).
Parameters
- userId: string
- muted: boolean
Returns Promise<void>
- Defined in packages/core/src/store.ts:1724

rejectUser

rejectUser(userId: string): Promise<void>
Reject a user from the waiting room (owner only).
Parameters
- userId: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:1676

remoteMuteAudio

remoteMuteAudio(userId: string, muted: boolean): Promise<void>
Remotely mute/unmute a participant's audio (owner only).
Parameters
- userId: string
- muted: boolean
Returns Promise<void>
- Defined in packages/core/src/store.ts:1686

remoteMuteVideo

remoteMuteVideo(userId: string, muted: boolean): Promise<void>
Remotely mute/unmute a participant's video (owner only).
Parameters
- userId: string
- muted: boolean
Returns Promise<void>
- Defined in packages/core/src/store.ts:1705

removeAdvertisedRoom

removeAdvertisedRoom(
cloudClient: { removeAdvertisedRoom(roomName: string): Promise<void> },
roomName: string,
): Promise<void>
Remove an advertised room from discovery (owner action).
Parameters
- cloudClient: { removeAdvertisedRoom(roomName: string): Promise<void> }
- roomName: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:2285

renameUserFile

renameUserFile(fileId: string, newFilename: string): Promise<void>
Rename a user file.
Parameters
- fileId: string
- newFilename: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:2102

resetLightweightClient

resetLightweightClient(): void
Invalidate the cached lightweight client so the next API call generates a fresh room token for the new user. Call this on user change / logout to prevent stale-token data leaks.

Returns void
- Defined in packages/core/src/store.ts:2033

sendDataMessage

sendDataMessage(data: unknown): void
Send a data message (arbitrary JSON).
Parameters
- data: unknown
Returns void
- Defined in packages/core/src/store.ts:1620

sendMessage

sendMessage(content: string): void
Send a text chat message.
Parameters
- content: string
Returns void
- Defined in packages/core/src/store.ts:1602

setActiveRoom

setActiveRoom(roomName: string): void
Switch the active room name for file operations on an existing no-video connection. Avoids tearing down and re-establishing the signaling connection.
Parameters
- roomName: string
Returns void
- Defined in packages/core/src/store.ts:1380

setAiChatMessages

setAiChatMessages(messages: AiChatMessage[]): void
Set AI chat messages.
Parameters
- messages: AiChatMessage[]
Returns void
- Defined in packages/core/src/store.ts:1803

setAudioInputDevice

setAudioInputDevice(deviceId: string): Promise<void>
Switch to a different microphone.
Parameters
- deviceId: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:1439

setAudioOutputDevice

setAudioOutputDevice(deviceId: string): Promise<void>
Switch to a different speaker.
Parameters
- deviceId: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:1446

setDominant

setDominant(userId: string | null): void
Set the dominant speaker for video grid layouts (owner only).
Parameters
- userId: string | null
Returns void
- Defined in packages/core/src/store.ts:1754

setGain

setGain(value: number): void
Set the microphone gain (0-100).
Parameters
- value: number
Returns void
- Defined in packages/core/src/store.ts:1747

setVideoDevice

setVideoDevice(deviceId: string): Promise<void>
Switch to a different camera.
Parameters
- deviceId: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:1432

shareUserFile

shareUserFile(
    fileId: string,
    userIds: string[],
    sharedRoom?: string,
): Promise<void>
Share a user file with other users.
Parameters
- fileId: string
- userIds: string[]
- OptionalsharedRoom: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:2116

startRecording

startRecording(options?: RecordingOptions): Promise<boolean>
Start recording. Returns true if API call succeeded.
Parameters
- Optionaloptions: RecordingOptions
Returns Promise<boolean>
- Defined in packages/core/src/store.ts:1453

startScreenShare

startScreenShare(): Promise<void>
Start sharing screen.

Returns Promise<void>
- Defined in packages/core/src/store.ts:1420

startStreaming

startStreaming(options?: StreamingOptions): Promise<void>
Start cloud streaming.
Parameters
- Optionaloptions: StreamingOptions
Returns Promise<void>
- Defined in packages/core/src/store.ts:1487

startTranscription

startTranscription(): Promise<boolean>
Start real-time transcription. Returns true if API call succeeded.

Returns Promise<boolean>
- Defined in packages/core/src/store.ts:1555

stopRecording

stopRecording(): Promise<void>
Stop the current recording.

Returns Promise<void>
- Defined in packages/core/src/store.ts:1476

stopScreenShare

stopScreenShare(): Promise<void>
Stop sharing screen.

Returns Promise<void>
- Defined in packages/core/src/store.ts:1426

stopStreaming

stopStreaming(): Promise<void>
Stop live streaming.

Returns Promise<void>
- Defined in packages/core/src/store.ts:1507

stopTranscription

stopTranscription(): Promise<void>
Stop transcription.

Returns Promise<void>
- Defined in packages/core/src/store.ts:1568

subscribe(listener: () => void): () => void
Subscribe to all state changes. Returns unsubscribe function.
Parameters
- listener: () => void
Returns () => void
- Defined in packages/core/src/store.ts:277

subscribeToSlice

subscribeToSlice(slice: keyof HiyveStoreState, listener: () => void): () => void
Subscribe to changes in a specific state slice. Returns unsubscribe function.
Parameters
- slice: keyof HiyveStoreState
- listener: () => void
Returns () => void
- Defined in packages/core/src/store.ts:283

switchStreamingUser

switchStreamingUser(userId: string): Promise<void>
Switch the featured user in the stream.
Parameters
- userId: string
Returns Promise<void>
- Defined in packages/core/src/store.ts:1518

toggleAudio

toggleAudio(): Promise<void>
Toggle local microphone mute/unmute.

Returns Promise<void>
- Defined in packages/core/src/store.ts:1402

toggleHandRaised

toggleHandRaised(): Promise<void>
Toggle the local user's hand raised state.

Returns Promise<void>
- Defined in packages/core/src/store.ts:1764

toggleOutputMute

toggleOutputMute(): Promise<void>
Toggle speaker/output mute.

Returns Promise<void>
- Defined in packages/core/src/store.ts:1414

toggleVideo

toggleVideo(): Promise<void>
Toggle local camera on/off.

Returns Promise<void>
- Defined in packages/core/src/store.ts:1408

transcribeRecording

transcribeRecording(recordingId: string): Promise<boolean>
Trigger post-recording transcription and analysis on a completed recording. Unlike real-time transcription, this processes an existing recording asynchronously. Poll transcription status to track progress.
Parameters
- recordingId: string
Returns Promise<boolean>
- Defined in packages/core/src/store.ts:1544

updateAdvertisedRoom

updateAdvertisedRoom(
    cloudClient: {
        updateAdvertisedRoom(
            roomName: string,
            updates: Partial<AdvertiseRoomOptions>,
        ): Promise<void>;
    },
    roomName: string,
    updates: Partial<AdvertiseRoomOptions>,
): Promise<void>
Update an advertised room's metadata (owner action).
Parameters
- cloudClient: {
      updateAdvertisedRoom(
          roomName: string,
          updates: Partial<AdvertiseRoomOptions>,
      ): Promise<void>;
  }
- roomName: string
- updates: Partial<AdvertiseRoomOptions>
Returns Promise<void>
- Defined in packages/core/src/store.ts:2293

updateCoachingData

updateCoachingData(
    data: {
        currentTopic?: string;
        hints?: CoachingHint[];
        talkRatio?: { listening: number; speaking: number };
        topicShifts?: TopicShift[];
    },
): void
Update coaching data from the coaching endpoint response.
Parameters
- data: {
      currentTopic?: string;
      hints?: CoachingHint[];
      talkRatio?: { listening: number; speaking: number };
      topicShifts?: TopicShift[];
  }
Returns void
- Defined in packages/core/src/store.ts:1837

updateStoredRoom

updateStoredRoom(
    roomName: string,
    updates: StoredRoomUpdates,
    userId: string,
): Promise<boolean>
Update an existing stored room by roomName.
Parameters
- roomName: string
- updates: StoredRoomUpdates
- userId: string
Returns Promise<boolean>
- Defined in packages/core/src/store.ts:1957

updateUserFileAppData

updateUserFileAppData(
fileId: string,
appData: Record<string, unknown>,
): Promise<void>
Update application-specific metadata for a file without re-uploading content. Unlike other file mutations, this does NOT refresh the full file list to avoid disrupting the UI (re-sorting, losing selection). Callers manage local state.
Parameters
- fileId: string
- appData: Record<string, unknown>
Returns Promise<void>
- Defined in packages/core/src/store.ts:2127

uploadUserFile

uploadUserFile(
    file: File,
    location: string,
    resourceType?: string,
): Promise<{ fileId: string }>
Upload a file to the user's file storage.
Parameters
- file: File
- location: string
- OptionalresourceType: string
Returns Promise<{ fileId: string }>
- Defined in packages/core/src/store.ts:2136

Class HiyveStore

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns HiyveStore

Methods

addStoredRoom

Parameters

Returns Promise<StoredRoom | null>

admitUser

Parameters

Returns Promise<void>

advertiseRoom

Parameters

Returns Promise<void>

clearActiveRoomsError

Returns void

clearRecordingError

Returns void

clearStoredRooms

Returns void

clearStoredRoomsError

Returns void

clearStreamingError

Returns void

clearUnread

Returns void

clearUserFiles

Returns void

clearUserFilesError

Returns void

closeNoVideoRoom

Returns Promise<void>

connectActiveRooms

Parameters

Returns void

createNoVideoRoom

Parameters

Returns Promise<void>

createRoom

Parameters

Returns Promise<void>

createUserFolder

Parameters

Returns Promise<void>

deleteStoredRoom

Parameters

Returns Promise<boolean>

deleteUserFile

Parameters

Returns Promise<void>

deleteUserFolder

Parameters

Returns Promise<void>

destroy

Returns void

disableCoaching

Returns void

disconnectActiveRooms

Returns void

dismissHint

Parameters

Returns void

enableCoaching

Parameters

Returns void

enrichTranscription

Parameters

Returns void

fetchActiveRooms

Parameters

Returns Promise<ActiveRoom[]>

fetchStoredRooms

Parameters

Returns Promise<StoredRoom[]>

fetchUserFiles

Parameters