@cloudflare/realtimekit-ui 0.0.0 → 1.0.0-staging.10

package/dist/types/lib/lang/default-language.d.ts

@@ -0,0 +1,415 @@
+/**
+ * Default language dictionary
+ */
+export declare const defaultLanguage: {
+    about_call: string;
+    screen: string;
+    camera: string;
+    leave: string;
+    dismiss: string;
+    logo: string;
+    page: string;
+    more: string;
+    'page.prev': string;
+    'page.next': string;
+    layout: string;
+    'layout.auto': string;
+    settings: string;
+    file: string;
+    image: string;
+    connection: string;
+    leave_confirmation: string;
+    cancel: string;
+    yes: string;
+    '(you)': string;
+    you: string;
+    everyone: string;
+    to: string;
+    mute: string;
+    kick: string;
+    pin: string;
+    pinned: string;
+    accept: string;
+    unpin: string;
+    pip_on: string;
+    pip_off: string;
+    viewers: string;
+    join: string;
+    joined: string;
+    create: string;
+    close: string;
+    ask: string;
+    type: string;
+    activate: string;
+    requests: string;
+    mic_off: string;
+    disable_mic: string;
+    mic_on: string;
+    enable_mic: string;
+    audio: string;
+    test: string;
+    minimize: string;
+    maximize: string;
+    mute_all: string;
+    'mute_all.description': string;
+    'mute_all.header': string;
+    'mute_all.allow_unmute': string;
+    video_off: string;
+    disable_video: string;
+    video_on: string;
+    enable_video: string;
+    video: string;
+    offline: string;
+    'offline.description': string;
+    disconnected: string;
+    failed: string;
+    'failed.description': string;
+    'disconnected.description': string;
+    participants: string;
+    'participants.errors.empty_results': string;
+    'participants.empty_list': string;
+    'participants.no_pending_requests': string;
+    'participants.turn_off_video': string;
+    polls: string;
+    'polls.by': string;
+    'polls.question': string;
+    'polls.question.placeholder': string;
+    'polls.answers': string;
+    'polls.option': string;
+    'polls.option.placeholder': string;
+    'polls.results.anon': string;
+    'polls.results.hide': string;
+    'polls.create': string;
+    'polls.cancel': string;
+    'polls.empty': string;
+    'polls.errors.question_required': string;
+    'polls.errors.empty_option': string;
+    screenshare: string;
+    'screenshare.min_preview': string;
+    'screenshare.max_preview': string;
+    'screenshare.shared': string;
+    'screenshare.start': string;
+    'screenshare.stop': string;
+    'screenshare.error.unknown': string;
+    'screenshare.error.max_count': string;
+    plugins: string;
+    perm_denied: string;
+    'perm_denied.audio': string;
+    'perm_denied.video': string;
+    'perm_denied.screenshare': string;
+    'perm_denied.audio.chrome.message': string;
+    'perm_denied.video.chrome.message': string;
+    'perm_denied.screenshare.chrome.message': string;
+    'perm_denied.audio.safari.message': string;
+    'perm_denied.video.safari.message': string;
+    'perm_denied.screenshare.safari.message': string;
+    'perm_denied.audio.edge.message': string;
+    'perm_denied.video.edge.message': string;
+    'perm_denied.screenshare.edge.message': string;
+    'perm_denied.audio.microsoft edge.message': string;
+    'perm_denied.video.microsoft edge.message': string;
+    'perm_denied.screenshare.microsoft edge.message': string;
+    'perm_denied.audio.firefox.message': string;
+    'perm_denied.video.firefox.message': string;
+    'perm_denied.screenshare.firefox.message': string;
+    'perm_denied.audio.others.message': string;
+    'perm_denied.video.others.message': string;
+    'perm_denied.screenshare.others.message': string;
+    perm_sys_denied: string;
+    'perm_sys_denied.audio': string;
+    'perm_sys_denied.video': string;
+    'perm_sys_denied.screenshare': string;
+    'perm_sys_denied.audio.macos.message': string;
+    'perm_sys_denied.video.macos.message': string;
+    'perm_sys_denied.screenshare.macos.message': string;
+    'perm_sys_denied.audio.ios.message': string;
+    'perm_sys_denied.video.ios.message': string;
+    'perm_sys_denied.screenshare.ios.message': string;
+    'perm_sys_denied.audio.windows.message': string;
+    'perm_sys_denied.video.windows.message': string;
+    'perm_sys_denied.screenshare.windows.message': string;
+    'perm_sys_denied.audio.android.message': string;
+    'perm_sys_denied.video.android.message': string;
+    'perm_sys_denied.screenshare.android.message': string;
+    'perm_sys_denied.audio.others.message': string;
+    'perm_sys_denied.video.others.message': string;
+    'perm_sys_denied.screenshare.others.message': string;
+    perm_could_not_start: string;
+    'perm_could_not_start.audio': string;
+    'perm_could_not_start.video': string;
+    'perm_could_not_start.screenshare': string;
+    'perm_could_not_start.audio.message': string;
+    'perm_could_not_start.video.message': string;
+    'perm_could_not_start.screenshare.message': string;
+    full_screen: string;
+    'full_screen.exit': string;
+    'waitlist.header_title': string;
+    'waitlist.body_text': string;
+    'waitlist.deny_request': string;
+    'waitlist.accept_request': string;
+    'waitlist.accept_all': string;
+    'stage_request.header_title': string;
+    'stage_request.deny_request': string;
+    'stage_request.accept_request': string;
+    'stage_request.accept_all': string;
+    'stage_request.deny_all': string;
+    'stage_request.approval_pending': string;
+    'stage_request.denied': string;
+    'stage_request.request': string;
+    'stage_request.requested': string;
+    'stage_request.cancel_request': string;
+    'stage_request.leave_stage': string;
+    'stage_request.request_tip': string;
+    'stage_request.leave_tip': string;
+    'stage_request.pending_tip': string;
+    'stage_request.denied_tip': string;
+    'stage.empty_host': string;
+    'stage.empty_host_summary': string;
+    'stage.empty_viewer': string;
+    'stage.remove_from_stage': string;
+    'stage.invited_notification': string;
+    'stage.add_to_stage': string;
+    'stage.join_title': string;
+    'stage.join_summary': string;
+    'stage.join_cancel': string;
+    'stage.join_confirm': string;
+    'setup_screen.join_in_as': string;
+    'setup_screen.joining_as': string;
+    'setup_screen.your_name': string;
+    'stage.reconnecting': string;
+    'recording.label': string;
+    'recording.indicator': string;
+    'recording.started': string;
+    'recording.stopped': string;
+    'recording.paused': string;
+    'recording.error.start': string;
+    'recording.error.stop': string;
+    'recording.error.resume': string;
+    'recording.start': string;
+    'recording.stop': string;
+    'recording.resume': string;
+    'recording.starting': string;
+    'recording.stopping': string;
+    'recording.loading': string;
+    'recording.idle': string;
+    audio_playback: string;
+    'audio_playback.title': string;
+    'audio_playback.description': string;
+    breakout_rooms: string;
+    'breakout_rooms.room_config_header': string;
+    'breakout_rooms.join_breakout_header': string;
+    'breakout_rooms.empty': string;
+    'breakout_rooms.delete': string;
+    'breakout_rooms.switch': string;
+    'breakout_rooms.main_room': string;
+    'breakout_rooms.shuffle_participants': string;
+    'breakout_rooms.deselect': string;
+    'breakout_rooms.selected': string;
+    'breakout_rooms.num_of_rooms': string;
+    'breakout_rooms.approx': string;
+    'breakout_rooms.participants_per_room': string;
+    'breakout_rooms.division_text': string;
+    'breakout_rooms.start_breakout': string;
+    'breakout_rooms.close_breakout': string;
+    'breakout_rooms.update_breakout': string;
+    'breakout_rooms.discard_changes': string;
+    'breakout_rooms.room': string;
+    'breakout_rooms.rooms': string;
+    'breakout_rooms.room_name': string;
+    'breakout_rooms.edit_room_name': string;
+    'breakout_rooms.save_room_name': string;
+    'breakout_rooms.add_room': string;
+    'breakout_rooms.add_room_brief': string;
+    'breakout_rooms.select_all': string;
+    'breakout_rooms.unassign_all': string;
+    'breakout_rooms.assign': string;
+    'breakout_rooms.assign_participants': string;
+    'breakout_rooms.none_assigned': string;
+    'breakout_rooms.drag_drop_participants': string;
+    'breakout_rooms.click_drop_participants': string;
+    'breakout_rooms.status.assign_multiple': string;
+    'breakout_rooms.status.select_room': string;
+    'breakout_rooms.ephemeral_status.participants_assigned': string;
+    'breakout_rooms.ephemeral_status.participants_assigned_randomly': string;
+    'breakout_rooms.ephemeral_status.changes_discarded': string;
+    'breakout_rooms.confirm_modal.start_breakout.header': string;
+    'breakout_rooms.confirm_modal.start_breakout.content': string;
+    'breakout_rooms.confirm_modal.start_breakout.cancelText': string;
+    'breakout_rooms.confirm_modal.start_breakout.ctaText': string;
+    'breakout_rooms.confirm_modal.close_breakout.header': string;
+    'breakout_rooms.confirm_modal.close_breakout.content': string;
+    'breakout_rooms.confirm_modal.close_breakout.ctaText': string;
+    'breakout_rooms.move_reason.started_msg': string;
+    'breakout_rooms.move_reason.started_desc': string;
+    'breakout_rooms.move_reason.closed_msg': string;
+    'breakout_rooms.move_reason.closed_desc': string;
+    'breakout_rooms.move_reason.switch_room': string;
+    'breakout_rooms.move_reason.switch_main_room': string;
+    'breakout_rooms.all_assigned': string;
+    'breakout_rooms.empty_main_room': string;
+    'breakout_rooms.leave_confirmation': string;
+    'breakout_rooms.leave_confirmation.main_room_btn': string;
+    ai: string;
+    'ai.meeting_ai': string;
+    'ai.home': string;
+    'ai.transcriptions': string;
+    'ai.personal': string;
+    'ai.caption_view': string;
+    'ai.chat.tooltip': string;
+    'ai.chat.summerise': string;
+    'ai.chat.agenda': string;
+    search: string;
+    'search.could_not_find': string;
+    'search.empty': string;
+    end: string;
+    'end.all': string;
+    ended: string;
+    'ended.rejected': string;
+    'ended.left': string;
+    'ended.kicked': string;
+    'ended.disconnected': string;
+    'ended.network': string;
+    'ended.unauthorized': string;
+    network: string;
+    'network.reconnecting': string;
+    'network.delay_extended': string;
+    'network.disconnected': string;
+    'network.leaving': string;
+    'network.restored': string;
+    'network.delay': string;
+    'network.lost': string;
+    'network.lost_extended': string;
+    livestream: string;
+    'livestream.indicator': string;
+    'livestream.skip': string;
+    'livestream.idle': string;
+    'livestream.starting': string;
+    'livestream.stopping': string;
+    'livestream.waiting_on_manual_ingestion': string;
+    'livestream.error.not_supported': string;
+    'livestream.error.not_found': string;
+    'livestream.error.unknown': string;
+    'livestream.error.sync': string;
+    'livestream.error.start': string;
+    'livestream.error.stop': string;
+    'livestream.go_live': string;
+    'livestream.end_live': string;
+    'livestream.error': string;
+    'cta.help': string;
+    'cta.continue': string;
+    'cta.reload': string;
+    'cta.confirmation': string;
+    'cta.system_settings': string;
+    'remote_access.empty': string;
+    'remote_access.requests': string;
+    'remote_access.allow': string;
+    'remote_access.grant': string;
+    'remote_access.indicator': string;
+    chat: string;
+    'chat.new': string;
+    'chat.max_limit_warning': string;
+    'chat.rate_limit_error': string;
+    'chat.new_channel': string;
+    'chat.channel_name': string;
+    'chat.member_name': string;
+    'chat.add_members': string;
+    'chat.delete_msg': string;
+    'chat.edit_msg': string;
+    'chat.send_msg': string;
+    'chat.send_attachment': string;
+    'chat.send_img': string;
+    'chat.send_file': string;
+    'chat.send_emoji': string;
+    'chat.update_msg': string;
+    'chat.channel_members': string;
+    'chat.img.loading': string;
+    'chat.error.img_not_found': string;
+    'chat.error.empty_results': string;
+    'chat.img.shared_by': string;
+    'chat.reply': string;
+    'chat.message_placeholder': string;
+    'chat.click_to_send': string;
+    'chat.search_msgs': string;
+    'chat.search_conversations': string;
+    'chat.start_conversation': string;
+    'chat.empty_search': string;
+    'chat.empty_channel': string;
+    'chat.cancel_upload': string;
+    'chat.view_chats': string;
+    'chat.everyone': string;
+    'chat.pinned_msgs': string;
+    'chat.toggle_pinned_msgs': string;
+    'date.today': string;
+    'date.yesteday': string;
+    'date.sunday': string;
+    'date.monday': string;
+    'date.tuesday': string;
+    'date.wednesday': string;
+    'date.thursday': string;
+    'date.friday': string;
+    'date.saturday': string;
+    'list.empty': string;
+    'grid.listening': string;
+    'transcript.off': string;
+    'transcript.on': string;
+    'settings.notification_sound': string;
+    'settings.microphone_input': string;
+    'settings.speaker_output': string;
+    'settings.mirror_video': string;
+    'settings.camera_off': string;
+    'dialog.close': string;
+    'notifications.joined': string;
+    'notifications.left': string;
+    'notifications.requesting_to_join_meeting': string;
+    'notifications.requested_to_join_stage': string;
+    'notifications.joined_stage': string;
+    'notifications.request_to_join_accepted': string;
+    'notifications.request_to_join_rejected': string;
+    'notifications.accept': string;
+    'notifications.new_poll_created_by': string;
+    'notifications.connected_to': string;
+    'notifications.plugin_switched_to': string;
+    'notifications.remote_control_requested': string;
+    'notifications.remote_control_request_sent': string;
+    'notifications.remote_control_request_accepted': string;
+    'notifications.remote_control_granted': string;
+    'notifications.remote_control_terminated': string;
+    'debugger.troubleshooting.label': string;
+    'debugger.quality.good': string;
+    'debugger.quality.average': string;
+    'debugger.quality.poor': string;
+    'debugger.stats.bitrate.label': string;
+    'debugger.stats.bitrate.description': string;
+    'debugger.stats.packet_loss.label': string;
+    'debugger.stats.packet_loss.description': string;
+    'debugger.stats.jitter.label': string;
+    'debugger.stats.jitter.description': string;
+    'debugger.stats.cpu_limitations.label': string;
+    'debugger.stats.cpu_limitations.description': string;
+    'debugger.stats.bandwidth_limitations.label': string;
+    'debugger.stats.bandwidth_limitations.description': string;
+    'debugger.audio.label': string;
+    'debugger.audio.troubleshooting.label': string;
+    'debugger.audio.messages.generating_report': string;
+    'debugger.audio.messages.enable_media': string;
+    'debugger.audio.sections.network_media': string;
+    'debugger.video.label': string;
+    'debugger.video.troubleshooting.label': string;
+    'debugger.video.messages.generating_report': string;
+    'debugger.video.messages.enable_media': string;
+    'debugger.video.sections.network_media': string;
+    'debugger.screenshare.label': string;
+    'debugger.screenshare.troubleshooting.label': string;
+    'debugger.screenshare.sections.network_media': string;
+    'debugger.screenshare.messages.generating_report': string;
+    'debugger.screenshare.messages.enable_media': string;
+    'debugger.system.label': string;
+    'debugger.system.troubleshooting.label': string;
+    'debugger.system.sections.battery': string;
+    'debugger.system.battery.level.label': string;
+    'debugger.system.battery.level.description': string;
+    'debugger.system.battery.charging.label': string;
+    'debugger.system.battery.charging.description': string;
+    'debugger.system.battery.charging.is_charging': string;
+    'debugger.system.battery.charging.is_not_charging': string;
+};

