@pitcher/js-api 1.21.0-beta.2 → 1.22.0-alpha.0

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

@@ -0,0 +1,466 @@
+import { CSSProperties, Ref } from 'vue';
+import { MaybeRef } from '@vueuse/core';
+import { CanvasActions } from '../../../main.lib';
+import { Canvas, CanvasRetrieve, File, FileContentTypeEnum, FileRetrieve, Folder, FolderRetrieve, MetadataTemplate, PatchedCanvasUpdateRequest, SharedLink, User } from '../../../../types/openapi';
+import { PaginatedData } from '../../../types/paginatedData';
+import { OpenExternalUrlRequestPayload, PitcherEnv } from '../../../sdk/main';
+import { EmbedLocation, EmbeddedLocationProperties } from '../../../types/app';
+import { FileModel } from '../../../components/CFileViewer/CFileViewer.types';
+import { aspectRatios } from '@canvas-builder/constants';
+
+type AvailableAspectRatio = (typeof aspectRatios)[number];
+export declare enum HtmlLayoutTypes {
+    PREVIEW = "preview",
+    EDIT = "edit"
+}
+export declare enum ContentGridLayoutTypes {
+    CAROUSEL = "carousel",
+    GRID = "grid"
+}
+export declare enum GridLayoutTypes {
+    ONE = "one",
+    TWO_EQUAL = "two-equal",
+    TWO_LEFT = "two-left",
+    TWO_RIGHT = "two-right",
+    THREE_EQUAL = "three-equal",
+    FOUR_EQUAL = "four-equal"
+}
+export declare enum LinkAnchorTypes {
+    WEB = "web",
+    CANVAS_ANCHOR = "canvas-anchor"
+}
+export declare enum LinkAlignmentTypes {
+    LEFT = "left",
+    CENTER = "center",
+    RIGHT = "right"
+}
+export declare enum LinkPreviewTypes {
+    SOLID_BUTTON = "solid-button",
+    OUTLINE_BUTTON = "outline-button",
+    TEXT_LINK = "text-link"
+}
+export interface EmbeddableProps {
+    type: 'app';
+    app_name: string;
+    src: string | null;
+    height?: string;
+    width?: string;
+    embed_locations?: EmbedLocation[];
+    headless_locations?: EmbedLocation[];
+    properties_by_embed_location?: Partial<Record<EmbedLocation, EmbeddedLocationProperties>>;
+    file: ContentGridFileProps | null;
+    settings?: Record<string, unknown>;
+}
+export interface TextProps {
+    content?: string;
+}
+export interface CarouselProps {
+    images?: {
+        url: string;
+        is_uploaded_asset?: boolean;
+    }[];
+    placeholder_height?: string;
+    include_all_images_in_pdf?: boolean;
+}
+export interface CanvasFile {
+    readonly name: FileModel['name'];
+    readonly file_id: FileModel['id'];
+    readonly content_extension: FileModel['content_extension'];
+    readonly content_type: FileModel['content_type'];
+    readonly content_url: FileModel['content_url'];
+    readonly thumbnail_url: FileModel['thumbnail_url'];
+    readonly content_length: FileModel['content_length'];
+    readonly content_thumbnails: FileModel['content_thumbnails'];
+    readonly pspdfkit_token?: string;
+    readonly pspdfkit_server_url?: FileModel['pspdfkit_server_url'];
+    readonly pspdfkit_auth_payload?: FileModel['pspdfkit_auth_payload'];
+}
+declare const MULTIMEDIA_IMG_TYPE: {
+    readonly external: "external";
+    readonly pitcher_asset: "pitcher_asset";
+};
+export declare enum MultimediaHorizontalAlignmentOptions {
+    LEFT = "left",
+    CENTER = "center",
+    RIGHT = "right"
+}
+export type ExternalMultimediaAssetType = {
+    asset_type: typeof MULTIMEDIA_IMG_TYPE.external;
+    external_url: string;
+    type: 'image' | 'video';
+    horizontal_alignment?: MultimediaHorizontalAlignmentOptions;
+};
+export type PitcherMultimediaAssetType = {
+    asset_type: typeof MULTIMEDIA_IMG_TYPE.pitcher_asset;
+    file: {
+        id: File['id'];
+        name: File['name'];
+        content_url?: File['content_url'];
+    };
+    type: 'image' | 'video';
+    horizontal_alignment?: MultimediaHorizontalAlignmentOptions;
+};
+export type MultimediaProps = ExternalMultimediaAssetType | PitcherMultimediaAssetType;
+type ContentGridCommonFileProps = {
+    id: FileRetrieve['id'];
+    snapshot_id?: FileRetrieve['id'];
+    name: FileRetrieve['name'];
+    is_deleted?: boolean;
+    content_url?: FileRetrieve['content_url'];
+    content_type?: FileContentTypeEnum | null;
+    content_extension?: FileRetrieve['content_extension'];
+};
+export type ContentGridFileProps = ContentGridCommonFileProps & {
+    thumbnail_url?: FileRetrieve['thumbnail_url'];
+    content_url: FileRetrieve['content_url'];
+    content_type: FileContentTypeEnum | null;
+    content_extension: FileRetrieve['content_extension'];
+    content_length: FileRetrieve['content_length'];
+    content_thumbnails?: FileRetrieve['content_thumbnails'] | null;
+    readonly pspdfkit_token?: string;
+    readonly pspdfkit_server_url?: FileModel['pspdfkit_server_url'];
+    readonly pspdfkit_auth_payload?: FileModel['pspdfkit_auth_payload'];
+};
+export type ContentGridItemFileProps = {
+    file: ContentGridFileProps;
+    type: 'file';
+};
+export type ContentGridItemSlideProps = {
+    file: ContentGridCommonFileProps;
+    slide: {
+        index: number;
+        url?: FileRetrieve['content_thumbnails'][number];
+    };
+    type: 'slide';
+};
+export interface ContentGridProps {
+    items: (ContentGridItemSlideProps | ContentGridItemFileProps)[];
+    size?: 'medium';
+    layout_type?: ContentGridLayoutTypes;
+}
+export interface SectionListSection {
+    id: string;
+    style?: Record<string, any>;
+    aspect_ratio?: AvailableAspectRatio;
+    background_video_url?: string;
+}
+export interface SectionListProps {
+    sections: SectionListSection[];
+    animation_in?: string;
+}
+export interface GridItemTooltipProps {
+    content?: string;
+    content_style?: Record<string, any>;
+    trigger?: string;
+    trigger_style?: Record<string, any>;
+}
+export interface GridItemProps {
+    span: number;
+    tooltips?: GridItemTooltipProps[];
+}
+export interface GridProps {
+    layout_type: GridLayoutTypes;
+    columns: number;
+}
+export interface HtmlProps {
+    html: string;
+}
+export interface LinkProps {
+    alignment?: LinkAlignmentTypes;
+    background_color?: string;
+    canvas_anchor?: string;
+    color?: string;
+    display_text?: string;
+    font_family?: string;
+    font_size?: number;
+    link_type?: LinkAnchorTypes;
+    preview_type?: LinkPreviewTypes;
+    target?: '_self' | '_blank';
+    url?: string;
+}
+export interface PageBreakProps {
+}
+export interface PageProps {
+    aspect_ratio?: AvailableAspectRatio;
+    background_video_url?: string;
+}
+export interface TimelineEvent {
+    top_hint?: string;
+    top_hint_style?: Record<string, any>;
+    title?: string;
+    title_style?: Record<string, any>;
+    description?: string;
+    description_style?: Record<string, any>;
+    image_url?: string;
+    image_style?: Record<string, any>;
+    icon?: string;
+    icon_style?: Record<string, any>;
+    card_style?: Record<string, any>;
+}
+export interface TimelineProps {
+    events: TimelineEvent[];
+    layout: 'vertical' | 'horizontal';
+}
+type AvailableComponentProps = GridProps | GridItemProps | TextProps | CarouselProps | MultimediaProps | EmbeddableProps | ContentGridProps | SectionListProps | HtmlProps | LinkProps | PageBreakProps | PageProps | TimelineProps;
+export interface ComponentNodeVisible {
+    edit_mode: boolean;
+    presentation_mode: boolean;
+    pdf: boolean;
+    web: boolean;
+}
+export interface ComponentNode<T = AvailableComponentProps> {
+    id: string;
+    type: ComponentTypes;
+    tracking_id: string;
+    visible?: ComponentNodeVisible;
+    allow_admins_to_overwrite?: boolean;
+    autofill?: 'off' | 'ai' | 'matching_metadata' | 'matching_tags' | 'matching_metadata_or_tags';
+    autofill_content_types?: FileContentTypeEnum[] | null;
+    data?: T;
+    children?: ComponentNode[];
+    when_used_in_section?: {
+        is_editable: boolean;
+        is_removable: boolean;
+    };
+    style?: CSSProperties;
+    tags?: string[];
+}
+export interface CanvasContent {
+    data?: ComponentNode[];
+    overrides?: SectionComponentOverrides;
+    hidden?: {
+        dsr: {
+            sections: HiddenElementsInCanvas;
+            components: HiddenElementsInCanvas;
+        };
+        dsr_print: {
+            sections: HiddenElementsInCanvas;
+            components: HiddenElementsInCanvas;
+        };
+    };
+}
+export interface HiddenElementsInCanvas {
+    [elementId: string]: true;
+}
+export type SectionComponentOverride = {
+    node?: ComponentNode;
+    after_sibling_id?: ComponentNode['id'];
+    is_removed?: true;
+};
+export type SectionComponentOverrides = {
+    [sectionId: Canvas['id']]: {
+        [componentId: ComponentNode['id'] | 'root']: SectionComponentOverride;
+    };
+};
+export interface ComponentMeta {
+    allowedChildren: ComponentTypes[];
+    defaultChildren: Partial<ComponentNode>[];
+    defaultData: AvailableComponentProps;
+    singleton?: boolean;
+    defaultPrintable: boolean;
+}
+export declare enum ComponentTypes {
+    Root = "Root",
+    ContentGrid = "ContentGrid",
+    SectionList = "SectionList",
+    Grid = "Grid",
+    GridItem = "GridItem",
+    Multimedia = "Multimedia",
+    Text = "Text",
+    Embeddable = "Embeddable",
+    Carousel = "Carousel",
+    Html = "Html",
+    Link = "Link",
+    PageBreak = "PageBreak",
+    Page = "Page",
+    Timeline = "Timeline"
+}
+export declare enum ComponentIcon {
+    AR = "cube",
+    Carousel = "gallery-thumbnails",
+    Collection = "rectangle-history-circle-plus",
+    Embeddable = "browser",
+    File = "file-circle-plus",
+    ContentGrid = "files",
+    Grid = "table-columns",
+    GridItem = "objects-column",
+    GridParent = "angle-down",
+    Multimedia = "image",
+    SectionList = "bring-forward",
+    Text = "text-size",
+    Video = "video",
+    Html = "code",
+    Link = "hand-pointer",
+    PageBreak = "arrows-from-line",
+    Page = "pager",
+    Timeline = "timeline-arrow"
+}
+export type CanvasTheme = {
+    canvas_bg_color?: string;
+    global_component_spacing?: number;
+    font?: {
+        name: string;
+        url: string;
+    };
+    fluid?: boolean;
+    style?: Record<string, any>;
+    aspect_ratio?: AvailableAspectRatio;
+};
+export declare enum CanvasBuilderMode {
+    ADMIN = "admin",
+    IMPACT = "impact",
+    SHARING = "sharing"
+}
+export interface ComponentTrackingParams {
+    trackable: boolean;
+}
+export declare enum CanvasHistoryAction {
+    ADD = "add",
+    REMOVE = "remove",
+    REORDER = "reorder",
+    OPEN = "open"
+}
+export interface CanvasHistoryItem {
+    active?: boolean;
+    action: CanvasHistoryAction;
+    componentType: ComponentTypes;
+    icon?: string;
+    id: string;
+    snapshot: ComponentNode[];
+    timestamp: string;
+}
+export interface FileProps {
+    file_id: FileRetrieve['id'];
+    source_file_id?: FileRetrieve['id'];
+    name: FileRetrieve['name'];
+    thumbnail_url?: FileRetrieve['thumbnail_url'];
+    content_url: FileRetrieve['content_url'];
+    content_type: FileRetrieve['content_type'];
+    content_extension: FileRetrieve['content_extension'];
+    content_length: FileRetrieve['content_length'];
+    content_thumbnails: FileRetrieve['content_thumbnails'] | null;
+    is_deleted?: boolean;
+    readonly pspdfkit_token?: string;
+    readonly pspdfkit_server_url?: FileModel['pspdfkit_server_url'];
+    readonly pspdfkit_auth_payload?: FileModel['pspdfkit_auth_payload'];
+}
+type FileOpenParams = (FileProps & {
+    page_index?: number;
+    newTab?: boolean;
+}) | {
+    file_id: File['id'];
+    name?: File['name'];
+    page_index?: number;
+    newTab?: boolean;
+};
+type NoCRMBuilderProps = {
+    isCRM: false;
+    onSfdcAccountSearch?: never;
+};
+export type SharingBuilderProps = NoCRMBuilderProps & {
+    isFullscreen?: boolean;
+    displayMode?: 'default' | 'print';
+    startPage?: number;
+    endPage?: number;
+    isRedirectEvent?: never;
+    mode: CanvasBuilderMode.SHARING;
+    metadata: {
+        baseStackingContext?: number;
+    };
+    activeCanvas: Canvas;
+    templates?: never;
+    onExit: () => void;
+    onSave?: never;
+    onEnter?: () => void;
+    onComponentEnter?: (data: ComponentNode | Canvas, params: ComponentTrackingParams) => void;
+    onComponentExit?: (data: ComponentNode | Canvas, params: ComponentTrackingParams) => void;
+    onFileOpen: (file: FileOpenParams) => void;
+    onOpenExternalUrl: (payload: OpenExternalUrlRequestPayload) => Promise<void>;
+    deleteFile?: never;
+    listFiles?: never;
+    listCanvases?: never;
+    fetchFolder?: never;
+    fetchFile?: never;
+    fetchInstanceMetadataTemplate?: never;
+    fetchCanvas?: never;
+    renderPageAsImageUrl?: (fileId: File['id'], pageIndex: number, options: {
+        width: number;
+    } | {
+        height: number;
+    }) => Promise<string>;
+    getEnv: () => Promise<PitcherEnv>;
+    onTrackShare?: never;
+    share?: never;
+    onEditMode: never;
+    inCall?: never;
+    myUserId?: never;
+    onDownloadFile?: (file: File | ContentGridFileProps | ContentGridCommonFileProps) => Promise<void>;
+    onDownloadCanvas?: (canvas: Canvas) => Promise<void>;
+};
+export interface CRMBuilderProps {
+    isCRM: true;
+    onSfdcAccountSearch: (searchTerm?: MaybeRef<string>) => {
+        accountsLoading: Ref<boolean>;
+        accounts: Ref<{
+            label: string;
+            value: string;
+        }[]>;
+    };
+}
+type AdminImpactCommonBuilderProps = {
+    isFullscreen?: boolean;
+    displayMode?: 'default' | 'print';
+    startPage?: number;
+    endPage?: number;
+    metadata: {
+        baseStackingContext?: number;
+        startInMode?: CanvasActions.Present | CanvasActions.Edit;
+    };
+    activeCanvas: Canvas;
+    templates: {
+        label: Canvas['name'];
+        value: Canvas['id'];
+    }[];
+    onExit: () => void;
+    onEnter?: () => void;
+    onComponentEnter?: (data: ComponentNode | Canvas, params: ComponentTrackingParams) => void;
+    onComponentExit?: (data: ComponentNode | Canvas, params: ComponentTrackingParams) => void;
+    onSave: (canvasId: Canvas['id'], canvas: PatchedCanvasUpdateRequest & {
+        fields?: string;
+    }, showToast?: boolean) => Promise<Canvas>;
+    onFileOpen: (file: FileOpenParams) => void;
+    deleteFile: (fileId: FileRetrieve['id']) => Promise<string | void>;
+    listFiles: (params?: any) => Promise<File[]>;
+    listCanvases: (params?: any) => Promise<PaginatedData<Canvas>>;
+    fetchFolder: (folderId: Folder['id'] | undefined) => Promise<FolderRetrieve>;
+    fetchFile: (fileId: FileRetrieve['id']) => Promise<FileRetrieve>;
+    fetchCanvas: (canvasId: Canvas['id']) => Promise<CanvasRetrieve>;
+    fetchInstanceMetadataTemplate: () => Promise<MetadataTemplate>;
+    renderPageAsImageUrl?: (fileId: File['id'], pageIndex: number, options: {
+        width: number;
+    } | {
+        height: number;
+    }) => Promise<string>;
+    getEnv?: () => Promise<PitcherEnv>;
+    onEditMode?: (isEditMode: boolean) => void;
+    onTrackShare?: (canvasId: Canvas['id']) => Promise<void>;
+    onOpenExternalUrl: (payload: OpenExternalUrlRequestPayload) => Promise<void>;
+    share?: (canvasId: Canvas['id']) => Promise<SharedLink>;
+    isCRM: boolean;
+    onDownloadFile?: (file: File | ContentGridFileProps | ContentGridCommonFileProps) => Promise<void>;
+    onDownloadCanvas?: (canvas: Canvas) => Promise<void>;
+};
+type AdminBuilderProps = AdminImpactCommonBuilderProps & (CRMBuilderProps | NoCRMBuilderProps) & {
+    isRedirectEvent?: never;
+    mode: CanvasBuilderMode.ADMIN;
+    inCall?: never;
+    myUserId?: never;
+};
+type ImpactBuilderProps = AdminImpactCommonBuilderProps & (CRMBuilderProps | NoCRMBuilderProps) & {
+    isRedirectEvent?: boolean;
+    mode: CanvasBuilderMode.IMPACT;
+    inCall?: boolean;
+    myUserId?: User['id'];
+};
+export type CanvasBuilderProps = AdminBuilderProps | ImpactBuilderProps | SharingBuilderProps;
+export {};

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

