@pitcher/js-api 1.26.0-beta.3 → 1.26.0-beta.5

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;
@@ -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;
@@ -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;
@@ -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;

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

@@ -449,6 +449,9 @@ export default function useCanvasTheme(): {
     backgroundPositionY: import('vue').Ref<BackgroundPositionY, BackgroundPositionY>;
     backgroundSize: import('vue').Ref<BackgroundSize, BackgroundSize>;
     backgroundRepeat: import('vue').Ref<BackgroundRepeat, BackgroundRepeat>;
+    pdfDimensionsPreset: import('vue').Ref<string | undefined, string | undefined>;
+    pdfDimensionsWidth: import('vue').Ref<string | undefined, string | undefined>;
+    pdfDimensionsHeight: import('vue').Ref<string | undefined, string | undefined>;
     isLoading: import('vue').Ref<boolean, boolean>;
     initializeTheme: typeof initializeTheme;
     getDefaultTypographyConfiguration: typeof getDefaultTypographyConfiguration;

package/lib/apps/canvas-builder/constants/theme.const.d.ts

@@ -2,3 +2,37 @@ export declare const DEFAULT_GLOBAL_COMPONENT_SPACING = 32;
 export declare const DEFAULT_GLOBAL_COMPONENT_SPACING_INTERVAL = 4;
 export declare const CANVAS_TYPOGRAPHY_CSS_PROPERTIES: readonly ["font-family", "font-size", "font-weight", "line-height", "letter-spacing", "text-transform", "color"];
 export declare const CANVAS_TYPOGRAPHY_PRESETS: readonly ["h_1", "h_2", "h_3", "big_text", "normal_text", "small_text"];
+export declare const PAPER_SIZE_PRESETS: {
+    readonly A4: {
+        readonly width: "210mm";
+        readonly height: "297mm";
+    };
+    readonly A3: {
+        readonly width: "297mm";
+        readonly height: "420mm";
+    };
+    readonly A5: {
+        readonly width: "148mm";
+        readonly height: "210mm";
+    };
+    readonly B3: {
+        readonly width: "353mm";
+        readonly height: "500mm";
+    };
+    readonly B4: {
+        readonly width: "250mm";
+        readonly height: "353mm";
+    };
+    readonly B5: {
+        readonly width: "176mm";
+        readonly height: "250mm";
+    };
+    readonly 'US Legal': {
+        readonly width: "8.5in";
+        readonly height: "14in";
+    };
+    readonly 'US Letter': {
+        readonly width: "8.5in";
+        readonly height: "11in";
+    };
+};

package/lib/apps/canvas-builder/types/canvas.d.ts

@@ -436,6 +436,11 @@ export declare const ComponentIcon: {
     readonly Video: "video";
 };
 export declare const componentIconType: Record<string, FontAwesomeType>;
+export interface CanvasPdfDimensions {
+    preset?: 'A4' | 'A3' | 'A5' | 'B3' | 'B4' | 'B5' | 'US Legal' | 'US Letter' | 'Custom';
+    width?: string;
+    height?: string;
+}
 export type CanvasTheme = {
     background_video_url?: string;
     canvas_bg_color?: string;
@@ -453,6 +458,7 @@ export type CanvasTheme = {
     inherit_theme_from_parent?: boolean;
     logo?: CanvasThemeAsset | null;
     assets?: CanvasThemeAsset[];
+    pdf_dimensions?: CanvasPdfDimensions;
 };
 export declare enum CanvasBuilderMode {
     ADMIN = "admin",

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/CPdfDimensionsSelector/CPdfDimensionsSelector.vue.d.ts

@@ -0,0 +1,25 @@
+interface Props {
+    preset?: string;
+    width?: string;
+    height?: string;
+    disabled?: boolean;
+    defaultWidth?: string;
+    defaultHeight?: string;
+}
+declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    "update:preset": (value: string | undefined) => any;
+    "update:width": (value: string | undefined) => any;
+    "update:height": (value: string | undefined) => any;
+}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{
+    "onUpdate:preset"?: ((value: string | undefined) => any) | undefined;
+    "onUpdate:width"?: ((value: string | undefined) => any) | undefined;
+    "onUpdate:height"?: ((value: string | undefined) => any) | undefined;
+}>, {
+    height: string;
+    disabled: boolean;
+    width: string;
+    defaultWidth: string;
+    defaultHeight: string;
+    preset: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

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

@@ -1,5 +1,5 @@
 import { SortingState, PaginationState, ColumnDef } from '@tanstack/table-core';
-import { StyleValue } from 'vue';
+import { ComputedRef, StyleValue } from 'vue';
 type RowItem = Record<string, any>;
 type __VLS_Props = {
     selectedRows?: Record<string, boolean>;
@@ -25,11 +25,11 @@ type __VLS_Props = {
 declare function isRowDisabled(id: string | number): boolean;
 declare function handleSelectAll(): void;
 declare const _default: import('vue').DefineComponent<__VLS_Props, {
-    isNoneSelected: import('vue').ComputedRef<boolean>;
-    areAllSelected: import('vue').ComputedRef<boolean>;
+    isNoneSelected: ComputedRef<boolean>;
+    areAllSelected: ComputedRef<boolean>;
     selectAll: typeof handleSelectAll;
-    selectedRowsCount: import('vue').ComputedRef<number>;
-    pageRowsCount: import('vue').ComputedRef<number>;
+    selectedRowsCount: ComputedRef<number>;
+    pageRowsCount: ComputedRef<number>;
     isRowDisabled: typeof isRowDisabled;
 }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     sortChanged: (s: SortingState) => any;
@@ -56,5 +56,6 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {
     disabledIds: Array<string | number>;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
     tableScroller: HTMLDivElement;
+    tableElement: HTMLTableElement;
 }, HTMLDivElement>;
 export default _default;

package/lib/components/assignedCanvases/CAssignedCanvasesManagement.vue.d.ts

@@ -161,6 +161,7 @@ declare function __VLS_template(): {
             disabledIds: Array<string | number>;
         }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
             tableScroller: HTMLDivElement;
+            tableElement: HTMLTableElement;
         }, HTMLDivElement, import('vue').ComponentProvideOptions, {
             P: {};
             B: {};
@@ -367,6 +368,7 @@ declare const __VLS_component: import('vue').DefineComponent<Props, {
         disabledIds: Array<string | number>;
     }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
         tableScroller: HTMLDivElement;
+        tableElement: HTMLTableElement;
     }, HTMLDivElement, import('vue').ComponentProvideOptions, {
         P: {};
         B: {};

package/lib/components/canvas-blocks/CBlockManagement.vue.d.ts

@@ -167,6 +167,7 @@ declare function __VLS_template(): {
             disabledIds: Array<string | number>;
         }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
             tableScroller: HTMLDivElement;
+            tableElement: HTMLTableElement;
         }, HTMLDivElement, import('vue').ComponentProvideOptions, {
             P: {};
             B: {};
@@ -378,6 +379,7 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
         disabledIds: Array<string | number>;
     }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
         tableScroller: HTMLDivElement;
+        tableElement: HTMLTableElement;
     }, HTMLDivElement, import('vue').ComponentProvideOptions, {
         P: {};
         B: {};

package/lib/components/canvas-templates/CTemplateManagement.vue.d.ts

@@ -591,6 +591,7 @@ declare function __VLS_template(): {
             disabledIds: Array<string | number>;
         }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
             tableScroller: HTMLDivElement;
+            tableElement: HTMLTableElement;
         }, HTMLDivElement, import('vue').ComponentProvideOptions, {
             P: {};
             B: {};
@@ -1215,6 +1216,7 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
         disabledIds: Array<string | number>;
     }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
         tableScroller: HTMLDivElement;
+        tableElement: HTMLTableElement;
     }, HTMLDivElement, import('vue').ComponentProvideOptions, {
         P: {};
         B: {};

package/lib/components/savedCanvases/CSavedCanvasesManagement.vue.d.ts

@@ -195,6 +195,7 @@ declare function __VLS_template(): {
                 disabledIds: Array<string | number>;
             }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
                 tableScroller: HTMLDivElement;
+                tableElement: HTMLTableElement;
             }, HTMLDivElement, import('vue').ComponentProvideOptions, {
                 P: {};
                 B: {};
@@ -333,6 +334,7 @@ declare function __VLS_template(): {
             disabledIds: Array<string | number>;
         }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
             tableScroller: HTMLDivElement;
+            tableElement: HTMLTableElement;
         }, HTMLDivElement, import('vue').ComponentProvideOptions, {
             P: {};
             B: {};
@@ -565,6 +567,7 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
             disabledIds: Array<string | number>;
         }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
             tableScroller: HTMLDivElement;
+            tableElement: HTMLTableElement;
         }, HTMLDivElement, import('vue').ComponentProvideOptions, {
             P: {};
             B: {};
@@ -703,6 +706,7 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
         disabledIds: Array<string | number>;
     }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
         tableScroller: HTMLDivElement;
+        tableElement: HTMLTableElement;
     }, HTMLDivElement, import('vue').ComponentProvideOptions, {
         P: {};
         B: {};

package/lib/components/savedCanvases/smartFolders/SmartFolders.vue.d.ts

@@ -74,6 +74,7 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {
         disabledIds: Array<string | number>;
     }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
         tableScroller: HTMLDivElement;
+        tableElement: HTMLTableElement;
     }, HTMLDivElement, import('vue').ComponentProvideOptions, {
         P: {};
         B: {};

package/lib/components/sections/CSectionManagement.vue.d.ts

@@ -166,6 +166,7 @@ declare function __VLS_template(): {
             disabledIds: Array<string | number>;
         }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
             tableScroller: HTMLDivElement;
+            tableElement: HTMLTableElement;
         }, HTMLDivElement, import('vue').ComponentProvideOptions, {
             P: {};
             B: {};
@@ -379,6 +380,7 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
         disabledIds: Array<string | number>;
     }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
         tableScroller: HTMLDivElement;