package/dist/types/lib/lang/index.d.ts

@@ -0,0 +1,16 @@
+import { defaultLanguage } from './default-language';
+/**
+ * Language dictionary object type
+ */
+export type LangDict = typeof defaultLanguage;
+/**
+ * i18n helper method type
+ */
+export type RtkI18n = (key: keyof LangDict | (string & {})) => string;
+/**
+ * Creates an i18n instance from a language dictionary/object.
+ * @param lang The language dictionary
+ * @returns A function which handles i18n
+ */
+export declare const useLanguage: (lang?: Partial<LangDict | {}>) => RtkI18n;
+export { defaultLanguage };

package/dist/types/lib/notification.d.ts

@@ -0,0 +1,19 @@
+import { Meeting } from '../types/rtk-client';
+declare const SOUNDS: {
+    joined: string;
+    left: string;
+    message: string;
+};
+export type Sound = keyof typeof SOUNDS;
+/**
+ * Handles notification sounds in a meeting
+ */
+export default class RTKNotificationsAudio {
+    private audio;
+    private playing;
+    private meeting;
+    constructor(meeting: Meeting);
+    play(sound: Sound, duration?: number): void;
+    setDevice(id: string): Promise<void>;
+}
+export {};

package/dist/types/lib/render/index.d.ts

