@pitcher/js-api 1.25.0-beta.2 → 1.25.0

package/lib/composables/useCommentTracking.d.ts

@@ -0,0 +1,25 @@
+interface CommentTrackingPayload {
+    canvasId?: string;
+    componentId?: string;
+    threadId: string;
+    commentId?: string;
+    action: string;
+    content?: string;
+    authorId?: string | number;
+    authorName?: string;
+    authorEmail?: string;
+    assigneeId?: string | number;
+    assigneeName?: string;
+    assigneeEmail?: string;
+    resolved?: boolean;
+    deleted?: boolean;
+    timestamp?: string;
+}
+export declare function useCommentTracking(): {
+    trackCommentAdded: (payload: Omit<CommentTrackingPayload, "action">) => Promise<void>;
+    trackCommentReplied: (payload: Omit<CommentTrackingPayload, "action">) => Promise<void>;
+    trackCommentAssigned: (payload: Omit<CommentTrackingPayload, "action">) => Promise<void>;
+    trackCommentResolved: (payload: Omit<CommentTrackingPayload, "action">) => Promise<void>;
+    trackCommentDeleted: (payload: Omit<CommentTrackingPayload, "action">) => Promise<void>;
+};
+export {};

package/lib/composables/useCommentsStorage.d.ts

@@ -0,0 +1,70 @@
+import { Ref } from 'vue';
+interface Comment {
+    id: string;
+    content: string;
+    author?: string;
+    authorId?: string | number;
+    authorEmail?: string;
+    createdAt: string;
+}
+interface Thread {
+    id: string;
+    content: string;
+    author: string;
+    authorId?: string | number;
+    authorEmail?: string;
+    createdAt: string;
+    resolved: boolean;
+    canvasId?: string;
+    componentId?: string;
+    assignee?: any;
+    comments: Comment[];
+}
+export declare function useCommentsStorage(canvasId: Ref<string | undefined>): {
+    threads: Ref<{
+        id: string;
+        content: string;
+        author: string;
+        authorId?: string | number | undefined;
+        authorEmail?: string | undefined;
+        createdAt: string;
+        resolved: boolean;
+        canvasId?: string | undefined;
+        componentId?: string | undefined;
+        assignee?: any;
+        comments: {
+            id: string;
+            content: string;
+            author?: string | undefined;
+            authorId?: string | number | undefined;
+            authorEmail?: string | undefined;
+            createdAt: string;
+        }[];
+    }[], Thread[] | {
+        id: string;
+        content: string;
+        author: string;
+        authorId?: string | number | undefined;
+        authorEmail?: string | undefined;
+        createdAt: string;
+        resolved: boolean;
+        canvasId?: string | undefined;
+        componentId?: string | undefined;
+        assignee?: any;
+        comments: {
+            id: string;
+            content: string;
+            author?: string | undefined;
+            authorId?: string | number | undefined;
+            authorEmail?: string | undefined;
+            createdAt: string;
+        }[];
+    }[]>;
+    isLoading: Ref<boolean, boolean>;
+    isSaving: Ref<boolean, boolean>;
+    lastSaved: Ref<Date | null, Date | null>;
+    saveComments: () => Promise<void>;
+    loadComments: () => Promise<void>;
+    deleteComments: () => Promise<void>;
+};
+export {};

package/lib/composables/useFileDisplayHelpers.d.ts

@@ -10,4 +10,6 @@ export default function useFileDisplayHelpers(): {
     renderContentType: (contentType: FileContentTypeEnum) => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
         [key: string]: any;
     }>;
+    isFileExpired: (expiresAt: string) => boolean | "";
+    isFileExpiring: (expiresAt: string) => string | null;
 };

package/lib/composables/useInstalledApps.d.ts

@@ -1,2 +1,3 @@
 import { AppFile } from '../types/app';
 export declare const loadCanvasAndDsrApps: () => Promise<AppFile[]>;
