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

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

@@ -1,4 +1,4 @@
-import { SharePayload, ShareResponse } from '../../payload.types';
+import { SharePayload, ShareResponse, ShowPeerSessionRequestPayload } from '../../payload.types';
 /**
  * Dispatch iOS sharing dialog.
  *
@@ -6,3 +6,10 @@ import { SharePayload, ShareResponse } from '../../payload.types';
  * api.share({text: "example text", subject: "example subject"})
  */
 export declare function share(payload: SharePayload): Promise<ShareResponse>;
+/**
+ * Show peer session dialog with button coordinates, for local peer sharing feature.
+ *
+ * @example
+ * api.showPeerSession({x: 100, y: 200})
+ */
+export declare function showPeerSession(payload: ShowPeerSessionRequestPayload): Promise<void>;

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

@@ -1,5 +1,5 @@
 import { CanvasRetrieve } from '../../../../../types/openapi';
-import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest, UiSelectCanvasesRequest, UiSelectCanvasesResponse } from './types.ui';
+import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest, UiPrintCanvasRequest, UiPrintCanvasResponse, UiSelectCanvasesRequest, UiSelectCanvasesResponse } from './types.ui';
 /**
  * Modify the currently loaded canvas. On the web it sends
  * an [update_canvas](https://pitcher.readme.io/reference/update_canvas) request to the server.
@@ -7,6 +7,20 @@ import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest,
  * @param payload parts of the canvas object to update with fields to return
  */
 export declare function updateCanvas(payload: UiUpdateCanvasRequest): Promise<CanvasRetrieve>;
+/**
+ * Trigger async print/download of a canvas with optional notification URL.
+ * Calls the downloader-test endpoint to convert the canvas to PDF.
+ *
+ * @param payload Canvas ID and optional notify URL for async notifications
+ * @returns Promise with job ID and success status
+ *
+ * @example
+ * useUi().printCanvas({
+ *   id: '01HH4RCBH631K4JDHWAQB0RPR6',
+ *   notify_url: 'https://my-webhook.example.com/canvas-ready'
+ * })
+ */
+export declare function printCanvas(payload: UiPrintCanvasRequest): Promise<UiPrintCanvasResponse>;
 /**
  * Notify the CatalogIQ instance that the app is loaded and ready to get the data. Triggering this method will trigger
  * the `on_app_set_data` event.
@@ -35,6 +49,16 @@ export declare function appResize(payload: UiAppResizeRequest): Promise<void>;
  * useUi().closeCanvasSectionExecution()
  */
 export declare function closeCanvasSectionExecution(): Promise<void>;
+/**
+ * Close the Canvas Drawer modal. Only takes effect for apps running in `canvas_drawer` embed location
+ *
+ * Note that this method simply closes the drawer and will result in the app calling it being unmounted from the DOM and
+ * destroyed. Make sure your app has finished updating data before you call this method.
+ *
+ * @example
+ * useUi().closeCanvasDrawer()
+ */
+export declare function closeCanvasDrawer(): Promise<void>;
 /**
  * Navigate to the next page in the current canvas. Noop if the current page is the last one.
  *

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

@@ -122,9 +122,11 @@ declare const _default: {
     disablePostcallSubmit(): Promise<void>;
     setPostcallStyle(payload: import('./types.ui').UiSetPostcallStyleRequest): Promise<void>;
     updateCanvas(payload: import('./types.ui').UiUpdateCanvasRequest): Promise<import('../../../../main.lib').CanvasRetrieve>;
+    printCanvas(payload: import('./types.ui').UiPrintCanvasRequest): Promise<import('./types.ui').UiPrintCanvasResponse>;
     appLoaded(): Promise<void>;
     appResize(payload: import('./types.ui').UiAppResizeRequest): Promise<void>;
     closeCanvasSectionExecution(): Promise<void>;
+    closeCanvasDrawer(): Promise<void>;
     canvasNavigateNextPage(): Promise<void>;
     canvasNavigatePreviousPage(): Promise<void>;
     canvasNavigatePage(payload: import('./types.ui').UiCanvasNavigatePageRequest): Promise<void>;

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

@@ -21,6 +21,7 @@ export declare const UI_API_METHOD_TYPES: {
     readonly UI_TOAST: "ui_toast";
     readonly UI_CAPTURE_APP_ERROR: "ui_capture_app_error";
     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_SELECT_COLLECTION_PLAYER_CONTENT: "ui_select_collection_player_content";
     readonly UI_SELECT_AGENDA_CONTENT: "ui_select_agenda_content";
@@ -40,6 +41,7 @@ export declare const UI_API_METHOD_TYPES: {
     readonly UI_APP_LOADED: "ui_app_loaded";
     readonly UI_APP_RESIZE: "ui_app_resize";
     readonly UI_CLOSE_CANVAS_SECTION_EXECUTION: "ui_close_canvas_section_execution";
+    readonly UI_CLOSE_CANVAS_DRAWER: "ui_close_canvas_drawer";
 };
 export declare const UI_MESSAGE_TYPES: {
     readonly UI_MEETING_CANCELED: "ui_meeting_canceled";
@@ -70,6 +72,14 @@ export type UiSelectContentRequest = {
      * Disables files from selection which are not sharable (optional).
      */
     disable_no_sharable?: boolean;
