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

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

@@ -247,6 +247,7 @@ export default function useCanvasBlocks(): {
                 } | undefined;
                 readonly name: string;
                 readonly hide_footer?: boolean | undefined;
+                readonly data_accessor?: string | undefined;
             } | {
                 readonly layout_type: import('../types/canvas').GridLayoutTypes;
                 readonly columns: number;
@@ -401,7 +402,7 @@ export default function useCanvasBlocks(): {
                     readonly style?: {
                         readonly [x: string]: any;
                     } | undefined;
-                    readonly aspect_ratio?: ("unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
+                    readonly aspect_ratio?: ("contain" | "unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
                     readonly background_video_url?: string | undefined;
                 }[];
                 readonly animation_in?: string | undefined;
@@ -492,7 +493,7 @@ export default function useCanvasBlocks(): {
                 readonly target?: "_self" | "_blank" | undefined;
                 readonly url?: string | undefined;
             } | {} | {
-                readonly aspect_ratio?: ("unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
+                readonly aspect_ratio?: ("contain" | "unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
                 readonly background_video_url?: string | undefined;
             } | {
                 readonly events: readonly {
@@ -627,6 +628,7 @@ export default function useCanvasBlocks(): {
                 } | undefined;
                 readonly name: string;
                 readonly hide_footer?: boolean | undefined;
+                readonly data_accessor?: string | undefined;
             } | {
                 readonly layout_type: import('../types/canvas').GridLayoutTypes;
                 readonly columns: number;
@@ -781,7 +783,7 @@ export default function useCanvasBlocks(): {
                     readonly style?: {
                         readonly [x: string]: any;
                     } | undefined;
-                    readonly aspect_ratio?: ("unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
+                    readonly aspect_ratio?: ("contain" | "unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
                     readonly background_video_url?: string | undefined;
                 }[];
                 readonly animation_in?: string | undefined;
@@ -872,7 +874,7 @@ export default function useCanvasBlocks(): {
                 readonly target?: "_self" | "_blank" | undefined;
                 readonly url?: string | undefined;
             } | {} | {
-                readonly aspect_ratio?: ("unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
+                readonly aspect_ratio?: ("contain" | "unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
                 readonly background_video_url?: string | undefined;
             } | {
                 readonly events: readonly {

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

@@ -0,0 +1,14 @@
+import { ComputedRef } from 'vue';
+import { SectionListProps, ComponentNode } from '../types/canvas';
+import { WizardStep } from '../components/container/CanvasCompletionWizard/CanvasCompletionWizard.vue';
+export default function useCanvasCompletionWizard(): {
+    wizardSteps: ComputedRef<WizardStep[]>;
+    sectionListNodes: ComputedRef<ComponentNode<import('../../collection-player/export').CollectionPlayer | import('../types/canvas').GridProps | import('../types/canvas').GridItemProps | import('../types/canvas').TextProps | import('../types/canvas').CarouselProps | import('../types/canvas').MultimediaProps | import('../types/canvas').EmbeddableProps | import('../types/canvas').ContentGridProps | SectionListProps | import('../types/canvas').HtmlProps | import('../types/canvas').IFrameProps | import('../types/canvas').LinkProps | import('../types/canvas').PageBreakProps | import('../types/canvas').PageProps | import('../types/canvas').TimelineProps>[]>;
+    isCompletionWizardEnabled: ComputedRef<boolean>;
+    isCompletionWizardCompleted: ComputedRef<boolean>;
+    isCompletionWizardShowing: ComputedRef<boolean>;
+    retriggerWizard: () => Promise<void>;
+    canRetriggerWizard: () => boolean;
+    resetWizard: () => Promise<void>;
+    getStrategyLabel: (strategy?: string) => string;
+};

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

@@ -79,6 +79,7 @@ export default function useCanvasHistory(): {
                 filters?: Record<string, any> | undefined;
                 name: string;
                 hide_footer?: boolean | undefined;
+                data_accessor?: string | undefined;
             } | {
                 layout_type: import('../types/canvas').GridLayoutTypes;
                 columns: number;
@@ -221,7 +222,7 @@ export default function useCanvasHistory(): {
                 sections: {
                     id: string;
                     style?: Record<string, any> | undefined;
-                    aspect_ratio?: ("unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
+                    aspect_ratio?: ("contain" | "unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
                     background_video_url?: string | undefined;
                 }[];
                 animation_in?: string | undefined;
@@ -308,7 +309,7 @@ export default function useCanvasHistory(): {
                 target?: "_self" | "_blank" | undefined;
                 url?: string | undefined;
             } | {
-                aspect_ratio?: ("unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
+                aspect_ratio?: ("contain" | "unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
                 background_video_url?: string | undefined;
             } | {
                 events: {
@@ -425,6 +426,7 @@ export default function useCanvasHistory(): {
                 filters?: Record<string, any> | undefined;
                 name: string;
                 hide_footer?: boolean | undefined;
+                data_accessor?: string | undefined;
             } | {
                 layout_type: import('../types/canvas').GridLayoutTypes;
                 columns: number;
@@ -567,7 +569,7 @@ export default function useCanvasHistory(): {
                 sections: {
                     id: string;
                     style?: Record<string, any> | undefined;
-                    aspect_ratio?: ("unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
+                    aspect_ratio?: ("contain" | "unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
                     background_video_url?: string | undefined;
                 }[];
                 animation_in?: string | undefined;
@@ -654,7 +656,7 @@ export default function useCanvasHistory(): {
                 target?: "_self" | "_blank" | undefined;
                 url?: string | undefined;
             } | {
-                aspect_ratio?: ("unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
+                aspect_ratio?: ("contain" | "unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
                 background_video_url?: string | undefined;
             } | {
                 events: {

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

@@ -2,16 +2,20 @@ import { ComputedRef } from 'vue';
 import { ComponentNode, SectionListProps } from '../types/canvas';
 import { CanvasRetrieve } from '../../../../types/openapi';
 type AnimationDirection = 'Left' | 'Right';
+declare function broadcastCanvasOpenedEvent(): Promise<void>;
+declare function broadcastCanvasClosedEvent(canvasId?: string): Promise<void>;
 declare function goToNextPage(): void;
 declare function goToPreviousPage(): void;
-declare function goToPage({ componentId, sectionId, scrollTo, itemIndex, }: {
-    componentId: ComponentNode['id'];
-    sectionId?: CanvasRetrieve['id'];
-    scrollTo?: 'component' | 'top';
-    itemIndex?: number;
-}): void;
+declare function goToFirstPage(componentId?: ComponentNode['id'], skipSetPreviousLocation?: boolean): void;
 declare function reset(): void;
 export default function useCanvasPages(): {
+    activeSection: ComputedRef<{
+        readonly id: string;
+        name: string;
+        content: Record<string, any>;
+        theme?: (Record<string, any> | null) | undefined;
+        metadata?: Record<string, any> | undefined;
+    } | null>;
     activeSectionId: ComputedRef<string | null>;
     activeSectionTheme: ComputedRef<Record<string, any> | null>;
     canvasPages: ComputedRef<ComponentNode<import('../../collection-player/export').CollectionPlayer | import('../types/canvas').GridProps | import('../types/canvas').GridItemProps | import('../types/canvas').TextProps | import('../types/canvas').CarouselProps | import('../types/canvas').MultimediaProps | import('../types/canvas').EmbeddableProps | import('../types/canvas').ContentGridProps | SectionListProps | import('../types/canvas').HtmlProps | import('../types/canvas').IFrameProps | import('../types/canvas').LinkProps | import('../types/canvas').PageBreakProps | import('../types/canvas').PageProps | import('../types/canvas').TimelineProps>[][]>;
@@ -29,9 +33,21 @@ export default function useCanvasPages(): {
     isLastPage: ComputedRef<boolean>;
     goToNextPage: typeof goToNextPage;
     goToPreviousPage: typeof goToPreviousPage;
-    goToPage: typeof goToPage;
+    goToPage: ({ componentId, sectionId, scrollTo, itemIndex, sectionIndex, skipSetPreviousLocation, }: {
+        componentId: ComponentNode["id"];
+        sectionId?: CanvasRetrieve["id"];
+        scrollTo?: "component" | "top";
+        itemIndex?: number;
+        sectionIndex?: number;
+        skipSetPreviousLocation?: boolean;
+    }) => void;
+    goToFirstPage: typeof goToFirstPage;
     reset: typeof reset;
     keepActivePageValid: () => void;
     animationDirection: import('vue').Ref<"" | AnimationDirection, "" | AnimationDirection>;
+    broadcastCanvasOpenedEvent: typeof broadcastCanvasOpenedEvent;
+    broadcastCanvasClosedEvent: typeof broadcastCanvasClosedEvent;
+    backToPreviousLocation: () => void;
+    isBackToPreviousLocationVisible: ComputedRef<boolean | undefined>;
 };
 export {};

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

@@ -1,6 +1,6 @@
 import { Ref } from 'vue';
 import { CanvasRetrieve } from '../../../../types/openapi';
-import { ComponentNode, SectionComponentOverrides } from '../types/canvas';
+import { ComponentNode, SectionOverrides, SectionComponentOverrides } from '../types/canvas';
 declare function discardOverridesConfirmationOptions(t: (input: string) => string, callback: () => void): {
     title: string;
     content: string;
@@ -9,6 +9,7 @@ declare function discardOverridesConfirmationOptions(t: (input: string) => strin
     hasExit: boolean;
     onConfirm: () => Promise<void>;
 };
+declare function setSectionOverrides(sectionId: CanvasRetrieve['id'], overrides?: SectionOverrides): void;
 declare function cleanup(): void;
 export default function useCanvasSectionOverrides(): {
     getComponentOverrides: (data: Ref<ComponentNode["data"]>, id: Ref<ComponentNode["id"]>, sectionId?: Ref<CanvasRetrieve["id"]>) => import('vue').ComputedRef<{
@@ -25,5 +26,6 @@ export default function useCanvasSectionOverrides(): {
     }) => void;
     cleanup: typeof cleanup;
     sectionComponentOverrides: Ref<SectionComponentOverrides, SectionComponentOverrides>;
+    setSectionOverrides: typeof setSectionOverrides;
 };
 export {};

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

@@ -418,6 +418,7 @@ export default function useCanvasTheme(): {
     inheritThemeFromParent: import('vue').Ref<boolean, boolean>;
     isEditingCanvasTheme: import('vue').Ref<boolean, boolean>;
     isFluid: import('vue').Ref<boolean, boolean>;
+    aspectRatio: import('vue').Ref<"contain" | "unlocked" | "16:9" | "16:10" | "4:3" | "1:1", "contain" | "unlocked" | "16:9" | "16:10" | "4:3" | "1:1">;
     maintainSectionTheme: import('vue').Ref<boolean, boolean>;
     palette: import('vue').Ref<string[], string[]>;
     logo: import('vue').Ref<{

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

@@ -12,6 +12,7 @@ type ContentSelectorPayload = {
     allowedIds?: File['id'][];
     initialMetadataFilters?: Record<string, any>;
     maxSelections?: number;
+    onlyAllowContentPdfPages?: boolean;
     onSelected?: (selections: (SelectedFile | SelectedPage)[]) => void;
     usedInSectionId?: CanvasRetrieve['id'];
 };
@@ -63,6 +64,7 @@ export default function (): {
         allowedIds?: File["id"][] | undefined;
         initialMetadataFilters?: Record<string, any> | undefined;
         maxSelections?: number | undefined;
+        onlyAllowContentPdfPages?: boolean | undefined;
         onSelected?: ((selections: (SelectedFile | SelectedPage)[]) => void) | undefined;
         usedInSectionId?: CanvasRetrieve["id"] | undefined;
     }, ContentSelectorState | {
@@ -92,6 +94,7 @@ export default function (): {
         allowedIds?: File["id"][] | undefined;
         initialMetadataFilters?: Record<string, any> | undefined;
         maxSelections?: number | undefined;
+        onlyAllowContentPdfPages?: boolean | undefined;
         onSelected?: ((selections: (SelectedFile | SelectedPage)[]) => void) | undefined;
         usedInSectionId?: CanvasRetrieve["id"] | undefined;
     }>;

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

@@ -0,0 +1,7 @@
+export default function useEmbeddable(): {
+    embeddableHeights: import('vue').Ref<Record<string, number>, Record<string, number>>;
+    getEmbeddableHeight: (componentId: string) => number;
+    hasZeroHeight: (componentId: string) => boolean;
+    updateEmbeddableHeights: () => Promise<void>;
+    updateSectionEmbeddableHeights: () => Promise<void>;
+};

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

@@ -1,5 +1,11 @@
-export declare const usePitcherEvents: () => {
+export declare const usePitcherEvents: (goToNextPage?: () => void, goToPreviousPage?: () => void, onCanvasCloseRequested?: () => void) => {
     isOpenPhotosCaptured: import('vue').Ref<boolean, boolean>;
     registerPhotosCapturedListener: () => void;
     unregisterPhotosCapturedListener: () => void;
+    registerCanvasPageNextListener: () => void;
+    unregisterCanvasPageNextListener: () => void;
+    registerCanvasPagePreviousListener: () => void;
+    unregisterCanvasPagePreviousListener: () => void;
+    registerCanvasCloseListener: () => void;
+    unregisterCanvasCloseListener: () => void;
 };