npm - @pitcher/js-api - Versions diffs - 1.25.0 → 1.25.1 - Mend

@pitcher/js-api 1.25.0 → 1.25.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (305) hide show

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

@@ -2,19 +2,24 @@ 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;
+        is_draft: boolean;
+    } | 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>[][]>;
+    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 | import('../types/canvas').DynamicDataTableProps | import('../types/canvas').CustomDataTableProps>[][]>;
     currentPageIndex: import('vue').Ref<number, number>;
     currentSectionList: ComputedRef<{
         sectionListId: string;
@@ -29,9 +34,22 @@ 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>;
+    isBackToPreviousLocationDisabled: ComputedRef<boolean>;
 };
 export {};

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

@@ -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,10 +9,11 @@ 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<{
-        data: (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 | import('../types/canvas').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) | undefined;
+        data: (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 | import('../types/canvas').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 | import('../types/canvas').DynamicDataTableProps | import('../types/canvas').CustomDataTableProps) | undefined;
         is_removed: boolean;
     }>;
     discardOverridesConfirmationOptions: typeof discardOverridesConfirmationOptions;
@@ -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 CHANGED Viewed

@@ -106,6 +106,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         };
         created_by: {
             readonly id: number;
@@ -133,6 +134,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         };
         modified_by?: {
             readonly id: number;
@@ -160,6 +162,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         } | undefined;
         logo?: {
             id: string;
@@ -217,6 +220,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         };
         created_by: {
             readonly id: number;
@@ -244,6 +248,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         };
         modified_by?: {
             readonly id: number;
@@ -271,6 +276,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         } | undefined;
         logo?: {
             id: string;
@@ -324,8 +330,6 @@ export default function useCanvasTheme(): {
         metadata?: Record<string, any> | undefined;
         app_metadata?: Record<string, any> | undefined;
         tags?: Array<string> | undefined;
-        transcript?: string | undefined;
-        readonly search: string | null;
         readonly published_at: string | null;
         expires_at?: string | null | undefined;
         readonly instance_id: string;
@@ -381,8 +385,6 @@ export default function useCanvasTheme(): {
         metadata?: Record<string, any> | undefined;
         app_metadata?: Record<string, any> | undefined;
         tags?: Array<string> | undefined;
-        transcript?: string | undefined;
-        readonly search: string | null;
         readonly published_at: string | null;
         expires_at?: string | null | undefined;
         readonly instance_id: string;
@@ -418,6 +420,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<{
@@ -446,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;
@@ -485,6 +491,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         };
         created_by: {
             readonly id: number;
@@ -512,6 +519,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         };
         modified_by?: {
             readonly id: number;
@@ -539,6 +547,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         } | undefined;
         logo?: {
             id: string;
@@ -596,6 +605,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         };
         created_by: {
             readonly id: number;
@@ -623,6 +633,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         };
         modified_by?: {
             readonly id: number;
@@ -650,6 +661,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         } | undefined;
         logo?: {
             id: string;
@@ -715,6 +727,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         };
         created_by: {
             readonly id: number;
@@ -742,6 +755,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         };
         modified_by?: {
             readonly id: number;
@@ -769,6 +783,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         } | undefined;
         logo?: {
             id: string;
@@ -826,6 +841,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         };
         created_by: {
             readonly id: number;
@@ -853,6 +869,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         };
         modified_by?: {
             readonly id: number;
@@ -880,6 +897,7 @@ export default function useCanvasTheme(): {
             readonly picture: string | null;
             timezone?: string | undefined;
             tags?: (Array<string> | null) | undefined;
+            readonly connection?: string | null | undefined;
         } | undefined;
         logo?: {
             id: string;

package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts CHANGED Viewed

@@ -1,8 +1,9 @@
 import { CanvasRetrieve } from '../../../../types/openapi';
 import { ComponentNode, ComponentNodeVisible } from '../types/canvas';
+import { CollectionPlayer } from '../../collection-player/types/collection-player.type.ts';
 export default function useCanvasVisibility(): {
     getComponentDefaultVisibility: (type: ComponentNode["type"], mode?: keyof ComponentNodeVisible) => boolean;
-    getVisibleCanvasContent: (data: ComponentNode[], mode?: keyof ComponentNodeVisible) => 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 | import('../types/canvas').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>[];
+    getVisibleCanvasContent: (data: ComponentNode[], mode?: keyof ComponentNodeVisible) => ComponentNode<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 | import('../types/canvas').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 | import('../types/canvas').DynamicDataTableProps | import('../types/canvas').CustomDataTableProps>[];
     getVisibleKey: () => keyof ComponentNodeVisible | undefined;
     shouldRenderComponentWrapper: (c: ComponentNode, sectionId?: CanvasRetrieve["id"]) => boolean | undefined;
 };

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

@@ -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/useControlBarCollapse.d.ts ADDED Viewed

@@ -0,0 +1,8 @@
+declare function toggleControlBarsCollapse(): void;
+declare function resetControlBarsCollapse(): void;
+export default function (): {
+    toggleControlBarsCollapse: typeof toggleControlBarsCollapse;
+    areControlBarsCollapsed: import('vue').Ref<boolean, boolean>;
+    resetControlBarsCollapse: typeof resetControlBarsCollapse;
+};
+export {};

package/lib/apps/canvas-builder/composables/useCrmShape.d.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 import { ComputedRef } from 'vue';
 import { User } from '../../../../types/openapi';
-interface DefaultCrmShape {
+export interface DefaultCrmShape {
     account?: {
         name?: string;
     };
@@ -28,4 +28,3 @@ export default function useCrmShape(): {
     }) => Partial<DefaultCrmShape>;
     setRealTimeExtraCrmShape: (shape: Record<string, any>) => void;
 };
-export {};

package/lib/apps/canvas-builder/composables/useCrmShapeWithSectionContext.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+import { ComputedRef } from 'vue';
+export default function useCanvasContext(): {
+    getSectionCtx: () => any;
+    crmShapeWithSectionCtx: ComputedRef<any>;
+};

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

@@ -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/useInstalledEmbeddables.d.ts CHANGED Viewed

@@ -7,6 +7,7 @@ export declare function useInstalledEmbeddables(): {
     shouldUseDeviceUrl: ComputedRef<boolean | undefined>;
     shortcuts: ComputedRef<Record<"edit" | "presentation" | "fullscreen", (EmbeddedAppShortcut & {
         appName: string;
+        displayName: string;
     })[]>>;
     refetch: (fileId?: AppFile["id"]) => void;
     cleanup: () => void;

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

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