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

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

@@ -1,12 +1,14 @@
 import { TableColumnSetting } from '../CTableColumnsSettings/CTableColumnsSettings.vue';
 import { MetadataTemplateFieldTypeEnum } from '../../../types/openapi';
+import { CanvasType } from '../../types/canvases';
 type __VLS_Props = {
     breadcrumbs: {
         id: string;
         name: string;
     }[];
+    canvasType: Exclude<CanvasType, 'section' | 'canvas' | 'block'>;
     search: string;
-    filterValues: Record<string, any>;
+    metadataFilterValues: Record<string, any>;
     recommendedIds: string[];
     tableColumnsSettings: TableColumnSetting[];
     customFilterComponents: {
@@ -24,8 +26,12 @@ type __VLS_Props = {
         field: string;
         order: 'asc' | 'desc';
     };
+    viewMode?: 'table' | 'list';
 };
-declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+declare function clearSearch(): void;
+declare const _default: import('vue').DefineComponent<__VLS_Props, {
+    clearSearch: typeof clearSearch;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     search: (s: string) => any;
     select: (payload: {
         id: TableColumnSetting["id"];
@@ -45,6 +51,7 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
     convert: () => any;
     "update:filter-values": (mf: Record<string, any>) => any;
     "breadcrumb:click": (id: string | null) => any;
+    "toggle-view-mode": () => any;
 }, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
     onSearch?: ((s: string) => any) | undefined;
     onSelect?: ((payload: {
@@ -65,6 +72,7 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
     onConvert?: (() => any) | undefined;
     "onUpdate:filter-values"?: ((mf: Record<string, any>) => any) | undefined;
     "onBreadcrumb:click"?: ((id: string | null) => any) | undefined;
+    "onToggle-view-mode"?: (() => any) | undefined;
 }>, {
     breadcrumbs: {
         id: string;
@@ -74,5 +82,178 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {
         field: string;
         order: "asc" | "desc";
     };
-}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    searchFiltersRef: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
+        disabled?: boolean;
+        engagingIds?: string[];
+        entity: import('../../main.lib').MetadataFilterRequest["entity"];
+        includeDraftValues?: boolean;
+        isSection?: import('../../main.lib').MetadataFilterRequest["is_section"];
+        isTemplate?: import('../../main.lib').MetadataFilterRequest["is_template"];
+        searchInOptions?: import('../CSearchFilters/CSearchFilters.types').SearchInOption[];
+        filters?: Record<string, any>;
+        initialSearchValue?: string;
+        ownerId?: number | null;
+        placeholder?: string;
+        popularIds?: string[];
+        recommendedIds?: string[];
+        showLatestFilter?: boolean;
+        hideMetadataFilters?: boolean;
+        hideFilters?: boolean;
+        customFilterComponents?: {
+            type: MetadataTemplateFieldTypeEnum;
+            name: string;
+            label: string;
+            options?: [];
+        }[];
+        enableDependentFilters?: boolean;
+        dependentFiltersEntity?: "file" | "canvas";
+    }> & Readonly<{
+        "onUpdate:search"?: ((search: string, filters?: Record<string, any> | undefined) => any) | undefined;
+        "onUpdate:filters"?: ((filters: Record<string, any>) => any) | undefined;
+        "onUpdate:searchIn"?: ((searchIn: string) => any) | undefined;
+    }>, {
+        clearSearch: () => void;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+        "update:search": (search: string, filters?: Record<string, any> | undefined) => any;
+        "update:filters": (filters: Record<string, any>) => any;
+        "update:searchIn": (searchIn: string) => any;
+    }, import('vue').PublicProps, {
+        filters: Record<string, any>;
+        placeholder: string;
+        initialSearchValue: string;
+        includeDraftValues: boolean;
+        engagingIds: string[];
+        popularIds: string[];
+        recommendedIds: string[];
+        showLatestFilter: boolean;
+        hideMetadataFilters: boolean;
+        hideFilters: boolean;
+        dependentFiltersEntity: "file" | "canvas";
+    }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
+        searchOnClickRef: ({
+            $: import('vue').ComponentInternalInstance;
+            $data: {};
+            $props: {
+                readonly disabled?: boolean | undefined;
+                readonly placeholder?: string | undefined;
+                readonly fullWidth?: boolean | undefined;
+                readonly initialSearchValue?: string | undefined;
+                readonly onSearch?: ((s: string) => any) | undefined;
+            } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps;
+            $attrs: {
+                [x: string]: unknown;
+            };
+            $refs: {
+                [x: string]: unknown;
+            };
+            $slots: Readonly<{
+                [name: string]: import('vue').Slot<any> | undefined;
+            }>;
+            $root: import('vue').ComponentPublicInstance | null;
+            $parent: import('vue').ComponentPublicInstance | null;
+            $host: Element | null;
+            $emit: (event: "search", s: string) => void;
+            $el: HTMLDivElement;
+            $options: import('vue').ComponentOptionsBase<Readonly<{
+                disabled?: boolean;
+                placeholder?: string;
+                fullWidth?: boolean;
+                initialSearchValue?: string;
+            }> & Readonly<{
+                onSearch?: ((s: string) => any) | undefined;
+            }>, {
+                clear: () => Promise<void>;
+            }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+                search: (s: string) => any;
+            }, string, {
+                initialSearchValue: string;
+            }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & {
+                beforeCreate?: (() => void) | (() => void)[];
+                created?: (() => void) | (() => void)[];
+                beforeMount?: (() => void) | (() => void)[];
+                mounted?: (() => void) | (() => void)[];
+                beforeUpdate?: (() => void) | (() => void)[];
+                updated?: (() => void) | (() => void)[];
+                activated?: (() => void) | (() => void)[];
+                deactivated?: (() => void) | (() => void)[];
+                beforeDestroy?: (() => void) | (() => void)[];
+                beforeUnmount?: (() => void) | (() => void)[];
+                destroyed?: (() => void) | (() => void)[];
+                unmounted?: (() => void) | (() => void)[];
+                renderTracked?: ((e: import('vue').DebuggerEvent) => void) | ((e: import('vue').DebuggerEvent) => void)[];
+                renderTriggered?: ((e: import('vue').DebuggerEvent) => void) | ((e: import('vue').DebuggerEvent) => void)[];
+                errorCaptured?: ((err: unknown, instance: import('vue').ComponentPublicInstance | null, info: string) => boolean | void) | ((err: unknown, instance: import('vue').ComponentPublicInstance | null, info: string) => boolean | void)[];
+            };
+            $forceUpdate: () => void;
+            $nextTick: typeof import('vue').nextTick;
+            $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (...args: [R, R, import('@vue/reactivity').OnCleanup]) => any : (...args: [any, any, import('@vue/reactivity').OnCleanup]) => any, options?: import('vue').WatchOptions): import('vue').WatchStopHandle;
+        } & Readonly<{
+            initialSearchValue: string;
+        }> & Omit<Readonly<{
+            disabled?: boolean;
+            placeholder?: string;
+            fullWidth?: boolean;
+            initialSearchValue?: string;
+        }> & Readonly<{
+            onSearch?: ((s: string) => any) | undefined;
+        }>, "clear" | "initialSearchValue"> & import('vue').ShallowUnwrapRef<{
+            clear: () => Promise<void>;
+        }> & {} & import('vue').ComponentCustomProperties & {} & {
+            $slots: {
+                options?(_: {}): any;
+            };
+        }) | null;
+    }, HTMLDivElement, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<{
+        disabled?: boolean;
+        engagingIds?: string[];
+        entity: import('../../main.lib').MetadataFilterRequest["entity"];
+        includeDraftValues?: boolean;
+        isSection?: import('../../main.lib').MetadataFilterRequest["is_section"];
+        isTemplate?: import('../../main.lib').MetadataFilterRequest["is_template"];
+        searchInOptions?: import('../CSearchFilters/CSearchFilters.types').SearchInOption[];
+        filters?: Record<string, any>;
+        initialSearchValue?: string;
+        ownerId?: number | null;
+        placeholder?: string;
+        popularIds?: string[];
+        recommendedIds?: string[];
+        showLatestFilter?: boolean;
+        hideMetadataFilters?: boolean;
+        hideFilters?: boolean;
+        customFilterComponents?: {
+            type: MetadataTemplateFieldTypeEnum;
+            name: string;
+            label: string;
+            options?: [];
+        }[];
+        enableDependentFilters?: boolean;
+        dependentFiltersEntity?: "file" | "canvas";
+    }> & Readonly<{
+        "onUpdate:search"?: ((search: string, filters?: Record<string, any> | undefined) => any) | undefined;
+        "onUpdate:filters"?: ((filters: Record<string, any>) => any) | undefined;
+        "onUpdate:searchIn"?: ((searchIn: string) => any) | undefined;
+    }>, {
+        clearSearch: () => void;
+    }, {}, {}, {}, {
+        filters: Record<string, any>;
+        placeholder: string;
+        initialSearchValue: string;
+        includeDraftValues: boolean;
+        engagingIds: string[];
+        popularIds: string[];
+        recommendedIds: string[];
+        showLatestFilter: boolean;
+        hideMetadataFilters: boolean;
+        hideFilters: boolean;
+        dependentFiltersEntity: "file" | "canvas";
+    }> | null;
+}, HTMLDivElement>;
 export default _default;

package/lib/components/canvases/CanvasesManagementBulk.use.d.ts

@@ -48,5 +48,24 @@ export default function useCanvasesManagementBulk(): {
     bulkUpdateFileAttributes: ({ selectedRows, fileNames, metadataFetcher, noMetadataErrorText, title, subtitle, isBulkUpdating, onComplete, confirmText, cancelText, }: BulkUpdateFileAttributeProps) => Promise<void>;
     bulkAddTagsDialog: ({ filteredData, selectedRows, isBulkUpdating, canvasType, onComplete, isReadonly, title, confirmText, cancelText, }: BulkTagsProps) => Promise<void>;
     bulkRemoveTagsDialog: ({ filteredData, selectedRows, isBulkUpdating, canvasType, onComplete, isReadonly, title, confirmText, cancelText, }: BulkTagsProps) => Promise<void>;
+    bulkUpdateDistributionDialog: ({ selectedCount, isBulkUpdating, canvasType, selectedRows, onComplete, title, confirmText, cancelText, }: {
+        selectedCount: number;
+        isBulkUpdating: Ref<boolean>;
+        canvasType: CanvasType;
+        selectedRows: Ref<Record<string, boolean>>;
+        onComplete: () => void | Promise<void>;
+        title?: string;
+        confirmText?: string;
+        cancelText?: string;
+    }) => Promise<void>;
+    bulkUpdateFileDistributionDialog: ({ selectedCount, isBulkUpdating, selectedRows, onComplete, title, confirmText, cancelText, }: {
+        selectedCount: number;
+        isBulkUpdating: Ref<boolean>;
+        selectedRows: Ref<Record<string, boolean>>;
+        onComplete: () => void | Promise<void>;
+        title?: string;
+        confirmText?: string;
+        cancelText?: string;
+    }) => Promise<void>;
 };
 export {};

package/lib/components/filters/CSearchFilter.vue.d.ts

@@ -1,8 +1,16 @@
+import { MetadataFilterRequest } from '../../types/core/MetadataFilter';
 type Props = {
     disabled?: boolean;
+    entity?: MetadataFilterRequest['entity'];
     inline?: boolean;
+    includeDraftValues?: boolean;
     name?: string;
     modelValue?: string;
+    filterKey?: string;
+    isCustom?: boolean;
+    isSection?: boolean;
+    isTemplate?: boolean;
+    ownerId?: number | null;
 };
 declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
     clear: () => any;
@@ -15,6 +23,12 @@ declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, imp
     disabled: boolean;
     inline: boolean;
     modelValue: string;
+    isSection: boolean;
+    isTemplate: boolean;
+    includeDraftValues: boolean;
+    ownerId: number | null;
+    filterKey: string;
+    isCustom: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
     searchOnClickRef: ({
         $: import('vue').ComponentInternalInstance;

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

@@ -38,7 +38,7 @@ declare function __VLS_template(): {
     refs: {
         toolbarWrapper: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
             search: string;
-            filterValues: Record<string, any>;
+            metadataFilterValues: Record<string, any>;
             tableColumnsSettings: import('../CTableColumnsSettings/CTableColumnsSettings.vue').TableColumnSetting[];
             customFilterComponents: {
                 type: MetadataTemplateFieldTypeEnum;
@@ -86,7 +86,7 @@ declare function __VLS_template(): {
             Defaults: {};
         }, Readonly<{
             search: string;
-            filterValues: Record<string, any>;
+            metadataFilterValues: Record<string, any>;
             tableColumnsSettings: import('../CTableColumnsSettings/CTableColumnsSettings.vue').TableColumnSetting[];
             customFilterComponents: {
                 type: MetadataTemplateFieldTypeEnum;
@@ -402,7 +402,7 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
 }>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
     toolbarWrapper: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
         search: string;
-        filterValues: Record<string, any>;
+        metadataFilterValues: Record<string, any>;
         tableColumnsSettings: import('../CTableColumnsSettings/CTableColumnsSettings.vue').TableColumnSetting[];
         customFilterComponents: {
             type: MetadataTemplateFieldTypeEnum;
@@ -450,7 +450,7 @@ declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {
         Defaults: {};
     }, Readonly<{
         search: string;
-        filterValues: Record<string, any>;
+        metadataFilterValues: Record<string, any>;
         tableColumnsSettings: import('../CTableColumnsSettings/CTableColumnsSettings.vue').TableColumnSetting[];
         customFilterComponents: {
             type: MetadataTemplateFieldTypeEnum;

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

@@ -2,7 +2,7 @@ import { TableColumnSetting } from '../CTableColumnsSettings/CTableColumnsSettin
 import { MetadataTemplateFieldTypeEnum } from '../../../types/openapi';
 type __VLS_Props = {
     search: string;
-    filterValues: Record<string, any>;
+    metadataFilterValues: Record<string, any>;
     tableColumnsSettings: TableColumnSetting[];
     customFilterComponents: {
         type: MetadataTemplateFieldTypeEnum;

package/lib/composables/useCanvasLocks.d.ts

@@ -41,6 +41,7 @@ export default function useCanvasLocks(options?: {
     }[]>;
     isFetching: import('vue').Ref<boolean, boolean>;
     isChangingLock: import('vue').Ref<boolean, boolean>;
+    isOrgAdmin: ComputedRef<boolean>;
     error: import('vue').Ref<Error | null, Error | null>;
     canvasLockMap: ComputedRef<Record<string, CanvasLock>>;
     isCanvasLocked: (canvasId: string) => boolean;

package/lib/composables/useCanvasOverlay.d.ts

@@ -4,6 +4,12 @@ interface CanvasOverlay {
     edit_mode?: boolean;
     component_id?: string;
     section_id?: string;
+    position?: {
+        left?: number | string;
+        right?: number | string;
+        top?: number | string;
+        bottom?: number | string;
+    };
 }
 declare const _default: () => {
     isCanvasOverlayOpen: import('vue').ComputedRef<boolean>;
@@ -13,8 +19,14 @@ declare const _default: () => {
         edit_mode?: boolean | undefined;
         component_id?: string | undefined;
         section_id?: string | undefined;
+        position?: {
+            left?: number | string | undefined;
+            right?: number | string | undefined;
+            top?: number | string | undefined;
+            bottom?: number | string | undefined;
+        } | undefined;
     } | undefined>;
-    openCanvasOverlay: ({ id, fullscreen, edit_mode, component_id, section_id }: CanvasOverlay) => void;
+    openCanvasOverlay: ({ id, fullscreen, edit_mode, component_id, section_id, position }: CanvasOverlay) => void;
     closeCanvasOverlay: () => void;
 };
 export default _default;

package/lib/composables/useMetadataSearch.d.ts

@@ -0,0 +1,19 @@
+import { MetadataFilterRequest, MetadataSearchParams } from '../types/core/MetadataFilter';
+import { StyledAutoCompleteOption } from '../types/search';
+interface UseMetadataSearchOptions {
+    includeSearchTermAsOption?: boolean;
+}
+export default function useMetadataSearch(options?: UseMetadataSearchOptions): {
+    handleFetch: (searchTerm: string, entity: MetadataFilterRequest["entity"], { includeNameSearch, includeDraftValues, isSection, isTemplate, isBlock, key, ownerId, searchMode, threshold, }?: {
+        includeNameSearch?: boolean;
+        includeDraftValues?: boolean;
+        isSection?: boolean;
+        isTemplate?: boolean;
+        isBlock?: boolean;
+        key?: MetadataSearchParams["key"];
+        ownerId?: number | null;
+        searchMode?: MetadataSearchParams["searchMode"];
+        threshold?: number;
+    }) => Promise<StyledAutoCompleteOption[]>;
+};
+export {};

package/lib/composables/useWindowEvents.d.ts

@@ -1,6 +1,7 @@
 import { PLATFORM_TYPE, CLIENT_TYPE, CDP_EVENT_TYPE } from '../constants/cdp.const';
 import { usePitcherApi } from '../sdk/main';
 type EventType = 'active' | 'passive';
+type EventLifecycle = 'enter' | 'exit';
 export type InactiveEventPayload = {
     platform?: (typeof PLATFORM_TYPE)[keyof typeof PLATFORM_TYPE];
     client?: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
@@ -10,11 +11,11 @@ export type InactiveEventPayload = {
 export default function (track: (eventName: string, payload: any) => void, pitcherApi?: ReturnType<typeof usePitcherApi>): {
     registerInactiveEvent: ({ id, payload, enterEvent, exitEvent, type, }: {
         id: string;
-        payload: InactiveEventPayload | (() => InactiveEventPayload);
+        payload: InactiveEventPayload | ((type?: EventLifecycle) => InactiveEventPayload);
         enterEvent: (typeof CDP_EVENT_TYPE)[keyof typeof CDP_EVENT_TYPE];
         exitEvent: (typeof CDP_EVENT_TYPE)[keyof typeof CDP_EVENT_TYPE];
         type?: EventType;
-    }) => void;
-    unregisterInactiveEvent: (id: string) => void;
+    }) => string | void;
+    unregisterInactiveEvent: (id: string, canvas_correlation_id?: string) => void;
 };
 export {};

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

@@ -1,6 +1,4 @@
 export declare const CDP_EVENT_TYPE: {
-    readonly instanceEntered: "Instance Entered";
-    readonly instanceExited: "Instance Exited";
     readonly fileEntered: "File Entered";
     readonly fileExited: "File Exited";
     readonly webFileEntered: "Web File Entered";
@@ -8,6 +6,8 @@ export declare const CDP_EVENT_TYPE: {
     readonly pageEntered: "Page Entered";
     readonly pageExited: "Page Exited";
     readonly pageViewed: "Page Viewed";
+    readonly appEntered: "App Entered";
+    readonly appExited: "App Exited";
     readonly canvasEntered: "Canvas Entered";
     readonly canvasExited: "Canvas Exited";
     readonly canvasShared: "Canvas Shared";

package/lib/main.lib.d.ts

@@ -26,6 +26,7 @@ export { default as CModal } from './components/CModal/CModal.vue';
 export { default as CPopover } from './components/CPopover/CPopover.vue';
 export { default as CSearch } from './components/CSearch/CSearch.vue';
 export { default as CSearchOnClick } from './components/CSearch/CSearchOnClick.vue';
+export { default as CSearchOnClickWithSuggestions } from './components/CSearch/CSearchOnClickWithSuggestions.vue';
 export { default as CSelect } from './components/CSelect/CSelect.vue';
 export { default as CTag } from './components/CTag/CTag.vue';
 export { default as CThemeEditor } from './components/CThemeEditor/CThemeEditor.vue';
@@ -135,6 +136,7 @@ export { default as useOpenFileStack } from './composables/openFileStack.use';
 export { useAdminAndDsrState } from './composables/useAdminAndDsrState';
 export { default as useCanvasVisibility } from './apps/canvas-builder/composables/useCanvasVisibility';
 export { default as useMetadataTemplates } from './composables/useMetadataTemplates';
+export { default as useMetadataSearch } from './composables/useMetadataSearch';
 export * from './composables/appsDb.use';
 export { default as useCanvasLocks } from './composables/useCanvasLocks';
 export * from './plugins/vueQuery';
@@ -202,6 +204,7 @@ export * from './types/toast';
 export * from './types/instanceSettings.types';
 export * from './types/organizationSettings.types';
 export * from './components/CConfigEditor/CConfigEditor.types';
+export * from './types/search';
 export * from './types/selections';
 export * from './apps/agenda-selector/types/agenda.type';
 export * from './apps/collection-player/types/collection-player.type';

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

@@ -110,7 +110,6 @@ export declare function createHighLevelApi(options?: ApiOptions): {
     getEnv(): Promise<import('../interfaces').PitcherEnv>;
     updateMyUser(payload: {
         language?: import('../../main.lib').LanguageEnum | undefined;
-        dark_mode?: boolean | undefined;
     }): Promise<import('../../main.lib').User>;
     getLanguages(): Promise<modules.Language[]>;
     getEvents(payload: Partial<import('../../main.lib').EventRequest>): Promise<import('../../main.lib').PaginatedData<import('../../main.lib').Event>>;

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

@@ -75,6 +75,20 @@ export declare function updateCanvas(payload: PatchedCanvasUpdateRequest & {
  *   })
  * })
  * ```
+ *
+ * You can also specify a position for the canvas overlay:
+ *
+ * ```
+ * adminApi.openCanvasOverlay({
+ *   id: '01HH4RCBH631K4JDHWAQB0RPR6',
+ *   position: {
+ *     top: '10px',
+ *     left: '20px',
+ *     right: '20px',
+ *     bottom: '10px'
+ *   }
+ * })
+ * ```
  */
 export declare function openCanvasOverlay(payload: {
     id: CanvasRetrieve['id'];
@@ -82,6 +96,12 @@ export declare function openCanvasOverlay(payload: {
     fullscreen?: boolean;
     component_id?: string;
     section_id?: string;
+    position?: {
+        left?: number | string;
+        right?: number | string;
+        top?: number | string;
+        bottom?: number | string;
+    };
 }): Promise<void>;
 /**
  * Allows the user to select (and preselect) canvases from the instance.

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

@@ -47,6 +47,12 @@ declare const _default: {
         fullscreen?: boolean;
         component_id?: string;
         section_id?: string;
+        position?: {
+            left?: number | string;
+            right?: number | string;
+            top?: number | string;
+            bottom?: number | string;
+        };
     }): Promise<void>;
     selectCanvases(payload?: import('./types.admin').AdminSelectCanvasesRequest): Promise<import('./types.admin').AdminSelectCanvasesResponse>;
     getEnv(): Promise<import('./types.admin').AdminEnv>;

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

@@ -17,6 +17,6 @@ import { User } from '../../../../types/openapi';
  * })
  */
 export declare function getEnv(): Promise<PitcherEnv>;
-type UpdateEnvParams = Pick<User, 'language' | 'dark_mode'>;
+type UpdateEnvParams = Pick<User, 'language'>;
 export declare function updateMyUser(payload: UpdateEnvParams): Promise<User>;
 export {};

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

@@ -81,6 +81,20 @@ export declare function canvasNavigatePage(payload: UiCanvasNavigatePageRequest)
  *   })
  * })
  * ```
+ *
+ * You can also specify a position for the canvas overlay:
+ *
+ * ```
+ * uiApi.openCanvasOverlay({
+ *   id: '01HH4RCBH631K4JDHWAQB0RPR6',
+ *   position: {
+ *     top: '10px',
+ *     left: '20px',
+ *     right: '20px',
+ *     bottom: '10px'
+ *   }
+ * })
+ * ```
  */
 export declare function openCanvasOverlay(payload: {
     id: CanvasRetrieve['id'];
@@ -88,6 +102,12 @@ export declare function openCanvasOverlay(payload: {
     fullscreen?: boolean;
     component_id?: string;
     section_id?: string;
+    position?: {
+        left?: number | string;
+        right?: number | string;
+        top?: number | string;
+        bottom?: number | string;
+    };
 }): Promise<void>;
 /**
  * Allows the user to select (and preselect) canvases from the instance.

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

@@ -134,6 +134,12 @@ declare const _default: {
         fullscreen?: boolean;
         component_id?: string;
         section_id?: string;
+        position?: {
+            left?: number | string;
+            right?: number | string;
+            top?: number | string;
+            bottom?: number | string;
+        };
     }): Promise<void>;
     selectCanvases(payload?: import('./types.ui').UiSelectCanvasesRequest): Promise<import('./types.ui').UiSelectCanvasesResponse>;
     captureAppError(payload: import('./types.ui').UiCaptureAppErrorRequest): Promise<void>;

package/lib/sdk/main.d.ts

@@ -45,6 +45,12 @@ export declare function useUi(): {
         fullscreen?: boolean;
         component_id?: string;
         section_id?: string;
+        position?: {
+            left?: number | string;
+            right?: number | string;
+            top?: number | string;
+            bottom?: number | string;
+        };
     }): 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>;
@@ -111,6 +117,12 @@ export declare function useAdmin(): {
         fullscreen?: boolean;
         component_id?: string;
         section_id?: string;
+        position?: {
+            left?: number | string;
+            right?: number | string;
+            top?: number | string;
+            bottom?: number | string;
+        };
     }): 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>;
@@ -174,7 +186,6 @@ export declare function useApi(options?: ApiOptions): {
     getEnv(): Promise<import('./interfaces').PitcherEnv>;
     updateMyUser(payload: {
         language?: import('../main.lib').LanguageEnum | undefined;
-        dark_mode?: boolean | undefined;
     }): Promise<import('../main.lib').User>;
     getLanguages(): Promise<import('./api/modules').Language[]>;
     getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
@@ -356,6 +367,12 @@ export declare function useApi(options?: ApiOptions): {
         fullscreen?: boolean;
         component_id?: string;
         section_id?: string;
+        position?: {
+            left?: number | string;
+            right?: number | string;
+            top?: number | string;
+            bottom?: number | string;
+        };
     }): 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>;
@@ -395,6 +412,12 @@ export declare function useApi(options?: ApiOptions): {
             fullscreen?: boolean;
             component_id?: string;
             section_id?: string;
+            position?: {
+                left?: number | string;
+                right?: number | string;
+                top?: number | string;
+                bottom?: number | string;
+            };
         }): 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>;
@@ -432,7 +455,6 @@ export declare function useApi(options?: ApiOptions): {
         getEnv(): Promise<import('./interfaces').PitcherEnv>;
         updateMyUser(payload: {
             language?: import('../main.lib').LanguageEnum | undefined;
-            dark_mode?: boolean | undefined;
         }): Promise<import('../main.lib').User>;
         getLanguages(): Promise<import('./api/modules').Language[]>;
         getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;
@@ -603,6 +625,12 @@ export declare function useApi(options?: ApiOptions): {
         fullscreen?: boolean;
         component_id?: string;
         section_id?: string;
+        position?: {
+            left?: number | string;
+            right?: number | string;
+            top?: number | string;
+            bottom?: number | string;
+        };
     }): 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>;
@@ -636,7 +664,6 @@ export declare function useApi(options?: ApiOptions): {
     getEnv(): Promise<import('./interfaces').PitcherEnv>;
     updateMyUser(payload: {
         language?: import('../main.lib').LanguageEnum | undefined;
-        dark_mode?: boolean | undefined;
     }): Promise<import('../main.lib').User>;
     getLanguages(): Promise<import('./api/modules').Language[]>;
     getEvents(payload: Partial<import('../main.lib').EventRequest>): Promise<import('../main.lib').PaginatedData<import('../main.lib').Event>>;