@pitcher/js-api 1.26.0-beta.9 → 1.26.1

package/lib/apps/canvas-builder/components/ui/DynamicContent/useDynamicContent.d.ts

@@ -0,0 +1,436 @@
+import { ComputedRef, Ref } from 'vue';
+import { DynamicContentProps } from '../../../types/canvas';
+import { FileStatusEnum, CanvasRetrieve, FileRetrieve } from '../../../../../../types/openapi';
+export interface DynamicContentSection {
+    section: CanvasRetrieve;
+    index: number;
+}
+export interface DynamicContentFile {
+    id: string;
+    file_id: string;
+    type: 'file';
+    component_id: string;
+    index: number;
+    file: FileRetrieve;
+    section: undefined;
+}
+export declare function cleanupDynamicContent(): void;
+export declare function useDynamicContent(hasConfig?: Ref<boolean> | ComputedRef<boolean>): {
+    resolvedSections: Ref<{
+        section: {
+            readonly id: string;
+            name: string;
+            content?: Record<string, any> | undefined;
+            context?: any;
+            indicators?: (Record<string, any> | null) | undefined;
+            theme?: (Record<string, any> | null) | undefined;
+            is_draft?: boolean | undefined;
+            is_template?: boolean | undefined;
+            is_section?: boolean | undefined;
+            is_block?: boolean | undefined;
+            is_editable?: boolean | undefined;
+            is_default?: boolean | undefined;
+            metadata?: any;
+            tags?: Array<string> | undefined;
+            start_at?: string | null | undefined;
+            expires_at?: string | null | undefined;
+            access_type?: import('../../../../../../types/openapi').AccessTypeEnum | undefined;
+            thumbnail_url?: string | null | undefined;
+            instance_id: string;
+            readonly template: {
+                readonly id: string;
+                name: string;
+            };
+            readonly sections: {
+                readonly id: string;
+                name: string;
+                content: Record<string, any>;
+                theme?: (Record<string, any> | null) | undefined;
+                metadata?: Record<string, any> | undefined;
+                is_draft: boolean;
+            }[];
+            readonly shared_link: {
+                readonly url: string;
+                short_url?: string | null | undefined;
+            };
+            account?: {
+                id?: string | undefined;
+                name?: string | undefined;
+            } | null | undefined;
+            readonly events: {
+                readonly id: string;
+                start_at: string;
+                subject: string;
+            }[];
+            folder_id?: string | null | undefined;
+            readonly owned_by: {
+                readonly id: number;
+                readonly name: string;
+                email?: string | undefined;
+            };
+            readonly created_at: string;
+            readonly created_by: {
+                readonly id: number;
+                readonly name: string;
+                email?: string | undefined;
+            };
+            readonly modified_at: string;
+            readonly modified_by: {
+                readonly id: number;
+                readonly name: string;
+                email?: string | undefined;
+            };
+        };
+        index: number;
+    }[], DynamicContentSection[] | {
+        section: {
+            readonly id: string;
+            name: string;
+            content?: Record<string, any> | undefined;
+            context?: any;
+            indicators?: (Record<string, any> | null) | undefined;
+            theme?: (Record<string, any> | null) | undefined;
+            is_draft?: boolean | undefined;
+            is_template?: boolean | undefined;
+            is_section?: boolean | undefined;
+            is_block?: boolean | undefined;
+            is_editable?: boolean | undefined;
+            is_default?: boolean | undefined;
+            metadata?: any;
+            tags?: Array<string> | undefined;
+            start_at?: string | null | undefined;
+            expires_at?: string | null | undefined;
+            access_type?: import('../../../../../../types/openapi').AccessTypeEnum | undefined;
+            thumbnail_url?: string | null | undefined;
+            instance_id: string;
+            readonly template: {
+                readonly id: string;
+                name: string;
+            };
+            readonly sections: {
+                readonly id: string;
+                name: string;
+                content: Record<string, any>;
+                theme?: (Record<string, any> | null) | undefined;
+                metadata?: Record<string, any> | undefined;
+                is_draft: boolean;
+            }[];
+            readonly shared_link: {
+                readonly url: string;
+                short_url?: string | null | undefined;
+            };
+            account?: {
+                id?: string | undefined;
+                name?: string | undefined;
+            } | null | undefined;
+            readonly events: {
+                readonly id: string;
+                start_at: string;
+                subject: string;
+            }[];
+            folder_id?: string | null | undefined;
+            readonly owned_by: {
+                readonly id: number;
+                readonly name: string;
+                email?: string | undefined;
+            };
+            readonly created_at: string;
+            readonly created_by: {
+                readonly id: number;
+                readonly name: string;
+                email?: string | undefined;
+            };
+            readonly modified_at: string;
+            readonly modified_by: {
+                readonly id: number;
+                readonly name: string;
+                email?: string | undefined;
+            };
+        };
+        index: number;
+    }[]>;
+    resolvedFiles: Ref<{
+        id: string;
+        file_id: string;
+        type: "file";
+        component_id: string;
+        index: number;
+        file: {
+            readonly id: string;
+            readonly global_id: string;
+            name?: string | undefined;
+            readonly type: import('../../../../../../types/openapi').FileTypeEnum;
+            readonly size: number | null;
+            readonly status: FileStatusEnum;
+            readonly version: {
+                readonly id: string;
+                readonly comment: string;
+                readonly created_at: string;
+            };
+            readonly content_type: import('../../../../../../types/openapi').FileContentTypeEnum;
+            readonly content_extension: string | null;
+            readonly content_length: number | null;
+            readonly content_url: string | null;
+            readonly content_thumbnails: Array<string>;
+            readonly original_extension: string | null;
+            readonly original_url: string | null;
+            readonly thumbnail_url: string | null;
+            download_type?: import('../../../../../../types/openapi').DownloadTypeEnum | undefined;
+            readonly zip_size: number | null;
+            readonly zip_url: string | null;
+            access_type?: import('../../../../../../types/openapi').AccessTypeEnum | undefined;
+            readonly role: import('../../../../../../types/openapi').CollaborationRoleEnum;
+            permissions?: {
+                can_download?: boolean | undefined;
+                can_share?: boolean | undefined;
+                can_be_divided?: boolean | undefined;
+                readonly can_print: boolean;
+            } | undefined;
+            readonly pspdfkit_server_url: string | null;
+            readonly pspdfkit_document_id: string | null;
+            readonly pspdfkit_auth_payload: Record<string, any> | null;
+            metadata?: Record<string, any> | undefined;
+            app_metadata?: Record<string, any> | undefined;
+            tags?: Array<string> | undefined;
+            readonly published_at: string | null;
+            expires_at?: string | null | undefined;
+            available_at?: string | null | undefined;
+            readonly instance_id: string;
+            folder_id?: string | undefined;
+            readonly folder: {
+                readonly id: string;
+                name: string;
+            };
+            readonly shared_link: {
+                readonly url: string;
+                short_url?: string | null | undefined;
+            };
+            readonly owned_by: {
+                readonly id: number;
+                readonly name: string;
+                email?: string | undefined;
+            };
+            readonly created_at: string;
+            readonly created_by: {
+                readonly id: number;
+                readonly name: string;
+                email?: string | undefined;
+            };
+            readonly modified_at: string;
+            readonly modified_by: {
+                readonly id: number;
+                readonly name: string;
+                email?: string | undefined;
+            };
+        };
+        section: undefined;
+    }[], DynamicContentFile[] | {
+        id: string;
+        file_id: string;
+        type: "file";
+        component_id: string;
+        index: number;
+        file: {
+            readonly id: string;
+            readonly global_id: string;
+            name?: string | undefined;
+            readonly type: import('../../../../../../types/openapi').FileTypeEnum;
+            readonly size: number | null;
+            readonly status: FileStatusEnum;
+            readonly version: {
+                readonly id: string;
+                readonly comment: string;
+                readonly created_at: string;
+            };
+            readonly content_type: import('../../../../../../types/openapi').FileContentTypeEnum;
+            readonly content_extension: string | null;
+            readonly content_length: number | null;
+            readonly content_url: string | null;
+            readonly content_thumbnails: Array<string>;
+            readonly original_extension: string | null;
+            readonly original_url: string | null;
+            readonly thumbnail_url: string | null;
+            download_type?: import('../../../../../../types/openapi').DownloadTypeEnum | undefined;
+            readonly zip_size: number | null;
+            readonly zip_url: string | null;
+            access_type?: import('../../../../../../types/openapi').AccessTypeEnum | undefined;
+            readonly role: import('../../../../../../types/openapi').CollaborationRoleEnum;
+            permissions?: {
+                can_download?: boolean | undefined;
+                can_share?: boolean | undefined;
+                can_be_divided?: boolean | undefined;
+                readonly can_print: boolean;
+            } | undefined;
+            readonly pspdfkit_server_url: string | null;
+            readonly pspdfkit_document_id: string | null;
+            readonly pspdfkit_auth_payload: Record<string, any> | null;
+            metadata?: Record<string, any> | undefined;
+            app_metadata?: Record<string, any> | undefined;
+            tags?: Array<string> | undefined;
+            readonly published_at: string | null;
+            expires_at?: string | null | undefined;
+            available_at?: string | null | undefined;
+            readonly instance_id: string;
+            folder_id?: string | undefined;
+            readonly folder: {
+                readonly id: string;
+                name: string;
+            };
+            readonly shared_link: {
+                readonly url: string;
+                short_url?: string | null | undefined;
+            };
+            readonly owned_by: {
+                readonly id: number;
+                readonly name: string;
+                email?: string | undefined;
+            };
+            readonly created_at: string;
+            readonly created_by: {
+                readonly id: number;
+                readonly name: string;
+                email?: string | undefined;
+            };
+            readonly modified_at: string;
+            readonly modified_by: {
+                readonly id: number;
+                readonly name: string;
+                email?: string | undefined;
+            };
+        };
+        section: undefined;
+    }[]>;
+    isLoading: Ref<boolean, boolean>;
+    error: Ref<string | null, string | null>;
+    sectionContentCache: Ref<Map<string, {
+        readonly id: string;
+        name: string;
+        content?: Record<string, any> | undefined;
+        context?: any;
+        indicators?: (Record<string, any> | null) | undefined;
+        theme?: (Record<string, any> | null) | undefined;
+        is_draft?: boolean | undefined;
+        is_template?: boolean | undefined;
+        is_section?: boolean | undefined;
+        is_block?: boolean | undefined;
+        is_editable?: boolean | undefined;
+        is_default?: boolean | undefined;
+        metadata?: any;
+        tags?: Array<string> | undefined;
+        start_at?: string | null | undefined;
+        expires_at?: string | null | undefined;
+        access_type?: import('../../../../../../types/openapi').AccessTypeEnum | undefined;
+        thumbnail_url?: string | null | undefined;
+        instance_id: string;
+        readonly template: {
+            readonly id: string;
+            name: string;
+        };
+        readonly sections: {
+            readonly id: string;
+            name: string;
+            content: Record<string, any>;
+            theme?: (Record<string, any> | null) | undefined;
+            metadata?: Record<string, any> | undefined;
+            is_draft: boolean;
+        }[];
+        readonly shared_link: {
+            readonly url: string;
+            short_url?: string | null | undefined;
+        };
+        account?: {
+            id?: string | undefined;
+            name?: string | undefined;
+        } | null | undefined;
+        readonly events: {
+            readonly id: string;
+            start_at: string;
+            subject: string;
+        }[];
+        folder_id?: string | null | undefined;
+        readonly owned_by: {
+            readonly id: number;
+            readonly name: string;
+            email?: string | undefined;
+        };
+        readonly created_at: string;
+        readonly created_by: {
+            readonly id: number;
+            readonly name: string;
+            email?: string | undefined;
+        };
+        readonly modified_at: string;
+        readonly modified_by: {
+            readonly id: number;
+            readonly name: string;
+            email?: string | undefined;
+        };
+    }> & Omit<Map<string, CanvasRetrieve>, keyof Map<any, any>>, Map<string, CanvasRetrieve> | (Map<string, {
+        readonly id: string;
+        name: string;
+        content?: Record<string, any> | undefined;
+        context?: any;
+        indicators?: (Record<string, any> | null) | undefined;
+        theme?: (Record<string, any> | null) | undefined;
+        is_draft?: boolean | undefined;
+        is_template?: boolean | undefined;
+        is_section?: boolean | undefined;
+        is_block?: boolean | undefined;
+        is_editable?: boolean | undefined;
+        is_default?: boolean | undefined;
+        metadata?: any;
+        tags?: Array<string> | undefined;
+        start_at?: string | null | undefined;
+        expires_at?: string | null | undefined;
+        access_type?: import('../../../../../../types/openapi').AccessTypeEnum | undefined;
+        thumbnail_url?: string | null | undefined;
+        instance_id: string;
+        readonly template: {
+            readonly id: string;
+            name: string;
+        };
+        readonly sections: {
+            readonly id: string;
+            name: string;
+            content: Record<string, any>;
+            theme?: (Record<string, any> | null) | undefined;
+            metadata?: Record<string, any> | undefined;
+            is_draft: boolean;
+        }[];
+        readonly shared_link: {
+            readonly url: string;
+            short_url?: string | null | undefined;
+        };
+        account?: {
+            id?: string | undefined;
+            name?: string | undefined;
+        } | null | undefined;
+        readonly events: {
+            readonly id: string;
+            start_at: string;
+            subject: string;
+        }[];
+        folder_id?: string | null | undefined;
+        readonly owned_by: {
+            readonly id: number;
+            readonly name: string;
+            email?: string | undefined;
+        };
+        readonly created_at: string;
+        readonly created_by: {
+            readonly id: number;
+            readonly name: string;
+            email?: string | undefined;
+        };
+        readonly modified_at: string;
+        readonly modified_by: {
+            readonly id: number;
+            readonly name: string;
+            email?: string | undefined;
+        };
+    }> & Omit<Map<string, CanvasRetrieve>, keyof Map<any, any>>)>;
+    hasSectionCached: (sectionId: string) => boolean;
+    getCachedSection: (sectionId: string) => CanvasRetrieve | undefined;
+    fetchDynamicContent: (config: DynamicContentProps) => Promise<void>;
+    fetchSectionContent: (sectionId: string) => Promise<CanvasRetrieve | null>;
+};

