@cloudflare/realtimekit 1.5.2-staging.8 → 2.0.0-staging.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2010,30 +2010,6 @@ declare class RoomSocketHandler {
2010
2010
  on(event: number, handler: (message: EventHandlerTypes) => void): void;
2011
2011
  getUserPermissions(userId: string): Promise<Pick<PresetTypeV2['permissions'], 'chat' | 'polls' | 'plugins'>>;
2012
2012
  }
2013
- type TranscriptionData = {
2014
- id: string;
2015
- name: string;
2016
- peerId: string;
2017
- userId: string;
2018
- customParticipantId: string;
2019
- transcript: string;
2020
- isPartialTranscript: boolean;
2021
- date: Date;
2022
- };
2023
- type AiEvents = {
2024
- ['transcript']: (t: TranscriptionData) => void;
2025
- ['*']: (event: string, ...args: any[]) => void;
2026
- };
2027
- declare class Ai extends TypedEventEmitter<AiEvents> {
2028
- transcripts: TranscriptionData[];
2029
- readonly telemetry: Telemetry;
2030
- constructor(context: Context<ContextState>);
2031
- static init(context: Context<ContextState>, transcriptionEnabled: boolean): Promise<Ai>;
2032
- static parseTranscript(transcriptData: string, isPartialTranscript?: boolean): TranscriptionData | undefined;
2033
- static parseTranscripts(transcriptData: string): TranscriptionData[];
2034
- getActiveTranscript(): Promise<void>;
2035
- onTranscript(transcript: TranscriptionData): Promise<void>;
2036
- }
2037
2013
  type ActiveTabType = 'screenshare' | 'plugin';
