@pitcher/js-api 1.22.0-alpha.3 → 1.22.0-alpha.5

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 (47) hide show
  1. package/js-api.esm.js +139 -43
  2. package/js-api.esm.js.map +1 -1
  3. package/js-api.umd.min.js +10 -10
  4. package/js-api.umd.min.js.map +1 -1
  5. package/lib/api/canvases/canvases.queries.d.ts +1 -1
  6. package/lib/apps/browser/stores/api.d.ts +53 -53
  7. package/lib/apps/browser/stores/app.d.ts +18 -17
  8. package/lib/apps/browser/stores/upload.d.ts +29 -29
  9. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +607 -621
  10. package/lib/apps/canvas-builder/composables/useCanvasDnd.d.ts +12 -0
  11. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +93 -95
  12. package/lib/apps/canvas-builder/composables/useCanvasPages.d.ts +1 -0
  13. package/lib/apps/canvas-builder/composables/useCanvasSectionOverrides.d.ts +8 -7
  14. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +11 -11
  15. package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts +5 -4
  16. package/lib/apps/canvas-builder/composables/useCollapsibles.d.ts +2 -2
  17. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +9 -9
  18. package/lib/apps/canvas-builder/composables/useRecommendations.d.ts +12 -10
  19. package/lib/apps/canvas-builder/types/canvas.d.ts +4 -3
  20. package/lib/apps/canvas-builder/util/tree.d.ts +1 -0
  21. package/lib/apps/content-selector/stores/app.d.ts +16 -15
  22. package/lib/components/CFileViewer/CFileViewer.use.d.ts +1 -1
  23. package/lib/composables/bulkActions.use.d.ts +4 -4
  24. package/lib/composables/recentFiles.use.d.ts +1 -1
  25. package/lib/composables/useDetailsView.d.ts +1 -1
  26. package/lib/composables/useLocation.d.ts +1 -1
  27. package/lib/composables/useLocationAPI.d.ts +2 -2
  28. package/lib/composables/useLocationManipulation.d.ts +1 -1
  29. package/lib/composables/useToast.d.ts +2 -2
  30. package/lib/custom-naive-locales/el.d.ts +1 -1
  31. package/lib/main.lib.d.ts +1 -1
  32. package/lib/sdk/api/HighLevelApi.d.ts +31 -31
  33. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +6 -1
  34. package/lib/sdk/api/modules/ui/content.ui.d.ts +5 -5
  35. package/lib/sdk/api/modules/ui/index.d.ts +9 -2
  36. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +6 -0
  37. package/lib/sdk/api/modules/ui/types.ui.d.ts +74 -10
  38. package/lib/sdk/interfaces.d.ts +3 -5
  39. package/lib/sdk/main.d.ts +140 -95
  40. package/lib/theme/light.d.ts +5 -315
  41. package/lib/types/instanceSettings.d.ts +1 -0
  42. package/lib/types/launchDarkly.types.d.ts +1 -1
  43. package/lib/types/organization.types.d.ts +14 -0
  44. package/lib/types/organizationSettings.types.d.ts +3 -0
  45. package/lib/util/network.d.ts +1 -1
  46. package/package.json +1 -1
  47. /package/lib/types/{organization.d.ts → organizationMetadata.types.d.ts} +0 -0
@@ -0,0 +1,12 @@
1
+ import { ComponentNode } from '@canvas-builder/types/canvas';
2
+
3
+ export declare function useCanvasDnd(id: ComponentNode['id']): {
4
+ isDraggingNode: import('vue').Ref<boolean>;
5
+ highlightedZone: import('vue').Ref<"bottom" | "left" | "right" | "top" | null>;
6
+ currentDraggedComponentId: import('vue').Ref<string | null>;
7
+ currentDraggedOverComponentId: import('vue').Ref<string | null>;
8
+ onDragOver: import('lodash').DebouncedFunc<(e: DragEvent | TouchEvent) => void>;
9
+ onDragStart: (e: DragEvent | TouchEvent) => void;
10
+ onDragEnd: (e: DragEvent | TouchEvent) => void;
11
+ setStartedFromHandle: (value: boolean) => void;
12
+ };
@@ -1,12 +1,12 @@
1
- import { CanvasHistoryAction, ComponentTypes } from '@canvas-builder/types/canvas';
1
+ import { ComponentNode, CanvasHistoryAction, ComponentTypes } from '@canvas-builder/types/canvas';
2
2
 