+export declare const loadCrmShapeFromApps: () => Promise<Record<string, any>>;

package/lib/composables/useMetadataFilters.d.ts

@@ -1,11 +1,11 @@
 import { MetadataTemplateField, MetadataTemplateOption } from '../../types/openapi';
 export declare function getComponentNameByFilterType(type: string): "CSearchFilter" | "CSelectFilter" | "CDateRangeFilter";
 export default function useMetadataFilters(t: (input: string) => string): {
-    getBooleanOptions: () => {
+    getBooleanOptions: (availableValues?: Array<string | boolean | number>) => {
         label: string;
         value: string;
     }[];
     getComponentNameByFilterType: typeof getComponentNameByFilterType;
     getDefaultDateOptions: () => MetadataTemplateOption[];
-    getFilterOptions: (type: MetadataTemplateField["type"], options: MetadataTemplateField["options"]) => MetadataTemplateOption[];
+    getFilterOptions: (type: MetadataTemplateField["type"], options: MetadataTemplateField["options"], availableValues?: Array<string | boolean | number>) => MetadataTemplateOption[];
 };

package/lib/composables/useMetadataSearch.d.ts

@@ -4,7 +4,7 @@ interface UseMetadataSearchOptions {
     includeSearchTermAsOption?: boolean;
 }
 export default function useMetadataSearch(options?: UseMetadataSearchOptions): {
-    handleFetch: (searchTerm: string, entity: MetadataFilterRequest["entity"], { includeNameSearch, includeDraftValues, isSection, isTemplate, isBlock, key, ownerId, searchMode, threshold, }?: {
+    handleFetch: (searchTerm: string, entity: MetadataFilterRequest["entity"], { includeNameSearch, includeDraftValues, isSection, isTemplate, isBlock, key, ownerId, searchMode, threshold, fetchAllUnique, }?: {
         includeNameSearch?: boolean;
         includeDraftValues?: boolean;
         isSection?: boolean;
@@ -14,6 +14,7 @@ export default function useMetadataSearch(options?: UseMetadataSearchOptions): {
         ownerId?: number | null;
         searchMode?: MetadataSearchParams["searchMode"];
         threshold?: number;
+        fetchAllUnique?: boolean;
     }) => Promise<StyledAutoCompleteOption[]>;
 };
 export {};

package/lib/composables/useSharedCommentsStorage.d.ts

@@ -0,0 +1,32 @@
+import { Ref } from 'vue';
+interface Comment {
+    id: string;
+    content: string;
+    author?: string;
+    authorId?: string | number;
+    authorEmail?: string;
+    createdAt: string;
+}
+interface Thread {
+    id: string;
+    content: string;
+    author: string;
+    authorId?: string | number;
+    authorEmail?: string;
+    createdAt: string;
+    resolved: boolean;
+    canvasId?: string;
+    componentId?: string;
+    assignee?: any;
+    comments: Comment[];
+}
+export declare function useSharedCommentsStorage(canvasId: Ref<string | undefined>): {
+    threads: import('vue').ComputedRef<Thread[]>;
+    isLoading: import('vue').ComputedRef<boolean>;
+    isSaving: import('vue').ComputedRef<boolean>;
+    lastSaved: import('vue').ComputedRef<Date | null>;
+    saveComments: () => Promise<void>;
+    loadComments: (silent?: boolean) => Promise<void>;
+    deleteComments: () => Promise<void>;
+};
+export {};

package/lib/constants/cdp.const.d.ts

@@ -23,11 +23,17 @@ export declare const CDP_EVENT_TYPE: {
     readonly userFileReviewed: "User File Reviewed";
     readonly hotspotClicked: "Hotspot Clicked";
     readonly collectionPlayerContentChanged: "Collection Player Content Changed";
+    readonly commentAdded: "Comment Added";
+    readonly commentReplied: "Comment Replied";
+    readonly commentAssigned: "Comment Assigned";
+    readonly commentResolved: "Comment Resolved";
+    readonly commentDeleted: "Comment Deleted";
 };
 export declare const CLIENT_TYPE: {
     readonly admin: "admin";
     readonly impact: "impact";
     readonly dsr: "dsr";
+    readonly impactCanvasHome: "impact-canvas-home";
 };
 export declare const DSR_TYPE: {
     readonly file: "file";

package/lib/constants/roles.const.d.ts

@@ -0,0 +1,16 @@
+export declare const NON_MEMBER_ROLES: readonly ["Org Admin", "Admin", "Editor", "Dev"];
+export declare const isNonMemberRole: (role: string | null | undefined) => boolean;
+export interface RolePermissions {
+    isOrgAdmin: boolean;
+    isCurrentInstanceAdmin: boolean;
+    isCurrentInstanceEditor: boolean;
+    isOrgDeveloper: boolean;
+}
+/**
+ * Determine user role based on permissions
+ */
+export declare const determineUserRole: (permissions: RolePermissions) => string;
+/**
+ * Get the icon class for a given role
+ */
+export declare const getRoleIcon: (role: string | null | undefined) => string;

package/lib/directives/element-mounted.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    mounted(el: HTMLElement, binding: any): void;
+};
+export default _default;

package/lib/main.lib.d.ts

@@ -100,6 +100,7 @@ export { default as CSettingsEditor } from './components/CSettingsEditor/CSettin
 export { default as CFilePanel } from './components/CFilePanel/CFilePanel.vue';
 export { default as CWarningAlert } from './components/CWarningAlert/CWarningAlert.vue';
 export { default as CUpsertFolderModal } from './components/CUpsertFolderModal/CUpsertFolderModal.vue';
+export { default as CInfoBadge } from './components/CInfoBadge/CInfoBadge.vue';
 export { default as CanvasBuilderApp } from './apps/canvas-builder/App.vue';
 export { default as CollectionSelectorApp } from './apps/collection-selector/App.vue';
 export { default as CollectionPlayerApp } from './apps/collection-player/App.vue';
@@ -139,6 +140,8 @@ export { default as useMetadataTemplates } from './composables/useMetadataTempla
 export { default as useMetadataSearch } from './composables/useMetadataSearch';
 export * from './composables/appsDb.use';
 export { default as useCanvasLocks } from './composables/useCanvasLocks';
+export { useCommentTracking } from './composables/useCommentTracking';
+export { useSharedCommentsStorage } from './composables/useSharedCommentsStorage';
 export * from './plugins/vueQuery';
 export * from './apps/canvas-builder/util/canvas.util';
 export * from './apps/canvas-builder/util/tree';
@@ -221,6 +224,8 @@ export * from './constants/config.const';
 export * from './constants/pitcherSettings.const';
 export * from './constants/appsDb.const';
 export * from './apps/canvas-builder/constants/theme.const';
+export * from './constants/roles.const';
+export type { RolePermissions } from './constants/roles.const';
 export * from './api/events/events.queries';
 export * from './api/users/users.queries';
 export * from './api/canvases/canvases.queries';
@@ -231,5 +236,6 @@ export { default as clickOutsideDirective } from './directives/clickOutside';
 export { default as autofocusDirective } from './directives/autofocus';
 export { default as tooltipDirective } from './directives/tooltip';
 export { default as usageTrackDirective } from './directives/usage-track.directive';
+export { default as elementMountedDirective } from './directives/element-mounted';
 export * from './constants/i18n.const';
 export * from './types/i18n.types';

package/lib/sdk/api/HighLevelApi.d.ts

@@ -111,6 +111,7 @@ export declare function createHighLevelApi(options?: ApiOptions): {
     updateMyUser(payload: {
         language?: import('../../main.lib').LanguageEnum | undefined;
     }): Promise<import('../../main.lib').User>;
+    isOffline(): Promise<boolean>;
     getLanguages(): Promise<modules.Language[]>;
     getEvents(payload: Partial<import('../../main.lib').EventRequest>): Promise<import('../../main.lib').PaginatedData<import('../../main.lib').Event>>;
     createEvent(payload: import('../../main.lib').EventRequest): Promise<import('../../main.lib').Event>;
@@ -210,6 +211,7 @@ export declare function createHighLevelApi(options?: ApiOptions): {
         message: string;
     }): Promise<void>;
     query(payload: import('../payload.types').QueryPayload): Promise<any>;
+    crmQuery(payload: import('../payload.types').CRMQueryPayload): Promise<any>;
     getFolders(payload: import('../payload.types').FolderListRequest): Promise<import('../../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../../main.lib').FolderRetrieve["id"];

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

@@ -15,6 +15,7 @@ declare function on(type: (typeof ADMIN_MESSAGE_TYPES)[keyof typeof ADMIN_MESSAG
  */
 declare function toast(payload: AdminToastRequest): Promise<void>;
 declare const _default: {
+    getUsers(payload?: import('../../../../main.lib').GetUsersParams): Promise<import('../../../../main.lib').PaginatedData<import('../../../../main.lib').User>>;
     getAppConfig(payload: {
         app_name: string;
     }): Promise<Record<string, any>>;

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

@@ -29,6 +29,7 @@ export declare const ADMIN_API_METHOD_TYPES: {
     readonly CLOSE: "admin_close_file_overlay";
     readonly GET_FILES: "admin_get_files";
     readonly GET_INSTANCE_METADATA_TEMPLATES: "admin_get_instance_metadata_templates";
+    readonly GET_USERS: "admin_get_users";
     readonly TOAST: "admin_toast";
     readonly UPDATE_CANVAS: "admin_update_canvas";
     readonly SELECT_COLLECTION_PLAYER_CONTENT: "admin_select_collection_player_content";

package/lib/sdk/api/modules/admin/users.admin.d.ts

@@ -0,0 +1,14 @@
+import { GetUsersParams } from '../../../../types/users';
+import { PaginatedData } from '../../../../types/paginatedData';
+import { User } from '../../../../../types/openapi';
+/**
+ * Fetches a list of users from the admin API.
+ *
+ * @param payload - Optional parameters for filtering users
+ * @returns Promise resolving to a paginated list of users
+ *
+ * @example
+ * const adminApi = useAdmin()
+ * const users = await adminApi.getUsers({ page_size: 100 })
+ */
+export declare function getUsers(payload?: GetUsersParams): Promise<PaginatedData<User>>;

package/lib/sdk/api/modules/env.d.ts

@@ -19,4 +19,5 @@ import { User } from '../../../../types/openapi';
 export declare function getEnv(): Promise<PitcherEnv>;
 type UpdateEnvParams = Pick<User, 'language'>;
 export declare function updateMyUser(payload: UpdateEnvParams): Promise<User>;
+export declare function isOffline(): Promise<boolean>;
 export {};

package/lib/sdk/api/modules/query.d.ts

@@ -1,2 +1,3 @@
-import { QueryPayload } from '../../payload.types';
+import { QueryPayload, CRMQueryPayload } from '../../payload.types';
 export declare function query(payload: QueryPayload): Promise<any>;
+export declare function crmQuery(payload: CRMQueryPayload): Promise<any>;

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

@@ -242,6 +242,10 @@ export type UiAppSetDataPayload = {
     height: string | undefined;
     /** Display mode */
     display_mode: string | undefined;
+    /** Section index in section list */
+    section_index: number | null;
+    /** Section list ID */
+    section_list_id: string | null;
 };
 export type UiAppUpdateDataPayload = {
     /** Call status */

package/lib/sdk/interfaces.d.ts

@@ -66,6 +66,7 @@ export interface PitcherEnv {
             id: File['id'];
         };
     };
+    device_locale?: string;
 }
 export interface PitcherAPI extends Emitter<ApiEventMap> {
     request(type: string, body: any, callback: () => any): Promise<PitcherResponse>;

package/lib/sdk/main.d.ts

@@ -85,6 +85,7 @@ export declare function useUi(): {
  * ```
  */
 export declare function useAdmin(): {
+    getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
     getAppConfig(payload: {
         app_name: string;
     }): Promise<Record<string, any>>;
@@ -188,6 +189,7 @@ export declare function useApi(options?: ApiOptions): {
     updateMyUser(payload: {
         language?: import('../main.lib').LanguageEnum | undefined;
     }): Promise<import('../main.lib').User>;
+    isOffline(): Promise<boolean>;
     getLanguages(): Promise<import('./api/modules').Language[]>;
     getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
     createEvent(payload: import('../main.lib').EventRequest): Promise<import('../main.lib').Event>;
@@ -287,6 +289,7 @@ export declare function useApi(options?: ApiOptions): {
         message: string;
     }): Promise<void>;
     query(payload: import('./payload.types').QueryPayload): Promise<any>;
+    crmQuery(payload: import('./payload.types').CRMQueryPayload): Promise<any>;
     getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../main.lib').FolderRetrieve["id"];
@@ -337,6 +340,7 @@ export declare function useApi(options?: ApiOptions): {
     }>;
     API: import('./api/LowLevelApi').LowLevelApi;
 } | {
+    getUsers(payload?: import('../main.lib').GetUsersParams): Promise<import('../main.lib').PaginatedData<import('../main.lib').User>>;
     getAppConfig(payload: {
         app_name: string;
     }): Promise<Record<string, any>>;
@@ -459,6 +463,7 @@ export declare function useApi(options?: ApiOptions): {
         updateMyUser(payload: {
             language?: import('../main.lib').LanguageEnum | undefined;
         }): Promise<import('../main.lib').User>;
+        isOffline(): Promise<boolean>;
         getLanguages(): Promise<import('./api/modules').Language[]>;
         getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
         createEvent(payload: import('../main.lib').EventRequest): Promise<import('../main.lib').Event>;
@@ -558,6 +563,7 @@ export declare function useApi(options?: ApiOptions): {
             message: string;
         }): Promise<void>;
         query(payload: import('./payload.types').QueryPayload): Promise<any>;
+        crmQuery(payload: import('./payload.types').CRMQueryPayload): Promise<any>;
         getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
         getFolder(payload?: {
             id: import('../main.lib').FolderRetrieve["id"];
@@ -669,6 +675,7 @@ export declare function useApi(options?: ApiOptions): {
     updateMyUser(payload: {
         language?: import('../main.lib').LanguageEnum | undefined;
     }): Promise<import('../main.lib').User>;
+    isOffline(): Promise<boolean>;
     getLanguages(): Promise<import('./api/modules').Language[]>;
     getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
     createEvent(payload: import('../main.lib').EventRequest): Promise<import('../main.lib').Event>;
@@ -759,6 +766,7 @@ export declare function useApi(options?: ApiOptions): {
         };
     }): Promise<ArrayBuffer>;
     query(payload: import('./payload.types').QueryPayload): Promise<any>;
+    crmQuery(payload: import('./payload.types').CRMQueryPayload): Promise<any>;
     getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../main.lib').FolderRetrieve["id"];

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.
  */

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 {
@@ -18,9 +17,9 @@ export declare enum PostAction {
 }
 export type CallPresentationHistory = {
     type: 'canvas' | 'section' | 'file' | 'page' | 'canvas_page';
-    notesContent?: string;
     duration?: number;
     timeStarted?: string;
+    accumulatedDuration?: number;
     name?: string;
     page?: number;
     component_ids?: string[];

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_dynamic_data_table_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' | '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_hotspot_visibility' | '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_reorder_search' | 'enable_reorder_scribble_isolation' | '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.2",
+  "version": "1.25.0",
   "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;