+    /**
+     * Disables files from selection which do not have pptx_data in metadata object (optional).
+     */
+    disable_no_pptx_data?: boolean;
+    /**
+     * Only allow content pdf pages (optional). User will be forced to select a page from the pdf.
+     */
+    only_allow_content_pdf_pages?: boolean;
 };
 export type UiSelectContentResponse = {
     /** User action result */
@@ -136,6 +146,18 @@ export type UiUpdateCanvasRequest = Mutable<CanvasRetrieve> & {
     /** Comma-separated list of field keys to return from the server */
     fields?: string;
 };
+export type UiPrintCanvasRequest = {
+    /** Canvas ID to print */
+    id: CanvasRetrieve['id'];
+    /** Optional HTTPS URL for async download notifications */
+    notify_url?: string;
+};
+export type UiPrintCanvasResponse = {
+    /** Job ID for tracking the async download */
+    job_id?: string;
+    /** Indicates if the request was successful */
+    success: boolean;
+};
 export type UiOpenRequest = OpenRequestPayload & {
     /** Name of the app to open */
     app_name?: string;

package/lib/sdk/interfaces.d.ts

@@ -126,13 +126,21 @@ export declare enum PitcherEventName {
     EXITED_FULLSCREEN = "exited_fullscreen",
     SUBMIT_POSTCALL_CLICKED = "submit_postcall_clicked",
     ANALYTICS_CAPTURED = "analytics_captured",
-    OPEN_FOLDER_REQUESTED = "open_folder_requested"
+    OPEN_FOLDER_REQUESTED = "open_folder_requested",
+    CANVAS_PAGE_NEXT_REQUESTED = "canvas_page_next_requested",
+    CANVAS_PAGE_PREVIOUS_REQUESTED = "canvas_page_previous_requested",
+    CANVAS_OPEN_REQUESTED = "canvas_open_requested",
+    CANVAS_CLOSE_REQUESTED = "canvas_close_requested"
 }
 export declare enum PitcherBroadcastedEventName {
     UI_SHOW_MODAL = "ui:show-modal",
     UI_HIDE_MODAL = "ui:hide-modal",
     FAVORITES_CHANGED = "favorites:changed",
-    FILE_DOWNLOAD = "file:download"
+    FILE_DOWNLOAD = "file:download",
+    CANVAS_NEXT_BUTTON_CLICKED = "canvas_next_button_clicked",// NOTE: This event is separate from `CANVAS_PAGE_NEXT_REQUESTED`
+    CANVAS_PREVIOUS_BUTTON_CLICKED = "canvas_previous_button_clicked",// NOTE: This event is separate from `CANVAS_PAGE_PREVIOUS_REQUESTED`
+    CANVAS_OPENED = "canvas_opened",
+    CANVAS_CLOSED = "canvas_closed"
 }
 export declare enum PitcherExternalEventName {
     CREATE_AND_OPEN_CANVAS = "create_and_open_canvas",
@@ -371,6 +379,20 @@ export interface PitcherEventMap {
         view_id?: string;
     };
     [PitcherEventName.SUBMIT_POSTCALL_CLICKED]: void;
+    [PitcherEventName.CANVAS_PAGE_NEXT_REQUESTED]: {
+        canvas_id?: string;
+        current_page_index?: number;
+    };
+    [PitcherEventName.CANVAS_PAGE_PREVIOUS_REQUESTED]: {
+        canvas_id?: string;
+        current_page_index?: number;
+    };
+    [PitcherEventName.CANVAS_OPEN_REQUESTED]: {
+        canvas_id?: string;
+    };
+    [PitcherEventName.CANVAS_CLOSE_REQUESTED]: {
+        canvas_id?: string;
+    };
     [PitcherBroadcastedEventName.UI_SHOW_MODAL]: void;
     [PitcherBroadcastedEventName.UI_HIDE_MODAL]: void;
     [PitcherBroadcastedEventName.FAVORITES_CHANGED]: {
@@ -379,6 +401,28 @@ export interface PitcherEventMap {
     [PitcherBroadcastedEventName.FILE_DOWNLOAD]: {
         body: File['id'];
     };
+    [PitcherBroadcastedEventName.CANVAS_NEXT_BUTTON_CLICKED]: {
+        body: {
+            current_page_index: number;
+            canvas_id?: string;
+        };
+    };
+    [PitcherBroadcastedEventName.CANVAS_PREVIOUS_BUTTON_CLICKED]: {
+        body: {
+            current_page_index: number;
+            canvas_id?: string;
+        };
+    };
+    [PitcherBroadcastedEventName.CANVAS_OPENED]: {
+        body: {
+            canvas_id: string;
+        };
+    };
+    [PitcherBroadcastedEventName.CANVAS_CLOSED]: {
+        body: {
+            canvas_id: string;
+        };
+    };
     [PitcherExternalEventName.OPEN_CANVAS]: OpenCanvasPitcherEvent;
     [PitcherExternalEventName.START_CALL]: StartCallPitcherEvent;
     [PitcherExternalEventName.CREATE_AND_OPEN_CANVAS]: CreateAndOpenCanvasEvent;

package/lib/sdk/main.d.ts

@@ -33,9 +33,11 @@ export declare function useUi(): {
     disablePostcallSubmit(): Promise<void>;
     setPostcallStyle(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
     updateCanvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+    printCanvas(payload: import('./api/modules/ui/types.ui').UiPrintCanvasRequest): Promise<import('./api/modules/ui/types.ui').UiPrintCanvasResponse>;
     appLoaded(): Promise<void>;
     appResize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
     closeCanvasSectionExecution(): Promise<void>;
+    closeCanvasDrawer(): Promise<void>;
     canvasNavigateNextPage(): Promise<void>;
     canvasNavigatePreviousPage(): Promise<void>;
     canvasNavigatePage(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -330,6 +332,7 @@ export declare function useApi(options?: ApiOptions): {
     close(): Promise<any>;
     openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
     share(payload: import('./payload.types').SharePayload): Promise<import('./payload.types').ShareResponse>;
+    showPeerSession(payload: import('./payload.types').ShowPeerSessionRequestPayload): Promise<void>;
     getThemes(payload: Partial<import('../main.lib').CanvasThemeRetrieve>): Promise<import('../main.lib').CanvasThemeRetrieve[]>;
     assignCanvasTheme(payload: {
         canvas_id: import('../main.lib').CanvasRetrieve["id"];
@@ -407,9 +410,11 @@ export declare function useApi(options?: ApiOptions): {
         disablePostcallSubmit(): Promise<void>;
         setPostcallStyle(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
         updateCanvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+        printCanvas(payload: import('./api/modules/ui/types.ui').UiPrintCanvasRequest): Promise<import('./api/modules/ui/types.ui').UiPrintCanvasResponse>;
         appLoaded(): Promise<void>;
         appResize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
         closeCanvasSectionExecution(): Promise<void>;
+        closeCanvasDrawer(): Promise<void>;
         canvasNavigateNextPage(): Promise<void>;
         canvasNavigatePreviousPage(): Promise<void>;
         canvasNavigatePage(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -604,6 +609,7 @@ export declare function useApi(options?: ApiOptions): {
         close(): Promise<any>;
         openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
         share(payload: import('./payload.types').SharePayload): Promise<import('./payload.types').ShareResponse>;
+        showPeerSession(payload: import('./payload.types').ShowPeerSessionRequestPayload): Promise<void>;
         getThemes(payload: Partial<import('../main.lib').CanvasThemeRetrieve>): Promise<import('../main.lib').CanvasThemeRetrieve[]>;
         assignCanvasTheme(payload: {
             canvas_id: import('../main.lib').CanvasRetrieve["id"];
@@ -623,9 +629,11 @@ export declare function useApi(options?: ApiOptions): {
     disablePostcallSubmit(): Promise<void>;
     setPostcallStyle(payload: import('./api/modules/ui/types.ui').UiSetPostcallStyleRequest): Promise<void>;
     updateCanvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
+    printCanvas(payload: import('./api/modules/ui/types.ui').UiPrintCanvasRequest): Promise<import('./api/modules/ui/types.ui').UiPrintCanvasResponse>;
     appLoaded(): Promise<void>;
     appResize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
     closeCanvasSectionExecution(): Promise<void>;
+    closeCanvasDrawer(): Promise<void>;
     canvasNavigateNextPage(): Promise<void>;
     canvasNavigatePreviousPage(): Promise<void>;
     canvasNavigatePage(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -807,6 +815,7 @@ export declare function useApi(options?: ApiOptions): {
     close(): Promise<any>;
     openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
     share(payload: import('./payload.types').SharePayload): Promise<import('./payload.types').ShareResponse>;
+    showPeerSession(payload: import('./payload.types').ShowPeerSessionRequestPayload): Promise<void>;
     getThemes(payload: Partial<import('../main.lib').CanvasThemeRetrieve>): Promise<import('../main.lib').CanvasThemeRetrieve[]>;
     assignCanvasTheme(payload: {
         canvas_id: import('../main.lib').CanvasRetrieve["id"];

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

@@ -248,6 +248,19 @@ export type ShareResponse = {
      */
     activity_type?: string;
 };
+/**
+ * Payload for showing peer session dialog.
+ */
+export interface ShowPeerSessionRequestPayload {
+    /**
+     * The x-coordinate of the button that triggered the action.
+     */
+    x: number;
+    /**
+     * The y-coordinate of the button that triggered the action.
+     */
+    y: number;
+}
 export type FolderListRequest = {
     search?: string;
     ordering?: string;

package/lib/stores/sectionSmartFolderStore.d.ts

@@ -0,0 +1,110 @@
+import { ComputedRef } from 'vue';
+export interface SmartFolderProperty {
+    name: string;
+    display_name?: string;
+    accessor: string;
+    type: string;
+    description?: string;
+    display_names_by_value?: Record<string, string>;
+}
+export interface SectionById {
+    id: string;
+    name: string;
+    created_at: string;
+    modified_at: string;
+    thumbnail_url?: string;
+    metadata?: Record<string, any>;
+    is_editable: boolean;
+    is_default: boolean;
+    access_type: string;
+    context: Record<string, any>;
+    used_in_count: number;
+    theme?: Record<string, any>;
+    indicators?: Record<string, any>;
+    tags?: string[];
+}
+interface PathSegment {
+    value: string;
+    property: SmartFolderProperty;
+}
+export default function useSectionSmartFolderStore(): {
+    state: {
+        readonly hierarchyLevels: readonly {
+            readonly name: string;
+            readonly display_name?: string | undefined;
+            readonly accessor: string;
+            readonly type: string;
+            readonly description?: string | undefined;
+            readonly display_names_by_value?: {
+                readonly [x: string]: string;
+            } | undefined;
+        }[];
+        readonly currentPath: readonly {
+            readonly value: string;
+            readonly property: {
+                readonly name: string;
+                readonly display_name?: string | undefined;
+                readonly accessor: string;
+                readonly type: string;
+                readonly description?: string | undefined;
+                readonly display_names_by_value?: {
+                    readonly [x: string]: string;
+                } | undefined;
+            };
+        }[];
+        readonly availableValues: readonly {
+            readonly value: string;
+            readonly files_count: number;
+        }[];
+        readonly matchingSections: readonly {
+            readonly id: string;
+            readonly name: string;
+            readonly created_at: string;
+            readonly modified_at: string;
+            readonly thumbnail_url?: string | undefined;
+            readonly metadata?: {
+                readonly [x: string]: any;
+            } | undefined;
+            readonly is_editable: boolean;
+            readonly is_default: boolean;
+            readonly access_type: string;
+            readonly context: {
+                readonly [x: string]: any;
+            };
+            readonly used_in_count: number;
+            readonly theme?: {
+                readonly [x: string]: any;
+            } | undefined;
+            readonly indicators?: {
+                readonly [x: string]: any;
+            } | undefined;
+            readonly tags?: readonly string[] | undefined;
+        }[];
+        readonly isLoading: boolean;
+        readonly isSavingConfig: boolean;
+        readonly viewMode: "folders" | "sections";
+        readonly totalCount: number;
+        readonly page: number;
+        readonly pageSize: number;
+    };
+    isSmartFoldersView: import('@vueuse/shared').RemovableRef<boolean>;
+    smartFolderRuleAttributes: ComputedRef<{
+        name: string;
+        type: "string" | "boolean" | "number" | "date" | "array";
+        accessor: string;
+        display_name: string;
+    }[]>;
+    actions: {
+        fetchData: () => Promise<void>;
+        loadConfiguration: () => Promise<void>;
+        navigateToLevel: (index: number) => void;
+        setCurrentPath: (value: PathSegment[]) => void;
+        selectValue: (value: string, { skipFetchData }?: {
+            skipFetchData?: boolean;
+        }) => void;
+        toggleViewMode: () => void;
+        reset: () => void;
+        setMatchingSections: (sections: SectionById[]) => void;
+    };
+};
+export {};

package/lib/types/app.d.ts

@@ -48,12 +48,29 @@ export type Module = {
     };
     shortcuts: EmbeddedAppShortcutsDict;
 } & EmbeddedLocationProperties;
-type AppJsonOptions = {
+type AppTypeJsonOptions = {
     dimensions?: {
         width?: number | string;
         height?: number | string;
     };
     placement?: 'top-left' | 'top-center' | 'top-right' | 'left' | 'center' | 'right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
+    mode_config?: {
+        fullscreen?: {
+            show?: boolean;
+            icon?: string;
+            order_override?: number;
+        };
+        presentation?: {
+            show?: boolean;
+            icon?: string;
+            order_override?: number;
+        };
+        edit?: {
+            show?: boolean;
+            icon?: string;
+            order_override?: number;
+        };
+    };
 };
 export type AppJson = {
     name: string;
@@ -66,8 +83,8 @@ export type AppJson = {
     description?: string;
     authors?: string[];
     module: Record<EmbedLocation, Module>;
-    app_type?: 'canvas-popup' | 'section-selector';
-    app_options?: AppJsonOptions;
+    app_type?: 'canvas-popup' | 'section-selector' | 'sharebox';
+    app_options?: AppTypeJsonOptions;
     order_override?: number;
 };
 export type AppFile = File & {

package/lib/types/call.d.ts

@@ -19,6 +19,7 @@ export type CallPresentationHistory = {
     type: 'canvas' | 'section' | 'file' | 'page' | 'canvas_page';
     duration?: number;
     timeStarted?: string;
+    lastTimeStarted?: string;
     accumulatedDuration?: number;
     name?: string;
     page?: number;

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

@@ -14,6 +14,8 @@ export interface MetadataFilterRequest {
     include_name_search?: boolean;
     include_draft_values?: boolean;
     owner_id?: string | null;
+    content_type?: string[];
+    return_arrays?: boolean;
 }
 export type MetadataSearchParams = MetadataFilterRequest & {
     searchMode?: 'exact' | 'partial' | 'fuzzy';

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

@@ -11,6 +11,12 @@ export type CanvasComponentTypes = Exclude<keyof typeof ComponentTypes, CanvasEx
 export type CanvasComponentAvailability = {
     [component in CanvasComponentTypes]: boolean;
 };
+export type CanvasComponentAvailabilityRoles = {
+    [component in CanvasComponentTypes]: {
+        admin?: boolean;
+        rep?: boolean;
+    };
+};
 export type AutohideSectionOnCreated = {
     autohide_in_shared_link?: string;
     start_date?: Date;
@@ -23,6 +29,12 @@ export type InstanceSettings = OrganizationSettings & {
         component_availability?: CanvasComponentAvailability & {
             apps?: Record<string, boolean>;
         };
+        component_availability_roles?: CanvasComponentAvailabilityRoles & {
+            apps?: Record<string, {
+                admin?: boolean;
+                rep?: boolean;
+            }>;
+        };
         content_grid_autofill_files_filter_iteratee?: string;
         section_content_grid_autofill_files_filter_iteratee?: string;
         show_extra_exit_button_in_fullscreen_mode?: boolean;
@@ -33,12 +45,13 @@ export type InstanceSettings = OrganizationSettings & {
         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;
+        async_download_expiration_hours?: number;
+        async_download_api_url?: string;
+        async_download_callback_url?: string;
     };
     enable_recents?: boolean;
     enable_favorites?: boolean;
+    enable_multipeer_connectivity?: 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_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 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_html_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_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_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_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_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_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_section_selector_drag_n_drop' | 'enable_smart_folders' | 'enable_smart_folders_for_sections' | '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_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_only_preview_mode_for_html_component' | 'show_popularity_icons' | 'show_system_filters' | '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';
 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

@@ -13,8 +13,14 @@ type SmartFolderRuleAttributes = {
     files?: SmartFolderRuleAttribute[];
     canvas?: SmartFolderRuleAttribute[];
     canvas_templates?: SmartFolderRuleAttribute[];
+    section?: SmartFolderRuleAttribute[];
 };
 export type OrganizationSettings = {
+    auto_assignment_rules?: {
+        connection_id: string;
+        target_instance_id: string;
+        groups?: string[];
+    }[];
     canvas?: {
         locks_polling_interval?: number;
         shared_link?: {
@@ -24,8 +30,11 @@ export type OrganizationSettings = {
             logo_style?: Record<string, any>;
         };
     };
+    api_client_timeout?: number;
+    enable_monaco_html_editor?: boolean;
     skip_metadata_keys_in_list_item?: string[];
     enable_multi_language?: boolean;
+    enable_multipeer_connectivity?: boolean;
     canvases_route_order?: number;
     content_browser_route_order?: number;
     impact_show_only_saved_canvases_in_canvas_manager?: boolean;
@@ -53,16 +62,20 @@ 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;
+    generate_only_sections_in_ppt_converter?: boolean;
     enable_search_with_suggestions?: boolean;
     enable_search_filter_with_suggestions?: boolean;
+    enable_quick_filters_for_search_metadata_filters?: boolean;
     enable_thumbnails_for_templates_and_blocks?: boolean;
     default_pdf_page_dimensions?: {
         width?: number;
         height?: number;
+        printScale?: number;
     };
     disable_browser_search_context?: boolean;
     location_prompt_type?: 'warning' | 'block';
     location_prompt_message?: string;
     use_collection_player_with_annotations?: boolean;
+    disable_core_canvas_metadata?: boolean;
 };
 export {};

package/lib/util/date.d.ts

@@ -3,6 +3,7 @@ export declare const dayjs: typeof dayjsInstance;
 export declare const formatDayMonthBasedOnBrowserLang: (date: Date) => string;
 export declare const formatDateTimeAgo: (dateStr?: string | null) => string | null | undefined;
 export declare const formatDateTime: (dateStr?: string | null, format?: string) => string | null | undefined;
+export declare const formatDateDetailed: (dateValue?: string | null, isDetailedEnabled?: boolean) => string | null | undefined;
 export declare const formatDate: (dateStr?: string | null | Dayjs, format?: string) => string | null | undefined;
 export declare const isBefore: (dateStr?: string | null) => boolean;
 export declare const isSameOrBefore: (dateStr?: string | null) => boolean;

package/lib/util/network.d.ts

@@ -1,5 +1,13 @@
 import { PaginatedData } from '../types/paginatedData';
 export declare const fetchAll: <T>(reqFunction: (reqParams: any) => Promise<PaginatedData<T>>, reqParams?: any, maxLimit?: number) => Promise<T[]>;
+export declare const fetchAllWithOffset: <T>(reqFunction: (reqParams: any) => Promise<{
+    pagination: {
+        limit: number;
+        offset: number;
+        total: number;
+    };
+    data: T[];
+}>, reqParams?: any, maxLimit?: number) => Promise<T[]>;
 export declare function fetchFirstChunkAndRemainingAsync<T>(reqFunction: (reqParams: any) => Promise<PaginatedData<T>>, reqParams?: any): Promise<[T[], Promise<T[]>]>;
 export declare function urlSafeFetchInChunks<T>(ids: (string | number)[], fetchFunction: (chunk: (string | number)[]) => Promise<{
     results: T[];

package/package.json

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

package/types/openapi/index.d.ts

@@ -55,7 +55,6 @@ export type { DeletedFolder } from './models/DeletedFolder';
 export type { DeletedInstance } from './models/DeletedInstance';
 export type { DeletedInstanceAssignmentGroup } from './models/DeletedInstanceAssignmentGroup';
 export type { DeletedMetadataTemplate } from './models/DeletedMetadataTemplate';
-export type { DeletedRegion } from './models/DeletedRegion';
 export { DownloadTypeEnum } from './models/DownloadTypeEnum';
 export type { Environment } from './models/Environment';
 export type { EnvironmentRequest } from './models/EnvironmentRequest';
@@ -159,8 +158,6 @@ export type { MiniFolderRequest } from './models/MiniFolderRequest';
 export type { MiniInstance } from './models/MiniInstance';
 export type { MiniInstanceRequest } from './models/MiniInstanceRequest';
 export type { MiniPage } from './models/MiniPage';
-export type { MiniRegion } from './models/MiniRegion';
-export type { MiniRegionRequest } from './models/MiniRegionRequest';
 export type { MiniSharedLink } from './models/MiniSharedLink';
 export type { MiniSharedLinkRequest } from './models/MiniSharedLinkRequest';
 export type { MiniUser } from './models/MiniUser';
@@ -200,7 +197,6 @@ export type { PaginatedInstanceMembershipList } from './models/PaginatedInstance
 export type { PaginatedInvitationList } from './models/PaginatedInvitationList';
 export type { PaginatedMetadataTemplateList } from './models/PaginatedMetadataTemplateList';
 export type { PaginatedOfflineSyncFolderList } from './models/PaginatedOfflineSyncFolderList';
-export type { PaginatedRegionList } from './models/PaginatedRegionList';
 export type { PaginatedRevisionList } from './models/PaginatedRevisionList';
 export type { PaginatedSearchResultList } from './models/PaginatedSearchResultList';
 export type { PaginatedUserList } from './models/PaginatedUserList';
@@ -220,14 +216,11 @@ export type { PatchedInstanceMembershipRequest } from './models/PatchedInstanceM
 export type { PatchedInstanceUpdateRequest } from './models/PatchedInstanceUpdateRequest';
 export type { PatchedMetadataTemplateRequest } from './models/PatchedMetadataTemplateRequest';
 export type { PatchedOrganizationUpdateRequest } from './models/PatchedOrganizationUpdateRequest';
-export type { PatchedRegionRequest } from './models/PatchedRegionRequest';
 export type { PatchedUserRequest } from './models/PatchedUserRequest';
 export type { PSPDFKitAuthPayload } from './models/PSPDFKitAuthPayload';
 export type { PSPDFKitAuthPayloadRequest } from './models/PSPDFKitAuthPayloadRequest';
 export type { PSPDFKitToken } from './models/PSPDFKitToken';
 export type { PSPDFKitTokenRequest } from './models/PSPDFKitTokenRequest';
-export type { Region } from './models/Region';
-export type { RegionRequest } from './models/RegionRequest';
 export type { Revision } from './models/Revision';
 export type { RevisionRequest } from './models/RevisionRequest';
 export type { SearchApp } from './models/SearchApp';