@pitcher/js-api 1.24.0-rc.0 → 1.25.0-beta.0

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

@@ -156,6 +156,10 @@ export interface OpenRequestPayload {
      * Indicates if the app should be opened as overlay.
      */
     isOverlayApp?: boolean;
+    /**
+     * Tracking id for the canvas presentation session.
+     */
+    canvasCorrelationId?: string;
 }
 /**
  * Payload object for opening an external URL.

package/lib/types/app.d.ts

@@ -67,4 +67,7 @@ export type PitcherInfo = {
     accessToken: string;
     instanceId: string;
     apiOrigin: string;
+    isAnyTypeOfAdmin: boolean;
+    platform?: 'impact' | 'admin';
+    isOrgAdmin?: boolean;
 } | undefined;

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

@@ -8,5 +8,37 @@ export interface MetadataFilterRequest {
     and?: MetadataAndCondition[];
     entity?: 'canvas' | 'file';
     instance_id: string;
+    is_section?: boolean;
+    is_block?: boolean;
+    is_template?: boolean;
+    include_name_search?: boolean;
+    include_draft_values?: boolean;
+    owner_id?: string | null;
 }
+export type MetadataSearchParams = MetadataFilterRequest & {
+    searchMode?: 'exact' | 'partial' | 'fuzzy';
+    threshold?: number;
+    cursor?: string;
+    page_size?: number;
+};
+interface MetadataResultItem {
+    id: string;
+    is_name_match: boolean;
+}
+interface MetadataResultItemFuzzy {
+    value: string;
+    score: number;
+    is_name_match: boolean;
+}
+interface MetadataResultFuzzy {
+    ids: string[];
+    score: MetadataResultItemFuzzy[];
+}
+export type MetadataSearchResponse = {
+    results: Record<string, MetadataResultItem[] | MetadataResultFuzzy>;
+    pagination: {
+        cursor: string | null;
+        has_more: boolean;
+    };
+};
 export {};

package/lib/types/files.d.ts

@@ -1,4 +1,4 @@
-import { Favorite, FileCreateRequest } from '../../types/openapi';
+import { Favorite, FileCreateRequest, FileStatusEnum } from '../../types/openapi';
 import { RecentFile } from './recentFiles.types';
 import { CompactFile, CompactFolder } from '../apps/browser/stores/api';
 export interface DeviceFileCreateRequest extends Omit<FileCreateRequest, 'content'> {
@@ -24,6 +24,7 @@ export type ViewCompactFolder = Omit<CompactFolder, 'created_by'> & {
     file_thumbnail_urls?: string[];
     folders_count?: number;
     files_count?: number;
+    status?: string;
 };
 export interface DeviceFile {
     name: string;
@@ -35,4 +36,5 @@ export type ViewCompactFileFolder = ViewCompactFolder | ViewCompactFile;
 export type RenderableFile = (Favorite & {
     thumbnail_url?: string;
     file_thumbnail_urls?: string[];
+    status?: FileStatusEnum;
 }) | RecentFile | ViewCompactFileFolder;

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

@@ -17,6 +17,8 @@ export type AutohideSectionOnCreated = {
 };
 export type InstanceSettings = OrganizationSettings & {
     canvas?: {
+        hide_page_break_in_toc?: boolean;
+        disable_display_index_in_toc?: boolean;
         autohide_section_on_created?: AutohideSectionOnCreated;
         component_availability?: CanvasComponentAvailability & {
             apps?: Record<string, boolean>;
@@ -34,5 +36,7 @@ export type InstanceSettings = OrganizationSettings & {
             enabled?: boolean;
         };
     };
+    enable_recents?: boolean;
+    enable_favorites?: boolean;
     ios?: InstanceSettings;
 };

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_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_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_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' | '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 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

@@ -42,5 +42,8 @@ export type OrganizationSettings = {
     use_collection_player_as_default_file_viewer_for_content_extensions?: string[];
     use_collection_player_as_default_file_viewer_for_original_extensions?: string[];
     enable_ppt_converter_in_canvas_templates?: boolean;
+    enable_search_with_suggestions?: boolean;
+    enable_search_filter_with_suggestions?: boolean;
+    enable_thumbnails_for_templates_and_blocks?: boolean;
 };
 export {};

package/lib/types/recentFiles.types.d.ts

@@ -1,7 +1,8 @@
-import { Instance, File } from '../../types/openapi';
+import { Instance, File, FileStatusEnum } from '../../types/openapi';
 export type RecentFile = Pick<File, 'id' | 'name' | 'content_type' | 'instance_id'> & {
     tags?: Readonly<File['tags']>;
     thumbnail_url?: string | null;
     page_index?: number;
+    status?: FileStatusEnum;
 };
 export type InstanceRecentFilesMap = Record<Instance['id'], RecentFile[]>;

package/lib/types/search.d.ts

@@ -0,0 +1,5 @@
+import { AutoCompleteOption } from 'naive-ui';
+export interface StyledAutoCompleteOption extends AutoCompleteOption {
+    style?: string;
+    isTypedSearchQuery?: boolean;
+}

package/lib/util/anchor.d.ts

@@ -1,2 +1,2 @@
-export declare const downloadFile: (url?: string, name?: string) => void;
+export declare const downloadFile: (url?: string, name?: string, target?: string) => void;
 export declare function openUsdz(url: string): void;

package/lib/util/image.d.ts

@@ -1 +1,7 @@
 export declare const isImageAccessible: (url: string) => Promise<unknown>;
+/**
+ * Generates an AI thumbnail URL for an img based on its description
+ * @param imgDesc - Description to generate thumbnail for
+ * @returns URL to the AI-generated thumbnail
+ */
+export declare const generateAIThumbnailUrl: (imgDesc: string) => string;

