@pitcher/js-api 1.25.0-beta.1 → 1.25.0-beta.3

package/lib/sdk/payload.types.d.ts

@@ -84,6 +84,20 @@ export interface QueryPayload {
      */
     args?: string[][];
 }
+export type CRMServiceType = 'salesforce' | 'dynamics' | 'sap';
+/**
+ * Payload for executing a query against CRM.
+ */
+export interface CRMQueryPayload {
+    /**
+     * The query string to execute.
+     */
+    query: string;
+    /**
+     * Optional name of the service to be queried.
+     */
+    service?: CRMServiceType;
+}
 /**
  * Payload for submitting user feedback.
  */
@@ -234,3 +248,13 @@ export type ShareResponse = {
      */
     activity_type?: string;
 };
+export type FolderListRequest = {
+    search?: string;
+    ordering?: string;
+    filters?: Record<string, any>;
+    fields?: string;
+    name?: string;
+    page?: number;
+    page_size?: number;
+    id__in?: string[];
+};

package/lib/sdk/utils/window.d.ts

@@ -1 +1,3 @@
-export declare function getTopPitcherWindow(current?: Window & typeof globalThis): Window & typeof globalThis;
+type WindowType = Window & typeof globalThis;
+export declare function getTopPitcherWindow(current?: WindowType): WindowType;
+export {};

package/lib/types/app.d.ts

@@ -48,17 +48,27 @@ export type Module = {
     };
     shortcuts: EmbeddedAppShortcutsDict;
 } & EmbeddedLocationProperties;
