@cloudflare/realtimekit 1.5.1 → 1.5.2-staging.2

package/dist/index.d.ts

@@ -1503,70 +1503,6 @@ interface DeleteChatMessageResponse {
  */
 declare const DeleteChatMessageResponse: DeleteChatMessageResponse$Type;
 
-declare class EnablePluginResponse$Type extends MessageType$1<EnablePluginResponse> {
-    constructor();
-}
-/**
- * Response sent whenever a plugin is enabled.
- * Applicable for all requests that enable a plugin.
- *
- * @generated from protobuf message socket.plugin.EnablePluginResponse
- */
-interface EnablePluginResponse {
-    /**
-     * @generated from protobuf field: string plugin_id = 1;
-     */
-    pluginId: string;
-    /**
-     * @generated from protobuf field: string enabled_by = 2;
-     */
-    enabledBy: string;
-}
-/**
- * @generated MessageType for protobuf message socket.plugin.EnablePluginResponse
- */
-declare const EnablePluginResponse: EnablePluginResponse$Type;
-declare class EnablePluginsResponse$Type extends MessageType$1<EnablePluginsResponse> {
-    constructor();
-}
-/**
- * Response sent when all enabled plugins are requested.
- *
- * @generated from protobuf message socket.plugin.EnablePluginsResponse
- */
-interface EnablePluginsResponse {
-    /**
-     * @generated from protobuf field: repeated socket.plugin.EnablePluginResponse plugins = 1;
-     */
-    plugins: EnablePluginResponse[];
-}
-/**
- * @generated MessageType for protobuf message socket.plugin.EnablePluginsResponse
- */
-declare const EnablePluginsResponse: EnablePluginsResponse$Type;
-declare class DisablePluginResponse$Type extends MessageType$1<DisablePluginResponse> {
-    constructor();
-}
-/**
- * Response sent whenever a plugin is disabled.
- * Applicable for all requests that disable a plugin.
- *
- * @generated from protobuf message socket.plugin.DisablePluginResponse
- */
-interface DisablePluginResponse {
-    /**
-     * @generated from protobuf field: string plugin_id = 1;
-     */
-    pluginId: string;
-    /**
-     * @generated from protobuf field: string disabled_by = 2;
-     */
-    disabledBy: string;
-}
-/**
- * @generated MessageType for protobuf message socket.plugin.DisablePluginResponse
- */
-declare const DisablePluginResponse: DisablePluginResponse$Type;
 declare class PluginStoreItem$Type extends MessageType$1<PluginStoreItem> {
     constructor();
 }
@@ -1622,28 +1558,6 @@ interface PluginStoreResponse {
  * @generated MessageType for protobuf message socket.plugin.PluginStoreResponse
  */
 declare const PluginStoreResponse: PluginStoreResponse$Type;
-declare class PluginEventResponse$Type extends MessageType$1<PluginEventResponse> {
-    constructor();
-}
-/**
- * Response sent for custom plugin event.
- *
- * @generated from protobuf message socket.plugin.PluginEventResponse
- */
-interface PluginEventResponse {
-    /**
-     * @generated from protobuf field: string plugin_id = 1;
-     */
-    pluginId: string;
-    /**
-     * @generated from protobuf field: bytes plugin_data = 2;
-     */
-    pluginData: Uint8Array;
-}
-/**
- * @generated MessageType for protobuf message socket.plugin.PluginEventResponse
- */
-declare const PluginEventResponse: PluginEventResponse$Type;
 
 declare class GetStagePeersResponse$Type extends MessageType$1<GetStagePeersResponse> {
     constructor();
@@ -3205,154 +3119,6 @@ declare class Livestream extends TypedEventEmitter$1<LivestreamEvents> {
     stop(): Promise<void>;
 }
 
-type PluginSocketMessage = DisablePluginResponse | EnablePluginResponse | PluginEventResponse | PluginStoreResponse | SendChatMessageToPeersResponse | SendChatMessageToRoomResponse;
-declare class PluginSocketHandler {
-    constructor(context: Context<ContextState>, socketService: SocketService);
-    get logger(): Logger;
-    addPlugin(pluginId: string, staggered: boolean): void;
-    removePlugin(pluginId: string): void;
-    getActivePlugins(): Promise<EnablePluginsResponse>;
-    customPluginEventToRoom(pluginId: string, data: any, messageId?: string): void;
-    customPluginEventToPeers(pluginId: string, peerIds: string[], data: any, messageId?: string): void;
-    enablePluginForRoom(pluginId: string, messageId?: string): void;
-    enablePluginForPeers(pluginId: string, peerIds: string[], messageId?: string): void;
-    disablePluginForRoom(pluginId: string, messageId?: string): void;
-    disablePluginForPeers(pluginId: string, peerIds: string[], messageId?: string): void;
-    storeInsertKeys(pluginId: string, store: string, insertKeys: {
-        key: string;
-        payload?: any;
-    }[], messageId?: string): void;
-    storeGetKeys(pluginId: string, store: string, getKeys: {
-        key: string;
-    }[], messageId?: string): void;
-    storeDeleteKeys(pluginId: string, store: string, deleteKeys: {
-        key: string;
-    }[], messageId?: string): void;
-    storeDelete(pluginId: string, store: string, messageId?: string): void;
-    getPluginDataOld(pluginId: string, store: string): void;
-    storePluginDataOld(pluginId: string, store: string, data: any): void;
-    on(event: number, handler: (socketMessage: PluginSocketMessage, messageId?: string) => void): void;
-}
-
-interface PluginResponse {
-    baseURL: string;
-    createdAt: string;
-    description: string;
-    id: string;
-    name: string;
-    organizationId: string;
-    picture: string;
-    private: boolean;
-    published: boolean;
-    staggered: boolean;
-    tags: string[];
-    type: string;
-    updatedAt: string;
-}
-interface PluginViews {
-    [viewId: string]: {
-        url: string;
-        suggestedPosition: string;
-    };
-}
-interface PluginConfig {
-    name: string;
-    pluginId: string;
-    version: string;
-    description: string;
-    author?: string;
-    repository?: string;
-    tags?: string[];
-    picture?: string;
-    url?: string;
-    files: {
-        include: string[];
-        exclude?: string[];
-    };
-    views?: PluginViews;
-    contentScript?: string;
-    permissions?: {
-        [key: string]: {
-            default: boolean;
-            description: string;
-        };
-    };
-    config?: {
-        [key: string]: string;
-    };
-}
-interface PluginIframeMessage {
-    type: number;
-    uuid: string;
-    payload?: any;
-}
-interface SendDataOptions {
-    eventName: string;
-    data: any;
-}
-interface ReactNativeWebViewEvent {
-    nativeEvent: {
-        data: string;
-    };
-}
-interface ReactNativeWebView {
-    src: string;
-    allow: string;
-    title: string;
-    props: {
-        onMessage: (event: ReactNativeWebViewEvent) => void;
-    };
-    postMessage: (message: string) => void;
-}
-declare const PluginEventKeys: {
-    stateUpdate: string;
-    ready: string;
-    closed: string;
-    toggleViewMode: string;
-    enabled: string;
-    '* ': string;
-};
-type _string = string & {
-    _?: any;
-};
-type PluginEvents$1 = keyof typeof PluginEventKeys | _string;
-declare class Plugin extends CustomEventEmitter<PluginEvents$1> {
-    readonly baseURL: string;
-    readonly createdAt: Date;
-    readonly description: string;
-    readonly id: string;
-    readonly name: string;
-    readonly organizationId: string;
-    readonly picture: string;
-    readonly private: boolean;
-    readonly published: boolean;
-    readonly staggered: boolean;
-    readonly tags: string[];
-    readonly type: string;
-    readonly updatedAt: Date;
-    config?: PluginConfig;
-    active: boolean;
-    iframes: Map<string, {
-        iframe: HTMLIFrameElement | ReactNativeWebView;
-        listener?: (message: MessageEvent) => void;
-    }>;
-    enabledBy: string;
-    get telemetry(): Telemetry;
-    constructor(context: Context<ContextState>, { baseURL, createdAt, description, id, name, organizationId, picture, private: isPrivate, published, staggered, tags, type, updatedAt, }: PluginResponse, pluginSocketHandler: PluginSocketHandler, self: Self, participants: Participants, chat: Readonly<Chat>, meetingTitle: string);
-    sendIframeEvent(message: PluginIframeMessage): void;
-    private handleIframeMessage;
-    sendData(payload: SendDataOptions): void;
-    removePluginView(viewId?: string): void;
-    addPluginView(iframe: HTMLIFrameElement | ReactNativeWebView, viewId?: string): void;
-    private setActive;
-    activateForSelf(): Promise<void>;
-    deactivateForSelf(): void;
-    enable(): Promise<void>;
-    disable(): void;
-    activate(): Promise<void>;
-    deactivate(): Promise<void>;
-}
-
 interface RecordingConfig {
     fileNamePrefix?: string;
     videoConfig?: {
@@ -3370,10 +3136,6 @@ declare class APIClient extends API {
     telemetry: Telemetry;
     constructor(context: Context<ContextState>, options?: APIOptions);
     getICEServers(): Promise<any>;
-    getPlugins(): Promise<any[]>;
-    getPluginDetails(pluginId: string): Promise<PluginResponse>;
-    getPluginConfig(pluginBaseUrl: string): Promise<PluginConfig>;
-    authorizePlugin(pluginId: string): Promise<string>;
     getPresignedUrls(filename: string): Promise<{
         getLocation: any;
         putLocation: any;
@@ -3576,6 +3338,113 @@ declare class Polls extends TypedEventEmitter$1<PollsEvents> {
     vote(id: string, index: number): Promise<void>;
 }
 
+declare class StoresSocketHandler {
+    constructor(context: Context<ContextState>, socketService: SocketService);
+    get logger(): Logger;
+    get peerId(): string;
+    storeInsertKeys(pluginId: string, store: string, insertKeys: {
+        key: string;
+        payload?: unknown;
+    }[], messageId?: string): void;
+    storeGetKeys(pluginId: string, store: string, getKeys: {
+        key: string;
+    }[], messageId?: string): void;
+    storeDeleteKeys(pluginId: string, store: string, deleteKeys: {
+        key: string;
+    }[], messageId?: string): void;
+    on(event: number, handler: (socketMessage: PluginStoreResponse, messageId?: string) => void): void;
+}
+
+type StoreData = {
+    [type: string]: any;
+};
+type RateLimitConfig = {
+    maxInvocations: number;
+    period: number;
+};
+declare class Store {
+    name: string;
+    rateLimitConfig: {
+        maxInvocations: number;
+        period: number;
+    };
+    bulkRateLimitConfig: {
+        maxInvocations: number;
+        period: number;
+    };
+    private listeners;
+    constructor({ name, socketHandler, meetingId }: {
+        name: string;
+        socketHandler: StoresSocketHandler;
+        meetingId: string;
+    });
+    set(key: string, value: any, sync?: boolean, emit?: boolean): Promise<void>;
+    private remoteSet;
+    bulkSet(data: Array<{
+        key: string;
+        payload: any;
+    }>): Promise<void>;
+    update(key: string, value: any, sync?: boolean): Promise<void>;
+    delete(key: string, sync?: boolean, emit?: boolean): Promise<void>;
+    bulkDelete(data: Array<{
+        key: string;
+    }>): Promise<void>;
+    get(key: string): any;
+    getAll(): StoreData;
+    clear(): void;
+    get rateLimits(): {
+        maxInvocations: number;
+        period: number;
+    };
+    updateRateLimits(num: number, period: number): void;
+    get bulkRateLimits(): {
+        maxInvocations: number;
+        period: number;
+    };
+    updateBulkRateLimits(num: number, period: number): void;
+    subscribe(key: string | '*', cb: (value: any) => any): void;
+    unsubscribe(key: string | '*', cb?: (value: any) => any): void;
+    populate(data: StoreData): void;
+}
+
+interface ClientPluginPermissions {
+    canActivate: boolean;
+    canDeactivate: boolean;
+}
+interface ClientPluginConfig {
+    name: string;
+    icon: string;
+    id: string;
+    permissions: ClientPluginPermissions;
+    component: unknown;
+}
+declare const PluginEventKeys: {
+    stateUpdate: string;
+    ready: string;
+    closed: string;
+    enabled: string;
+    '* ': string;
+};
+type _string = string & {
+    _?: any;
+};
+type PluginEvents$1 = keyof typeof PluginEventKeys | _string;
+declare class Plugin extends CustomEventEmitter<PluginEvents$1> {
+    readonly name: string;
+    readonly icon: string;
+    readonly id: string;
+    readonly permissions: ClientPluginPermissions;
+    active: boolean;
+    enabledBy: string;
+    get component(): unknown;
+    get telemetry(): Telemetry;
+    constructor(context: Context<ContextState>, config: ClientPluginConfig, activePluginsStore: Store, self: Self);
+    activateForSelf(): void;
+    deactivateForSelf(): void;
+    activate(): Promise<void>;
+    deactivate(): Promise<void>;
+}
+
 type PluginMapEvents = {
     ['pluginAdded']: (plugin: Plugin) => void;
     ['pluginDeleted']: (plugin: Plugin) => void;
@@ -3605,6 +3474,13 @@ declare class Plugins {
     constructor(logger: Logger);
 }
 
+declare class StoreManager {
+    stores: Map<String, Store>;
+    constructor(context: Context<ContextState>, handler: StoresSocketHandler);
+    create(name: string, _internal?: boolean): Promise<Store>;
+    refresh(name: string): Promise<Store>;
+}
+
 declare class SelfMedia extends TypedEventEmitter$1<SelfEvents> {
     protected localMediaHandler: LocalMediaHandler;
     constructor(context: Context<ContextState>, logger: Logger);
@@ -3787,63 +3663,6 @@ declare class Internals {
     static init(context: Context<ContextState>): Internals;
 }
 
-type StoreData = {
-    [type: string]: any;
-};
-type RateLimitConfig = {
-    maxInvocations: number;
-    period: number;
-};
-declare class Store {
-    name: string;
-    rateLimitConfig: {
-        maxInvocations: number;
-        period: number;
-    };
-    bulkRateLimitConfig: {
-        maxInvocations: number;
-        period: number;
-    };
-    private listeners;
-    constructor({ name, socketHandler, meetingId }: {
-        name: string;
-        socketHandler: PluginSocketHandler;
-        meetingId: string;
-    });
-    set(key: string, value: any, sync?: boolean, emit?: boolean): Promise<void>;
-    private remoteSet;
-    bulkSet(data: Array<{
-        key: string;
-        payload: any;
-    }>): Promise<void>;
-    update(key: string, value: any, sync?: boolean): Promise<void>;
-    delete(key: string, sync?: boolean, emit?: boolean): Promise<void>;
-    bulkDelete(data: Array<{
-        key: string;
-    }>): Promise<void>;
-    get(key: string): any;
-    getAll(): StoreData;
-    get rateLimits(): {
-        maxInvocations: number;
-        period: number;
-    };
-    updateRateLimits(num: number, period: number): void;
-    get bulkRateLimits(): {
-        maxInvocations: number;
-        period: number;
-    };
-    updateBulkRateLimits(num: number, period: number): void;
-    subscribe(key: string | '*', cb: (value: any) => any): void;
-    unsubscribe(key: string | '*', cb?: (value: any) => any): void;
-    populate(data: StoreData): void;
-}
-
-declare class StoreManager {
-    stores: Map<String, Store>;
-    constructor(context: Context<ContextState>, handler: PluginSocketHandler);
-    create(name: string): Promise<Store>;
-}
-
 declare const enum PRODUCERS_TYPE {
     WEBCAM = "webcam",
     WEBCAM_BACKUP = "webcam_backup",
@@ -4054,14 +3873,6 @@ interface Modules {
     devTools?: {
         logs: boolean;
         logLevel?: LogLevel[number];
-        plugins?: {
-            id: string;
-            name: string;
-            port: number;
-            picture?: string;
-            description?: string;
-            staggered?: boolean;
-        }[];
     };
     experimentalAudioPlayback?: boolean;
 }
@@ -4077,6 +3888,7 @@ interface DefaultOptions {
         screenshare?: ScreenshareQualityConstraints;
     };
     isNonPreferredDevice?: (device: MediaDeviceInfo) => boolean;
+    plugins?: ClientPluginConfig[];
 }
 interface RoomDetails {
     meetingTitle: string;
@@ -4894,7 +4706,6 @@ interface IceServerInformation {
 }
 interface CachedUserDetails {
     peerId?: string;
-    pluginInformation: PluginResponse[];
     userDetails: UserDetailsResponseV2;
     roomDetails: RoomDetails;
     iceServers: IceServerInformation[];
@@ -4915,7 +4726,6 @@ declare class API {
     protected authToken: string;
     protected organizationId: string;
     protected iceServers: IceServerInformation[];
-    protected pluginInformation: PluginResponse[];
     protected userDetails: UserDetailsResponseV2;
     protected roomDetails: RoomDetails;
     get peerId(): string;
@@ -4993,6 +4803,7 @@ type RTKParticipantMap = Readonly<ParticipantMap>;
 type RTKPlugin = Readonly<Plugin>;
 type RTKPlugins = Readonly<Plugins>;
 type RTKPluginMap = Readonly<PluginMap>;
+
 type RTKMeta = Readonly<Meta>;
 type RTKSelf = Readonly<Self>;
 type RTKSelfMedia = Readonly<SelfMedia>;
@@ -5032,4 +4843,4 @@ declare global {
     }
 }
 
-export { ActiveTab, ActiveTabType, AudioMiddleware, BroadcastMessagePayload, CachedUserDetails, ChatUpdateParams, ClientError, CustomMessage, DeviceConfig, FileMessage, ImageMessage, JoinedPeer, LeaveRoomState, LivestreamIngestionCredentials, LivestreamState, LogData, MediaConnectionState, MediaConnectionUpdate, MediaConstraints, MediaKind, MediaPermission, Message, BasicParticipant as RTKBasicParticipant, BasicParticipantsMap as RTKBasicParticipantsMap, RTKChat, ClientOptions as RTKClientOptions, RTKConfigOptions, RTKConnectedMeetings, RTKLivestream, RTKLogger, RTKMeta, RTKParticipant, RTKParticipantMap, RTKParticipants, RTKPermissionsPreset, RTKPlugin, RTKPluginMap, RTKPlugins, RTKPolls, RTKRecording, RTKSelf, RTKSelfMedia, RTKStore, StoreData as RTKStoreData, RateLimitConfig as RTKStoreRateLimitConfig, RTKThemePreset, RecordingState, RequestToJoinType, SocketConnectionState, StageStatus, StartLivestreamConfig, TextMessage, UserDetailsResponseV2, VideoMiddleware, VideoQualityConstraints, Client as default, LeaveRoomState as leaveRoomState };
+export { ActiveTab, ActiveTabType, AudioMiddleware, BroadcastMessagePayload, CachedUserDetails, ChatUpdateParams, ClientError, ClientPluginConfig, ClientPluginPermissions, CustomMessage, DeviceConfig, FileMessage, ImageMessage, JoinedPeer, LeaveRoomState, LivestreamIngestionCredentials, LivestreamState, LogData, MediaConnectionState, MediaConnectionUpdate, MediaConstraints, MediaKind, MediaPermission, Message, BasicParticipant as RTKBasicParticipant, BasicParticipantsMap as RTKBasicParticipantsMap, RTKChat, ClientOptions as RTKClientOptions, RTKConfigOptions, RTKConnectedMeetings, RTKLivestream, RTKLogger, RTKMeta, RTKParticipant, RTKParticipantMap, RTKParticipants, RTKPermissionsPreset, RTKPlugin, RTKPluginMap, RTKPlugins, RTKPolls, RTKRecording, RTKSelf, RTKSelfMedia, RTKStore, StoreData as RTKStoreData, RateLimitConfig as RTKStoreRateLimitConfig, RTKThemePreset, RecordingState, RequestToJoinType, SocketConnectionState, StageStatus, StartLivestreamConfig, TextMessage, UserDetailsResponseV2, VideoMiddleware, VideoQualityConstraints, Client as default, LeaveRoomState as leaveRoomState };