@@ -0,0 +1,45 @@
+import { FunctionalComponent } from '../../stencil-public-runtime';
+import { Meeting } from '../../types/rtk-client';
+import { Size, States } from '../../types/props';
+import { UIConfig } from '../../types/ui-config';
+import { Element } from '../../types/ui-config/root';
+import { IconPack } from '../icons';
+import { RtkI18n } from '../lang';
+export interface DefaultProps {
+    meeting: Meeting;
+    config: UIConfig;
+    size: Size;
+    states: States;
+    iconPack: IconPack;
+    t: RtkI18n;
+}
+export interface Props {
+    [prop: string]: any;
+}
+interface RenderChildrenProps {
+    elements: Element[];
+    defaults: DefaultProps;
+    props?: Props;
+    deepProps?: boolean;
+    elementProps?: Props;
+}
+/**
+ * Renders the children of an element.
+ */
+export declare const RenderChildren: FunctionalComponent<RenderChildrenProps>;
+interface RenderProps {
+    element: Element;
+    defaults: DefaultProps;
+    props?: Props;
+    childProps?: Props;
+    onlyChildren?: boolean;
+    asHost?: boolean;
+    deepProps?: boolean;
+    elementProps?: Props;
+}
+export declare const lenChildren: ({ element, defaults, props, elementProps }: RenderProps) => number;
+/**
+ * Renders an element from UI Config
+ */
+export declare const Render: FunctionalComponent<RenderProps>;
+export {};