+type AppJsonOptions = {
+    dimensions?: {
+        width?: number | string;
+        height?: number | string;
+    };
+    placement?: 'top-left' | 'top-center' | 'top-right' | 'left' | 'center' | 'right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
+};
 export type AppJson = {
     name: string;
     display_name: string;
     icon?: string;
     type?: 'web';
-    provide?: ('ui' | 'account_browser' | 'scheduler' | 'postcall' | 'crm_shape')[];
+    provide?: ('ui' | 'account_browser' | 'scheduler' | 'postcall' | 'crm_shape' | 'multimedia_selector')[];
     require?: 'crm'[];
     version: string;
     description?: string;
     authors?: string[];
     module: Record<EmbedLocation, Module>;
+    app_type?: 'canvas-popup' | 'section-selector';
+    app_options?: AppJsonOptions;
+    order_override?: number;
 };
 export type AppFile = File & {
     app_metadata?: AppJson;
@@ -71,3 +81,4 @@ export type PitcherInfo = {
     platform?: 'impact' | 'admin';
     isOrgAdmin?: boolean;
 } | undefined;
+export {};

package/lib/types/call.d.ts

@@ -9,7 +9,6 @@ export interface EventDate {
 export declare enum CallState {
     NO_CALL = "NO_CALL",
     IN_CALL = "IN_CALL",
-    PAUSED = "PAUSED",
     STOPPED = "STOPPED"
 }
 export declare enum PostAction {

package/lib/types/canvasTheme.d.ts

@@ -14,10 +14,16 @@ export declare enum CanvasThemeStatus {
     READY = "ready",
     DRAFT = "draft"
 }
+export interface CanvasThemeAsset {
+    id: string;
+    name: string;
+    url: string;
+}
 export interface CanvasThemeSettings {
     component_spacing: number;
     background_color: string;
     palette: string[];
+    assets?: CanvasThemeAsset[];
 }
 export interface CanvasThemeRetrieve {
     id: string;
@@ -30,6 +36,8 @@ export interface CanvasThemeRetrieve {
     owned_by: User;
     created_by: User;
     modified_by?: User;
+    logo?: CanvasThemeAsset;
+    assets?: CanvasThemeAsset[];
     settings: CanvasThemeSettings;
     typography: Record<string, CanvasTypographyPreset>;
     used_in_canvases_count?: number;
@@ -45,4 +53,8 @@ export interface CanvasThemeFormData {
         palette: string[];
     };
     typography: Record<string, CanvasTypographyPreset>;
+    assets: {
+        logo?: CanvasThemeAsset;
+        images: CanvasThemeAsset[];
+    };
 }

package/lib/types/core/MetadataFilter.d.ts

@@ -20,6 +20,7 @@ export type MetadataSearchParams = MetadataFilterRequest & {
     threshold?: number;
     cursor?: string;
     page_size?: number;
+    fetch_all_unique?: boolean;
 };
 interface MetadataResultItem {
     id: string;

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

@@ -1 +1 @@
-export type SupportedLocale = 'en' | 'de' | 'pl' | 'tr' | 'el';
+export type SupportedLocale = 'en' | 'de' | 'pl' | 'tr' | 'el' | 'fr' | 'es';

package/lib/types/instanceSettings.types.d.ts

@@ -32,9 +32,11 @@ export type InstanceSettings = OrganizationSettings & {
         autoselect_selected_canvas_account?: boolean;
         require_account_on_canvas_creation?: boolean;
         pptx_slide_image_width?: number;
+        enable_download_in_presentation_mode?: boolean;
         completion_wizard?: {
             enabled?: boolean;
         };
+        correlation_id_cleanup_delay?: number;
     };
     enable_recents?: boolean;
     enable_favorites?: boolean;

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

@@ -1,4 +1,4 @@
-export type LaunchDarklyBooleanFlagKey = 'allow_ai_prompts_in_canvas_text' | 'allow_bulk_actions_canvases_files' | 'allow_canvas_duplication' | 'allow_canvas_history' | 'allow_canvas_ownership_change' | 'allow_canvases_tables_columns_settings' | 'allow_content_grid_autofill' | 'allow_creating_canvas_with_no_template' | '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' | 'copy_context_to_canvas' | 'copy_template_metadata_to_canvas' | 'disable_canvas_edit_for_reps' | 'disable_file_edit_content' | 'disable_fullscreen_canvas_builder' | 'disable_impact_web_browser_fullscreen' | 'display_section_list_name' | 'enable_ai_generated_thumbnails' | 'enable_analytics' | 'enable_app_developer_role' | 'enable_background_image_theme_options' | 'enable_bulk_update_file_attributes' | 'enable_canvas_blocks' | 'enable_canvas_node_debugging' | 'enable_canvas_tokens' | 'enable_content_type_change_in_content_selector' | 'enable_create_section_from_section_template' | 'enable_default_crm_shape' | 'enable_dynamic_data_table_component' | 'enable_embedded_video_autoplay' | 'enable_embedded_video' | 'enable_enhanced_indicators' | 'enable_experimental_canvas_builder_dnd' | 'enable_file_pages_metadata' | 'enable_file_revisions' | 'enable_folder_details_edit' | 'enable_handlebar_template_support' | 'enable_height_in_component_theming' | 'enable_insearch_in_section_selector' | 'enable_instance_editor_role' | 'enable_knock_notifications' | 'enable_maintain_section_theme_control' | 'enable_metadata_in_file_uploads_with_default_values' | 'enable_multimedia_component_ai_images' | 'enable_pia_assistant' | 'enable_pipe_character_multi_search' | 'enable_resizable_multimedia_component' | 'enable_saved_canvases_filters' | 'enable_scribble_component' | 'enable_search_and_filters_in_multimedia_component' | 'enable_section_context_in_dsr' | 'enable_section_selector_drag_n_drop' | 'enable_smart_folders' | 'enable_smart_folders_in_files' | '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_meeting_bar_account_selection_disabled' | 'is_meeting_bar_hidden' | 'is_rep_canvas_creation_disabled' | 'is_shared_link_creation_disabled' | 'is_timeline_component_allowed' | 'launch_in_full_screen_on_present_mode' | 'launch_in_present_mode_on_creation' | 'prefer_online_handlers' | 'reorder_component_in_drawer' | 'show_asset_manager_for_multimedia' | 'show_clear_all_annotations_button' | 'show_content_selector_list_view' | 'show_metadata_filters_in_all_canvas_things' | 'show_popularity_icons' | 'show_system_filters' | 'use_core_endpoint_for_analytics' | 'use_short_url_for_shared_link' | 'use_zoho_instead_of_ms_wopi';
+export type LaunchDarklyBooleanFlagKey = 'allow_ai_prompts_in_canvas_text' | 'allow_bulk_actions_canvases_files' | 'allow_canvas_duplication' | 'allow_canvas_history' | 'allow_canvas_ownership_change' | 'allow_canvases_tables_columns_settings' | 'allow_content_grid_autofill' | 'allow_creating_canvas_with_no_template' | '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' | 'enable_ai_generated_thumbnails' | 'enable_analytics' | 'enable_app_developer_role' | 'enable_background_image_theme_options' | 'enable_bulk_update_file_attributes' | 'enable_canvas_as_home' | 'enable_canvas_blocks' | 'enable_canvas_node_debugging' | 'enable_canvas_template_edit_in_impact' | 'enable_canvas_tokens' | 'enable_client_only_canvas_context' | 'enable_collaborations' | 'enable_content_type_change_in_content_selector' | 'enable_create_section_from_section_template' | 'enable_custom_display_overrides' | 'enable_default_crm_shape' | 'enable_dynamic_data_table_component' | 'enable_embedded_video_autoplay' | 'enable_embedded_video' | 'enable_enhanced_indicators' | 'enable_experimental_canvas_builder_dnd' | 'enable_file_pages_metadata' | 'enable_file_revisions' | 'enable_folder_details_edit' | 'enable_handlebar_template_support' | 'enable_height_in_component_theming' | 'enable_insearch_in_section_selector' | 'enable_instance_editor_role' | 'enable_knock_notifications' | 'enable_maintain_section_theme_control' | 'enable_metadata_in_file_uploads_with_default_values' | 'enable_multimedia_component_ai_images' | '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_pptx_download' | 'enable_print_mode_experiments' | 'enable_resizable_multimedia_component' | 'enable_responsive_scribble_component' | 'enable_saved_canvases_filters' | 'enable_scribble_component' | 'enable_search_and_filters_in_multimedia_component' | 'enable_section_context_in_dsr' | 'enable_section_selector_drag_n_drop' | 'enable_smart_folders' | 'enable_smart_folders_in_files' | '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_meeting_bar_account_selection_disabled' | 'is_meeting_bar_hidden' | 'is_rep_canvas_creation_disabled' | 'is_shared_link_creation_disabled' | 'is_timeline_component_allowed' | 'launch_in_full_screen_on_present_mode' | 'launch_in_present_mode_on_creation' | 'prefer_online_handlers' | 'reorder_component_in_drawer' | 'show_asset_manager_for_multimedia' | 'show_clear_all_annotations_button' | 'show_content_selector_list_view' | 'show_metadata_filters_in_all_canvas_things' | 'show_popularity_icons' | 'show_system_filters' | 'use_core_endpoint_for_analytics' | 'use_short_url_for_shared_link' | 'use_zoho_instead_of_ms_wopi';
 export type LaunchDarklyNumberFlagKey = 'canvas_section_selector_page_size' | 'canvas_section_selector_selected_items_with_thumbnail_size';
 type LaunchDarklyObjectFlags = {
     canvas_table_pagination: CanvasTablePagination;

package/lib/types/organizationSettings.types.d.ts

@@ -15,6 +15,17 @@ type SmartFolderRuleAttributes = {
     canvas_templates?: SmartFolderRuleAttribute[];
 };
 export type OrganizationSettings = {
+    canvas?: {
+        locks_polling_interval?: number;
+        shared_link?: {
+            title?: string;
+            email_disclaimer?: string;
+            logo_url?: string;
+            logo_style?: Record<string, any>;
+        };
+    };
+    skip_metadata_keys_in_list_item?: string[];
+    enable_multi_language?: boolean;
     canvases_route_order?: number;
     content_browser_route_order?: number;
     impact_show_only_saved_canvases_in_canvas_manager?: boolean;
@@ -45,5 +56,13 @@ export type OrganizationSettings = {
     enable_search_with_suggestions?: boolean;
     enable_search_filter_with_suggestions?: boolean;
     enable_thumbnails_for_templates_and_blocks?: boolean;
+    default_pdf_page_dimensions?: {
+        width?: number;
+        height?: number;
+    };
+    disable_browser_search_context?: boolean;
+    location_prompt_type?: 'warning' | 'block';
+    location_prompt_message?: string;
+    use_collection_player_with_annotations?: boolean;
 };
 export {};

package/lib/util/image.d.ts

@@ -5,3 +5,7 @@ export declare const isImageAccessible: (url: string) => Promise<unknown>;
  * @returns URL to the AI-generated thumbnail
  */
 export declare const generateAIThumbnailUrl: (imgDesc: string) => string;
+export declare function getImageSize(url: string): Promise<{
+    width: number;
+    height: number;
+}>;

package/lib/util/style.util.d.ts

@@ -1 +1,2 @@
 export declare function hasPadding(style?: Record<string, any>): boolean;
+export declare function toDimensionValue(value: number | string | undefined, defaultValue?: string): string;

package/lib/util/userAgents.d.ts

@@ -7,3 +7,4 @@ export declare const isTouchScreen: boolean;
 export declare const isMac: boolean;
 export declare const isWindows: boolean;
 export declare const isSafari: boolean;
+export declare const isFirefox: boolean;

package/package.json

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

package/types/openapi/models/App.d.ts

@@ -12,6 +12,7 @@ export type App = {
     readonly latest_version: string | null;
     logo?: string | null;
     readonly is_published: boolean;
+    readonly metadata: any;
     readonly created_at: string;
     readonly created_by: MiniUser;
     readonly modified_at: string;

package/types/openapi/models/CanvasCreate.d.ts

@@ -24,6 +24,7 @@ export type CanvasCreate = {
     expires_at?: string | null;
     access_type?: AccessTypeEnum;
     thumbnail_url?: string | null;
+    instance_id: string;
     readonly template: MiniCanvas;
     readonly sections: Array<CanvasSection>;
     readonly shared_link: MiniSharedLink;

package/types/openapi/models/CanvasRecommendedFile.d.ts

@@ -34,6 +34,8 @@ export type CanvasRecommendedFile = {
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;
     tags?: Array<string>;
+    transcript?: string;
+    readonly search: string | null;
     readonly published_at: string | null;
     expires_at?: string | null;
     readonly instance_id: string;

package/types/openapi/models/CanvasRetrieve.d.ts

@@ -24,6 +24,7 @@ export type CanvasRetrieve = {
     expires_at?: string | null;
     access_type?: AccessTypeEnum;
     thumbnail_url?: string | null;
+    instance_id: string;
     readonly template: MiniCanvas;
     readonly sections: Array<CanvasSection>;
     readonly shared_link: MiniSharedLink;

package/types/openapi/models/CanvasUpdate.d.ts

@@ -24,6 +24,7 @@ export type CanvasUpdate = {
     expires_at?: string | null;
     access_type?: AccessTypeEnum;
     thumbnail_url?: string | null;
+    instance_id: string;
     readonly template: MiniCanvas;
     readonly sections: Array<CanvasSection>;
     readonly shared_link: MiniSharedLink;

package/types/openapi/models/CanvasUpdateRequest.d.ts

@@ -18,6 +18,7 @@ export type CanvasUpdateRequest = {
     expires_at?: string | null;
     access_type?: AccessTypeEnum;
     thumbnail_url?: string | null;
+    instance_id: string;
     account?: AccountRequest | null;
     folder_id?: string | null;
     owned_by_id?: number | null;

package/types/openapi/models/DeletedFile.d.ts

@@ -34,6 +34,8 @@ export type DeletedFile = {
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;
     tags?: Array<string>;
+    transcript?: string;
+    readonly search: string | null;
     readonly published_at: string | null;
     expires_at?: string | null;
     readonly instance_id: string;

package/types/openapi/models/File.d.ts

@@ -34,6 +34,8 @@ export type File = {
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;
     tags?: Array<string>;
+    transcript?: string;
+    readonly search: string | null;
     readonly published_at: string | null;
     expires_at?: string | null;
     readonly instance_id: string;

package/types/openapi/models/FileCreate.d.ts

@@ -40,6 +40,8 @@ export type FileCreate = {
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;
     tags?: Array<string>;
+    transcript?: string;
+    readonly search: string | null;
     readonly published_at: string | null;
     expires_at?: string | null;
     instance_id: string;

package/types/openapi/models/FileCreateRequest.d.ts

@@ -20,6 +20,7 @@ export type FileCreateRequest = {
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;
     tags?: Array<string>;
+    transcript?: string;
     expires_at?: string | null;
     instance_id: string;
     folder_id?: string;

package/types/openapi/models/FileRetrieve.d.ts

@@ -40,6 +40,8 @@ export type FileRetrieve = {
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;
     tags?: Array<string>;
+    transcript?: string;
+    readonly search: string | null;
     readonly published_at: string | null;
     expires_at?: string | null;
     readonly instance_id: string;

package/types/openapi/models/FileUpdate.d.ts

@@ -40,6 +40,8 @@ export type FileUpdate = {
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;
     tags?: Array<string>;
+    transcript?: string;
+    readonly search: string | null;
     readonly published_at: string | null;
     expires_at?: string | null;
     readonly instance_id: string;

package/types/openapi/models/FileUpdateRequest.d.ts

@@ -14,6 +14,7 @@ export type FileUpdateRequest = {
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;
     tags?: Array<string>;
+    transcript?: string;
     expires_at?: string | null;
     folder_id?: string;
     owned_by_id?: number | null;

package/types/openapi/models/InstanceMembershipUser.d.ts

@@ -7,4 +7,6 @@ export type InstanceMembershipUser = {
     readonly instance_last_login: string;
     picture: string;
     readonly tags: Array<string> | null;
+    readonly ios_app_version?: string;
+    readonly web_app_version?: string;
 };

package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts

@@ -18,6 +18,7 @@ export type PatchedCanvasUpdateRequest = {
     expires_at?: string | null;
     access_type?: AccessTypeEnum;
     thumbnail_url?: string | null;
+    instance_id?: string;
     account?: AccountRequest | null;
     folder_id?: string | null;
     owned_by_id?: number | null;

package/types/openapi/models/PatchedFileUpdateRequest.d.ts

@@ -14,6 +14,7 @@ export type PatchedFileUpdateRequest = {
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;
     tags?: Array<string>;
+    transcript?: string;
     expires_at?: string | null;
     folder_id?: string;
     owned_by_id?: number | null;