+        tableElement: HTMLTableElement;
     }, HTMLDivElement, import('vue').ComponentProvideOptions, {
         P: {};
         B: {};

package/lib/components/themes/CThemeManagement.vue.d.ts

@@ -162,6 +162,7 @@ declare function __VLS_template(): {
             disabledIds: Array<string | number>;
         }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
             tableScroller: HTMLDivElement;
+            tableElement: HTMLTableElement;
         }, HTMLDivElement, import('vue').ComponentProvideOptions, {
             P: {};
             B: {};
@@ -373,6 +374,7 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
         disabledIds: Array<string | number>;
     }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
         tableScroller: HTMLDivElement;
+        tableElement: HTMLTableElement;
     }, HTMLDivElement, import('vue').ComponentProvideOptions, {
         P: {};
         B: {};

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

@@ -136,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';

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

@@ -93,6 +93,24 @@ export declare function createHighLevelApi(options?: ApiOptions): {
      *   })
      */
     broadcast: (event: PitcherEvent) => Promise<any>;
+    /**
+     * Broadcast an event to webviews only (iOS only).
+     * @param {PitcherEvent} event - The event to broadcast.
+     *
+     * @example
+     * usePitcherApi()
+     *   .broadcastToWebviews({
+     *     type: "canvas_updated",
+     *     body: { context: { myContextProperty: 'test' } },
+     *   })
+     *   .then(function (result) {
+     *     useUi().toast({
+     *       message: "Canvas Populated.",
+     *       type: "info",
+     *     })
+     *   })
+     */
+    broadcastToWebviews: (event: PitcherEvent) => Promise<any>;
     /**
      * Subscribe to updates.
      *

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