3
3
  export default function useCanvasHistory(): {
4
4
  activeHistoryItemIndex: import('vue').ComputedRef<number>;
5
5
  canvasHistory: import('vue').Ref<{
6
- active?: boolean | undefined;
6
+ active?: boolean;
7
7
  action: CanvasHistoryAction;
8
8
  componentType: ComponentTypes;
9
- icon?: string | undefined;
9
+ icon?: string;
10
10
  id: string;
11
11
  snapshot: {
12
12
  id: string;
@@ -18,155 +18,153 @@ export default function useCanvasHistory(): {
18
18
  pdf: boolean;
19
19
  web: boolean;
20
20
  } | undefined;
21
- allow_admins_to_overwrite?: boolean | undefined;
22
- autofill?: "off" | "ai" | "matching_metadata" | "matching_tags" | "matching_metadata_or_tags" | undefined;
23
- autofill_content_types?: import('../../../main.lib').FileContentTypeEnum[] | null | undefined;
21
+ allow_admins_to_overwrite?: boolean;
22
+ autofill?: "off" | "ai" | "matching_metadata" | "matching_tags" | "matching_metadata_or_tags";
23
+ autofill_content_types?: import('../../../main.lib').FileContentTypeEnum[] | null;
24
24
  data?: import('@canvas-builder/types/canvas').PageBreakProps | {
25
25
  layout_type: import('@canvas-builder/types/canvas').GridLayoutTypes;
26
26
  columns: number;
27
27
  } | {
28
28
  span: number;
29
29
  tooltips?: {
30
- content?: string | undefined;
31
- content_style?: Record<string, any> | undefined;
32
- trigger?: string | undefined;
33
- trigger_style?: Record<string, any> | undefined;
30
+ content?: string;
31
+ content_style?: Record<string, any>;
32
+ trigger?: string;
33
+ trigger_style?: Record<string, any>;
34
34
  }[] | undefined;
35
35
  } | {
36
- content?: string | undefined;
36
+ content?: string;
37
37
  } | {
38
38
  images?: {
39
39
  url: string;
40
- is_uploaded_asset?: boolean | undefined;
40
+ is_uploaded_asset?: boolean;
41
41
  }[] | undefined;
42
- placeholder_height?: string | undefined;
43
- include_all_images_in_pdf?: boolean | undefined;
42
+ placeholder_height?: string;
43
+ include_all_images_in_pdf?: boolean;
44
44
  } | {
45
45
  asset_type: "external";
46
46
  external_url: string;
47
- type: "video" | "image";
48
- horizontal_alignment?: import('@canvas-builder/types/canvas').MultimediaHorizontalAlignmentOptions | undefined;
47
+ type: "image" | "video";
48
+ horizontal_alignment?: import('@canvas-builder/types/canvas').MultimediaHorizontalAlignmentOptions;
49
49
  } | {
50
50
  asset_type: "pitcher_asset";
51
51
  file: {
52
- id: string;
53
- name: string | undefined;
54
- content_url?: string | null | undefined;
52
+ id: import('../../../main.lib').File["id"];
53
+ name: import('../../../main.lib').File["name"];
54
+ content_url?: import('../../../main.lib').File["content_url"];
55
55
  };
56
- type: "video" | "image";
57
- horizontal_alignment?: import('@canvas-builder/types/canvas').MultimediaHorizontalAlignmentOptions | undefined;
56
+ type: "image" | "video";
57
+ horizontal_alignment?: import('@canvas-builder/types/canvas').MultimediaHorizontalAlignmentOptions;
58
58
  } | {
59
59
  type: "app";
60
60
  app_name: string;
61
61
  src: string | null;
62
- height?: string | undefined;
63
- width?: string | undefined;
64
- embed_locations?: import('../../../main.lib').EmbedLocation[] | undefined;
65
- headless_locations?: import('../../../main.lib').EmbedLocation[] | undefined;
62
+ height?: string;
63
+ width?: string;
64
+ embed_locations?: import('../../../main.lib').EmbedLocation[];
65
+ headless_locations?: import('../../../main.lib').EmbedLocation[];
66
66
  properties_by_embed_location?: {
67
67
  canvas?: {
68
- start_in_loading_mode?: boolean | undefined;
68
+ start_in_loading_mode?: boolean;
69
69
  } | undefined;
70
70
  dsr?: {
71
- start_in_loading_mode?: boolean | undefined;
71
+ start_in_loading_mode?: boolean;
72
72
  } | undefined;
73
73
  ui_app?: {
74
- start_in_loading_mode?: boolean | undefined;
74
+ start_in_loading_mode?: boolean;
75
75
  } | undefined;
76
76
  admin_instance?: {
77
- start_in_loading_mode?: boolean | undefined;
77
+ start_in_loading_mode?: boolean;
78
78
  } | undefined;
79
79
  } | undefined;
80
80
  file: {
81
- id: string;
82
- snapshot_id?: string | undefined;
83
- name: string | undefined;
84
- is_deleted?: boolean | undefined;
85
- content_url: string | null;
81
+ id: import('../../../main.lib').FileRetrieve["id"];
82
+ snapshot_id?: import('../../../main.lib').FileRetrieve["id"];
83
+ name: import('../../../main.lib').FileRetrieve["name"];
84
+ is_deleted?: boolean;
85
+ content_url: import('../../../main.lib').FileRetrieve["content_url"];
86
86
  content_type: import('../../../main.lib').FileContentTypeEnum | null;
87
- content_extension: string | null;
88
- thumbnail_url?: string | null | undefined;
89
- content_length: number | null;
90
- content_thumbnails?: string[] | null | undefined;
91
- readonly pspdfkit_token?: string | undefined;
92
- readonly pspdfkit_server_url?: string | null | undefined;
93
- readonly pspdfkit_auth_payload?: Record<string, any> | null | undefined;
87
+ content_extension: import('../../../main.lib').FileRetrieve["content_extension"];
88
+ thumbnail_url?: import('../../../main.lib').FileRetrieve["thumbnail_url"];
89
+ content_length: import('../../../main.lib').FileRetrieve["content_length"];
90
+ content_thumbnails?: import('../../../main.lib').FileRetrieve["content_thumbnails"] | null;
91
+ readonly pspdfkit_server_url?: import('../../../components/CFileViewer/CFileViewer.types').FileModel["pspdfkit_server_url"];
92
+ readonly pspdfkit_auth_payload?: import('../../../components/CFileViewer/CFileViewer.types').FileModel["pspdfkit_auth_payload"];
94
93
  } | null;
95
- settings?: Record<string, unknown> | undefined;
94
+ settings?: Record<string, unknown>;
96
95
  } | {
97
96
  items: ({
98
97
  file: {
99
- id: string;
100
- snapshot_id?: string | undefined;
101
- name: string | undefined;
102
- is_deleted?: boolean | undefined;
103
- content_url?: string | null | undefined;
104
- content_type?: import('../../../main.lib').FileContentTypeEnum | null | undefined;
105
- content_extension?: string | null | undefined;
98
+ id: import('../../../main.lib').FileRetrieve["id"];
99
+ snapshot_id?: import('../../../main.lib').FileRetrieve["id"];
100
+ name: import('../../../main.lib').FileRetrieve["name"];
101
+ is_deleted?: boolean;
102
+ content_url?: import('../../../main.lib').FileRetrieve["content_url"];
103
+ content_type?: import('../../../main.lib').FileContentTypeEnum | null;
104
+ content_extension?: import('../../../main.lib').FileRetrieve["content_extension"];
106
105
  };
107
106
  slide: {
108
107
  index: number;
109
- url?: string | undefined;
108
+ url?: import('../../../main.lib').FileRetrieve["content_thumbnails"][number];
110
109
  };
111
110
  type: "slide";
112
111
  } | {
113
112
  file: {
114
- id: string;
115
- snapshot_id?: string | undefined;
116
- name: string | undefined;
117
- is_deleted?: boolean | undefined;
118
- content_url: string | null;
113
+ id: import('../../../main.lib').FileRetrieve["id"];
114
+ snapshot_id?: import('../../../main.lib').FileRetrieve["id"];
115
+ name: import('../../../main.lib').FileRetrieve["name"];
116
+ is_deleted?: boolean;
117
+ content_url: import('../../../main.lib').FileRetrieve["content_url"];
119
118
  content_type: import('../../../main.lib').FileContentTypeEnum | null;
120
- content_extension: string | null;
121
- thumbnail_url?: string | null | undefined;
122
- content_length: number | null;
123
- content_thumbnails?: string[] | null | undefined;
124
- readonly pspdfkit_token?: string | undefined;
125
- readonly pspdfkit_server_url?: string | null | undefined;
126
- readonly pspdfkit_auth_payload?: Record<string, any> | null | undefined;
119
+ content_extension: import('../../../main.lib').FileRetrieve["content_extension"];
120
+ thumbnail_url?: import('../../../main.lib').FileRetrieve["thumbnail_url"];
121
+ content_length: import('../../../main.lib').FileRetrieve["content_length"];
122
+ content_thumbnails?: import('../../../main.lib').FileRetrieve["content_thumbnails"] | null;
123
+ readonly pspdfkit_server_url?: import('../../../components/CFileViewer/CFileViewer.types').FileModel["pspdfkit_server_url"];
124
+ readonly pspdfkit_auth_payload?: import('../../../components/CFileViewer/CFileViewer.types').FileModel["pspdfkit_auth_payload"];
127
125
  };
128
126
  type: "file";
129
127
  })[];
130
- size?: "medium" | undefined;
131
- layout_type?: import('@canvas-builder/types/canvas').ContentGridLayoutTypes | undefined;
128
+ size?: "medium";
129
+ layout_type?: import('@canvas-builder/types/canvas').ContentGridLayoutTypes;
132
130
  } | {
133
131
  sections: {
134
132
  id: string;
135
- style?: Record<string, any> | undefined;
136
- aspect_ratio?: "unlocked" | "16:9" | "16:10" | "4:3" | "1:1" | undefined;
137
- background_video_url?: string | undefined;
133
+ style?: Record<string, any>;
134
+ aspect_ratio?: "unlocked" | "16:9" | "16:10" | "4:3" | "1:1";
135
+ background_video_url?: string;
138
136
  }[];
139
- animation_in?: string | undefined;
137
+ animation_in?: string;
140
138
  } | {
141
139
  html: string;
142
140
  } | {
143
- alignment?: import('@canvas-builder/types/canvas').LinkAlignmentTypes | undefined;
144
- background_color?: string | undefined;
145
- canvas_anchor?: string | undefined;
146
- color?: string | undefined;
147
- display_text?: string | undefined;
148
- font_family?: string | undefined;
149
- font_size?: number | undefined;
150
- link_type?: import('@canvas-builder/types/canvas').LinkAnchorTypes | undefined;
151
- preview_type?: import('@canvas-builder/types/canvas').LinkPreviewTypes | undefined;
152
- target?: "_self" | "_blank" | undefined;
153
- url?: string | undefined;
141
+ alignment?: import('@canvas-builder/types/canvas').LinkAlignmentTypes;
142
+ background_color?: string;
143
+ canvas_anchor?: string;
144
+ color?: string;
145
+ display_text?: string;
146
+ font_family?: string;
147
+ font_size?: number;
148
+ link_type?: import('@canvas-builder/types/canvas').LinkAnchorTypes;
149
+ preview_type?: import('@canvas-builder/types/canvas').LinkPreviewTypes;
150
+ target?: "_self" | "_blank";
151
+ url?: string;
154
152
  } | {
155
- aspect_ratio?: "unlocked" | "16:9" | "16:10" | "4:3" | "1:1" | undefined;
156
- background_video_url?: string | undefined;
153
+ aspect_ratio?: "unlocked" | "16:9" | "16:10" | "4:3" | "1:1";
154
+ background_video_url?: string;
157
155
  } | {
158
156
  events: {
159
- top_hint?: string | undefined;
160
- top_hint_style?: Record<string, any> | undefined;
161
- title?: string | undefined;
162
- title_style?: Record<string, any> | undefined;
163
- description?: string | undefined;
164
- description_style?: Record<string, any> | undefined;
165
- image_url?: string | undefined;
166
- image_style?: Record<string, any> | undefined;
167
- icon?: string | undefined;
168
- icon_style?: Record<string, any> | undefined;
169
- card_style?: Record<string, any> | undefined;
157
+ top_hint?: string;
158
+ top_hint_style?: Record<string, any>;
159
+ title?: string;
160
+ title_style?: Record<string, any>;
161
+ description?: string;
162
+ description_style?: Record<string, any>;
163
+ image_url?: string;
164
+ image_style?: Record<string, any>;
165
+ icon?: string;
166
+ icon_style?: Record<string, any>;
167
+ card_style?: Record<string, any>;
170
168
  }[];
171
169
  layout: "vertical" | "horizontal";
172
170
  } | undefined;
@@ -552,7 +550,7 @@ export default function useCanvasHistory(): {
552
550
  writingMode?: import("csstype").Property.WritingMode | undefined;
553
551
  zIndex?: import("csstype").Property.ZIndex | undefined;
554
552
  zoom?: import("csstype").Property.Zoom | undefined;
555
- all?: import('csstype').Globals | undefined;
553
+ all?: import("csstype").Property.All | undefined;
556
554
  animation?: import("csstype").Property.Animation<string & {}> | undefined;
557
555
  animationRange?: import("csstype").Property.AnimationRange<string | number> | undefined;
558
556
  background?: import("csstype").Property.Background<string | number> | undefined;
@@ -1769,13 +1767,13 @@ export default function useCanvasHistory(): {
1769
1767
  "text-anchor"?: import("csstype").Property.TextAnchor | undefined;
1770
1768
  "vector-effect"?: import("csstype").Property.VectorEffect | undefined;
1771
1769
  } | undefined;
1772
- tags?: string[] | undefined;
1770
+ tags?: string[];
1773
1771
  }[];
1774
1772
  timestamp: string;
1775
1773
  }[]>;
1776
1774
  addCanvasHistoryItem: ({ action, componentType, }: {
1777
1775
  action: CanvasHistoryAction;
1778
- componentType: ComponentTypes;
1776
+ componentType: ComponentNode["type"];
1779
1777
  }) => void;
1780
1778
  applyHistoryItem: (id: string) => void;
1781
1779
  undoCanvasHistoryItem: () => void;
@@ -10,6 +10,7 @@ declare function goToPage(componentId: ComponentNode['id'], sectionId?: Canvas['
10
10
  }): void;
11
11
  declare function reset(): void;
12
12
  export default function useCanvasPages(): {
13
+ activeSectionId: ComputedRef<string | null>;
13
14
  activeSectionTheme: ComputedRef<any>;
14
15
  canvasPages: ComputedRef<ComponentNode<import('@canvas-builder/types/canvas').GridProps | import('@canvas-builder/types/canvas').GridItemProps | import('@canvas-builder/types/canvas').TextProps | import('@canvas-builder/types/canvas').CarouselProps | import('@canvas-builder/types/canvas').MultimediaProps | import('@canvas-builder/types/canvas').EmbeddableProps | import('@canvas-builder/types/canvas').ContentGridProps | SectionListProps | import('@canvas-builder/types/canvas').HtmlProps | import('@canvas-builder/types/canvas').LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>[][]>;
15
16
  currentPageIndex: import('vue').Ref<number>;
@@ -1,5 +1,6 @@
1
1
  import { Ref } from 'vue';
2
- import { SectionComponentOverrides } from '@canvas-builder/types/canvas';
2
+ import { Canvas } from '../../../../types/openapi';
3
+ import { ComponentNode, SectionComponentOverrides } from '@canvas-builder/types/canvas';
3
4
 
4
5
  declare function discardOverridesConfirmationOptions(t: (input: string) => string, callback: () => void): {
5
6
  title: string;
@@ -11,17 +12,17 @@ declare function discardOverridesConfirmationOptions(t: (input: string) => strin
11
12
  };
12
13
  declare function cleanup(): void;
13
14
  export default function useCanvasSectionOverrides(): {
14
- getComponentOverrides: (data: Ref<(import('@canvas-builder/types/canvas').GridProps | import('@canvas-builder/types/canvas').GridItemProps | import('@canvas-builder/types/canvas').TextProps | import('@canvas-builder/types/canvas').CarouselProps | import('@canvas-builder/types/canvas').MultimediaProps | import('@canvas-builder/types/canvas').EmbeddableProps | import('@canvas-builder/types/canvas').ContentGridProps | import('@canvas-builder/types/canvas').SectionListProps | import('@canvas-builder/types/canvas').HtmlProps | import('@canvas-builder/types/canvas').LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps) | undefined>, id: Ref<string>, sectionId?: Ref<string> | undefined) => import('vue').ComputedRef<{
15
+ getComponentOverrides: (data: Ref<ComponentNode["data"]>, id: Ref<ComponentNode["id"]>, sectionId?: Ref<Canvas["id"]>) => import('vue').ComputedRef<{
15
16
  data: (import('@canvas-builder/types/canvas').GridProps | import('@canvas-builder/types/canvas').GridItemProps | import('@canvas-builder/types/canvas').TextProps | import('@canvas-builder/types/canvas').CarouselProps | import('@canvas-builder/types/canvas').MultimediaProps | import('@canvas-builder/types/canvas').EmbeddableProps | import('@canvas-builder/types/canvas').ContentGridProps | import('@canvas-builder/types/canvas').SectionListProps | import('@canvas-builder/types/canvas').HtmlProps | import('@canvas-builder/types/canvas').LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps) | undefined;
16
17
  is_removed: boolean;
17
18
  }>;
18
19
  discardOverridesConfirmationOptions: typeof discardOverridesConfirmationOptions;
19
20
  overrideSectionComponentData: ({ usedInSectionId, componentId, componentData, afterSiblingId, remove, }: {
20
- usedInSectionId: string;
21
- componentId: string;
22
- componentData?: (import('@canvas-builder/types/canvas').GridProps | import('@canvas-builder/types/canvas').GridItemProps | import('@canvas-builder/types/canvas').TextProps | import('@canvas-builder/types/canvas').CarouselProps | import('@canvas-builder/types/canvas').MultimediaProps | import('@canvas-builder/types/canvas').EmbeddableProps | import('@canvas-builder/types/canvas').ContentGridProps | import('@canvas-builder/types/canvas').SectionListProps | import('@canvas-builder/types/canvas').HtmlProps | import('@canvas-builder/types/canvas').LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps) | undefined;
23
- afterSiblingId?: string | undefined;
24
- remove?: boolean | undefined;
21
+ usedInSectionId: Canvas["id"];
22
+ componentId: ComponentNode["id"];
23
+ componentData?: ComponentNode["data"];
24
+ afterSiblingId?: ComponentNode["id"];
25
+ remove?: boolean;
25
26
  }) => void;
26
27
  cleanup: typeof cleanup;
27
28
  sectionComponentOverrides: Ref<SectionComponentOverrides>;
@@ -26,7 +26,7 @@ export default function useCanvasTheme(): {
26
26
  customFonts: import('vue').Ref<{
27
27
  readonly id: string;
28
28
  readonly global_id: string;
29
- name?: string | undefined;
29
+ name?: string;
30
30
  readonly type: FileTypeEnum;
31
31
  readonly size: number | null;
32
32
  readonly status: import('../../../../types/openapi/index').FileStatusEnum;
@@ -36,33 +36,33 @@ export default function useCanvasTheme(): {
36
36
  readonly content_url: string | null;
37
37
  readonly original_extension: string | null;
38
38
  readonly thumbnail_url: string | null;
39
- download_type?: import('../../../../types/openapi/index').DownloadTypeEnum | undefined;
39
+ download_type?: import('../../../../types/openapi/index').DownloadTypeEnum;
40
40
  readonly zip_size: number | null;
41
41
  readonly zip_url: string | null;
42
- access_type?: import('../../../../types/openapi/index').AccessTypeEnum | undefined;
42
+ access_type?: import('../../../../types/openapi/index').AccessTypeEnum;
43
43
  readonly role: import('../../../../types/openapi/index').CollaborationRoleEnum;
44
- metadata?: Record<string, any> | undefined;
45
- app_metadata?: Record<string, any> | undefined;
46
- tags?: string[] | undefined;
44
+ metadata?: Record<string, any>;
45
+ app_metadata?: Record<string, any>;
46
+ tags?: Array<string>;
47
47
  readonly published_at: string | null;
48
- expires_at?: string | null | undefined;
48
+ expires_at?: string | null;
49
49
  readonly instance_id: string;
50
- folder_id?: string | undefined;
50
+ folder_id?: string;
51
51
  readonly shared_link: {
52
52
  readonly url: string;
53
- short_url?: string | null | undefined;
53
+ short_url?: string | null;
54
54
  };
55
55
  readonly created_at: string;
56
56
  readonly created_by: {
57
57
  readonly id: number;
58
58
  readonly name: string;
59
- email?: string | undefined;
59
+ email?: string;
60
60
  };
61
61
  readonly modified_at: string;
62
62
  readonly modified_by: {
63
63
  readonly id: number;
64
64
  readonly name: string;
65
- email?: string | undefined;
65
+ email?: string;
66
66
  };
67
67
  }[]>;
68
68
  isEditingCanvasTheme: import('vue').Ref<boolean>;
@@ -1,8 +1,9 @@
1
- import { ComponentTypes, ComponentNode, ComponentNodeVisible } from '@canvas-builder/types/canvas';
1
+ import { Canvas } from '../../../../types/openapi';
2
+ import { ComponentNode, ComponentNodeVisible } from '@canvas-builder/types/canvas';
2
3
 
3
4
  export default function useCanvasVisibility(): {
4
- getComponentDefaultVisibility: (type: ComponentTypes, mode?: keyof ComponentNodeVisible | undefined) => boolean;
5
- getVisibleCanvasContent: (data: ComponentNode<import('@canvas-builder/types/canvas').GridProps | import('@canvas-builder/types/canvas').GridItemProps | import('@canvas-builder/types/canvas').TextProps | import('@canvas-builder/types/canvas').CarouselProps | import('@canvas-builder/types/canvas').MultimediaProps | import('@canvas-builder/types/canvas').EmbeddableProps | import('@canvas-builder/types/canvas').ContentGridProps | import('@canvas-builder/types/canvas').SectionListProps | import('@canvas-builder/types/canvas').HtmlProps | import('@canvas-builder/types/canvas').LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>[], mode?: keyof ComponentNodeVisible | undefined) => ComponentNode<import('@canvas-builder/types/canvas').GridProps | import('@canvas-builder/types/canvas').GridItemProps | import('@canvas-builder/types/canvas').TextProps | import('@canvas-builder/types/canvas').CarouselProps | import('@canvas-builder/types/canvas').MultimediaProps | import('@canvas-builder/types/canvas').EmbeddableProps | import('@canvas-builder/types/canvas').ContentGridProps | import('@canvas-builder/types/canvas').SectionListProps | import('@canvas-builder/types/canvas').HtmlProps | import('@canvas-builder/types/canvas').LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>[];
5
+ getComponentDefaultVisibility: (type: ComponentNode["type"], mode?: keyof ComponentNodeVisible) => boolean;
6
+ getVisibleCanvasContent: (data: ComponentNode[], mode?: keyof ComponentNodeVisible) => ComponentNode<import('@canvas-builder/types/canvas').GridProps | import('@canvas-builder/types/canvas').GridItemProps | import('@canvas-builder/types/canvas').TextProps | import('@canvas-builder/types/canvas').CarouselProps | import('@canvas-builder/types/canvas').MultimediaProps | import('@canvas-builder/types/canvas').EmbeddableProps | import('@canvas-builder/types/canvas').ContentGridProps | import('@canvas-builder/types/canvas').SectionListProps | import('@canvas-builder/types/canvas').HtmlProps | import('@canvas-builder/types/canvas').LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>[];
6
7
  getVisibleKey: () => keyof ComponentNodeVisible | undefined;
7
- shouldRenderComponentWrapper: (c: ComponentNode<import('@canvas-builder/types/canvas').GridProps | import('@canvas-builder/types/canvas').GridItemProps | import('@canvas-builder/types/canvas').TextProps | import('@canvas-builder/types/canvas').CarouselProps | import('@canvas-builder/types/canvas').MultimediaProps | import('@canvas-builder/types/canvas').EmbeddableProps | import('@canvas-builder/types/canvas').ContentGridProps | import('@canvas-builder/types/canvas').SectionListProps | import('@canvas-builder/types/canvas').HtmlProps | import('@canvas-builder/types/canvas').LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>, sectionId?: string | undefined) => boolean | undefined;
8
+ shouldRenderComponentWrapper: (c: ComponentNode, sectionId?: Canvas["id"]) => boolean | undefined;
8
9
  };
@@ -5,8 +5,8 @@ declare function resetClickedOnSection(): void;
5
5
  declare function setClickedOnSection(sectionListId: ComponentNode['id'], sectionId: Canvas['id']): void;
6
6
  export default function useCanvasTheme(): {
7
7
  clickedOnSection: Readonly<import('vue').Ref<{
8
- readonly sectionListId: string;
9
- readonly sectionId: string;
8
+ readonly sectionListId: ComponentNode["id"];
9
+ readonly sectionId: Canvas["id"];
10
10
  } | undefined>>;
11
11
  resetClickedOnSection: typeof resetClickedOnSection;
12
12
  setClickedOnSection: typeof setClickedOnSection;
@@ -24,23 +24,23 @@ declare function prepareMultimediaNodeData({ selectedItems, }: {
24
24
  export default function (): {
25
25
  clearContentSelectorMode: typeof clearContentSelectorMode;
26
26
  contentSelectorMode: import('vue').Ref<false | {
27
- id: string | null;
28
- componentType: ComponentTypes.ContentGrid | ComponentTypes.Multimedia;
27
+ id: ComponentNode["id"] | null;
28
+ componentType: Extract<ComponentTypes, ComponentTypes.ContentGrid | ComponentTypes.Multimedia>;
29
29
  selections?: ({
30
- fileId: string;
31
- type: "page" | "file";
32
- pageIndex?: number | undefined;
30
+ fileId: FileRetrieve["id"];
31
+ type: "file" | "page";
32
+ pageIndex?: number;
33
33
  } | {
34
34
  url: string;
35
35
  type: "external_link";
36
36
  content_type: "video" | "image";
37
37
  } | {
38
- fileId: string;
38
+ fileId: FileRetrieve["id"];
39
39
  type: "asset";
40
40
  })[] | undefined;
41
- allowedSelectorTypes?: SelectorType[] | undefined;
42
- allowedContentTypes?: FileContentTypeEnum[] | undefined;
43
- maxSelections?: number | undefined;
41
+ allowedSelectorTypes?: SelectorType[];
42
+ allowedContentTypes?: FileContentTypeEnum[];
43
+ maxSelections?: number;
44
44
  }>;
45
45
  setContentSelectorMode: typeof setContentSelectorMode;
46
46
  prepareContentGridNodeData: typeof prepareContentGridNodeData;
@@ -2,7 +2,8 @@ import { AxiosInstance } from 'axios';
2
2
  import { PitcherInfo } from '../../../types/app';
3
3
  import { ContentGridProps, CanvasBuilderProps } from '@canvas-builder/types/canvas';
4
4
  import { RecommendedContent } from '@canvas-builder/types/recommendations.types';
5
- import { Canvas, File } from '../../../../types/openapi';
5
+ import { Canvas } from '../../../../types/openapi';
6
+ import { InstanceSettings } from '../../../types/instanceSettings';
6
7
 
7
8
  declare function autofillCanvasContentGridsWithAi(filesFetcher: NonNullable<CanvasBuilderProps['listFiles']>): Promise<void>;
8
9
  declare function autofillSectionContentGridsWithAi(filesFetcher: NonNullable<CanvasBuilderProps['listFiles']>): Promise<void>;
@@ -10,6 +11,7 @@ declare function autofillSectionContentGridsWithMatchingProperties(sectionId: Ca
10
11
  filesFetcher: NonNullable<CanvasBuilderProps['listFiles']>;
11
12
  http: AxiosInstance;
12
13
  pitcherInfo: PitcherInfo;
14
+ instanceSettings: InstanceSettings;
13
15
  }): Promise<void>;
14
16
  declare function autofillCanvasContentGridsWithMatchingProperties(options: {
15
17
  filesFetcher: NonNullable<CanvasBuilderProps['listFiles']>;
@@ -19,20 +21,20 @@ declare function autofillCanvasContentGridsWithMatchingProperties(options: {
19
21
  declare function cleanup(): void;
20
22
  export default function useRecommendations(): {
21
23
  contextSections: import('vue').ComputedRef<{
22
- id: string;
23
- list_header_html?: string | undefined;
24
- recommended?: boolean | undefined;
25
- removed_by_user?: boolean | undefined;
24
+ id: Canvas["id"];
25
+ list_header_html?: string;
26
+ recommended?: boolean;
27
+ removed_by_user?: boolean;
26
28
  }[]>;
27
29
  listHeaderHtmlBySectionId: import('vue').ComputedRef<Record<string, string>>;
28
30
  recommendationStrategy: import('vue').ComputedRef<"force" | "suggest" | undefined>;
29
31
  recommendedContent: import('vue').ComputedRef<{
30
- content_grids?: RecommendedContent | undefined;
32
+ content_grids?: RecommendedContent;
31
33
  sections?: {
32
- [key: string]: {
33
- content_grids?: RecommendedContent | undefined;
34
+ [key: Canvas["id"]]: {
35
+ content_grids?: RecommendedContent;
34
36
  };
35
- } | undefined;
37
+ };
36
38
  }>;
37
39
  recommendedSectionIds: import('vue').ComputedRef<string[]>;
38
40
  standaloneSectionContentGridsWithMatchingPropertiesPreviewData: import('vue').Ref<Record<string, ContentGridProps>>;
@@ -41,7 +43,7 @@ export default function useRecommendations(): {
41
43
  autofillSectionContentGridsWithAi: typeof autofillSectionContentGridsWithAi;
42
44
  autofillSectionContentGridsWithMatchingProperties: typeof autofillSectionContentGridsWithMatchingProperties;
43
45
  previewStandaloneSectionContentGridsWithMatchingProperties: (options: {
44
- filesFetcher: (params?: any) => Promise<File[]>;
46
+ filesFetcher: NonNullable<CanvasBuilderProps["listFiles"]>;
45
47
  http: AxiosInstance;
46
48
  pitcherInfo: PitcherInfo;
47
49
  }) => Promise<void>;
@@ -71,7 +71,6 @@ export interface CanvasFile {
71
71
  readonly thumbnail_url: FileModel['thumbnail_url'];
72
72
  readonly content_length: FileModel['content_length'];
73
73
  readonly content_thumbnails: FileModel['content_thumbnails'];
74
- readonly pspdfkit_token?: string;
75
74
  readonly pspdfkit_server_url?: FileModel['pspdfkit_server_url'];
76
75
  readonly pspdfkit_auth_payload?: FileModel['pspdfkit_auth_payload'];
77
76
  }
@@ -117,7 +116,6 @@ export type ContentGridFileProps = ContentGridCommonFileProps & {
117
116
  content_extension: FileRetrieve['content_extension'];
118
117
  content_length: FileRetrieve['content_length'];
119
118
  content_thumbnails?: FileRetrieve['content_thumbnails'] | null;
120
- readonly pspdfkit_token?: string;
121
119
  readonly pspdfkit_server_url?: FileModel['pspdfkit_server_url'];
122
120
  readonly pspdfkit_auth_payload?: FileModel['pspdfkit_auth_payload'];
123
121
  };
@@ -340,7 +338,6 @@ export interface FileProps {
340
338
  content_length: FileRetrieve['content_length'];
341
339
  content_thumbnails: FileRetrieve['content_thumbnails'] | null;
342
340
  is_deleted?: boolean;
343
- readonly pspdfkit_token?: string;
344
341
  readonly pspdfkit_server_url?: FileModel['pspdfkit_server_url'];
345
342
  readonly pspdfkit_auth_payload?: FileModel['pspdfkit_auth_payload'];
346
343
  }
@@ -408,6 +405,10 @@ export interface CRMBuilderProps {
408
405
  };
409
406
  }
410
407
  type AdminImpactCommonBuilderProps = {
408
+ openOnStart?: {
409
+ component?: string;
410
+ section?: string;
411
+ };
411
412
  isFullscreen?: boolean;
412
413
  displayMode?: 'default' | 'print';
413
414
  startPage?: number;
@@ -21,4 +21,5 @@ export declare function skipElementsInTree<T extends TreeLike>(tree: T[], idsToH
21
21
  sections: HiddenElementsInCanvas;
22
22
  components: HiddenElementsInCanvas;
23
23
  }): T[];
24
+ export declare function moveNodeTo<T extends TreeLike>(tree: T[], nodeId: string | number, siblingId?: string | number, insertLocation?: 'before' | 'after'): T[];
24
25
  export {};
@@ -1,4 +1,4 @@
1
- import { Ref, ComputedRef } from 'vue';
1
+ import { Ref, ComputedRef, UnwrapNestedRefs } from 'vue';
2
2
  import { FolderRetrieve, FolderFile, FileRetrieve, File } from '../../../../types/openapi';
3
3
 
4
4
  export type SelectorType = 'content' | 'assets' | 'external_links';
@@ -39,6 +39,19 @@ export declare function isPage(item: ContentSelectorSelectedItem): item is Selec
39
39
  export declare function isFile(item: ContentSelectorSelectedItem): item is SelectedFile;
40
40
  export declare function isAsset(item: ContentSelectorSelectedItem): item is SelectedAsset;
41
41
  export declare function isExternalLink(item: ContentSelectorSelectedItem): item is SelectedExternalLink;
42
+ interface State {
43
+ activeSelectorType: Ref<SelectorType>;
44
+ search: Ref<string>;
45
+ selectedItems: Ref<ContentSelectorSelectedItem[]>;
46
+ selectedFiles: ComputedRef<SelectedFile[]>;
47
+ selectedPages: ComputedRef<SelectedPage[]>;
48
+ selectedAssets: ComputedRef<SelectedAsset[]>;
49
+ selectedExternalLinks: ComputedRef<SelectedExternalLink[]>;
50
+ activeFolder: Ref<FolderRetrieve | null>;
51
+ activeFile: Ref<FileRetrieve | null>;
52
+ isFetchingFolderItems: Ref<boolean>;
53
+ isFetchingFile: Ref<boolean>;
54
+ }
42
55
  declare function deselectFile(f: SelectedFile | Pick<FolderFile, 'id'>): void;
43
56
  declare function deselectPage(p: SelectedPage): void;
44
57
  declare function deselectAsset(a: SelectedAsset): void;
@@ -46,7 +59,7 @@ declare function deselectExternalLink(l: SelectedExternalLink): void;
46
59
  export default function (): {
47
60
  resetSelectedItems(): void;
48
61
  setSelectedItems(items: ContentSelectorSelectedItem[]): void;
49
- setActiveSelectorType(s?: SelectorType | undefined): void;
62
+ setActiveSelectorType(s?: SelectorType): void;
50
63
  selectItem(i: ContentSelectorSelectedItem): void;
51
64
  deselectFile: typeof deselectFile;
52
65
  deselectPage: typeof deselectPage;
@@ -54,19 +67,7 @@ export default function (): {
54
67
  deselectExternalLink: typeof deselectExternalLink;
55
68
  deselectItem(item: ContentSelectorSelectedItem): void;
56
69
  deselectFilePages(f: Pick<FolderFile, "id">): void;
57
- setState(newState: Partial<{
58
- activeSelectorType: SelectorType;
59
- search: string;
60
- selectedItems: ContentSelectorSelectedItem[];
61
- selectedFiles: SelectedFile[];
62
- selectedPages: SelectedPage[];
63
- selectedAssets: SelectedAsset[];
64
- selectedExternalLinks: SelectedExternalLink[];
65
- activeFolder: FolderRetrieve | null;
66
- activeFile: FileRetrieve | null;
67
- isFetchingFolderItems: boolean;
68
- isFetchingFile: boolean;
69
- }>): void;
70
+ setState(newState: Partial<UnwrapNestedRefs<State>>): void;
70
71
  activeSelectorType: Ref<SelectorType>;
71
72
  search: Ref<string>;
72
73
  selectedItems: Ref<ContentSelectorSelectedItem[]>;