@pitcher/js-api 1.26.0-beta.3 → 1.26.0-beta.5

package/lib/sdk/api/modules/ui/index.d.ts

@@ -143,6 +143,7 @@ declare const _default: {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./types.ui').UiOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./types.ui').UiSelectCanvasesRequest): Promise<import('./types.ui').UiSelectCanvasesResponse>;
     captureAppError(payload: import('./types.ui').UiCaptureAppErrorRequest): Promise<void>;
     updateLocation(payload: import('../../../interfaces').UpdateLocationPitcherEvent): Promise<any>;

package/lib/sdk/api/modules/ui/types.ui.d.ts

@@ -23,6 +23,7 @@ export declare const UI_API_METHOD_TYPES: {
     readonly UI_UPDATE_CANVAS: "ui_update_canvas";
     readonly UI_PRINT_CANVAS: "ui_print_canvas";
     readonly UI_OPEN_CANVAS_OVERLAY: "ui_open_canvas_overlay";
+    readonly UI_OPEN_COLLECTION_PLAYER_OVERLAY: "ui_open_collection_player_overlay";
     readonly UI_SELECT_COLLECTION_PLAYER_CONTENT: "ui_select_collection_player_content";
     readonly UI_SELECT_AGENDA_CONTENT: "ui_select_agenda_content";
     readonly UI_UPDATE_LOCATION: "ui_update_location";
@@ -219,6 +220,25 @@ export interface UiPreselectSfdcMeetingIdResponse {
     /** Salesforce Event */
     event: SfEvent | null;
 }
+export interface UiOpenCollectionPlayerOverlayGroup {
+    /** File ID */
+    id: string;
+    /** File name */
+    name: string;
+    /** Optional: specific slides/pages to show from the file */
+    slides?: Array<{
+        /** The file ID (same as parent group.id) */
+        file_id: string;
+        /** Zero-based page/slide index to show */
+        slide_index: number;
+    }>;
+}
+export interface UiOpenCollectionPlayerOverlayRequest {
+    /** Array of files/slides to be played in the collection */
+    groups: UiOpenCollectionPlayerOverlayGroup[];
+    /** The display name for the collection */
+    name: string;
+}
 export type UiMessagePayloads = {
     [UI_MESSAGE_TYPES.UI_MEETING_CANCELED]: UiMeetingCanceledPayload;
     [UI_MESSAGE_TYPES.UI_APP_SET_DATA]: UiAppSetDataPayload;

package/lib/sdk/interfaces.d.ts

@@ -114,6 +114,7 @@ export interface RouteChangedPitcherEvent {
 export declare enum PitcherEventName {
     ENV_CHANGED = "env_changed",
     PHOTOS_CAPTURED = "photos_captured",
+    GLOBAL_PHOTO_CAPTURED = "global_photo_captured",
     FILE_DOWNLOADED = "file_downloaded",
     FILE_UPLOAD_PROGRESS = "file_upload_progress",
     UPDATE_LOCATION = "update_location",
@@ -335,6 +336,13 @@ export interface PitcherEventMap {
      * @see iOS-only
      */
     [PitcherEventName.PHOTOS_CAPTURED]: void;
+    /**
+     * @see iOS-only
+     */
+    [PitcherEventName.GLOBAL_PHOTO_CAPTURED]: {
+        url: string;
+        section_id?: string;
+    };
     /**
      * @see iOS-only
      */

package/lib/sdk/main.d.ts

@@ -54,6 +54,7 @@ export declare function useUi(): {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./api/modules/ui/types.ui').UiOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./api/modules/ui/types.ui').UiSelectCanvasesRequest): Promise<import('./api/modules/ui/types.ui').UiSelectCanvasesResponse>;
     captureAppError(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
     updateLocation(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
@@ -127,6 +128,7 @@ export declare function useAdmin(): {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./api/modules/admin/types.admin').AdminOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./api/modules/admin/types.admin').AdminSelectCanvasesRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCanvasesResponse>;
     getEnv(): Promise<import('./api/modules/admin/types.admin').AdminEnv>;
     selectCollectionContent(payload?: import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerResponse>;
@@ -186,6 +188,7 @@ export declare function useApi(options?: ApiOptions): {
     quitInstance: () => Promise<any>;
     getRequestTypes: () => Promise<any>;
     broadcast: (event: import('./interfaces').PitcherEvent) => Promise<any>;
+    broadcastToWebviews: (event: import('./interfaces').PitcherEvent) => Promise<any>;
     subscribe: () => Promise<any>;
     unsubscribe: () => Promise<any>;
     open(payload?: import('./payload.types').OpenRequestPayload): Promise<string>;
@@ -387,6 +390,7 @@ export declare function useApi(options?: ApiOptions): {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./api/modules/admin/types.admin').AdminOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./api/modules/admin/types.admin').AdminSelectCanvasesRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCanvasesResponse>;
     getEnv(): Promise<import('./api/modules/admin/types.admin').AdminEnv>;
     selectCollectionContent(payload?: import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerResponse>;
@@ -438,6 +442,7 @@ export declare function useApi(options?: ApiOptions): {
                 bottom?: number | string;
             };
         }): Promise<void>;
+        openCollectionPlayerOverlay(payload: import('./api/modules/ui/types.ui').UiOpenCollectionPlayerOverlayRequest): Promise<void>;
         selectCanvases(payload?: import('./api/modules/ui/types.ui').UiSelectCanvasesRequest): Promise<import('./api/modules/ui/types.ui').UiSelectCanvasesResponse>;
         captureAppError(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
         updateLocation(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
@@ -467,6 +472,7 @@ export declare function useApi(options?: ApiOptions): {
         quitInstance: () => Promise<any>;
         getRequestTypes: () => Promise<any>;
         broadcast: (event: import('./interfaces').PitcherEvent) => Promise<any>;
+        broadcastToWebviews: (event: import('./interfaces').PitcherEvent) => Promise<any>;
         subscribe: () => Promise<any>;
         unsubscribe: () => Promise<any>;
         open(payload?: import('./payload.types').OpenRequestPayload): Promise<string>;
@@ -658,6 +664,7 @@ export declare function useApi(options?: ApiOptions): {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./api/modules/ui/types.ui').UiOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./api/modules/ui/types.ui').UiSelectCanvasesRequest): Promise<import('./api/modules/ui/types.ui').UiSelectCanvasesResponse>;
     captureAppError(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
     updateLocation(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
@@ -684,6 +691,7 @@ export declare function useApi(options?: ApiOptions): {
     quitInstance: () => Promise<any>;
     getRequestTypes: () => Promise<any>;
     broadcast: (event: import('./interfaces').PitcherEvent) => Promise<any>;
+    broadcastToWebviews: (event: import('./interfaces').PitcherEvent) => Promise<any>;
     subscribe: () => Promise<any>;
     unsubscribe: () => Promise<any>;
     openExternalUrl(payload: import('./payload.types').OpenExternalUrlRequestPayload): Promise<void>;

package/lib/types/i18n.types.d.ts

@@ -1 +1 @@
-export type SupportedLocale = 'en' | 'de' | 'pl' | 'tr' | 'el' | 'fr' | 'es' | 'th' | 'ja' | 'zh' | 'it' | 'pt' | 'nl';
+export type SupportedLocale = 'en' | 'de' | 'pl' | 'tr' | 'el' | 'fr' | 'es' | 'th' | 'ja' | 'zh' | 'it' | 'pt' | 'pt-br' | 'nl';

package/lib/types/launchDarkly.types.d.ts

@@ -1,4 +1,4 @@
-export type LaunchDarklyBooleanFlagKey = 'ai_code_generation_model' | 'ai_text_generation_model' | 'ai_image_generation_model' | 'ai_video_generation_model' | 'allow_ai_prompts_in_canvas_text' | 'allow_bulk_actions_canvases_files' | 'allow_content_grid_autofill' | 'allow_canvas_duplication' | 'allow_canvases_tables_columns_settings' | 'allow_creating_canvas_with_no_template' | 'allow_dynamic_data_table_for_scribble_component' | 'allow_html_for_scribble_component' | 'allow_embeddable_for_scribble_component' | 'allow_embeddable_hiding' | 'allow_multimedia_for_scribble_component' | 'allow_note_taking' | 'allow_rep_canvas_metadata_edit' | 'allow_rep_file_rating' | 'allow_rep_file_upload' | 'allow_saving_annotations_in_personal_layer' | 'allow_user_to_edit_font_size_and_color_in_canvas_tokens' | 'are_sections_system_controlled' | 'enable_canvas_core_distributions' | 'enable_file_core_distributions' | 'copy_context_to_canvas' | 'copy_template_metadata_to_canvas' | 'disable_canvas_edit_for_reps' | 'disable_custom_tooltips' | 'disable_file_edit_content' | 'disable_fullscreen_canvas_builder' | 'disable_impact_web_browser_fullscreen' | 'display_section_list_name' | 'disable_download_canvas' | 'enable_ai_generated_thumbnails' | 'enable_analytics' | 'enable_app_developer_role' | 'enable_algolia_search' | 'enable_background_image_theme_options' | 'enable_better_canvas_builder_control_bars_on_zoom' | 'enable_bulk_update_file_attributes' | 'enable_canvas_as_home' | 'enable_canvas_blocks' | 'enable_canvas_node_debugging' | 'enable_canvas_locks' | 'enable_canvas_template_edit_in_impact' | 'enable_canvas_tokens' | 'enable_client_only_canvas_context' | 'enable_collaborations' | 'enable_collection_player_data_accessor' | 'enable_content_grid_data_accessor' | 'enable_content_type_change_in_content_selector' | 'enable_cross_tab_instance_reload_for_ld_sync' | 'enable_create_section_from_section_template' | 'enable_custom_display_overrides' | 'enable_default_crm_shape' | 'enable_detailed_date_format' | 'enable_dsr_readonly_annotations' | 'enable_dynamic_data_table_component' | 'enable_embedded_video_autoplay' | 'enable_embedded_video' | 'enable_enhanced_canvas_drawer_app' | 'enable_enhanced_indicators' | 'enable_enhanced_section_execution_states' | 'enable_experimental_canvas_builder_dnd' | 'enable_extra_file_data' | 'enable_file_pages_metadata' | 'enable_file_revisions' | 'enable_folder_details_edit' | 'enable_handlebar_template_support' | 'enable_height_in_component_theming' | 'enable_hotspot_visibility' | 'enable_improved_canvas_node_updating' | 'enable_insearch_in_section_selector' | 'enable_instance_cloner' | 'enable_advanced_cloner' | 'enable_instance_editor_role' | 'enable_instance_navigation_from_management' | 'enable_knock_notifications' | 'enable_maintain_section_theme_control' | 'enable_metadata_in_file_uploads_with_default_values' | 'enable_more_intuitive_component_spacing' | 'enable_multimedia_component_ai_images' | 'enable_new_meeting_bar' | 'enable_original_pdf_link' | 'enable_scale_content' | 'enable_sorting_in_tiptap_table' | 'enable_theme_assets' | 'enable_toc_enhancements_to_support_same_section_in_section_list' | 'enable_pia_assistant' | 'enable_pipe_character_multi_search' | 'enable_popup_apps' | 'enable_reorder_search' | 'enable_reorder_scribble_isolation' | 'enable_reorder_component_options_menu' | 'enable_resizable_multimedia_component' | 'enable_responsive_scribble_component' | 'enable_saved_canvases_filters' | 'enable_short_tag_column_in_tables' | 'enable_scribble_component' | 'enable_scribble_content_as_background' | 'enable_search_and_filters_in_multimedia_component' | 'enable_section_context_in_dsr' | 'enable_selectors_dnd' | 'enable_section_selector_edit_section' | 'enable_smart_folders' | 'enable_smart_folders_for_sections' | 'enable_smart_folders_in_section_selector' | 'enable_smart_folders_in_files' | 'enable_sorting_in_sections' | 'enable_suggested_tags' | 'enable_template_folders' | 'enable_theme_options_border_radius' | 'enable_themes' | 'hide_asset_uploader' | 'include_files_content_in_print' | 'interpolate_rep_canvases_on_edit_mode' | 'is_fe_sentry_enabled' | 'is_timeline_component_allowed' | 'launch_in_full_screen_on_present_mode' | 'prefer_online_handlers' | 'show_asset_manager_for_multimedia' | 'show_clear_all_annotations_button' | 'show_content_selector_list_view' | 'show_metadata_filters_in_all_canvas_things' | 'show_only_preview_mode_for_html_component' | 'show_popularity_icons' | 'use_core_endpoint_for_analytics' | 'convert_pptx_to_section_with_scribble_pdfjs' | 'use_short_url_for_shared_link' | 'use_zoho_instead_of_ms_wopi' | 'enable_new_section_list' | 'enable_sharebox_apps' | 'enable_back_to_previous_location_in_canvas' | 'enable_crm_shape_for_external_links' | 'enable_adaptive_popup_apps' | 'enable_file_version_polling' | 'skip_pspdfkit_wait_for_high_res_thumbs' | 'enable_reactive_scribble_component_toolbar' | 'enable_embeddable_full_screen_mode' | 'enable_enhanced_user_management' | 'keep_static_pptx_editable';
+export type LaunchDarklyBooleanFlagKey = 'ai_code_generation_model' | 'ai_text_generation_model' | 'ai_image_generation_model' | 'ai_video_generation_model' | 'allow_ai_prompts_in_canvas_text' | 'allow_bulk_actions_canvases_files' | 'allow_content_grid_autofill' | 'allow_canvas_duplication' | 'allow_canvases_tables_columns_settings' | 'allow_table_column_resizing' | 'allow_creating_canvas_with_no_template' | 'allow_dynamic_data_table_for_scribble_component' | 'allow_html_for_scribble_component' | 'allow_embeddable_for_scribble_component' | 'allow_embeddable_hiding' | 'allow_multimedia_for_scribble_component' | 'allow_note_taking' | 'allow_rep_canvas_metadata_edit' | 'allow_rep_file_rating' | 'allow_rep_file_upload' | 'allow_saving_annotations_in_personal_layer' | 'allow_user_to_edit_font_size_and_color_in_canvas_tokens' | 'are_sections_system_controlled' | 'enable_canvas_core_distributions' | 'enable_file_core_distributions' | 'copy_context_to_canvas' | 'copy_template_metadata_to_canvas' | 'disable_canvas_edit_for_reps' | 'disable_custom_tooltips' | 'disable_file_edit_content' | 'disable_fullscreen_canvas_builder' | 'disable_impact_web_browser_fullscreen' | 'display_section_list_name' | 'disable_download_canvas' | 'enable_ai_generated_thumbnails' | 'enable_analytics' | 'enable_app_developer_role' | 'enable_algolia_search' | 'enable_background_image_theme_options' | 'enable_better_canvas_builder_control_bars_on_zoom' | 'enable_bulk_update_file_attributes' | 'enable_canvas_as_home' | 'enable_canvas_blocks' | 'enable_canvas_node_debugging' | 'enable_canvas_locks' | 'enable_canvas_template_edit_in_impact' | 'enable_canvas_tokens' | 'enable_client_only_canvas_context' | 'enable_collaborations' | 'enable_collection_player_data_accessor' | 'enable_content_grid_data_accessor' | 'enable_content_type_change_in_content_selector' | 'enable_cross_tab_instance_reload_for_ld_sync' | 'enable_create_section_from_section_template' | 'enable_custom_display_overrides' | 'enable_default_crm_shape' | 'enable_detailed_date_format' | 'enable_dsr_readonly_annotations' | 'enable_dynamic_data_table_component' | 'enable_embedded_video_autoplay' | 'enable_embedded_video' | 'enable_enhanced_canvas_drawer_app' | 'enable_enhanced_indicators' | 'enable_enhanced_section_execution_states' | 'enable_experimental_canvas_builder_dnd' | 'enable_extra_file_data' | 'enable_file_pages_metadata' | 'enable_file_revisions' | 'enable_folder_details_edit' | 'enable_handlebar_template_support' | 'enable_height_in_component_theming' | 'enable_hotspot_visibility' | 'enable_improved_canvas_node_updating' | 'enable_insearch_in_section_selector' | 'enable_instance_cloner' | 'enable_advanced_cloner' | 'enable_instance_editor_role' | 'enable_instance_navigation_from_management' | 'enable_knock_notifications' | 'enable_maintain_section_theme_control' | 'enable_metadata_in_file_uploads_with_default_values' | 'enable_more_intuitive_component_spacing' | 'enable_multimedia_component_ai_images' | 'enable_new_meeting_bar' | 'enable_original_pdf_link' | 'enable_scale_content' | 'enable_sorting_in_tiptap_table' | 'enable_theme_assets' | 'enable_toc_enhancements_to_support_same_section_in_section_list' | 'enable_pia_assistant' | 'enable_pipe_character_multi_search' | 'enable_popup_apps' | 'enable_reorder_search' | 'enable_reorder_scribble_isolation' | 'enable_reorder_component_options_menu' | 'enable_resizable_multimedia_component' | 'enable_responsive_scribble_component' | 'enable_saved_canvases_filters' | 'enable_short_tag_column_in_tables' | 'enable_scribble_component' | 'enable_scribble_content_as_background' | 'enable_search_and_filters_in_multimedia_component' | 'enable_section_context_in_dsr' | 'enable_selectors_dnd' | 'enable_section_selector_edit_section' | 'enable_smart_folders' | 'enable_smart_folders_for_sections' | 'enable_smart_folders_in_section_selector' | 'enable_smart_folders_in_files' | 'enable_sorting_in_sections' | 'enable_suggested_tags' | 'enable_template_folders' | 'enable_theme_options_border_radius' | 'enable_themes' | 'hide_asset_uploader' | 'include_files_content_in_print' | 'interpolate_rep_canvases_on_edit_mode' | 'is_fe_sentry_enabled' | 'is_timeline_component_allowed' | 'launch_in_full_screen_on_present_mode' | 'prefer_online_handlers' | 'show_asset_manager_for_multimedia' | 'show_clear_all_annotations_button' | 'show_content_selector_list_view' | 'show_metadata_filters_in_all_canvas_things' | 'show_only_preview_mode_for_html_component' | 'show_popularity_icons' | 'use_core_endpoint_for_analytics' | 'convert_pptx_to_section_with_scribble_pdfjs' | 'use_short_url_for_shared_link' | 'use_zoho_instead_of_ms_wopi' | 'enable_new_section_list' | 'enable_sharebox_apps' | 'enable_back_to_previous_location_in_canvas' | 'enable_crm_shape_for_external_links' | 'enable_adaptive_popup_apps' | 'enable_file_version_polling' | 'skip_pspdfkit_wait_for_high_res_thumbs' | 'enable_reactive_scribble_component_toolbar' | 'enable_embeddable_full_screen_mode' | 'enable_enhanced_user_management' | 'keep_static_pptx_editable' | 'enable_canvas_pdf_dimensions';
 export type LaunchDarklyNumberFlagKey = 'canvas_section_selector_page_size' | 'canvas_section_selector_selected_items_with_thumbnail_size';
 type LaunchDarklyObjectFlags = {
     canvas_manager_table_columns: CanvasManagerTableColumns;

package/lib/utils/iframeInitialize.d.ts

@@ -5,7 +5,7 @@
  * @param callback - Callback function to handle the response
  * @param options - Additional options for initialization
  */
-export declare function waitForIframeInitialize<InitT = any, CbT = any>(iframeRef: HTMLIFrameElement | null, initData: InitT, callback?: (data?: CbT) => void, options?: {
+export declare function waitForIframeInitialize<InitT = any, CbT = any>(iframeRef: HTMLIFrameElement | null, initData: InitT, embedLocation: string, callback?: (data?: CbT) => void, options?: {
     maxAttempts?: number;
     retryInterval?: number;
     componentName?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/js-api",
-  "version": "1.26.0-beta.3",
+  "version": "1.26.0-beta.5",
   "type": "module",
   "main": "js-api.umd.min.js",
   "module": "js-api.esm.js",