@@ -0,0 +1,2 @@
+export type FontAwesomeType = 'fa' | 'far' | 'fas' | 'fal' | 'fab' | 'fa-kit';
+export declare function isFontAwesomeType(type: string): type is FontAwesomeType;

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

@@ -0,0 +1,28 @@
+import { Canvas, File } from '../../../../types/openapi';
+
+export type RecommendedContent = {
+    type: 'file' | 'slide';
+    file: {
+        id: File['id'];
+    };
+    slide?: {
+        index: number;
+    };
+}[];
+export type Recommendations = {
+    recommendation_strategy?: 'force' | 'suggest';
+    sections?: {
+        id: Canvas['id'];
+        list_header_html?: string;
+        recommended?: boolean;
+        removed_by_user?: boolean;
+    }[];
+    recommended_content?: {
+        content_grids?: RecommendedContent;
+        sections?: {
+            [key: Canvas['id']]: {
+                content_grids?: RecommendedContent;
+            };
+        };
+    };
+};

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

@@ -0,0 +1,44 @@
+import { UnwrapRef } from 'vue';
+import { ComponentTypes, CarouselProps, ComponentNode, ContentGridProps, EmbeddableProps, GridItemProps, GridProps, HtmlProps, MultimediaProps, SectionComponentOverrides, SectionListProps, TextProps, CanvasBuilderMode, ComponentNodeVisible, LinkProps } from '@canvas-builder/types/canvas';
+import { Canvas } from '../../../../types/openapi';
+import { EmbedLocation } from '../../../types/app';
+import { SectionComponentNodesBySectionId, ComponentNodesById } from '@canvas-builder/composables/useCanvas';
+
+export declare function createNodeId(type?: ComponentTypes): string;
+export declare function getComponentKeywords(type: ComponentTypes, t: (input: string) => string): string[];
+export declare function getComponentTitle(type: ComponentTypes | string, t: (input: string) => string): string;
+export declare function getComponentDescription(type: ComponentTypes | string, t: (input: string) => string): string;
+export declare function getNodeDisplayNameByComponentType(node: ComponentNode | null | undefined): string;
+export declare function discardSectionComponentOverride(sectionId: Canvas['id'], componentId: ComponentNode['id'], overrides: SectionComponentOverrides): SectionComponentOverrides;
+export declare function addCanvasComponent(currentContent: ComponentNode[], add: {
+    type: ComponentTypes;
+    parentId?: ComponentNode['id'] | null;
+    afterSiblingId?: ComponentNode['id'] | null;
+    condition?: (node: ComponentNode[]) => boolean;
+    withData?: ComponentNode['data'] | null;
+    withChildren?: ComponentNode['children'];
+    withExtraNodeData?: Partial<ComponentNode>;
+}): {
+    newContent: ComponentNode<GridProps | GridItemProps | TextProps | CarouselProps | MultimediaProps | EmbeddableProps | ContentGridProps | SectionListProps | HtmlProps | LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>[];
+    newComponentId: null;
+} | {
+    newContent: ComponentNode<GridProps | GridItemProps | TextProps | CarouselProps | MultimediaProps | EmbeddableProps | ContentGridProps | SectionListProps | HtmlProps | LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>[];
+    newComponentId: string;
+};
+export declare function getAllPages(canvasContent: ComponentNode[], currentEmbedLocation: EmbedLocation, isEditMode?: boolean): ComponentNode<GridProps | GridItemProps | TextProps | CarouselProps | MultimediaProps | EmbeddableProps | ContentGridProps | SectionListProps | HtmlProps | LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>[][];
+export declare function getPageQuantity(canvasContent: ComponentNode[][]): number;
+export declare const getPageRange: (canvasContent: ComponentNode[], currentEmbedLocation: EmbedLocation, start?: number, end?: number) => ComponentNode[][];
+export declare function scrollCanvasToTop(): void;
+export declare function shouldShowEmbeddable(isEditMode: boolean, currentEmbedLocation: EmbedLocation, headlessLocations?: string[]): boolean;
+export declare const isHeadlessOrNotAvailableApp: (component: ComponentNode, isEditMode: boolean, currentEmbedLocation: EmbedLocation) => boolean;
+export declare function shouldDisplayPlaceholderComponent(isEditMode: boolean, mode: (typeof CanvasBuilderMode)[keyof typeof CanvasBuilderMode] | undefined, visibility?: ComponentNodeVisible): boolean;
+export declare function isTextComponentEmpty(component: ComponentNode, overrides?: SectionComponentOverrides, sectionId?: Canvas['id']): boolean;
+type FoundComponent = {
+    sectionId?: Canvas['id'];
+    sectionListId?: ComponentNode['id'];
+    componentId: ComponentNode['id'];
+} | null;
+export declare function findEmbeddableInSectionsContent(canvasPages: ComponentNode[][], sectionComponentNodesBySectionId: UnwrapRef<SectionComponentNodesBySectionId>, appName: string): FoundComponent;
+export declare function findEmbeddableInCanvasContent(componentNodesById: UnwrapRef<ComponentNodesById>, appName: string): FoundComponent;
+export declare function scrollToComponentById(id: ComponentNode['id'] | null | undefined, delay?: number): void;
+export {};

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

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

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