package/dist/types/lib/render/utils.d.ts

@@ -0,0 +1,31 @@
+import { Size, States } from '../../types/props';
+import { UIConfig, UIStyles } from '../../types/ui-config';
+import { Element, StyleProps, UIRoot } from '../../types/ui-config/root';
+interface ComputeSelectorsParameters {
+    element: string;
+    states: States;
+    size: Size;
+    config: UIConfig;
+}
+/**
+ * Computes selectors and returns them based on their priority.
+ */
+export declare const computeSelectors: ({ element, size, states, config, }: ComputeSelectorsParameters) => string[];
+interface GetComputedStyleParams {
+    selectors: string[];
+    styles: UIStyles;
+}
+/**
+ * Returns the computed styles - styles obtained from combining styles from all computed selectors
+ * on the basis of their priorities.
+ */
+export declare const getComputedStyles: ({ selectors, styles }: GetComputedStyleParams) => StyleProps;
+interface GetComputedChildrenParams {
+    selectors: string[];
+    root: UIRoot;
+}
+/**
+ * Returns the computed children which are to be rendered inside an element
+ */
+export declare const getComputedChildren: ({ selectors, root }: GetComputedChildrenParams) => Element[];
+export {};

package/dist/types/lib/visualizer.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Draws audio visualizer of variant `bars`
+ * @param canvas Canvas element
+ * @param volume Current volume
+ */
+export declare const drawBarsVisualizer: (canvas: HTMLCanvasElement, volume: number) => void;