2038
2014
  interface ActiveTab {
2039
2015
  type: ActiveTabType;
@@ -2057,7 +2033,6 @@ type MetaEvents = {
2057
2033
  ['meetingStartTimeUpdate']: (payload: {
2058
2034
  meetingStartedTimestamp: Date;
2059
2035
  }) => void;
2060
- ['transcript']: (t: TranscriptionData) => void;
2061
2036
  ['activeTabUpdate']: (tab: ActiveTab) => void;
2062
2037
  ['selfTabUpdate']: (tab: ActiveTab) => void;
2063
2038
  ['broadcastTabChangesUpdate']: (broadcastTabChanges: boolean) => void;
@@ -2488,8 +2463,6 @@ type PermissionEvents = {
2488
2463
  declare class PermissionPreset extends TypedEventEmitter<PermissionEvents> {
2489
2464
  private constructor();
2490
2465
  private setupEvents;
2491
- static fromResponse(response: PresetPermissions, viewType: ViewType, context: Context<ContextState>): PermissionPreset;
2492
- static default(context: Context<ContextState>, viewType: ViewType): PermissionPreset;
2493
2466
  static init(context: Context<ContextState>, viewType: ViewType, response?: PresetPermissions): PermissionPreset;
2494
2467
  readonly mediaRoomType: string;
2495
2468
  readonly stageEnabled: Readonly<boolean>;
@@ -2507,29 +2480,19 @@ declare class PermissionPreset extends TypedEventEmitter<PermissionEvents> {
2507
2480
  readonly kickParticipant: Readonly<boolean>;
2508
2481
  readonly pinParticipant: Readonly<boolean>;
2509
2482
  readonly canRecord: Readonly<boolean>;
2510
- readonly waitingRoomType: Readonly<WaitingRoomTypes>;
2511
2483
  readonly waitingRoomBehaviour: Readonly<WaitingRoomTypes>;
2512
2484
  readonly plugins: Readonly<PresetPermissions['plugins']>;
2513
2485
  readonly polls: Readonly<PresetPermissions['polls']>;
2514
- readonly produceVideo: Readonly<MediaProductionPermissionType>;
2515
- readonly requestProduce: Readonly<boolean>;
2516
2486
  readonly canProduceVideo: Readonly<MediaProductionPermissionType>;
2517
- readonly produceScreenshare: Readonly<MediaProductionPermissionType>;
2518
2487
  readonly canProduceScreenshare: Readonly<MediaProductionPermissionType>;
2519
- readonly produceAudio: Readonly<MediaProductionPermissionType>;
2520
2488
  readonly canProduceAudio: Readonly<MediaProductionPermissionType>;
2521
2489
  readonly chatPublic: Readonly<PresetPermissions['chat']['public']>;
2522
2490
  readonly chatPrivate: Readonly<PresetPermissions['chat']['private']>;
2523
2491
  readonly connectedMeetings: Readonly<PresetPermissions['connectedMeetings']>;
2524
2492
  readonly hiddenParticipant: Readonly<boolean>;
2525
2493
  readonly showParticipantList: Readonly<boolean>;
2526
- readonly canChangeParticipantRole: Readonly<boolean>;
2527
2494
  readonly canChangeParticipantPermissions: Readonly<boolean>;
2528
- readonly canChangeTheme: Readonly<boolean>;
2529
- readonly canPresent: Readonly<boolean>;
2530
- readonly acceptPresentRequests: Readonly<boolean>;
2531
2495
  readonly canEditDisplayName: Readonly<boolean>;
2532
- readonly maxScreenShareCount: Readonly<number>;
2533
2496
  readonly isRecorder: Readonly<boolean>;
2534
2497
  readonly canSpotlight: Readonly<boolean>;
2535
2498
  readonly canLivestream: Readonly<boolean>;
@@ -2653,6 +2616,30 @@ declare class API {
2653
2616
  setRoomUUID(id: string): void;
2654
2617
  setOrganizationId(id: string): void;
2655
2618
  }
2619
+ type TranscriptionData = {
2620
+ id: string;
2621
+ name: string;
2622
+ peerId: string;
2623
+ userId: string;
2624
+ customParticipantId: string;
2625
+ transcript: string;
2626
+ isPartialTranscript: boolean;
2627
+ date: Date;
2628
+ };
2629
+ type AiEvents = {
2630
+ ['transcript']: (t: TranscriptionData) => void;
2631
+ ['*']: (event: string, ...args: any[]) => void;
2632
+ };
2633
+ declare class Ai extends TypedEventEmitter<AiEvents> {
2634
+ transcripts: TranscriptionData[];
2635
+ readonly telemetry: Telemetry;
2636
+ constructor(context: Context<ContextState>);
2637
+ static init(context: Context<ContextState>, transcriptionEnabled: boolean): Promise<Ai>;
2638
+ static parseTranscript(transcriptData: string, isPartialTranscript?: boolean): TranscriptionData | undefined;
2639
+ static parseTranscripts(transcriptData: string): TranscriptionData[];
2640
+ getActiveTranscript(): Promise<void>;
2641
+ onTranscript(transcript: TranscriptionData): Promise<void>;
2642
+ }
2656
2643
  type StageSocketMessage = GetStageRequestsResponse | GetStagePeersResponse | DenyStageAccessRequest | PeerStatusUpdate;
2657
2644
  declare class StageSocketHandler {
2658
2645
  constructor(socketService: SocketService);
@@ -3356,8 +3343,6 @@ declare class Client {
3356
3343
  readonly stores: Readonly<StoreManager>;
3357
3344
  readonly audio: AudioPlaybackManager;
3358
3345
  readonly __internals__: Readonly<Internals>;
3359
- joinRoom(): Promise<void>;
3360
- leaveRoom(state?: LeaveRoomState): Promise<void>;
3361
3346
  }
3362
3347
  type ClientType = {
3363
3348
  callStats?: unknown;
@@ -3709,9 +3694,6 @@ declare class Participants extends TypedEventEmitter<ParticipantsEvents> {
3709
3694
  setPage(page: number): Promise<void>;
3710
3695
  disableAllAudio(allowUnmute: boolean): Promise<void>;
3711
3696
  disableAllVideo(): Promise<void>;
3712
- disableAudio(participantId: string): Promise<void>;
3713
- disableVideo(participantId: string): Promise<void>;
3714
- kick(participantId: string): Promise<void>;
3715
3697
  kickAll(): Promise<void>;
3716
3698
  broadcastMessage(type: Exclude<string, 'spotlight'>, payload: BroadcastMessagePayload, target?: BroadcastMessageTarget): Promise<void>;
3717
3699
  getAllJoinedPeers(searchQuery: string, limit: number, offset: number): Promise<{
@@ -3895,19 +3877,11 @@ declare class Chat extends TypedEventEmitter<ChatEvents> {
3895
3877
  editFileMessage(messageId: string, file: File | ReactNativeFile): Promise<void>;
3896
3878
  editMessage(messageId: string, message: MessagePayload): Promise<void>;
3897
3879
  deleteMessage(messageId: string): Promise<void>;
3898
- getMessagesByUser(userId: string): Message[];
3899
- getMessagesByType(type: keyof typeof MessageType): Message[];
3900
3880
  pin(id: string): Promise<void>;
3901
3881
  unpin(id: string): Promise<void>;
3902
3882
  fetchPublicMessages({ timestamp, limit, direction, }: FetchMessageOptions): Promise<Message[]>;
3903
3883
  fetchPrivateMessages({ timestamp, limit, direction, userId, }: FetchPrivateMessagesOptions): Promise<Message[]>;
3904
3884
  fetchPinnedMessages({ timestamp, limit, direction, }: FetchMessageOptions): Promise<Message[]>;
3905
- getMessages(timeStamp: number, size: number, reversed: boolean, offset?: number): Promise<{
3906
- messages: Message[];
3907
- next: boolean;
3908
- }>;
3909
- searchMessages(query: string, filters: unknown): Promise<unknown[]>;
3910
- readonly pinned: Message[];
3911
3885
  }
3912
3886
  declare const enum PRODUCERS_TYPE {
3913
3887
  WEBCAM = "webcam",
@@ -4247,7 +4221,6 @@ interface UserDetailsResponse {
4247
4221
  picture?: string;
4248
4222
  loggedIn?: boolean;
4249
4223
  scope?: string[];
4250
- clientSpecificId?: string;
4251
4224
  customParticipantId?: string;
4252
4225
  organizationId?: string;
4253
4226
  }
@@ -4333,7 +4306,6 @@ interface IParticipant {
4333
4306
  flags: {
4334
4307
  [key: string]: string | boolean;
4335
4308
  };
4336
- clientSpecificId?: string;
4337
4309
  customParticipantId?: string;
4338
4310
  stageStatus?: StageStatus;
4339
4311
  audioMuted: boolean;
@@ -4353,7 +4325,6 @@ declare class Participant extends TypedEventEmitter<ParticipantEvents> {
4353
4325
  picture: string;
4354
4326
  isHost: boolean;
4355
4327
  customParticipantId?: string;
4356
- readonly clientSpecificId: string;
4357
4328
  flags: {
4358
4329
  [key: string]: string | boolean;
4359
4330
  };
@@ -2047,30 +2047,6 @@ declare class RoomSocketHandler {
2047
2047
  on(event: number, handler: (message: EventHandlerTypes) => void): void;
2048
2048
  getUserPermissions(userId: string): Promise<Pick<PresetTypeV2['permissions'], 'chat' | 'polls' | 'plugins'>>;
2049
2049
  }
2050
- type TranscriptionData = {
2051
- id: string;
2052
- name: string;
2053
- peerId: string;
2054
- userId: string;
2055
- customParticipantId: string;
2056
- transcript: string;
2057
- isPartialTranscript: boolean;
2058
- date: Date;
2059
- };
2060
- type AiEvents = {
2061
- ['transcript']: (t: TranscriptionData) => void;
2062
- ['*']: (event: string, ...args: any[]) => void;
2063
- };
2064
- declare class Ai extends TypedEventEmitter$1<AiEvents> {
2065
- transcripts: TranscriptionData[];
2066
- readonly telemetry: Telemetry;
2067
- constructor(context: Context<ContextState>);
2068
- static init(context: Context<ContextState>, transcriptionEnabled: boolean): Promise<Ai>;
2069
- static parseTranscript(transcriptData: string, isPartialTranscript?: boolean): TranscriptionData | undefined;
2070
- static parseTranscripts(transcriptData: string): TranscriptionData[];
2071
- getActiveTranscript(): Promise<void>;
2072
- onTranscript(transcript: TranscriptionData): Promise<void>;
2073
- }
2074
2050
  type ActiveTabType = 'screenshare' | 'plugin';
2075
2051
  interface ActiveTab {
2076
2052
  type: ActiveTabType;
@@ -2094,7 +2070,6 @@ type MetaEvents = {
2094
2070
  ['meetingStartTimeUpdate']: (payload: {
2095
2071
  meetingStartedTimestamp: Date;
2096
2072
  }) => void;
2097
- ['transcript']: (t: TranscriptionData) => void;
2098
2073
  ['activeTabUpdate']: (tab: ActiveTab) => void;
2099
2074
  ['selfTabUpdate']: (tab: ActiveTab) => void;
2100
2075
  ['broadcastTabChangesUpdate']: (broadcastTabChanges: boolean) => void;
@@ -2585,9 +2560,6 @@ declare class Participants extends TypedEventEmitter$1<ParticipantsEvents> {
2585
2560
  setPage(page: number): Promise<void>;
2586
2561
  disableAllAudio(allowUnmute: boolean): Promise<void>;
2587
2562
  disableAllVideo(): Promise<void>;
2588
- disableAudio(participantId: string): Promise<void>;
2589
- disableVideo(participantId: string): Promise<void>;
2590
- kick(participantId: string): Promise<void>;
2591
2563
  kickAll(): Promise<void>;
2592
2564
  broadcastMessage(type: Exclude<string, 'spotlight'>, payload: BroadcastMessagePayload, target?: BroadcastMessageTarget): Promise<void>;
2593
2565
  getAllJoinedPeers(searchQuery: string, limit: number, offset: number): Promise<{
@@ -2993,8 +2965,6 @@ type PermissionEvents = {
2993
2965
  declare class PermissionPreset extends TypedEventEmitter$1<PermissionEvents> {
2994
2966
  private constructor();
2995
2967
  private setupEvents;
2996
- static fromResponse(response: PresetPermissions, viewType: ViewType, context: Context<ContextState>): PermissionPreset;
2997
- static default(context: Context<ContextState>, viewType: ViewType): PermissionPreset;
2998
2968
  static init(context: Context<ContextState>, viewType: ViewType, response?: PresetPermissions): PermissionPreset;
2999
2969
  readonly mediaRoomType: string;
3000
2970
  readonly stageEnabled: Readonly<boolean>;
@@ -3012,29 +2982,19 @@ declare class PermissionPreset extends TypedEventEmitter$1<PermissionEvents> {
3012
2982
  readonly kickParticipant: Readonly<boolean>;
3013
2983
  readonly pinParticipant: Readonly<boolean>;
3014
2984
  readonly canRecord: Readonly<boolean>;
3015
- readonly waitingRoomType: Readonly<WaitingRoomTypes>;
3016
2985
  readonly waitingRoomBehaviour: Readonly<WaitingRoomTypes>;
3017
2986
  readonly plugins: Readonly<PresetPermissions['plugins']>;
3018
2987
  readonly polls: Readonly<PresetPermissions['polls']>;
3019
- readonly produceVideo: Readonly<MediaProductionPermissionType>;
3020
- readonly requestProduce: Readonly<boolean>;
3021
2988
  readonly canProduceVideo: Readonly<MediaProductionPermissionType>;
3022
- readonly produceScreenshare: Readonly<MediaProductionPermissionType>;
3023
2989
  readonly canProduceScreenshare: Readonly<MediaProductionPermissionType>;
3024
- readonly produceAudio: Readonly<MediaProductionPermissionType>;
3025
2990
  readonly canProduceAudio: Readonly<MediaProductionPermissionType>;
3026
2991
  readonly chatPublic: Readonly<PresetPermissions['chat']['public']>;
3027
2992
  readonly chatPrivate: Readonly<PresetPermissions['chat']['private']>;
3028
2993
  readonly connectedMeetings: Readonly<PresetPermissions['connectedMeetings']>;
3029
2994
  readonly hiddenParticipant: Readonly<boolean>;
3030
2995
  readonly showParticipantList: Readonly<boolean>;
3031
- readonly canChangeParticipantRole: Readonly<boolean>;
3032
2996
  readonly canChangeParticipantPermissions: Readonly<boolean>;
3033
- readonly canChangeTheme: Readonly<boolean>;
3034
- readonly canPresent: Readonly<boolean>;
3035
- readonly acceptPresentRequests: Readonly<boolean>;
3036
2997
  readonly canEditDisplayName: Readonly<boolean>;
3037
- readonly maxScreenShareCount: Readonly<number>;
3038
2998
  readonly isRecorder: Readonly<boolean>;
3039
2999
  readonly canSpotlight: Readonly<boolean>;
3040
3000
  readonly canLivestream: Readonly<boolean>;
@@ -3262,19 +3222,11 @@ declare class Chat extends TypedEventEmitter$1<ChatEvents> {
3262
3222
  editFileMessage(messageId: string, file: File | ReactNativeFile): Promise<void>;
3263
3223
  editMessage(messageId: string, message: MessagePayload): Promise<void>;
3264
3224
  deleteMessage(messageId: string): Promise<void>;
3265
- getMessagesByUser(userId: string): Message[];
3266
- getMessagesByType(type: keyof typeof MessageType): Message[];
3267
3225
  pin(id: string): Promise<void>;
3268
3226
  unpin(id: string): Promise<void>;
3269
3227
  fetchPublicMessages({ timestamp, limit, direction, }: FetchMessageOptions): Promise<Message[]>;
3270
3228
  fetchPrivateMessages({ timestamp, limit, direction, userId, }: FetchPrivateMessagesOptions): Promise<Message[]>;
3271
3229
  fetchPinnedMessages({ timestamp, limit, direction, }: FetchMessageOptions): Promise<Message[]>;
3272
- getMessages(timeStamp: number, size: number, reversed: boolean, offset?: number): Promise<{
3273
- messages: Message[];
3274
- next: boolean;
3275
- }>;
3276
- searchMessages(query: string, filters: unknown): Promise<unknown[]>;
3277
- readonly pinned: Message[];
3278
3230
  }
3279
3231
  declare class PollSocketHandler {
3280
3232
  readonly logger: Logger;
@@ -3320,6 +3272,30 @@ declare class Polls extends TypedEventEmitter$1<PollsEvents> {
3320
3272
  create(question: string, options: string[], anonymous?: boolean, hideVotes?: boolean): Promise<void>;
3321
3273
  vote(id: string, index: number): Promise<void>;
3322
3274
  }
3275
+ type TranscriptionData = {
3276
+ id: string;
3277
+ name: string;
3278
+ peerId: string;
3279
+ userId: string;
3280
+ customParticipantId: string;
3281
+ transcript: string;
3282
+ isPartialTranscript: boolean;
3283
+ date: Date;
3284
+ };
3285
+ type AiEvents = {
3286
+ ['transcript']: (t: TranscriptionData) => void;
3287
+ ['*']: (event: string, ...args: any[]) => void;
3288
+ };
3289
+ declare class Ai extends TypedEventEmitter$1<AiEvents> {
3290
+ transcripts: TranscriptionData[];
3291
+ readonly telemetry: Telemetry;
3292
+ constructor(context: Context<ContextState>);
3293
+ static init(context: Context<ContextState>, transcriptionEnabled: boolean): Promise<Ai>;
3294
+ static parseTranscript(transcriptData: string, isPartialTranscript?: boolean): TranscriptionData | undefined;
3295
+ static parseTranscripts(transcriptData: string): TranscriptionData[];
3296
+ getActiveTranscript(): Promise<void>;
3297
+ onTranscript(transcript: TranscriptionData): Promise<void>;
3298
+ }
3323
3299
  declare class StoresSocketHandler {
3324
3300
  constructor(context: Context<ContextState>, socketService: SocketService);
3325
3301
  readonly logger: Logger;
@@ -4190,7 +4166,6 @@ interface UserDetailsResponse {
4190
4166
  picture?: string;
4191
4167
  loggedIn?: boolean;
4192
4168
  scope?: string[];
4193
- clientSpecificId?: string;
4194
4169
  customParticipantId?: string;
4195
4170
  organizationId?: string;
4196
4171
  }
@@ -4276,7 +4251,6 @@ interface IParticipant {
4276
4251
  flags: {
4277
4252
  [key: string]: string | boolean;
4278
4253
  };
4279
- clientSpecificId?: string;
4280
4254
  customParticipantId?: string;
4281
4255
  stageStatus?: StageStatus;
4282
4256
  audioMuted: boolean;
@@ -4296,7 +4270,6 @@ declare class Participant extends TypedEventEmitter$1<ParticipantEvents> {
4296
4270
  picture: string;
4297
4271
  isHost: boolean;
4298
4272
  customParticipantId?: string;
4299
- readonly clientSpecificId: string;
4300
4273
  flags: {
4301
4274
  [key: string]: string | boolean;
4302
4275
  };
@@ -4747,8 +4720,6 @@ declare class Client {
4747
4720
  readonly stores: Readonly<StoreManager>;
4748
4721
  readonly audio: AudioPlaybackManager;
4749
4722
  readonly __internals__: Readonly<Internals>;
4750
- joinRoom(): Promise<void>;
4751
- leaveRoom(state?: LeaveRoomState): Promise<void>;
4752
4723
  }
4753
4724
  declare enum RequestToJoinType {
4754
4725
  PRESENT = "REQUEST_TO_PRESENT"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cloudflare/realtimekit",
3
- "version": "1.5.2-staging.8",
3
+ "version": "2.0.0-staging.1",
4
4
  "description": "A real-time video and audio SDK for building custom, collaborative communication experiences.",
5
5
  "main": "./dist/index.cjs.js",
6
6
  "module": "./dist/index.es.js",