package/lib/apps/canvas-builder/components/ui/DynamicContent/useDynamicContent.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,17 @@
+import { CanvasRetrieve } from '../../../../types/openapi';
+/**
+ * Decide whether an incoming `activeCanvas` prop update requires a deep state refresh
+ * (re-cloning content.data, replacing sections, resetting canvas history) versus a
+ * cheap top-level shallow merge.
+ *
+ * Returns true when the canvas identity, content (including overrides and home_page),
+ * or sections have changed — i.e. anything that feeds the rendered slide tree. Returns
+ * false when only top-level metadata/tags/flags have changed, in which case the existing
+ * shallow merge in `updateActiveCanvasProperties` is safe (and preserves canvas-history
+ * undo state).
+ *
+ * Fixes PIT-5927: stale slide content flashes before fresh fetch lands because
+ * `canvasContent.value`/`sectionComponentOverrides.value`/`canvasHomePage.value` are only
+ * re-derived by `setActiveCanvas`, not by `updateActiveCanvasProperties`.
+ */
+export declare const needsDeepRefresh: (prev: CanvasRetrieve | null, next: CanvasRetrieve) => boolean;

package/lib/apps/canvas-builder/composables/canvasUpdateStrategy.spec.d.ts

@@ -0,0 +1 @@
+export {};