@pitcher/js-api 1.26.0-beta.2 → 1.26.0-beta.4

package/lib/apps/canvas-builder/components/container/CanvasContent/pageWrapper.paginated.vue.d.ts

@@ -1,21 +1,27 @@
 import { CSSProperties } from 'vue';
-import { ComponentTypes, ComponentNode } from '../../../types/canvas';
 interface Props {
-    page: ComponentNode[];
     isScaleContentEnabled?: boolean;
     aspectRatioStyle: CSSProperties | undefined;
-    componentMap: Record<ComponentTypes, any>;
-    getChildComponentStyle: (parent: ComponentNode, child: ComponentNode, index: number) => CSSProperties;
-    getComponentBindings: (component: ComponentNode) => any;
-    getTopLevelComponentStyle: (page: ComponentNode[], component: ComponentNode, index: number) => CSSProperties;
-    onElementVisibility: (isVisible: boolean, component: ComponentNode) => void;
-    shouldRenderComponentWrapper: (component: ComponentNode) => boolean | undefined;
     aspectRatio: {
         x: number;
         y: number;
     } | undefined;
 }
-declare const _default: import('vue').DefineComponent<Props, {
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+        default?(_: {}): any;
+    };
+    refs: {
+        pageWrapperRef: HTMLDivElement;
+        pageContainerRef: HTMLDivElement;
+        pageContentRef: HTMLDivElement;
+    };
+    rootEl: HTMLDivElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<Props, {
     pageWrapperRef: import('vue').Ref<HTMLElement | null, HTMLElement | null>;
     pageContainerRef: import('vue').Ref<HTMLElement | null, HTMLElement | null>;
     pageContentRef: import('vue').Ref<HTMLElement | null, HTMLElement | null>;
@@ -24,4 +30,10 @@ declare const _default: import('vue').DefineComponent<Props, {
     pageContainerRef: HTMLDivElement;
     pageContentRef: HTMLDivElement;
 }, HTMLDivElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/lib/apps/canvas-builder/components/container/EditableComponent/EditableComponent.vue.d.ts

@@ -31,6 +31,8 @@ type __VLS_Props = {
     resizable?: boolean;
     resizeHandles?: ResizeHandlePosition[];
     resizeMaintainAspectRatio?: boolean;
+    expiredContent?: boolean;
+    restrictedContent?: boolean;
     variants?: {
         title: string;
         options: DropdownOption[];

package/lib/apps/canvas-builder/components/container/EditableComponent/EditableComponentContent.vue.d.ts

@@ -37,6 +37,8 @@ type __VLS_Props = {
     showOnlyTopToolbar?: boolean;
     to?: HTMLElement | string;
     showOnlyBottomToolbar?: boolean;
+    expiredContent?: boolean;
+    restrictedContent?: boolean;
 };
 declare function __VLS_template(): {
     attrs: Partial<{}>;

package/lib/apps/canvas-builder/composables/useCanvas.d.ts

@@ -3952,6 +3952,7 @@ export default function useCanvas(): {
             zh?: Record<string, string> | undefined;
             it?: Record<string, string> | undefined;
             pt?: Record<string, string> | undefined;
+            "pt-br"?: Record<string, string> | undefined;
             nl?: Record<string, string> | undefined;
         } | undefined;
         file_annotations_mode?: "admin" | "personal" | undefined;
@@ -4019,9 +4020,9 @@ export default function useCanvas(): {
         enable_quick_filters_for_search_metadata_filters?: boolean | undefined;
         enable_thumbnails_for_templates_and_blocks?: boolean | undefined;
         default_pdf_page_dimensions?: {
-            width?: number | undefined;
-            height?: number | undefined;
-            printScale?: number | undefined;
+            width?: number | string | undefined;
+            height?: number | string | undefined;
+            print_scale?: number | undefined;
         } | undefined;
         disable_browser_search_context?: boolean | undefined;
         location_prompt_type?: "warning" | "block" | undefined;
@@ -4249,6 +4250,7 @@ export default function useCanvas(): {
             zh?: Record<string, string> | undefined;
             it?: Record<string, string> | undefined;
             pt?: Record<string, string> | undefined;
+            "pt-br"?: Record<string, string> | undefined;
             nl?: Record<string, string> | undefined;
         } | undefined;
         file_annotations_mode?: "admin" | "personal" | undefined;
@@ -4316,9 +4318,9 @@ export default function useCanvas(): {
         enable_quick_filters_for_search_metadata_filters?: boolean | undefined;
         enable_thumbnails_for_templates_and_blocks?: boolean | undefined;
         default_pdf_page_dimensions?: {
-            width?: number | undefined;
-            height?: number | undefined;
-            printScale?: number | undefined;
+            width?: number | string | undefined;
+            height?: number | string | undefined;
+            print_scale?: number | undefined;
         } | undefined;
         disable_browser_search_context?: boolean | undefined;
         location_prompt_type?: "warning" | "block" | undefined;
@@ -4539,6 +4541,9 @@ export default function useCanvas(): {
             readonly pt?: {
                 readonly [x: string]: string;
             } | undefined;
+            readonly "pt-br"?: {
+                readonly [x: string]: string;
+            } | undefined;
             readonly nl?: {
                 readonly [x: string]: string;
             } | undefined;
@@ -4608,9 +4613,9 @@ export default function useCanvas(): {
         readonly enable_quick_filters_for_search_metadata_filters?: boolean | undefined;
         readonly enable_thumbnails_for_templates_and_blocks?: boolean | undefined;
         readonly default_pdf_page_dimensions?: {
-            readonly width?: number | undefined;
-            readonly height?: number | undefined;
-            readonly printScale?: number | undefined;
+            readonly width?: number | string | undefined;
+            readonly height?: number | string | undefined;
+            readonly print_scale?: number | undefined;
         } | undefined;
         readonly disable_browser_search_context?: boolean | undefined;
         readonly location_prompt_type?: "warning" | "block" | undefined;
@@ -4830,6 +4835,9 @@ export default function useCanvas(): {
             readonly pt?: {
                 readonly [x: string]: string;
             } | undefined;
+            readonly "pt-br"?: {
+                readonly [x: string]: string;
+            } | undefined;
             readonly nl?: {
                 readonly [x: string]: string;
             } | undefined;
@@ -4899,9 +4907,9 @@ export default function useCanvas(): {
         readonly enable_quick_filters_for_search_metadata_filters?: boolean | undefined;
         readonly enable_thumbnails_for_templates_and_blocks?: boolean | undefined;
         readonly default_pdf_page_dimensions?: {
-            readonly width?: number | undefined;
-            readonly height?: number | undefined;
-            readonly printScale?: number | undefined;
+            readonly width?: number | string | undefined;
+            readonly height?: number | string | undefined;
+            readonly print_scale?: number | undefined;
         } | undefined;
         readonly disable_browser_search_context?: boolean | undefined;
         readonly location_prompt_type?: "warning" | "block" | undefined;

package/lib/apps/canvas-builder/util/print.util.d.ts

@@ -1 +1,30 @@
 export declare function replaceThemePresetsWithInlineStyles(htmlContent: string, shouldPreserveStyles?: boolean): string;
+/**
+ * Converts a measurement value to pixels.
+ * If the value is a number, it's assumed to be in pixels.
+ * If it's a string, it must include a unit (mm, cm, in, px, pt, pc).
+ * Supports both comma and period as decimal separators (e.g., "10.5mm" or "10,5mm").
+ *
+ * Conversion rates:
+ * - 1 inch = 96 pixels (CSS standard)
+ * - 1 cm = 37.795275591 pixels
+ * - 1 mm = 3.7795275591 pixels
+ * - 1 pt = 1.333333 pixels
+ * - 1 pc = 16 pixels
+ *
+ * @param value - Number in pixels or string with unit (e.g., "1000mm", "100,5cm", "4.5in", "96px", "72pt", "6pc")
+ * @returns Value in pixels
+ */
+export declare function convertToPixels(value: number | string | undefined): number | undefined;
+/**
+ * Formats a dimension value for Gotenberg PDF conversion.
+ * If the value is a string with units (mm, cm, in, px, pt, pc), normalizes it to use period as decimal separator.
+ * If it's a number, appends "px" since the convention is that numbers represent pixels.
+ * Supports both comma and period as decimal separators (e.g., "10.5mm" or "10,5mm").
+ *
+ * Gotenberg supports: 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified.
+ *
+ * @param value - Number in pixels or string with unit (e.g., "1000mm", "100,5cm", "4.5in", "96px", "72pt", "6pc")
+ * @returns Formatted value for Gotenberg (e.g., "1000mm", "10.5cm", "4in", "96px", "72pt", "6pc") or undefined
+ */
+export declare function formatDimensionForGotenberg(value: number | string | undefined): string | undefined;

package/lib/components/CContactSelector/CContactAccountListItem.vue.d.ts

@@ -11,6 +11,7 @@ type __VLS_Props = {
     loading: boolean;
     allowAccountChange?: boolean;
     allowContactsFromDifferentAccounts?: boolean;
+    restrictToSingleContact?: boolean;
     lastViewedDate?: string;
 };
 declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {

package/lib/components/CContactSelector/CContactSelector.vue.d.ts

@@ -9,6 +9,7 @@ type __VLS_Props = {
     singleColumnView?: boolean;
     allowAccountChange?: boolean;
     allowContactsFromDifferentAccounts?: boolean;
+    restrictToSingleContact?: boolean;
     isDraggable?: boolean;
     quickFiltersTitle?: string;
     mutuallyExclusiveQuickFilters?: boolean;
@@ -43,6 +44,7 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
     selectedContactIds: string[];
     allowAccountChange: boolean;
     isDraggable: boolean;
+    restrictToSingleContact: boolean;
     mutuallyExclusiveQuickFilters: boolean;
     singleColumnView: boolean;
     selectedQuickFilters: string[];

package/lib/components/CContactSelector/CContactSelectorAccountsWithContacts.vue.d.ts

@@ -16,6 +16,10 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         type: PropType<boolean>;
         default: boolean;
     };
+    restrictToSingleContact: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
     search: {
         type: PropType<string>;
         required: true;
@@ -79,6 +83,10 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         type: PropType<boolean>;
         default: boolean;
     };
+    restrictToSingleContact: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
     search: {
         type: PropType<string>;
         required: true;
@@ -130,6 +138,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
     selectedContactIds: string[];
     allowAccountChange: boolean;
     allowContactsFromDifferentAccounts: boolean;
+    restrictToSingleContact: boolean;
     mutuallyExclusiveQuickFilters: boolean;
     singleColumnView: boolean;
     customAccountDisplayField: string;
@@ -786,6 +795,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         loading: boolean;
         allowAccountChange?: boolean;
         allowContactsFromDifferentAccounts?: boolean;
+        restrictToSingleContact?: boolean;
         lastViewedDate?: string;
     }, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
         "remove-contact": (contactId: string) => any;
@@ -805,6 +815,7 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         loading: boolean;
         allowAccountChange?: boolean;
         allowContactsFromDifferentAccounts?: boolean;
+        restrictToSingleContact?: boolean;
         lastViewedDate?: string;
     }> & Readonly<{
         "onRemove-contact"?: ((contactId: string) => any) | undefined;

package/lib/components/CContentError/CContentError.vue.d.ts

@@ -0,0 +1,8 @@
+interface Props {
+    expired?: boolean;
+    restricted?: boolean;
+    onlyIcon?: boolean;
+    onlyTag?: boolean;
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/lib/composables/useCollectionPlayerOverlay.d.ts

@@ -0,0 +1,18 @@
+import { CollectionPlayer } from '../apps/collection-player/types/collection-player.type';
+export interface CollectionPlayerOverlayGroup {
+    id: string;
+    name: string;
+    slides?: Array<{
+        file_id: string;
+        slide_index: number;
+    }>;
+}
+export interface CollectionPlayerOverlay {
+    groups: CollectionPlayerOverlayGroup[];
+    name: string;
+}
+declare const _default: () => {
+    setCollectionPlayerData: import('vue').Ref<((data: CollectionPlayer) => void) | null, ((data: CollectionPlayer) => void) | null>;
+    openCollectionPlayerOverlay: (data: CollectionPlayerOverlay, fetchFile: (fileId: string) => Promise<any>) => Promise<void>;
+};
+export default _default;

package/lib/custom-naive-locales/pt-br.d.ts

@@ -0,0 +1,124 @@
+declare const _default: {
+    name: string;
+    global: {
+        undo: string;
+        redo: string;
+        confirm: string;
+        clear: string;
+    };
+    Popconfirm: {
+        positiveText: string;
+        negativeText: string;
+    };
+    Cascader: {
+        placeholder: string;
+        loading: string;
+        loadingRequiredMessage: (label: string) => string;
+    };
+    Time: {
+        dateFormat: string;
+        dateTimeFormat: string;
+    };
+    DatePicker: {
+        yearFormat: string;
+        monthFormat: string;
+        dayFormat: string;
+        yearTypeFormat: string;
+        monthTypeFormat: string;
+        dateFormat: string;
+        dateTimeFormat: string;
+        quarterFormat: string;
+        weekFormat: string;
+        clear: string;
+        now: string;
+        confirm: string;
+        selectTime: string;
+        selectDate: string;
+        datePlaceholder: string;
+        datetimePlaceholder: string;
+        monthPlaceholder: string;
+        yearPlaceholder: string;
+        quarterPlaceholder: string;
+        weekPlaceholder: string;
+        startDatePlaceholder: string;
+        endDatePlaceholder: string;
+        startDatetimePlaceholder: string;
+        endDatetimePlaceholder: string;
+        startMonthPlaceholder: string;
+        endMonthPlaceholder: string;
+        monthBeforeYear: boolean;
+        firstDayOfWeek: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+        today: string;
+    };
+    DataTable: {
+        checkTableAll: string;
+        uncheckTableAll: string;
+        confirm: string;
+        clear: string;
+    };
+    LegacyTransfer: {
+        sourceTitle: string;
+        targetTitle: string;
+    };
+    Transfer: {
+        selectAll: string;
+        unselectAll: string;
+        clearAll: string;
+        total: (num: number) => string;
+        selected: (num: number) => string;
+    };
+    Empty: {
+        description: string;
+    };
+    Select: {
+        placeholder: string;
+    };
+    TimePicker: {
+        placeholder: string;
+        positiveText: string;
+        negativeText: string;
+        now: string;
+        clear: string;
+    };
+    Pagination: {
+        goto: string;
+        selectionSuffix: string;
+    };
+    DynamicTags: {
+        add: string;
+    };
+    Log: {
+        loading: string;
+    };
+    Input: {
+        placeholder: string;
+    };
+    InputNumber: {
+        placeholder: string;
+    };
+    DynamicInput: {
+        create: string;
+    };
+    ThemeEditor: {
+        title: string;
+        clearAllVars: string;
+        clearSearch: string;
+        filterCompName: string;
+        filterVarName: string;
+        import: string;
+        export: string;
+        restore: string;
+    };
+    Image: {
+        tipPrevious: string;
+        tipNext: string;
+        tipCounterclockwise: string;
+        tipClockwise: string;
+        tipZoomOut: string;
+        tipZoomIn: string;
+        tipDownload: string;
+        tipClose: string;
+        tipOriginalSize: string;
+    };
+};
+export default _default;

package/lib/main.lib.d.ts

@@ -47,6 +47,7 @@ export { default as CConfirmationContent } from './components/CConfirmation/CCon
 export { default as CConfirmationAction } from './components/CConfirmation/CConfirmationAction.vue';
 export { default as CCanvasSelector } from './components/CCanvasSelector/CCanvasSelector.vue';
 export { default as CContactSelector } from './components/CContactSelector/CContactSelector.vue';
+export { default as CContentError } from './components/CContentError/CContentError.vue';
 export { default as CContactSelectorSelected } from './components/CContactSelector/CContactSelectorSelected.vue';
 export * from './components/CContactSelector/CContactSelector.types';
 export { default as CCreateCanvasModal } from './components/CCreateCanvasModal/CCreateCanvasModal.vue';
@@ -135,6 +136,7 @@ export { default as useBindValidation } from './composables/useBindValidation';
 export { default as useFileDisplayHelpers } from './composables/useFileDisplayHelpers';
 export { default as useFolderNameDescription } from './composables/useFolderNameDescription';
 export { default as useCanvasOverlay } from './composables/useCanvasOverlay';
+export { default as useCollectionPlayerOverlay, type CollectionPlayerOverlay, } from './composables/useCollectionPlayerOverlay';
 export { default as useInfiniteScroll } from './composables/useInfiniteScroll';
 export { default as useWindowEvents } from './composables/useWindowEvents';
 export { default as useConfirmation } from './composables/useConfirmation';
@@ -157,6 +159,7 @@ export { default as useBroadcastRouteChange } from './composables/useBroadcastRo
 export * from './plugins/vueQuery';
 export * from './apps/canvas-builder/util/canvas.util';
 export * from './apps/canvas-builder/util/tree';
+export * from './apps/canvas-builder/util/print.util';
 export * from './components/filters/filter.util';
 export * from './util/anchor';
 export * from './util/array';

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

@@ -1,7 +1,7 @@
 import { CanvasRetrieve, PatchedCanvasUpdateRequest, Instance, CanvasCreateRequest } from '../../../../../types/openapi';
 import { GetCanvasesParams } from '../../../../types/canvases';
 import { PaginatedData } from '../../../../types/paginatedData';
-import { AdminSelectCanvasesRequest, AdminSelectCanvasesResponse } from './types.admin';
+import { AdminSelectCanvasesRequest, AdminSelectCanvasesResponse, AdminOpenCollectionPlayerOverlayRequest } from './types.admin';
 /**
  * Creates a new canvas.
  *
@@ -103,6 +103,29 @@ export declare function openCanvasOverlay(payload: {
         bottom?: number | string;
     };
 }): Promise<void>;
+/**
+ * Opens a modal to display collection player content.
+ *
+ * @example
+ * adminApi.openCollectionPlayerOverlay({
+ *   name: 'My Collection',
+ *   groups: [
+ *     {
+ *       id: 'file-id-1',
+ *       name: 'Group 1',
+ *     },
+ *     {
+ *       id: 'group-2',
+ *       name: 'Group 2',
+ *       slides: [
+ *         { file_id: 'file-id-2', slide_index: 0 },
+ *         { file_id: 'file-id-3', slide_index: 1 },
+ *       ],
+ *     },
+ *   ],
+ * })
+ */
+export declare function openCollectionPlayerOverlay(payload: AdminOpenCollectionPlayerOverlayRequest): Promise<void>;
 /**
  * Allows the user to select (and preselect) canvases from the instance.
  *

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

@@ -55,6 +55,7 @@ declare const _default: {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./types.admin').AdminOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./types.admin').AdminSelectCanvasesRequest): Promise<import('./types.admin').AdminSelectCanvasesResponse>;
     getEnv(): Promise<import('./types.admin').AdminEnv>;
     selectCollectionContent(payload?: import('./types.admin').AdminSelectCollectionPlayerRequest): Promise<import('./types.admin').AdminSelectCollectionPlayerResponse>;

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

@@ -23,6 +23,7 @@ export declare const ADMIN_API_METHOD_TYPES: {
     readonly GET_CANVAS: "admin_get_canvas";
     readonly GET_CANVASES: "admin_get_canvases";
     readonly OPEN_CANVAS_OVERLAY: "admin_open_canvas_overlay";
+    readonly OPEN_COLLECTION_PLAYER_OVERLAY: "admin_open_collection_player_overlay";
     readonly GET_ENV: "admin_get_env";
     readonly GET_FILE: "admin_get_file";
     readonly OPEN: "admin_open_file_overlay";
@@ -257,6 +258,18 @@ export type AdminEnv = {
     crm_shape?: Record<string, any>;
     state?: PitcherEnv['state'];
 };
+export type AdminOpenCollectionPlayerOverlayGroup = {
+    id: string;
+    name: string;
+    slides?: Array<{
+        file_id: string;
+        slide_index: number;
+    }>;
+};
+export type AdminOpenCollectionPlayerOverlayRequest = {
+    groups: AdminOpenCollectionPlayerOverlayGroup[];
+    name: string;
+};
 export type AdminSelectCollectionPlayerRequest = {
     initial_data?: CollectionSelectorProps['initialData'];
     attach_to?: CollectionSelectorProps['attachTo'];

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

@@ -1,5 +1,5 @@
 import { CanvasRetrieve } from '../../../../../types/openapi';
-import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest, UiPrintCanvasRequest, UiPrintCanvasResponse, UiSelectCanvasesRequest, UiSelectCanvasesResponse } from './types.ui';
+import { UiAppResizeRequest, UiCanvasNavigatePageRequest, UiUpdateCanvasRequest, UiPrintCanvasRequest, UiPrintCanvasResponse, UiSelectCanvasesRequest, UiSelectCanvasesResponse, UiOpenCollectionPlayerOverlayRequest } 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.
@@ -133,6 +133,40 @@ export declare function openCanvasOverlay(payload: {
         bottom?: number | string;
     };
 }): Promise<void>;
+/**
+ * Opens the collection player overlay to view a collection of files/slides.
+ *
+ * This method opens the native Pitcher collection player interface with the specified
+ * files and slides. You can show entire files or specific pages from files.
+ *
+ * @example
+ * // Open collection with full files
+ * useUi().openCollectionPlayerOverlay({
+ *   groups: [
+ *     { id: 'file-123-abc', name: 'Product Overview' },
+ *     { id: 'file-456-def', name: 'Pricing Slides' }
+ *   ],
+ *   name: 'Sales Deck'
+ * })
+ *
+ * // Open collection with specific slides/pages
+ * useUi().openCollectionPlayerOverlay({
+ *   groups: [
+ *     {
+ *       id: 'file-123-abc',
+ *       name: 'Product Overview',
+ *       slides: [
+ *         { file_id: 'file-123-abc', slide_index: 0 },
+ *         { file_id: 'file-123-abc', slide_index: 2 }
+ *       ]
+ *     }
+ *   ],
+ *   name: 'Custom Sales Presentation'
+ * })
+ *
+ * @param payload Object containing groups array and collection name
+ */
+export declare function openCollectionPlayerOverlay(payload: UiOpenCollectionPlayerOverlayRequest): Promise<void>;
 /**
  * Allows the user to select (and preselect) canvases from the instance.
  *

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

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

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

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

package/lib/sdk/main.d.ts

@@ -54,6 +54,7 @@ export declare function useUi(): {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./api/modules/ui/types.ui').UiOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./api/modules/ui/types.ui').UiSelectCanvasesRequest): Promise<import('./api/modules/ui/types.ui').UiSelectCanvasesResponse>;
     captureAppError(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
     updateLocation(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
@@ -127,6 +128,7 @@ export declare function useAdmin(): {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./api/modules/admin/types.admin').AdminOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./api/modules/admin/types.admin').AdminSelectCanvasesRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCanvasesResponse>;
     getEnv(): Promise<import('./api/modules/admin/types.admin').AdminEnv>;
     selectCollectionContent(payload?: import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerResponse>;
@@ -387,6 +389,7 @@ export declare function useApi(options?: ApiOptions): {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./api/modules/admin/types.admin').AdminOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./api/modules/admin/types.admin').AdminSelectCanvasesRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCanvasesResponse>;
     getEnv(): Promise<import('./api/modules/admin/types.admin').AdminEnv>;
     selectCollectionContent(payload?: import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerResponse>;
@@ -438,6 +441,7 @@ export declare function useApi(options?: ApiOptions): {
                 bottom?: number | string;
             };
         }): Promise<void>;
+        openCollectionPlayerOverlay(payload: import('./api/modules/ui/types.ui').UiOpenCollectionPlayerOverlayRequest): Promise<void>;
         selectCanvases(payload?: import('./api/modules/ui/types.ui').UiSelectCanvasesRequest): Promise<import('./api/modules/ui/types.ui').UiSelectCanvasesResponse>;
         captureAppError(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
         updateLocation(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
@@ -658,6 +662,7 @@ export declare function useApi(options?: ApiOptions): {
             bottom?: number | string;
         };
     }): Promise<void>;
+    openCollectionPlayerOverlay(payload: import('./api/modules/ui/types.ui').UiOpenCollectionPlayerOverlayRequest): Promise<void>;
     selectCanvases(payload?: import('./api/modules/ui/types.ui').UiSelectCanvasesRequest): Promise<import('./api/modules/ui/types.ui').UiSelectCanvasesResponse>;
     captureAppError(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
     updateLocation(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;

package/lib/types/canvases.d.ts

@@ -14,6 +14,7 @@ export interface GetCanvasesParams {
     section_ids?: string[];
     tags__in?: string[];
     id__in?: string;
+    access_type?: string;
 }
 export interface CanvasMetadataRetrieve {
     canvas_id: CanvasRetrieve['id'];

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

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