@pitcher/js-api 1.22.0 → 1.23.0

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 (89) hide show
  1. package/js-api.esm.js +52 -43
  2. package/js-api.esm.js.map +1 -1
  3. package/js-api.umd.min.js +9 -9
  4. package/js-api.umd.min.js.map +1 -1
  5. package/lib/apps/browser/stores/api.d.ts +0 -12
  6. package/lib/apps/canvas-builder/App.vue.d.ts +256 -177
  7. package/lib/apps/canvas-builder/components/container/EditableComponent/EditableComponentActionToolbar.vue.d.ts +0 -2
  8. package/lib/apps/canvas-builder/components/ui/Block/Block.vue.d.ts +11 -0
  9. package/lib/apps/canvas-builder/components/ui/CollectionPlayer/composables/tracking.use.d.ts +4 -0
  10. package/lib/apps/canvas-builder/components/ui/CollectionPlayer/utils/type.util.d.ts +4 -4
  11. package/lib/apps/canvas-builder/components/ui/SectionList/Execution/SectionListExecution.vue.d.ts +10 -0
  12. package/lib/apps/canvas-builder/components/ui/SectionList/SectionSelectorItem.vue.d.ts +3 -0
  13. package/lib/apps/canvas-builder/components/ui/SectionList/SectionSelectorToolbar.vue.d.ts +2 -2
  14. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +570 -0
  15. package/lib/apps/canvas-builder/composables/useCanvasBlocks.d.ts +837 -0
  16. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +126 -0
  17. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +9 -5
  18. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +23 -4
  19. package/lib/apps/canvas-builder/types/canvas.d.ts +40 -4
  20. package/lib/apps/canvas-builder/util/canvas.util.d.ts +6 -2
  21. package/lib/apps/canvas-selector/stores/app.d.ts +14 -0
  22. package/lib/apps/content-selector/appTypes.d.ts +2 -0
  23. package/lib/apps/content-selector/stores/app.d.ts +1 -0
  24. package/lib/components/CApexChart/CApexChartLine.vue.d.ts +7 -3
  25. package/lib/components/CConfigEditor/CConfigEditor.validators.d.ts +3 -1
  26. package/lib/components/CConfigEditor/CConfigEditor.vue.d.ts +3 -0
  27. package/lib/components/{CCreateTemplateOrSectionModal/CCreateTemplateOrSectionModal.vue.d.ts → CCreateTemplateSectionBlockModal/CCreateTemplateSectionBlockModal.vue.d.ts} +2 -1
  28. package/lib/components/CEntitySelector/CEntitySelector.vue.d.ts +4 -0
  29. package/lib/components/CFilePanel/CFilePanel.use.d.ts +12 -0
  30. package/lib/components/CFilePanel/CFilePanel.vue.d.ts +14 -0
  31. package/lib/components/CFileViewer/CFileViewer.vue.d.ts +196 -6
  32. package/lib/components/CFileViewer/CFileViewerTop.vue.d.ts +6 -4
  33. package/lib/components/CFileViewer/pdf/CFileViewer.pageThumbMetadata.pdf.use.d.ts +8 -0
  34. package/lib/components/CFileViewer/pdf/CFileViewer.pdf.annotations.use.d.ts +2 -0
  35. package/lib/components/CFileViewer/pdf/CFileViewer.pdf.use.d.ts +4 -2
  36. package/lib/components/CFileViewer/pdf/CFileViewerBottom.pdf.vue.d.ts +5 -4
  37. package/lib/components/CFileViewer/pdf/CFileViewerCopyPagesMetadata.pdf.vue.d.ts +13 -0
  38. package/lib/components/CFileViewer/pdf/CFileViewerPageDrawer.pdf.vue.d.ts +26 -0
  39. package/lib/components/CFileViewer/pdf/CFileViewerPageDrawerSelectPage.vue.d.ts +15 -0
  40. package/lib/components/CInfoBadge/CInfoBadge.vue.d.ts +5 -2
  41. package/lib/components/CJsonEditor/CJsonEditor.vue.d.ts +5 -1
  42. package/lib/components/CRichTextEditor/components/CContentLinkToolbar.vue.d.ts +10 -0
  43. package/lib/components/CRichTextEditor/components/CInsertDropdown.vue.d.ts +2 -0
  44. package/lib/components/CRichTextEditor/extensions/contentLink.d.ts +22 -0
  45. package/lib/components/CSearch/CSearch.vue.d.ts +2 -0
  46. package/lib/components/CSingleFileSelector/CSingleFileSelector.vue.d.ts +28 -0
  47. package/lib/components/CTableInput/CTableInput.vue.d.ts +2 -0
  48. package/lib/components/CTags/CTags.vue.d.ts +1 -0
  49. package/lib/components/CVideo/CVideo.types.d.ts +7 -0
  50. package/lib/components/CVideo/CVideo.vue.d.ts +3 -7
  51. package/lib/components/canvas-blocks/CBlockManagement.vue.d.ts +253 -0
  52. package/lib/components/canvas-blocks/CBlockManagementActionsCell.vue.d.ts +32 -0
  53. package/lib/components/canvas-blocks/CBlockManagementToolbar.vue.d.ts +60 -0
  54. package/lib/components/canvas-templates/CTemplateManagement.vue.d.ts +2 -2
  55. package/lib/components/savedCanvases/CSavedCanvasesManagementIndicatorsCell.vue.d.ts +7 -0
  56. package/lib/components/savedCanvases/smartFolders/SmartFolders.use.d.ts +9 -12
  57. package/lib/constants/cdp.const.d.ts +1 -0
  58. package/lib/main.lib.d.ts +4 -1
  59. package/lib/sdk/api/HighLevelApi.d.ts +5 -0
  60. package/lib/sdk/api/modules/canvas.d.ts +26 -1
  61. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +10 -0
  62. package/lib/sdk/api/modules/ui/index.d.ts +1 -0
  63. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +1 -1
  64. package/lib/sdk/api/modules/ui/types.ui.d.ts +1 -0
  65. package/lib/sdk/main.d.ts +18 -0
  66. package/lib/types/app.d.ts +1 -1
  67. package/lib/types/canvases.d.ts +10 -1
  68. package/lib/types/file.types.d.ts +15 -0
  69. package/lib/types/launchDarkly.types.d.ts +3 -1
  70. package/lib/types/organizationSettings.types.d.ts +8 -0
  71. package/package.json +1 -1
  72. package/types/openapi/index.d.ts +1 -0
  73. package/types/openapi/models/Canvas.d.ts +1 -0
  74. package/types/openapi/models/CanvasCreate.d.ts +1 -0
  75. package/types/openapi/models/CanvasCreateRequest.d.ts +1 -0
  76. package/types/openapi/models/CanvasRetrieve.d.ts +1 -0
  77. package/types/openapi/models/CanvasUpdate.d.ts +1 -0
  78. package/types/openapi/models/CanvasUpdateRequest.d.ts +1 -0
  79. package/types/openapi/models/DeletedCanvas.d.ts +1 -0
  80. package/types/openapi/models/PatchedCanvasIndicatorsRequest.d.ts +3 -0
  81. package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +1 -0
  82. package/lib/apps/browser/components/Content/Panel/FilePanel/FilePanel.vue.d.ts +0 -2
  83. /package/lib/apps/canvas-builder/components/ui/CollectionPlayer/components/{PreviewImage.vue.d.ts → MainImage.vue.d.ts} +0 -0
  84. /package/lib/apps/canvas-builder/components/ui/CollectionPlayer/composables/{cache.use.d.ts → image-cache.use.d.ts} +0 -0
  85. /package/lib/{apps/browser/components/Content/Panel/FilePanel → components/CFilePanel}/BasicInfo.vue.d.ts +0 -0
  86. /package/lib/{apps/browser/components/Content/Panel/FilePanel → components/CFilePanel}/Details.vue.d.ts +0 -0
  87. /package/lib/{apps/browser/components/Content/Panel/FilePanel → components/CFilePanel}/Metadata.vue.d.ts +0 -0
  88. /package/lib/{apps/browser/components/Content/Panel/FilePanel → components/CFilePanel}/Tags.vue.d.ts +0 -0
  89. /package/lib/components/CFileViewer/pdf/{CFileViewer.pageFavorite.pdf.use.d.ts → CFileViewer.pageThumbFavorite.pdf.use.d.ts} +0 -0
