@pitcher/js-api 1.27.3 → 1.29.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 (41) hide show
  1. package/js-api.esm.js +325 -7
  2. package/js-api.esm.js.map +1 -1
  3. package/js-api.umd.min.js +11 -11
  4. package/js-api.umd.min.js.map +1 -1
  5. package/lib/apps/canvas-builder/components/ui/DynamicContent/dynamicContent.util.d.ts +36 -0
  6. package/lib/apps/canvas-builder/components/ui/DynamicContent/dynamicContent.util.spec.d.ts +1 -0
  7. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +63 -0
  8. package/lib/apps/canvas-builder/composables/useCanvasBlocks.d.ts +14 -0
  9. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +14 -0
  10. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +18 -18
  11. package/lib/apps/canvas-builder/composables/usePopupApps.d.ts +28 -0
  12. package/lib/apps/canvas-builder/types/canvas.d.ts +7 -0
  13. package/lib/apps/canvas-builder/util/canvas.util.d.ts +19 -0
  14. package/lib/components/CFileViewer/pdf/CFileViewer.pdf.util.d.ts +17 -0
  15. package/lib/components/CFileViewer/pdf/CFileViewer.pdf.util.spec.d.ts +1 -0
  16. package/lib/components/CRichTextEditor/components/CTextTypeSelect.test.d.ts +1 -0
  17. package/lib/composables/useCourseOnlyApps.d.ts +11 -0
  18. package/lib/sdk/api/HighLevelApi.d.ts +13 -3
  19. package/lib/sdk/api/modules/admin/types.admin.d.ts +1 -0
  20. package/lib/sdk/api/modules/appsDb.d.ts +57 -0
  21. package/lib/sdk/api/modules/appsDb.spec.d.ts +1 -0
  22. package/lib/sdk/api/modules/index.d.ts +3 -1
  23. package/lib/sdk/api/modules/stt.d.ts +65 -0
  24. package/lib/sdk/api/modules/stt.spec.d.ts +1 -0
  25. package/lib/sdk/api/modules/tts.d.ts +41 -0
  26. package/lib/sdk/api/modules/tts.spec.d.ts +1 -0
  27. package/lib/sdk/interfaces.d.ts +26 -1
  28. package/lib/sdk/main.d.ts +39 -6
  29. package/lib/sdk/payload.types.d.ts +253 -0
  30. package/lib/types/app.d.ts +14 -0
  31. package/lib/types/canvases.d.ts +0 -3
  32. package/lib/types/launchDarkly.types.d.ts +1 -1
  33. package/lib/types/sfdc.d.ts +15 -0
  34. package/lib/util/soql.util.d.ts +36 -0
  35. package/package.json +1 -1
  36. package/types/openapi/index.d.ts +0 -1
  37. package/types/openapi/models/PatchedUserRequest.d.ts +1 -2
  38. package/types/openapi/models/User.d.ts +1 -2
  39. package/types/openapi/models/UserRequest.d.ts +1 -2
  40. package/lib/sdk/api/modules/languages.d.ts +0 -8
  41. package/types/openapi/models/LanguageEnum.d.ts +0 -12