package/lib/util/tree-transformation.util.d.ts

@@ -1,5 +1,4 @@
 import { TreeSelectOption } from 'naive-ui';
-export declare function formatLabel(key: string): string;
 export declare function transformToArrayTree(data: Record<string, any>, parentKey?: string): TreeSelectOption[];
 export declare function transformToTree(data: Record<string, any>, parentKey?: string, arrayDict?: Record<string, any>): {
     options: TreeSelectOption[];

package/lib/util/url.d.ts

@@ -1,2 +1,3 @@
 import { InstanceSettings, OrganizationSettings } from '../main.lib';
 export declare function getPreviewUrl(url: string, pitcherSettings?: OrganizationSettings & InstanceSettings): string;
+export declare function getAppConfigFromAppSource(source: string): string | undefined;

package/package.json

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

package/types/openapi/index.d.ts

@@ -232,9 +232,7 @@ export type { Revision } from './models/Revision';
 export type { RevisionRequest } from './models/RevisionRequest';
 export type { SearchApp } from './models/SearchApp';
 export type { SearchCanvas } from './models/SearchCanvas';
-export type { SearchContentDistributionGroup } from './models/SearchContentDistributionGroup';
 export type { SearchFile } from './models/SearchFile';
-export type { SearchInstanceAssignmentGroup } from './models/SearchInstanceAssignmentGroup';
 export type { SearchResult } from './models/SearchResult';
 export type { SearchUser } from './models/SearchUser';
 export type { SharedLink } from './models/SharedLink';

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

@@ -11,6 +11,7 @@ export type FileCreateRequest = {
     is_asset?: boolean;
     content?: Blob;
     content_upload_id?: string;
+    url?: string;
     thumbnail?: Blob;
     thumbnail_upload_id?: string;
     download_type?: DownloadTypeEnum;

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

@@ -1,8 +1,10 @@
 /**
  * * `pending` - Pending
  * * `viewable` - Viewable
+ * * `failed` - Failed
  */
 export declare enum FileStatusEnum {
     PENDING = "pending",
-    VIEWABLE = "viewable"
+    VIEWABLE = "viewable",
+    FAILED = "failed"
 }

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

@@ -5,6 +5,7 @@ export type FileUpdateRequest = {
     name?: string;
     content?: Blob;
     content_upload_id?: string;
+    url?: string;
     thumbnail?: Blob;
     thumbnail_upload_id?: string;
     download_type?: DownloadTypeEnum;

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

@@ -6,4 +6,5 @@ export type InstanceMembershipUser = {
     readonly status: InstanceMembershipUserStatusEnum;
     readonly instance_last_login: string;
     picture: string;
+    readonly tags: Array<string> | null;
 };

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

@@ -5,6 +5,7 @@ export type PatchedFileUpdateRequest = {
     name?: string;
     content?: Blob;
     content_upload_id?: string;
+    url?: string;
     thumbnail?: Blob;
     thumbnail_upload_id?: string;
     download_type?: DownloadTypeEnum;

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

@@ -5,7 +5,7 @@ export type PatchedUserRequest = {
     last_name?: string;
     role?: UserRoleEnum;
     language?: LanguageEnum;
-    dark_mode?: boolean;
     preferred_username?: string;
     timezone?: string;
+    tags?: Array<string> | null;
 };

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

@@ -1,7 +1,5 @@
 import { SearchApp } from './SearchApp';
 import { SearchCanvas } from './SearchCanvas';
-import { SearchContentDistributionGroup } from './SearchContentDistributionGroup';
 import { SearchFile } from './SearchFile';
-import { SearchInstanceAssignmentGroup } from './SearchInstanceAssignmentGroup';
 import { SearchUser } from './SearchUser';
-export type SearchResult = (SearchFile | SearchUser | SearchApp | SearchCanvas | SearchInstanceAssignmentGroup | SearchContentDistributionGroup);
+export type SearchResult = (SearchFile | SearchUser | SearchApp | SearchCanvas);

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

@@ -4,7 +4,6 @@ import { SharedLinkOrganization } from './SharedLinkOrganization';
 export type SharedLink = {
     readonly id: string;
     readonly type: string;
-    is_snapshot?: boolean;
     readonly file: Record<string, any> | null;
     readonly canvas: SharedLinkCanvas;
     readonly instance: SharedLinkInstance;

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

@@ -4,7 +4,6 @@ import { SharedLinkOrganization } from './SharedLinkOrganization';
 export type SharedLinkCreate = {
     readonly id: string;
     readonly type: string;
-    is_snapshot?: boolean;
     readonly file: Record<string, any> | null;
     readonly canvas: SharedLinkCanvas;
     readonly instance: SharedLinkInstance;

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

@@ -1,5 +1,4 @@
 export type SharedLinkCreateRequest = {
-    is_snapshot?: boolean;
     short_url?: string | null;
     file_id?: string;
     canvas_id?: string;

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

@@ -3,5 +3,6 @@ export type SharedLinkInstance = {
     name: string;
     logo?: string | null;
     color?: string | null;
+    readonly environment: Record<string, any>;
     settings?: any;
 };

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

@@ -14,9 +14,9 @@ export type User = {
     readonly activated_at: string | null;
     readonly is_active: boolean;
     language?: LanguageEnum;
-    dark_mode?: boolean;
     readonly connected_services: Array<ConnectedService>;
     preferred_username?: string;
     readonly picture: string | null;
     timezone?: string;
+    tags?: Array<string> | null;
 };

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

@@ -5,7 +5,7 @@ export type UserRequest = {
     last_name?: string;
     role?: UserRoleEnum;
     language?: LanguageEnum;
-    dark_mode?: boolean;
     preferred_username?: string;
     timezone?: string;
+    tags?: Array<string> | null;
 };

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

@@ -1,10 +0,0 @@
-import { MiniUser } from './MiniUser';
-export type SearchContentDistributionGroup = {
-    readonly id: string;
-    name: string;
-    readonly size: number;
-    readonly created_by: MiniUser;
-    readonly created_at: string;
-    readonly modified_by: MiniUser;
-    readonly modified_at: string;
-};

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

@@ -1,10 +0,0 @@
-import { MiniUser } from './MiniUser';
-export type SearchInstanceAssignmentGroup = {
-    readonly id: string;
-    name: string;
-    readonly size: number;
-    readonly created_by: MiniUser;
-    readonly created_at: string;
-    readonly modified_by: MiniUser;
-    readonly modified_at: string;
-};