@@ -0,0 +1 @@
+export declare const simpleDeepClone: <T>(o: T) => T;

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

@@ -0,0 +1,6 @@
+import { PitcherInfo } from '../../../types/app';
+import { FileRetrieve } from '../../../../types/openapi';
+
+export declare const getFileNameWithoutExtension: (fileNameWithExtension: string) => string;
+export declare function getFileExtension(filename?: string): string;
+export declare function waitUntilFileViewable(id: FileRetrieve['id'], pitcherInfo: PitcherInfo): Promise<FileRetrieve>;

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

@@ -0,0 +1,24 @@
+import { ComponentTypes, HiddenElementsInCanvas } from '@canvas-builder/types/canvas';
+
+type Action<T> = (n: T) => void;
+type TreeLike = {
+    id: string;
+    children?: TreeLike[];
+    type?: ComponentTypes;
+    data?: any;
+};
+type Predicate<T> = (n: T) => boolean;
+export declare function applyToTreeBy<T extends TreeLike>(tree: T[], action: Action<T>, condition?: Predicate<T>): void;
+export declare function findNodeInTreeById<T extends TreeLike>(tree: T[], value: string | number, reverse?: boolean): T | null;
+export declare function findNodeInTreeByType<T extends TreeLike>(tree: T[], type: ComponentTypes, reverse?: boolean): T | null;
+export declare function findNodeInTreeByCondition<T extends TreeLike>(tree: T[], condition: Predicate<T>, reverse?: boolean): T | null;
+export declare function filterTreeBy<T extends TreeLike>(tree: T[], condition?: Predicate<T>): T[];
+export declare function collectAllNodesByCondition<T extends TreeLike>(tree: T[], condition: Predicate<T>): T[];
+export declare function findParentByNodeId<T extends TreeLike>(tree: T[], value: string | number): T | null;
+export declare function regenerateTreeIds<T extends TreeLike>(tree: T[]): T[];
+export declare function someNodeInTree<T extends TreeLike>(tree: T[], condition?: Predicate<T>): boolean;
+export declare function skipElementsInTree<T extends TreeLike>(tree: T[], idsToHide: {
+    sections: HiddenElementsInCanvas;
+    components: HiddenElementsInCanvas;
+}): T[];
+export {};