@@ -0,0 +1,36 @@
1
+ import { CSSProperties } from 'vue';
2
+ import { DynamicContentProps } from '../../../types/canvas';
3
+ /**
4
+ * Default heading font size (px) shown in the settings control. Must match the
5
+ * baseline `font-size-5` class the render/preview falls back to when unset
6
+ * (`font-size: 1.25rem` = 20px at a 16px root). Keep in sync if that class changes.
7
+ */
8
+ export declare const DEFAULT_HEADING_FONT_SIZE = 20;
9
+ export interface HeadingFormatting {
10
+ heading_font_family: string;
11
+ heading_font_size: number;
12
+ heading_color: string;
13
+ heading_alignment: 'left' | 'center' | 'right';
14
+ heading_bold: boolean;
15
+ heading_italic: boolean;
16
+ heading_underline: boolean;
17
+ }
18
+ /**
19
+ * Single source of truth for the heading's default formatting — the baseline look the
20
+ * settings modal opens on. Consumed by the ref initializers, `hasCustomFormatting`,
21
+ * `clearFormatting`, and `handleSave`'s collapse-to-undefined, so they can't drift.
22
+ * `themeFont` is the canvas theme font (`useCanvasTheme().font`), which the unset heading
23
+ * inherits; `heading_font_size` mirrors the `font-size-5` fallback.
24
+ */
25
+ export declare function getHeadingFormattingDefaults(themeFont: string): HeadingFormatting;
26
+ /**
27
+ * Builds the inline style overrides for the Dynamic Content heading.
28
+ * Only properties the user has explicitly set produce a value; unset properties
29
+ * return `undefined` so the component's baseline classes (`font-700 font-size-5
30
+ * color-text`) render — preserving the look of pre-existing canvases (PIT-7015 AC9).
31
+ *
32
+ * `heading_bold` is three-state on purpose: `undefined` (legacy / never set) and
33
+ * `true` both fall through to the bold `font-700` class; only an explicit `false`
34
+ * emits `fontWeight: 'normal'` to override it.
35
+ */
36
+ export declare function getHeadingStyle(data: Partial<DynamicContentProps> | undefined): CSSProperties;
@@ -409,6 +409,13 @@ declare const componentNodesById: import('vue').ComputedRef<{
409
409
  readonly show_heading?: boolean | undefined;
410
410
  readonly heading_text?: string | undefined;
411
411
  readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
412
+ readonly heading_font_family?: string | undefined;
413
+ readonly heading_font_size?: number | undefined;
414
+ readonly heading_color?: string | undefined;
415
+ readonly heading_alignment?: "left" | "center" | "right" | undefined;
416
+ readonly heading_bold?: boolean | undefined;
417
+ readonly heading_italic?: boolean | undefined;
418
+ readonly heading_underline?: boolean | undefined;
412
419
  } | {
413
420
  readonly filters?: readonly {
414
421
  readonly property: string;
@@ -913,6 +920,13 @@ declare const sectionComponentNodesBySectionId: import('vue').ComputedRef<{
913
920
  readonly show_heading?: boolean | undefined;
914
921
  readonly heading_text?: string | undefined;
915
922
  readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
923
+ readonly heading_font_family?: string | undefined;
924
+ readonly heading_font_size?: number | undefined;
925
+ readonly heading_color?: string | undefined;
926
+ readonly heading_alignment?: "left" | "center" | "right" | undefined;
927
+ readonly heading_bold?: boolean | undefined;
928
+ readonly heading_italic?: boolean | undefined;
929
+ readonly heading_underline?: boolean | undefined;
916
930
  } | {
917
931
  readonly filters?: readonly {
918
932
  readonly property: string;
@@ -1573,6 +1587,13 @@ export default function useCanvas(): {
1573
1587
  readonly show_heading?: boolean | undefined;
1574
1588
  readonly heading_text?: string | undefined;
1575
1589
  readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
1590
+ readonly heading_font_family?: string | undefined;
1591
+ readonly heading_font_size?: number | undefined;
1592
+ readonly heading_color?: string | undefined;
1593
+ readonly heading_alignment?: "left" | "center" | "right" | undefined;
1594
+ readonly heading_bold?: boolean | undefined;
1595
+ readonly heading_italic?: boolean | undefined;
1596
+ readonly heading_underline?: boolean | undefined;
1576
1597
  } | {
1577
1598
  readonly filters?: readonly {
1578
1599
  readonly property: string;
@@ -2089,6 +2110,13 @@ export default function useCanvas(): {
2089
2110
  readonly show_heading?: boolean | undefined;
2090
2111
  readonly heading_text?: string | undefined;
2091
2112
  readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
2113
+ readonly heading_font_family?: string | undefined;
2114
+ readonly heading_font_size?: number | undefined;
2115
+ readonly heading_color?: string | undefined;
2116
+ readonly heading_alignment?: "left" | "center" | "right" | undefined;
2117
+ readonly heading_bold?: boolean | undefined;
2118
+ readonly heading_italic?: boolean | undefined;
2119
+ readonly heading_underline?: boolean | undefined;
2092
2120
  } | {
2093
2121
  readonly filters?: readonly {
2094
2122
  readonly property: string;
@@ -2567,6 +2595,13 @@ export default function useCanvas(): {
2567
2595
  show_heading?: boolean | undefined;
2568
2596
  heading_text?: string | undefined;
2569
2597
  layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
2598
+ heading_font_family?: string | undefined;
2599
+ heading_font_size?: number | undefined;
2600
+ heading_color?: string | undefined;
2601
+ heading_alignment?: "left" | "center" | "right" | undefined;
2602
+ heading_bold?: boolean | undefined;
2603
+ heading_italic?: boolean | undefined;
2604
+ heading_underline?: boolean | undefined;
2570
2605
  } | {
2571
2606
  filters?: {
2572
2607
  property: string;
@@ -3026,6 +3061,13 @@ export default function useCanvas(): {
3026
3061
  show_heading?: boolean | undefined;
3027
3062
  heading_text?: string | undefined;
3028
3063
  layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
3064
+ heading_font_family?: string | undefined;
3065
+ heading_font_size?: number | undefined;
3066
+ heading_color?: string | undefined;
3067
+ heading_alignment?: "left" | "center" | "right" | undefined;
3068
+ heading_bold?: boolean | undefined;
3069
+ heading_italic?: boolean | undefined;
3070
+ heading_underline?: boolean | undefined;
3029
3071
  } | {
3030
3072
  filters?: {
3031
3073
  property: string;
@@ -3561,6 +3603,13 @@ export default function useCanvas(): {
3561
3603
  readonly show_heading?: boolean | undefined;
3562
3604
  readonly heading_text?: string | undefined;
3563
3605
  readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
3606
+ readonly heading_font_family?: string | undefined;
3607
+ readonly heading_font_size?: number | undefined;
3608
+ readonly heading_color?: string | undefined;
3609
+ readonly heading_alignment?: "left" | "center" | "right" | undefined;
3610
+ readonly heading_bold?: boolean | undefined;
3611
+ readonly heading_italic?: boolean | undefined;
3612
+ readonly heading_underline?: boolean | undefined;
3564
3613
  } | {
3565
3614
  readonly filters?: readonly {
3566
3615
  readonly property: string;
@@ -4270,6 +4319,13 @@ export default function useCanvas(): {
4270
4319
  readonly show_heading?: boolean | undefined;
4271
4320
  readonly heading_text?: string | undefined;
4272
4321
  readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
4322
+ readonly heading_font_family?: string | undefined;
4323
+ readonly heading_font_size?: number | undefined;
4324
+ readonly heading_color?: string | undefined;
4325
+ readonly heading_alignment?: "left" | "center" | "right" | undefined;
4326
+ readonly heading_bold?: boolean | undefined;
4327
+ readonly heading_italic?: boolean | undefined;
4328
+ readonly heading_underline?: boolean | undefined;
4273
4329
  } | {
4274
4330
  readonly filters?: readonly {
4275
4331
  readonly property: string;
@@ -4738,6 +4794,13 @@ export default function useCanvas(): {
4738
4794
  show_heading?: boolean | undefined;
4739
4795
  heading_text?: string | undefined;
4740
4796
  layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
4797
+ heading_font_family?: string | undefined;
4798
+ heading_font_size?: number | undefined;
4799
+ heading_color?: string | undefined;
4800
+ heading_alignment?: "left" | "center" | "right" | undefined;
4801
+ heading_bold?: boolean | undefined;
4802
+ heading_italic?: boolean | undefined;
4803
+ heading_underline?: boolean | undefined;
4741
4804
  } | {
4742
4805
  filters?: {
4743
4806
  property: string;
@@ -560,6 +560,13 @@ export default function useCanvasBlocks(): {
560
560
  readonly show_heading?: boolean | undefined;
561
561
  readonly heading_text?: string | undefined;
562
562
  readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
563
+ readonly heading_font_family?: string | undefined;
564
+ readonly heading_font_size?: number | undefined;
565
+ readonly heading_color?: string | undefined;
566
+ readonly heading_alignment?: "left" | "center" | "right" | undefined;
567
+ readonly heading_bold?: boolean | undefined;
568
+ readonly heading_italic?: boolean | undefined;
569
+ readonly heading_underline?: boolean | undefined;
563
570
  } | {
564
571
  readonly filters?: readonly {
565
572
  readonly property: string;
@@ -1061,6 +1068,13 @@ export default function useCanvasBlocks(): {
1061
1068
  readonly show_heading?: boolean | undefined;
1062
1069
  readonly heading_text?: string | undefined;
1063
1070
  readonly layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
1071
+ readonly heading_font_family?: string | undefined;
1072
+ readonly heading_font_size?: number | undefined;
1073
+ readonly heading_color?: string | undefined;
1074
+ readonly heading_alignment?: "left" | "center" | "right" | undefined;
1075
+ readonly heading_bold?: boolean | undefined;
1076
+ readonly heading_italic?: boolean | undefined;
1077
+ readonly heading_underline?: boolean | undefined;
1064
1078
  } | {
1065
1079
  readonly filters?: readonly {
1066
1080
  readonly property: string;
@@ -366,6 +366,13 @@ export default function useCanvasHistory(): {
366
366
  show_heading?: boolean | undefined;
367
367
  heading_text?: string | undefined;
368
368
  layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
369
+ heading_font_family?: string | undefined;
370
+ heading_font_size?: number | undefined;
371
+ heading_color?: string | undefined;
372
+ heading_alignment?: "left" | "center" | "right" | undefined;
373
+ heading_bold?: boolean | undefined;
374
+ heading_italic?: boolean | undefined;
375
+ heading_underline?: boolean | undefined;
369
376
  } | {
370
377
  filters?: {
371
378
  property: string;
@@ -833,6 +840,13 @@ export default function useCanvasHistory(): {
833
840
  show_heading?: boolean | undefined;
834
841
  heading_text?: string | undefined;
835
842
  layout_type?: import('../types/canvas').ContentGridLayoutTypes | undefined;
843
+ heading_font_family?: string | undefined;
844
+ heading_font_size?: number | undefined;
845
+ heading_color?: string | undefined;
846
+ heading_alignment?: "left" | "center" | "right" | undefined;
847
+ heading_bold?: boolean | undefined;
848
+ heading_italic?: boolean | undefined;
849
+ heading_underline?: boolean | undefined;
836
850
  } | {
837
851
  filters?: {
838
852
  property: string;
@@ -92,7 +92,7 @@ export default function useCanvasTheme(): {
92
92
  readonly deactivated_at: string | null;
93
93
  readonly activated_at: string | null;
94
94
  readonly is_active: boolean;
95
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
95
+ language?: string | undefined;
96
96
  readonly connected_services: {
97
97
  connection_id: string;
98
98
  type: string;
@@ -121,7 +121,7 @@ export default function useCanvasTheme(): {
121
121
  readonly deactivated_at: string | null;
122
122
  readonly activated_at: string | null;
123
123
  readonly is_active: boolean;
124
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
124
+ language?: string | undefined;
125
125
  readonly connected_services: {
126
126
  connection_id: string;
127
127
  type: string;
@@ -150,7 +150,7 @@ export default function useCanvasTheme(): {
150
150
  readonly deactivated_at: string | null;
151
151
  readonly activated_at: string | null;
152
152
  readonly is_active: boolean;
153
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
153
+ language?: string | undefined;
154
154
  readonly connected_services: {
155
155
  connection_id: string;
156
156
  type: string;
@@ -209,7 +209,7 @@ export default function useCanvasTheme(): {
209
209
  readonly deactivated_at: string | null;
210
210
  readonly activated_at: string | null;
211
211
  readonly is_active: boolean;
212
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
212
+ language?: string | undefined;
213
213
  readonly connected_services: {
214
214
  connection_id: string;
215
215
  type: string;
@@ -238,7 +238,7 @@ export default function useCanvasTheme(): {
238
238
  readonly deactivated_at: string | null;
239
239
  readonly activated_at: string | null;
240
240
  readonly is_active: boolean;
241
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
241
+ language?: string | undefined;
242
242
  readonly connected_services: {
243
243
  connection_id: string;
244
244
  type: string;
@@ -267,7 +267,7 @@ export default function useCanvasTheme(): {
267
267
  readonly deactivated_at: string | null;
268
268
  readonly activated_at: string | null;
269
269
  readonly is_active: boolean;
270
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
270
+ language?: string | undefined;
271
271
  readonly connected_services: {
272
272
  connection_id: string;
273
273
  type: string;
@@ -489,7 +489,7 @@ export default function useCanvasTheme(): {
489
489
  readonly deactivated_at: string | null;
490
490
  readonly activated_at: string | null;
491
491
  readonly is_active: boolean;
492
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
492
+ language?: string | undefined;
493
493
  readonly connected_services: {
494
494
  connection_id: string;
495
495
  type: string;
@@ -518,7 +518,7 @@ export default function useCanvasTheme(): {
518
518
  readonly deactivated_at: string | null;
519
519
  readonly activated_at: string | null;
520
520
  readonly is_active: boolean;
521
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
521
+ language?: string | undefined;
522
522
  readonly connected_services: {
523
523
  connection_id: string;
524
524
  type: string;
@@ -547,7 +547,7 @@ export default function useCanvasTheme(): {
547
547
  readonly deactivated_at: string | null;
548
548
  readonly activated_at: string | null;
549
549
  readonly is_active: boolean;
550
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
550
+ language?: string | undefined;
551
551
  readonly connected_services: {
552
552
  connection_id: string;
553
553
  type: string;
@@ -606,7 +606,7 @@ export default function useCanvasTheme(): {
606
606
  readonly deactivated_at: string | null;
607
607
  readonly activated_at: string | null;
608
608
  readonly is_active: boolean;
609
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
609
+ language?: string | undefined;
610
610
  readonly connected_services: {
611
611
  connection_id: string;
612
612
  type: string;
@@ -635,7 +635,7 @@ export default function useCanvasTheme(): {
635
635
  readonly deactivated_at: string | null;
636
636
  readonly activated_at: string | null;
637
637
  readonly is_active: boolean;
638
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
638
+ language?: string | undefined;
639
639
  readonly connected_services: {
640
640
  connection_id: string;
641
641
  type: string;
@@ -664,7 +664,7 @@ export default function useCanvasTheme(): {
664
664
  readonly deactivated_at: string | null;
665
665
  readonly activated_at: string | null;
666
666
  readonly is_active: boolean;
667
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
667
+ language?: string | undefined;
668
668
  readonly connected_services: {
669
669
  connection_id: string;
670
670
  type: string;
@@ -731,7 +731,7 @@ export default function useCanvasTheme(): {
731
731
  readonly deactivated_at: string | null;
732
732
  readonly activated_at: string | null;
733
733
  readonly is_active: boolean;
734
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
734
+ language?: string | undefined;
735
735
  readonly connected_services: {
736
736
  connection_id: string;
737
737
  type: string;
@@ -760,7 +760,7 @@ export default function useCanvasTheme(): {
760
760
  readonly deactivated_at: string | null;
761
761
  readonly activated_at: string | null;
762
762
  readonly is_active: boolean;
763
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
763
+ language?: string | undefined;
764
764
  readonly connected_services: {
765
765
  connection_id: string;
766
766
  type: string;
@@ -789,7 +789,7 @@ export default function useCanvasTheme(): {
789
789
  readonly deactivated_at: string | null;
790
790
  readonly activated_at: string | null;
791
791
  readonly is_active: boolean;
792
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
792
+ language?: string | undefined;
793
793
  readonly connected_services: {
794
794
  connection_id: string;
795
795
  type: string;
@@ -848,7 +848,7 @@ export default function useCanvasTheme(): {
848
848
  readonly deactivated_at: string | null;
849
849
  readonly activated_at: string | null;
850
850
  readonly is_active: boolean;
851
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
851
+ language?: string | undefined;
852
852
  readonly connected_services: {
853
853
  connection_id: string;
854
854
  type: string;
@@ -877,7 +877,7 @@ export default function useCanvasTheme(): {
877
877
  readonly deactivated_at: string | null;
878
878
  readonly activated_at: string | null;
879
879
  readonly is_active: boolean;
880
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
880
+ language?: string | undefined;
881
881
  readonly connected_services: {
882
882
  connection_id: string;
883
883
  type: string;
@@ -906,7 +906,7 @@ export default function useCanvasTheme(): {
906
906
  readonly deactivated_at: string | null;
907
907
  readonly activated_at: string | null;
908
908
  readonly is_active: boolean;
909
- language?: import('../../../../types/openapi').LanguageEnum | undefined;
909
+ language?: string | undefined;
910
910
  readonly connected_services: {
911
911
  connection_id: string;
912
912
  type: string;
@@ -44,6 +44,7 @@ export declare function usePopupApps(): {
44
44
  enabled: boolean;
45
45
  headless?: boolean | undefined;
46
46
  auto_install?: boolean | undefined;
47
+ course_only?: boolean | undefined;
47
48
  entry?: string | undefined;
48
49
  settings?: {
49
50
  sections: {
@@ -58,6 +59,7 @@ export declare function usePopupApps(): {
58
59
  label: string;
59
60
  value: string;
60
61
  }[] | undefined;
62
+ dynamic_options?: string | undefined;
61
63
  }[];
62
64
  }[];
63
65
  } | undefined;
@@ -94,6 +96,7 @@ export declare function usePopupApps(): {
94
96
  enabled: boolean;
95
97
  headless?: boolean | undefined;
96
98
  auto_install?: boolean | undefined;
99
+ course_only?: boolean | undefined;
97
100
  entry?: string | undefined;
98
101
  settings?: {
99
102
  sections: {
@@ -108,6 +111,7 @@ export declare function usePopupApps(): {
108
111
  label: string;
109
112
  value: string;
110
113
  }[] | undefined;
114
+ dynamic_options?: string | undefined;
111
115
  }[];
112
116
  }[];
113
117
  } | undefined;
@@ -144,6 +148,7 @@ export declare function usePopupApps(): {
144
148
  enabled: boolean;
145
149
  headless?: boolean | undefined;
146
150
  auto_install?: boolean | undefined;
151
+ course_only?: boolean | undefined;
147
152
  entry?: string | undefined;
148
153
  settings?: {
149
154
  sections: {
@@ -158,6 +163,7 @@ export declare function usePopupApps(): {
158
163
  label: string;
159
164
  value: string;
160
165
  }[] | undefined;
166
+ dynamic_options?: string | undefined;
161
167
  }[];
162
168
  }[];
163
169
  } | undefined;
@@ -194,6 +200,7 @@ export declare function usePopupApps(): {
194
200
  enabled: boolean;
195
201
  headless?: boolean | undefined;
196
202
  auto_install?: boolean | undefined;
203
+ course_only?: boolean | undefined;
197
204
  entry?: string | undefined;
198
205
  settings?: {
199
206
  sections: {
@@ -208,6 +215,7 @@ export declare function usePopupApps(): {
208
215
  label: string;
209
216
  value: string;
210
217
  }[] | undefined;
218
+ dynamic_options?: string | undefined;
211
219
  }[];
212
220
  }[];
213
221
  } | undefined;
@@ -244,6 +252,7 @@ export declare function usePopupApps(): {
244
252
  enabled: boolean;
245
253
  headless?: boolean | undefined;
246
254
  auto_install?: boolean | undefined;
255
+ course_only?: boolean | undefined;
247
256
  entry?: string | undefined;
248
257
  settings?: {
249
258
  sections: {
@@ -258,6 +267,7 @@ export declare function usePopupApps(): {
258
267
  label: string;
259
268
  value: string;
260
269
  }[] | undefined;
270
+ dynamic_options?: string | undefined;
261
271
  }[];
262
272
  }[];
263
273
  } | undefined;
@@ -294,6 +304,7 @@ export declare function usePopupApps(): {
294
304
  enabled: boolean;
295
305
  headless?: boolean | undefined;
296
306
  auto_install?: boolean | undefined;
307
+ course_only?: boolean | undefined;
297
308
  entry?: string | undefined;
298
309
  settings?: {
299
310
  sections: {
@@ -308,6 +319,7 @@ export declare function usePopupApps(): {
308
319
  label: string;
309
320
  value: string;
310
321
  }[] | undefined;
322
+ dynamic_options?: string | undefined;
311
323
  }[];
312
324
  }[];
313
325
  } | undefined;
@@ -344,6 +356,7 @@ export declare function usePopupApps(): {
344
356
  enabled: boolean;
345
357
  headless?: boolean | undefined;
346
358
  auto_install?: boolean | undefined;
359
+ course_only?: boolean | undefined;
347
360
  entry?: string | undefined;
348
361
  settings?: {
349
362
  sections: {
@@ -358,6 +371,7 @@ export declare function usePopupApps(): {
358
371
  label: string;
359
372
  value: string;
360
373
  }[] | undefined;
374
+ dynamic_options?: string | undefined;
361
375
  }[];
362
376
  }[];
363
377
  } | undefined;
@@ -493,6 +507,7 @@ export declare function usePopupApps(): {
493
507
  enabled: boolean;
494
508
  headless?: boolean | undefined;
495
509
  auto_install?: boolean | undefined;
510
+ course_only?: boolean | undefined;
496
511
  entry?: string | undefined;
497
512
  settings?: {
498
513
  sections: {
@@ -507,6 +522,7 @@ export declare function usePopupApps(): {
507
522
  label: string;
508
523
  value: string;
509
524
  }[] | undefined;
525
+ dynamic_options?: string | undefined;
510
526
  }[];
511
527
  }[];
512
528
  } | undefined;
@@ -543,6 +559,7 @@ export declare function usePopupApps(): {
543
559
  enabled: boolean;
544
560
  headless?: boolean | undefined;
545
561
  auto_install?: boolean | undefined;
562
+ course_only?: boolean | undefined;
546
563
  entry?: string | undefined;
547
564
  settings?: {
548
565
  sections: {
@@ -557,6 +574,7 @@ export declare function usePopupApps(): {
557
574
  label: string;
558
575
  value: string;
559
576
  }[] | undefined;
577
+ dynamic_options?: string | undefined;
560
578
  }[];
561
579
  }[];
562
580
  } | undefined;
@@ -593,6 +611,7 @@ export declare function usePopupApps(): {
593
611
  enabled: boolean;
594
612
  headless?: boolean | undefined;
595
613
  auto_install?: boolean | undefined;
614
+ course_only?: boolean | undefined;
596
615
  entry?: string | undefined;
597
616
  settings?: {
598
617
  sections: {
@@ -607,6 +626,7 @@ export declare function usePopupApps(): {
607
626
  label: string;
608
627
  value: string;
609
628
  }[] | undefined;
629
+ dynamic_options?: string | undefined;
610
630
  }[];
611
631
  }[];
612
632
  } | undefined;
@@ -643,6 +663,7 @@ export declare function usePopupApps(): {
643
663
  enabled: boolean;
644
664
  headless?: boolean | undefined;
645
665
  auto_install?: boolean | undefined;
666
+ course_only?: boolean | undefined;
646
667
  entry?: string | undefined;
647
668
  settings?: {
648
669
  sections: {
@@ -657,6 +678,7 @@ export declare function usePopupApps(): {
657
678
  label: string;
658
679
  value: string;
659
680
  }[] | undefined;
681
+ dynamic_options?: string | undefined;
660
682
  }[];
661
683
  }[];
662
684
  } | undefined;
@@ -693,6 +715,7 @@ export declare function usePopupApps(): {
693
715
  enabled: boolean;
694
716
  headless?: boolean | undefined;
695
717
  auto_install?: boolean | undefined;
718
+ course_only?: boolean | undefined;
696
719
  entry?: string | undefined;
697
720
  settings?: {
698
721
  sections: {
@@ -707,6 +730,7 @@ export declare function usePopupApps(): {
707
730
  label: string;
708
731
  value: string;
709
732
  }[] | undefined;
733
+ dynamic_options?: string | undefined;
710
734
  }[];
711
735
  }[];
712
736
  } | undefined;
@@ -743,6 +767,7 @@ export declare function usePopupApps(): {
743
767
  enabled: boolean;
744
768
  headless?: boolean | undefined;
745
769
  auto_install?: boolean | undefined;
770
+ course_only?: boolean | undefined;
746
771
  entry?: string | undefined;
747
772
  settings?: {
748
773
  sections: {
@@ -757,6 +782,7 @@ export declare function usePopupApps(): {
757
782
  label: string;
758
783
  value: string;
759
784
  }[] | undefined;
785
+ dynamic_options?: string | undefined;
760
786
  }[];
761
787
  }[];
762
788
  } | undefined;
@@ -793,6 +819,7 @@ export declare function usePopupApps(): {
793
819
  enabled: boolean;
794
820
  headless?: boolean | undefined;
795
821
  auto_install?: boolean | undefined;
822
+ course_only?: boolean | undefined;
796
823
  entry?: string | undefined;
797
824
  settings?: {
798
825
  sections: {
@@ -807,6 +834,7 @@ export declare function usePopupApps(): {
807
834
  label: string;
808
835
  value: string;
809
836
  }[] | undefined;
837
+ dynamic_options?: string | undefined;
810
838
  }[];
811
839
  }[];
812
840
  } | undefined;
@@ -109,6 +109,13 @@ export interface DynamicContentProps {
109
109
  show_heading?: boolean;
110
110
  heading_text?: string;
111
111
  layout_type?: ContentGridLayoutTypes;
112
+ heading_font_family?: string;
113
+ heading_font_size?: number;
114
+ heading_color?: string;
115
+ heading_alignment?: 'left' | 'center' | 'right';
116
+ heading_bold?: boolean;
117
+ heading_italic?: boolean;
118
+ heading_underline?: boolean;
112
119
  }
113
120
  export interface CustomDataTableHierarchyLevel {
114
121
  type: 'group' | 'data';
@@ -14,6 +14,17 @@ export declare function getComponentDescription(type: ComponentTypes | string, t
14
14
  description?: string;
15
15
  }): string;
16
16
  export declare function getNodeDisplayNameByComponentType(node: ComponentNode | null | undefined): string;
17
+ /**
18
+ * Resolves a component's human-readable title the same way the editor's Reorder panel does:
19
+ * prefer the admin-given name (`tracking_id`, via getNodeDisplayNameByComponentType), otherwise
20
+ * fall back to a localized component-type label. The name is trimmed first, so a whitespace-only
21
+ * value (e.g. a blank Text or a whitespace tracking_id) falls back to the type label instead of
22
+ * rendering a blank row; the `!== node.type` guard likewise prevents an un-renamed node (whose
23
+ * tracking_id defaults to its type string) from surfacing the raw type as its title.
24
+ * Shared by the editor Reorder panel and the rep "Customize your homepage" panel so the two views
25
+ * stay consistent by construction.
26
+ */
27
+ export declare function getNodeDisplayTitle(node: ComponentNode, t: (input: string) => string): string;
17
28
  export declare function getSectionGlobalComponentSpacing(section: CanvasRetrieve['sections'][number]): string | undefined;
18
29
  export declare function discardSectionComponentOverride(sectionId: CanvasRetrieve['id'], componentId: ComponentNode['id'], overrides: SectionComponentOverrides): SectionComponentOverrides;
19
30
  export declare function addCanvasComponent(currentContent: ComponentNode[], add: {
@@ -54,5 +65,13 @@ export declare function updateFirstCollectionPlayerWithShareboxItems(canvasConte
54
65
  export declare function handleThemeAssetComparison(key: string | symbol | number, objValue: any, othValue: any, object: any, other: any, fileProps: string[], isEqual: (obj1: any, obj2: any) => boolean, componentsWithThemeMeta?: Set<string>): boolean | undefined;
55
66
  export declare function applyCanvasThemeAssetsToNode(node: ComponentNode): ComponentNode;
56
67
  export declare function processCanvasForSectionThemeOverride(canvas: CanvasRetrieve, maintainSectionTheme: boolean): CanvasRetrieve;
68
+ /**
69
+ * Append `?instance_id=` to a core-API path when the id is known (PIT-7587).
70
+ * The canvas metadata PATCH is gated on the instance-scoped `canvas.update`
71
+ * permission, and the proxy doesn't forward `x-instance-id` on these calls, so
72
+ * instance context must travel as a query param (mirrors next-core's
73
+ * header-then-query fallback in `with-permission.ts`).
74
+ */
75
+ export declare function withInstanceId(path: string, instanceId?: string | null): string;
57
76
  export declare function isEmbeddableWithZeroHeight(component: ComponentNode): boolean;
58
77
  export {};
@@ -0,0 +1,17 @@
1
+ import { default as PSPDFKitType } from 'pspdfkit';
2
+ /**
3
+ * Tear down a PSPDFKit instance for a container without ever throwing.
4
+ *
5
+ * A password-protected PDF makes PSPDFKit render its own built-in password
6
+ * dialog and stay mid-load (the `PSPDFKit.load()` Promise never resolves, so no
7
+ * instance is ever assigned). Calling `PSPDFKit.unload(container)` while the
8
+ * container is still loading throws — which previously propagated out of the
9
+ * viewer's close handler and aborted it before the host was told to close. The
10
+ * user was then stuck on the password prompt with no way out but a full browser
11
+ * refresh (neither Exit nor Esc worked).
12
+ *
13
+ * Swallowing the unload error here keeps close/unmount teardown resilient: the
14
+ * container is removed from the DOM by the unmount that follows, which is what
15
+ * actually disposes the stuck dialog.
16
+ */
17
+ export declare function safePspdfkitUnload(pspdfkit: Pick<typeof PSPDFKitType, 'unload'> | undefined, container: HTMLElement | null): void;