@@ -46,6 +46,7 @@ export default function useCanvasHistory(): {
46
46
  type: "image" | "video";
47
47
  horizontal_alignment?: import('../types/canvas').MultimediaHorizontalAlignmentOptions | undefined;
48
48
  from?: ("custom" | "pexels" | "unsplash" | "ai") | undefined;
49
+ poster_url?: string | undefined;
49
50
  } | {
50
51
  asset_type: "pitcher_asset";
51
52
  file: {
@@ -55,6 +56,7 @@ export default function useCanvasHistory(): {
55
56
  };
56
57
  type: "image" | "video";
57
58
  horizontal_alignment?: import('../types/canvas').MultimediaHorizontalAlignmentOptions | undefined;
59
+ poster_url?: string | undefined;
58
60
  } | {
59
61
  type: "app";
60
62
  app_name: string;
@@ -79,6 +81,9 @@ export default function useCanvasHistory(): {
79
81
  overlay_app?: {
80
82
  start_in_loading_mode?: boolean | undefined;
81
83
  } | undefined;
84
+ canvas_section_execution?: {
85
+ start_in_loading_mode?: boolean | undefined;
86
+ } | undefined;
82
87
  } | undefined;
83
88
  file: {
84
89
  id: import('../../../main.lib').FileRetrieve["id"];
@@ -163,6 +168,58 @@ export default function useCanvasHistory(): {
163
168
  canvas_anchor?: string | undefined;
164
169
  color?: string | undefined;
165
170
  display_text?: string | undefined;
171
+ file?: {
172
+ readonly id?: string | undefined;
173
+ readonly global_id?: string | undefined;
174
+ name?: string | undefined;
175
+ readonly type?: import('../../../main.lib').FileTypeEnum | undefined;
176
+ readonly size?: number | null | undefined;
177
+ readonly status?: import('../../../main.lib').FileStatusEnum | undefined;
178
+ readonly content_type?: import('../../../main.lib').FileContentTypeEnum | undefined;
179
+ readonly content_extension?: string | null | undefined;
180
+ readonly content_length?: number | null | undefined;
181
+ readonly content_url?: string | null | undefined;
182
+ readonly original_extension?: string | null | undefined;
183
+ readonly thumbnail_url?: string | null | undefined;
184
+ download_type?: import('../../../main.lib').DownloadTypeEnum | undefined;
185
+ readonly zip_size?: number | null | undefined;
186
+ readonly zip_url?: string | null | undefined;
187
+ access_type?: import('../../../main.lib').AccessTypeEnum | undefined;
188
+ readonly role?: import('../../../main.lib').CollaborationRoleEnum | undefined;
189
+ permissions?: {
190
+ can_download?: boolean | undefined;
191
+ can_share?: boolean | undefined;
192
+ } | undefined;
193
+ metadata?: Record<string, any> | undefined;
194
+ app_metadata?: Record<string, any> | undefined;
195
+ tags?: Array<string> | undefined;
196
+ readonly published_at?: string | null | undefined;
197
+ expires_at?: (string | null) | undefined;
198
+ readonly instance_id?: string | undefined;
199
+ folder_id?: string | undefined;
200
+ readonly shared_link?: {
201
+ readonly url: string;
202
+ short_url?: (string | null) | undefined;
203
+ } | undefined;
204
+ readonly owned_by?: {
205
+ readonly id: number;
206
+ readonly name: string;
207
+ email?: string | undefined;
208
+ } | undefined;
209
+ readonly created_at?: string | undefined;
210
+ readonly created_by?: {
211
+ readonly id: number;
212
+ readonly name: string;
213
+ email?: string | undefined;
214
+ } | undefined;
215
+ readonly modified_at?: string | undefined;
216
+ readonly modified_by?: {
217
+ readonly id: number;
218
+ readonly name: string;
219
+ email?: string | undefined;
220
+ } | undefined;
221
+ page_index?: number | undefined;
222
+ } | null | undefined;
166
223
  font_family?: string | undefined;
167
224
  font_size?: number | undefined;
168
225
  link_type?: import('../types/canvas').LinkAnchorTypes | undefined;
@@ -195,7 +252,10 @@ export default function useCanvasHistory(): {
195
252
  id: string;
196
253
  type: "slide";
197
254
  file: {
255
+ metadata?: Record<string, any> | undefined;
198
256
  readonly id: string;
257
+ name?: string | undefined;
258
+ readonly type: import('../../../main.lib').FileTypeEnum;
199
259
  readonly content_url: string | null;
200
260
  readonly content_type: import('../../../main.lib').FileContentTypeEnum;
201
261
  readonly thumbnail_url: string | null;
@@ -215,7 +275,10 @@ export default function useCanvasHistory(): {
215
275
  id: string;
216
276
  type: "file";
217
277
  file: {
278
+ metadata?: Record<string, any> | undefined;
218
279
  readonly id: string;
280
+ name?: string | undefined;
281
+ readonly type: import('../../../main.lib').FileTypeEnum;
219
282
  readonly content_url: string | null;
220
283
  readonly content_type: import('../../../main.lib').FileContentTypeEnum;
221
284
  readonly thumbnail_url: string | null;
@@ -285,6 +348,7 @@ export default function useCanvasHistory(): {
285
348
  type: "image" | "video";
286
349
  horizontal_alignment?: import('../types/canvas').MultimediaHorizontalAlignmentOptions | undefined;
287
350
  from?: ("custom" | "pexels" | "unsplash" | "ai") | undefined;
351
+ poster_url?: string | undefined;
288
352
  } | {
289
353
  asset_type: "pitcher_asset";
290
354
  file: {
@@ -294,6 +358,7 @@ export default function useCanvasHistory(): {
294
358
  };
295
359
  type: "image" | "video";
296
360
  horizontal_alignment?: import('../types/canvas').MultimediaHorizontalAlignmentOptions | undefined;
361
+ poster_url?: string | undefined;
297
362
  } | {
298
363
  type: "app";
299
364
  app_name: string;
@@ -318,6 +383,9 @@ export default function useCanvasHistory(): {
318
383
  overlay_app?: {
319
384
  start_in_loading_mode?: boolean | undefined;
320
385
  } | undefined;
386
+ canvas_section_execution?: {
387
+ start_in_loading_mode?: boolean | undefined;
388
+ } | undefined;
321
389
  } | undefined;
322
390
  file: {
323
391
  id: import('../../../main.lib').FileRetrieve["id"];
@@ -402,6 +470,58 @@ export default function useCanvasHistory(): {
402
470
  canvas_anchor?: string | undefined;
403
471
  color?: string | undefined;
404
472
  display_text?: string | undefined;
473
+ file?: {
474
+ readonly id?: string | undefined;
475
+ readonly global_id?: string | undefined;
476
+ name?: string | undefined;
477
+ readonly type?: import('../../../main.lib').FileTypeEnum | undefined;
478
+ readonly size?: number | null | undefined;
479
+ readonly status?: import('../../../main.lib').FileStatusEnum | undefined;
480
+ readonly content_type?: import('../../../main.lib').FileContentTypeEnum | undefined;
481
+ readonly content_extension?: string | null | undefined;
482
+ readonly content_length?: number | null | undefined;
483
+ readonly content_url?: string | null | undefined;
484
+ readonly original_extension?: string | null | undefined;
485
+ readonly thumbnail_url?: string | null | undefined;
486
+ download_type?: import('../../../main.lib').DownloadTypeEnum | undefined;
487
+ readonly zip_size?: number | null | undefined;
488
+ readonly zip_url?: string | null | undefined;
489
+ access_type?: import('../../../main.lib').AccessTypeEnum | undefined;
490
+ readonly role?: import('../../../main.lib').CollaborationRoleEnum | undefined;
491
+ permissions?: {
492
+ can_download?: boolean | undefined;
493
+ can_share?: boolean | undefined;
494
+ } | undefined;
495
+ metadata?: Record<string, any> | undefined;
496
+ app_metadata?: Record<string, any> | undefined;
497
+ tags?: Array<string> | undefined;
498
+ readonly published_at?: string | null | undefined;
499
+ expires_at?: (string | null) | undefined;
500
+ readonly instance_id?: string | undefined;
501
+ folder_id?: string | undefined;
502
+ readonly shared_link?: {
503
+ readonly url: string;
504
+ short_url?: (string | null) | undefined;
505
+ } | undefined;
506
+ readonly owned_by?: {
507
+ readonly id: number;
508
+ readonly name: string;
509
+ email?: string | undefined;
510
+ } | undefined;
511
+ readonly created_at?: string | undefined;
512
+ readonly created_by?: {
513
+ readonly id: number;
514
+ readonly name: string;
515
+ email?: string | undefined;
516
+ } | undefined;
517
+ readonly modified_at?: string | undefined;
518
+ readonly modified_by?: {
519
+ readonly id: number;
520
+ readonly name: string;
521
+ email?: string | undefined;
522
+ } | undefined;
523
+ page_index?: number | undefined;
524
+ } | null | undefined;
405
525
  font_family?: string | undefined;
406
526
  font_size?: number | undefined;
407
527
  link_type?: import('../types/canvas').LinkAnchorTypes | undefined;
@@ -434,7 +554,10 @@ export default function useCanvasHistory(): {
434
554
  id: string;
435
555
  type: "slide";
436
556
  file: {
557
+ metadata?: Record<string, any> | undefined;
437
558
  readonly id: string;
559
+ name?: string | undefined;
560
+ readonly type: import('../../../main.lib').FileTypeEnum;
438
561
  readonly content_url: string | null;
439
562
  readonly content_type: import('../../../main.lib').FileContentTypeEnum;
440
563
  readonly thumbnail_url: string | null;
@@ -454,7 +577,10 @@ export default function useCanvasHistory(): {
454
577
  id: string;
455
578
  type: "file";
456
579
  file: {
580
+ metadata?: Record<string, any> | undefined;
457
581
  readonly id: string;
582
+ name?: string | undefined;
583
+ readonly type: import('../../../main.lib').FileTypeEnum;
458
584
  readonly content_url: string | null;
459
585
  readonly content_type: import('../../../main.lib').FileContentTypeEnum;
460
586
  readonly thumbnail_url: string | null;
@@ -33,10 +33,10 @@ declare function setFontAndFetchAsset(fontName?: string, url?: string): Promise<
33
33
  declare function initializeTheme(): void;
34
34
  declare function updateThemeProperties(theme: Partial<CanvasTheme>): void;
35
35
  declare function updateTextCSSVariables(typography: Record<string, CanvasTypographyPreset>): void;
36
+ declare function removeCssUrlFunc(url: string): string;
36
37
  export default function useCanvasTheme(): {
37
38
  areTokenConstraintsActive: import('vue').ComputedRef<boolean>;
38
39
  canvasBgColor: import('vue').Ref<string, string>;
39
- cleanup: typeof cleanup;
40
40
  customFonts: import('vue').Ref<{
41
41
  readonly id: string;
42
42
  readonly global_id: string;
@@ -139,16 +139,20 @@ export default function useCanvasTheme(): {
139
139
  };
140
140
  }[]>;
141
141
  font: import('vue').Ref<string, string>;
142
- getDefaultTypographyConfiguration: typeof getDefaultTypographyConfiguration;
143
142
  globalComponentSpacing: import('vue').Ref<number, number>;
144
- initializeTheme: typeof initializeTheme;
145
143
  isEditingCanvasTheme: import('vue').Ref<boolean, boolean>;
146
144
  isFluid: import('vue').Ref<boolean, boolean>;
147
- loadCustomFonts: typeof loadCustomFonts;
148
145
  palette: import('vue').Ref<string[], string[]>;
149
- setFontAndFetchAsset: typeof setFontAndFetchAsset;
150
146
  typography: import('vue').Ref<Record<string, CanvasTypographyPreset>, Record<string, CanvasTypographyPreset>>;
147
+ backgroundImageUrl: import('vue').Ref<string, string>;
148
+ backgroundVideoUrl: import('vue').Ref<string, string>;
149
+ initializeTheme: typeof initializeTheme;
150
+ getDefaultTypographyConfiguration: typeof getDefaultTypographyConfiguration;
151
+ loadCustomFonts: typeof loadCustomFonts;
152
+ setFontAndFetchAsset: typeof setFontAndFetchAsset;
151
153
  updateTextCSSVariables: typeof updateTextCSSVariables;
152
154
  updateThemeProperties: typeof updateThemeProperties;
155
+ removeCssUrlFunc: typeof removeCssUrlFunc;
156
+ cleanup: typeof cleanup;
153
157
  };
154
158
  export {};
@@ -1,16 +1,17 @@
1
- import { ComponentTypes, MultimediaProps, ComponentNode, ContentGridProps, CollectionSelectorGroup, CollectionPage, CollectionFile } from '../types/canvas';
1
+ import { ComponentTypes, MultimediaProps, ComponentNode, ContentGridProps, CollectionSelectorGroup, CollectionPage, CollectionFile, LinkProps } from '../types/canvas';
2
2
  import { Selection } from '../../content-selector/appTypes';
3
3
  import { FileContentTypeEnum, FileRetrieve } from '../../../../types/openapi';
4
4
  import { SelectedPage, SelectedFile, SelectorType, SelectedExternalLink, SelectedAsset } from '../../content-selector/stores/app';
5
5
  type ContentSelectorPayload = {
6
6
  id: ComponentNode['id'] | null;
7
- componentType: Extract<ComponentTypes, ComponentTypes.ContentGrid | ComponentTypes.Multimedia | ComponentTypes.CollectionPlayer>;
7
+ componentType: Extract<ComponentTypes, ComponentTypes.ContentGrid | ComponentTypes.Multimedia | ComponentTypes.CollectionPlayer | ComponentTypes.Link> | null;
8
8
  selections?: Selection[];
9
9
  allowedSelectorTypes?: SelectorType[];
10
10
  allowedContentTypes?: FileContentTypeEnum[];
11
11
  allowedAssetContentTypes?: FileContentTypeEnum[];
12
12
  maxSelections?: number;
13
13
  groupId?: CollectionSelectorGroup['id'];
14
+ onSelected?: (selections: (SelectedFile | SelectedPage)[]) => void;
14
15
  };
15
16
  type ContentSelectorState = false | ContentSelectorPayload;
16
17
  declare function clearContentSelectorMode(): void;
@@ -25,6 +26,11 @@ export declare function prepareContentGridNodeData({ selectedItems, filesById, n
25
26
  filesById: Record<FileRetrieve['id'], FileRetrieve>;
26
27
  node?: ComponentNode<ContentGridProps>;
27
28
  }): ContentGridProps;
29
+ declare function prepareLinkNodeData({ selectedItems, filesById, node, }: {
30
+ selectedItems: (SelectedFile | SelectedPage)[];
31
+ filesById: Record<FileRetrieve['id'], FileRetrieve>;
32
+ node?: ComponentNode<LinkProps>;
33
+ }): LinkProps;
28
34
  declare function prepareMultimediaNodeData({ selectedItems, }: {
29
35
  selectedItems: (SelectedExternalLink | SelectedAsset)[];
30
36
  }): MultimediaProps | undefined;
@@ -32,11 +38,16 @@ export default function (): {
32
38
  clearContentSelectorMode: typeof clearContentSelectorMode;
33
39
  contentSelectorMode: import('vue').Ref<false | {
34
40
  id: ComponentNode["id"] | null;
35
- componentType: Extract<ComponentTypes, ComponentTypes.ContentGrid | ComponentTypes.Multimedia | ComponentTypes.CollectionPlayer>;
41
+ componentType: Extract<ComponentTypes, ComponentTypes.ContentGrid | ComponentTypes.Multimedia | ComponentTypes.CollectionPlayer | ComponentTypes.Link> | null;
36
42
  selections?: ({
37
43
  fileId: FileRetrieve["id"];
38
44
  type: "file" | "page";
39
45
  pageIndex?: number | undefined;
46
+ name?: string | undefined;
47
+ file?: {
48
+ readonly id: string;
49
+ name?: string | undefined;
50
+ } | undefined;
40
51
  } | {
41
52
  url: string;
42
53
  type: "external_link";
@@ -51,13 +62,19 @@ export default function (): {
51
62
  allowedAssetContentTypes?: FileContentTypeEnum[] | undefined;
52
63
  maxSelections?: number | undefined;
53
64
  groupId?: CollectionSelectorGroup["id"] | undefined;
65
+ onSelected?: ((selections: (SelectedFile | SelectedPage)[]) => void) | undefined;
54
66
  }, ContentSelectorState | {
55
67
  id: ComponentNode["id"] | null;
56
- componentType: Extract<ComponentTypes, ComponentTypes.ContentGrid | ComponentTypes.Multimedia | ComponentTypes.CollectionPlayer>;
68
+ componentType: Extract<ComponentTypes, ComponentTypes.ContentGrid | ComponentTypes.Multimedia | ComponentTypes.CollectionPlayer | ComponentTypes.Link> | null;
57
69
  selections?: ({
58
70
  fileId: FileRetrieve["id"];
59
71
  type: "file" | "page";
60
72
  pageIndex?: number | undefined;
73
+ name?: string | undefined;
74
+ file?: {
75
+ readonly id: string;
76
+ name?: string | undefined;
77
+ } | undefined;
61
78
  } | {
62
79
  url: string;
63
80
  type: "external_link";
@@ -72,9 +89,11 @@ export default function (): {
72
89
  allowedAssetContentTypes?: FileContentTypeEnum[] | undefined;
73
90
  maxSelections?: number | undefined;
74
91
  groupId?: CollectionSelectorGroup["id"] | undefined;
92
+ onSelected?: ((selections: (SelectedFile | SelectedPage)[]) => void) | undefined;
75
93
  }>;
76
94
  setContentSelectorMode: typeof setContentSelectorMode;
77
95
  prepareContentGridNodeData: typeof prepareContentGridNodeData;
96
+ prepareLinkNodeData: typeof prepareLinkNodeData;
78
97
  prepareMultimediaNodeData: typeof prepareMultimediaNodeData;
79
98
  prepareCollectionPlayerNodeData: typeof prepareCollectionPlayerNodeData;
80
99
  };
@@ -29,8 +29,9 @@ export declare enum GridLayoutTypes {
29
29
  FOUR_EQUAL = "four-equal"
30
30
  }
31
31
  export declare enum LinkAnchorTypes {
32
- WEB = "web",
33
- CANVAS_ANCHOR = "canvas-anchor"
32
+ CANVAS_ANCHOR = "canvas-anchor",
33
+ FILE = "file",
34
+ WEB = "web"
34
35
  }
35
36
  export declare enum LinkAlignmentTypes {
36
37
  LEFT = "left",
@@ -57,6 +58,15 @@ export interface EmbeddableProps {
57
58
  export interface TextProps {
58
59
  content?: string;
59
60
  }
61
+ export interface BlockOverrides {
62
+ [key: ComponentNode['id']]: {
63
+ node_data: ComponentNode['data'];
64
+ };
65
+ }
66
+ export interface BlockProps {
67
+ id: CanvasRetrieve['id'];
68
+ overrides?: BlockOverrides;
69
+ }
60
70
  export interface CarouselProps {
61
71
  images?: {
62
72
  url: string;
@@ -92,6 +102,7 @@ export type ExternalMultimediaAssetType = {
92
102
  type: 'image' | 'video';
93
103
  horizontal_alignment?: MultimediaHorizontalAlignmentOptions;
94
104
  from?: 'custom' | 'pexels' | 'unsplash' | 'ai';
105
+ poster_url?: string;
95
106
  };
96
107
  export type PitcherMultimediaAssetType = {
97
108
  asset_type: typeof MULTIMEDIA_IMG_TYPE.pitcher_asset;
@@ -102,6 +113,7 @@ export type PitcherMultimediaAssetType = {
102
113
  };
103
114
  type: 'image' | 'video';
104
115
  horizontal_alignment?: MultimediaHorizontalAlignmentOptions;
116
+ poster_url?: string;
105
117
  };
106
118
  export type MultimediaProps = ExternalMultimediaAssetType | PitcherMultimediaAssetType;
107
119
  export type ContentGridCommonFileProps = {
@@ -178,7 +190,7 @@ export type CollectionPlayerProps = {
178
190
  groups: CollectionSelectorGroup[];
179
191
  name: string;
180
192
  };
181
- export type CollectionFileEntity = Pick<FileRetrieve, 'id' | 'thumbnail_url' | 'permissions' | 'content_url' | 'content_type' | 'pspdfkit_auth_payload' | 'pspdfkit_document_id' | 'pspdfkit_server_url'>;
193
+ export type CollectionFileEntity = Pick<FileRetrieve, 'id' | 'name' | 'type' | 'metadata' | 'thumbnail_url' | 'permissions' | 'content_url' | 'content_type' | 'pspdfkit_auth_payload' | 'pspdfkit_document_id' | 'pspdfkit_server_url'>;
182
194
  export type CollectionPage = {
183
195
  id: string;
184
196
  type: 'slide';
@@ -205,6 +217,9 @@ export interface LinkProps {
205
217
  canvas_anchor?: string;
206
218
  color?: string;
207
219
  display_text?: string;
220
+ file?: (Partial<File> & {
221
+ page_index?: number;
222
+ }) | null;
208
223
  font_family?: string;
209
224
  font_size?: number;
210
225
  link_type?: LinkAnchorTypes;
@@ -309,7 +324,8 @@ export declare enum ComponentTypes {
309
324
  PageBreak = "PageBreak",
310
325
  Page = "Page",
311
326
  Timeline = "Timeline",
312
- CollectionPlayer = "CollectionPlayer"
327
+ CollectionPlayer = "CollectionPlayer",
328
+ Block = "Block"
313
329
  }
314
330
  export declare enum ComponentIcon {
315
331
  AR = "cube",
@@ -335,6 +351,7 @@ export declare enum ComponentIcon {
335
351
  }
336
352
  export declare const componentIconType: Record<string, FontAwesomeType>;
337
353
  export type CanvasTheme = {
354
+ background_video_url?: string;
338
355
  canvas_bg_color?: string;
339
356
  global_component_spacing?: number;
340
357
  font?: {
@@ -399,6 +416,10 @@ type NoCRMBuilderProps = {
399
416
  isCRM: false;
400
417
  onSfdcAccountSearch?: never;
401
418
  };
419
+ export type NodeInfo = {
420
+ id: string;
421
+ type: ComponentTypes;
422
+ };
402
423
  export type SharingBuilderProps = NoCRMBuilderProps & {
403
424
  isFullscreen?: boolean;
404
425
  displayMode?: 'default' | 'print';
@@ -416,6 +437,11 @@ export type SharingBuilderProps = NoCRMBuilderProps & {
416
437
  onEnter?: () => void;
417
438
  onPageEnter?: (data: ComponentNode[], pageIndex: number) => void;
418
439
  onPageExit?: (data: ComponentNode[], pageIndex: number) => void;
440
+ onFileEnter?: (node: NodeInfo, file: CollectionFileEntity) => void;
441
+ onFileExit?: (node: NodeInfo, file: CollectionFileEntity) => void;
442
+ onFilePageEnter?: (node: NodeInfo, file: CollectionFileEntity, pageIndex: number) => void;
443
+ onFilePageExit?: (node: NodeInfo, file: CollectionFileEntity, pageIndex: number) => void;
444
+ onCollectionPlayerContentChange?: never;
419
445
  onComponentEnter?: (data: ComponentNode | CanvasRetrieve, params: ComponentTrackingParams) => void;
420
446
  onComponentExit?: (data: ComponentNode | CanvasRetrieve, params: ComponentTrackingParams) => void;
421
447
  onFileOpen: (file: FileOpenParams) => void;
@@ -481,6 +507,16 @@ type AdminImpactCommonBuilderProps = {
481
507
  onComponentExit?: (data: ComponentNode | CanvasRetrieve, params: ComponentTrackingParams) => void;
482
508
  onPageEnter?: (data: ComponentNode[], pageIndex: number) => void;
483
509
  onPageExit?: (data: ComponentNode[], pageIndex: number) => void;
510
+ onFileEnter?: (node: NodeInfo, file: CollectionFileEntity) => void;
511
+ onFileExit?: (node: NodeInfo, file: CollectionFileEntity) => void;
512
+ onFilePageEnter?: (node: NodeInfo, file: CollectionFileEntity, pageIndex: number) => void;
513
+ onFilePageExit?: (node: NodeInfo, file: CollectionFileEntity, pageIndex: number) => void;
514
+ onCollectionPlayerContentChange?: (payload: {
515
+ componentId: string;
516
+ uniqueFilesCount: number;
517
+ groupsCount: number;
518
+ slidesCount: number;
519
+ }) => void;
484
520
  onSave: (canvasId: CanvasRetrieve['id'], canvas: PatchedCanvasUpdateRequest & {
485
521
  fields?: string;
486
522
  }, showToast?: boolean) => Promise<CanvasRetrieve>;
@@ -6,8 +6,12 @@ import { SectionComponentNodesBySectionId, ComponentNodesById } from '../composa
6
6
  import { SelectedPage, SelectedFile } from '../../content-selector/stores/app';
7
7
  export declare function createNodeId(type?: ComponentTypes): string;
8
8
  export declare function getComponentKeywords(type: ComponentTypes, t: (input: string) => string): string[];
9
- export declare function getComponentTitle(type: ComponentTypes | string, t: (input: string) => string): string;
10
- export declare function getComponentDescription(type: ComponentTypes | string, t: (input: string) => string): string;
9
+ export declare function getComponentTitle(type: ComponentTypes | string, t: (input: string) => string, options?: {
10
+ name?: string;
11
+ }): string;
12
+ export declare function getComponentDescription(type: ComponentTypes | string, t: (input: string) => string, options?: {
13
+ description?: string;
14
+ }): string;
11
15
  export declare function getNodeDisplayNameByComponentType(node: ComponentNode | null | undefined): string;
12
16
  export declare function getSectionGlobalComponentSpacing(section: CanvasRetrieve['sections'][number]): string | undefined;
13
17
  export declare function discardSectionComponentOverride(sectionId: CanvasRetrieve['id'], componentId: ComponentNode['id'], overrides: SectionComponentOverrides): SectionComponentOverrides;
@@ -11,6 +11,7 @@ export default function useApp(): {
11
11
  is_draft?: boolean | undefined;
12
12
  is_template?: boolean | undefined;
13
13
  is_section?: boolean | undefined;
14
+ is_block?: boolean | undefined;
14
15
  is_editable?: boolean | undefined;
15
16
  is_default?: boolean | undefined;
16
17
  metadata?: Record<string, any> | undefined;
@@ -57,6 +58,7 @@ export default function useApp(): {
57
58
  is_draft?: boolean | undefined;
58
59
  is_template?: boolean | undefined;
59
60
  is_section?: boolean | undefined;
61
+ is_block?: boolean | undefined;
60
62
  is_editable?: boolean | undefined;
61
63
  is_default?: boolean | undefined;
62
64
  metadata?: Record<string, any> | undefined;
@@ -103,6 +105,7 @@ export default function useApp(): {
103
105
  is_draft?: boolean | undefined;
104
106
  is_template?: boolean | undefined;
105
107
  is_section?: boolean | undefined;
108
+ is_block?: boolean | undefined;
106
109
  is_editable?: boolean | undefined;
107
110
  is_default?: boolean | undefined;
108
111
  metadata?: Record<string, any> | undefined;
@@ -149,6 +152,7 @@ export default function useApp(): {
149
152
  is_draft?: boolean | undefined;
150
153
  is_template?: boolean | undefined;
151
154
  is_section?: boolean | undefined;
155
+ is_block?: boolean | undefined;
152
156
  is_editable?: boolean | undefined;
153
157
  is_default?: boolean | undefined;
154
158
  metadata?: Record<string, any> | undefined;
@@ -201,6 +205,7 @@ export default function useApp(): {
201
205
  is_draft?: boolean | undefined;
202
206
  is_template?: boolean | undefined;
203
207
  is_section?: boolean | undefined;
208
+ is_block?: boolean | undefined;
204
209
  is_editable?: boolean | undefined;
205
210
  is_default?: boolean | undefined;
206
211
  metadata?: Record<string, any> | undefined;
@@ -247,6 +252,7 @@ export default function useApp(): {
247
252
  is_draft?: boolean | undefined;
248
253
  is_template?: boolean | undefined;
249
254
  is_section?: boolean | undefined;
255
+ is_block?: boolean | undefined;
250
256
  is_editable?: boolean | undefined;
251
257
  is_default?: boolean | undefined;
252
258
  metadata?: Record<string, any> | undefined;
@@ -293,6 +299,7 @@ export default function useApp(): {
293
299
  is_draft?: boolean | undefined;
294
300
  is_template?: boolean | undefined;
295
301
  is_section?: boolean | undefined;
302
+ is_block?: boolean | undefined;
296
303
  is_editable?: boolean | undefined;
297
304
  is_default?: boolean | undefined;
298
305
  metadata?: Record<string, any> | undefined;
@@ -339,6 +346,7 @@ export default function useApp(): {
339
346
  is_draft?: boolean | undefined;
340
347
  is_template?: boolean | undefined;
341
348
  is_section?: boolean | undefined;
349
+ is_block?: boolean | undefined;
342
350
  is_editable?: boolean | undefined;
343
351
  is_default?: boolean | undefined;
344
352
  metadata?: Record<string, any> | undefined;
@@ -386,6 +394,7 @@ export default function useApp(): {
386
394
  is_draft?: boolean | undefined;
387
395
  is_template?: boolean | undefined;
388
396
  is_section?: boolean | undefined;
397
+ is_block?: boolean | undefined;
389
398
  is_editable?: boolean | undefined;
390
399
  is_default?: boolean | undefined;
391
400
  metadata?: Record<string, any> | undefined;
@@ -431,6 +440,7 @@ export default function useApp(): {
431
440
  is_draft?: boolean | undefined;
432
441
  is_template?: boolean | undefined;
433
442
  is_section?: boolean | undefined;
443
+ is_block?: boolean | undefined;
434
444
  is_editable?: boolean | undefined;
435
445
  is_default?: boolean | undefined;
436
446
  metadata?: Record<string, any> | undefined;
@@ -477,6 +487,7 @@ export default function useApp(): {
477
487
  is_draft?: boolean | undefined;
478
488
  is_template?: boolean | undefined;
479
489
  is_section?: boolean | undefined;
490
+ is_block?: boolean | undefined;
480
491
  is_editable?: boolean | undefined;
481
492
  is_default?: boolean | undefined;
482
493
  metadata?: Record<string, any> | undefined;
@@ -523,6 +534,7 @@ export default function useApp(): {
523
534
  is_draft?: boolean | undefined;
524
535
  is_template?: boolean | undefined;
525
536
  is_section?: boolean | undefined;
537
+ is_block?: boolean | undefined;
526
538
  is_editable?: boolean | undefined;
527
539
  is_default?: boolean | undefined;
528
540
  metadata?: Record<string, any> | undefined;
@@ -569,6 +581,7 @@ export default function useApp(): {
569
581
  is_draft?: boolean | undefined;
570
582
  is_template?: boolean | undefined;
571
583
  is_section?: boolean | undefined;
584
+ is_block?: boolean | undefined;
572
585
  is_editable?: boolean | undefined;
573
586
  is_default?: boolean | undefined;
574
587
  metadata?: Record<string, any> | undefined;
@@ -615,6 +628,7 @@ export default function useApp(): {
615
628
  is_draft?: boolean | undefined;
616
629
  is_template?: boolean | undefined;
617
630
  is_section?: boolean | undefined;
631
+ is_block?: boolean | undefined;
618
632
  is_editable?: boolean | undefined;
619
633
  is_default?: boolean | undefined;
620
634
  metadata?: Record<string, any> | undefined;
@@ -9,6 +9,8 @@ export type ContentSelection = {
9
9
  fileId: FileRetrieve['id'];
10
10
  type: 'file' | 'page';
11
11
  pageIndex?: number;
12
+ name?: string;
13
+ file?: Pick<FileRetrieve, 'id' | 'name'>;
12
14
  };
13
15
  export type ExternalLinkSelection = {
14
16
  url: string;
@@ -4,6 +4,7 @@ import { FileFetcher, FolderItemsFetcher } from '../appTypes';
4
4
  export type SelectorType = 'content' | 'assets' | 'external_links' | 'ai_images';
5
5
  export type SelectedPage = {
6
6
  id: string;
7
+ name?: string;
7
8
  file: {
8
9
  id: File['id'];
9
10
  name: File['name'];
@@ -1,11 +1,15 @@
1
1
  import { ApexOptions } from 'apexcharts';
2
- interface Props {
2
+ declare const _default: import('vue').DefineComponent<{
3
3
  series: ApexAxisChartSeries;
4
4
  options: ApexOptions;
5
5
  width?: number;
6
6
  height?: number;
7
- }
8
- declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {
7
+ }, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
8
+ series: ApexAxisChartSeries;
9
+ options: ApexOptions;
10
+ width?: number;
11
+ height?: number;
12
+ }> & Readonly<{}>, {
9
13
  width: number;
10
14
  height: number;
11
15
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
@@ -1,3 +1,5 @@
1
1
  import { FormItemRule } from 'naive-ui';
2
2
  import { MetadataTemplateField } from '../../../types/openapi';
3
- export declare function getValidationRules(field: MetadataTemplateField, t: (v: string) => string): FormItemRule;
3
+ export declare function getValidationRules(field: MetadataTemplateField, t: (v: string) => string, options: {
4
+ ignoreRequired?: boolean;
5
+ }): FormItemRule;
@@ -14,6 +14,7 @@ declare const _default: import('vue').DefineComponent<{
14
14
  initialValues?: Record<string, any>;
15
15
  readOnly?: boolean;
16
16
  showKeepAsIsPlaceholder?: boolean;
17
+ ignoreRequired?: boolean;
17
18
  }, {
18
19
  validate: typeof validate;
19
20
  }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
@@ -24,11 +25,13 @@ declare const _default: import('vue').DefineComponent<{
24
25
  initialValues?: Record<string, any>;
25
26
  readOnly?: boolean;
26
27
  showKeepAsIsPlaceholder?: boolean;
28
+ ignoreRequired?: boolean;
27
29
  }> & Readonly<{
28
30
  onChange?: ((config: Record<string, any>) => any) | undefined;
29
31
  }>, {
30
32
  loading: boolean;
31
33
  showKeepAsIsPlaceholder: boolean;
32
34
  readOnly: boolean;
35
+ ignoreRequired: boolean;
33
36
  }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
34
37
  export default _default;
@@ -1,9 +1,10 @@
1
1
  import { CanvasType } from '../../types/canvases';
2
- import { CanvasCreateRequest } from '../../../types/openapi';
2
+ import { CanvasRetrieve, CanvasCreateRequest } from '../../../types/openapi';
3
3
  type SubmitPayload = Omit<CanvasCreateRequest, 'instance_id'>;
4
4
  interface Props {
5
5
  isLoading?: boolean;
6
6
  canvasType: Exclude<CanvasType, 'canvas'>;
7
+ sectionTemplatesFetcher?: (params?: Record<string, any>) => Promise<CanvasRetrieve[]>;
7
8
  }
8
9
  declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
9
10
  cancel: () => any;