package/types/lib/apps/canvas-builder/util/tree.test.d.ts

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

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

@@ -0,0 +1,3 @@
+export type WithRequiredProperty<Type, Key extends keyof Type> = Type & {
+    [Property in Key]-?: Type[Property];
+};

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

@@ -0,0 +1,5 @@
+export declare function stripQueryParams(url?: string): string;
+export declare function isValidUrl(urlString: string): boolean;
+export declare function extractBaseUrlAndResource(urlString?: string | null): [string, string];
+export declare function extractBaseUrl(urlString?: string | null): string;
+export declare function extractResource(urlString?: string | null): string;

package/types/lib/apps/canvas-builder/util/url.test.d.ts

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

package/types/lib/apps/content-selector/appTypes.d.ts

@@ -0,0 +1,43 @@
+import { FolderRetrieve, Folder, File, FileRetrieve, FileContentTypeEnum } from '../../../types/openapi';
+import { Range } from '../../util/tsHelpers';
+import { SelectorType } from '@content-selector/stores/app';
+
+type FileFetcher = (fileId: FileRetrieve['id']) => Promise<FileRetrieve>;
+type FolderItemsFetcher = (folderId: Folder['id'] | undefined) => Promise<FolderRetrieve>;
+type FileListFetcher = (params?: any) => Promise<File[]>;
+type FileDeleter = (fileId: FileRetrieve['id']) => Promise<string | void>;
+export type ContentSelection = {
+    fileId: FileRetrieve['id'];
+    type: 'file' | 'page';
+    pageIndex?: number;
+};
+export type ExternalLinkSelection = {
+    url: string;
+    type: 'external_link';
+    content_type: 'video' | 'image';
+};
+export type AssetSelection = {
+    fileId: FileRetrieve['id'];
+    type: 'asset';
+};
+export type Selection = ContentSelection | ExternalLinkSelection | AssetSelection;
+export type AppProps = {
+    appName: 'impact' | 'admin';
+    allowedSelectorTypes?: SelectorType[];
+    allowedContentTypes?: FileContentTypeEnum[];
+    contentType: 'file' | 'slide' | 'content';
+    onFolderFetch?: FolderItemsFetcher;
+    onFileDelete?: FileDeleter;
+    onFileFetch?: FileFetcher;
+    onFilesList?: FileListFetcher;
+    onFileOpen?: ({ fileId, pageIndex, newTab, }: {
+        fileId: FileRetrieve['id'];
+        pageIndex?: number;
+        newTab?: boolean;
+    }) => void;
+    selections?: Selection[];
+    primaryActionText?: string;
+    maxSelections?: number;
+    minSelections?: Range<0, 999>;
+};
+export {};