@pitcher/js-api 1.29.0 → 1.31.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 (158) hide show
  1. package/js-api.esm.js +488 -56
  2. package/js-api.esm.js.map +1 -1
  3. package/js-api.umd.min.js +32 -11
  4. package/js-api.umd.min.js.map +1 -1
  5. package/lib/ai-tasks/__tests__/weekly-focus.spec.d.ts +1 -0
  6. package/lib/ai-tasks/weekly-focus.d.ts +241 -0
  7. package/lib/apps/browser/appTypes.d.ts +28 -0
  8. package/lib/apps/browser/components/ContextMenu/TranslateFileButton.test.d.ts +1 -0
  9. package/lib/apps/browser/stores/api.d.ts +6 -1
  10. package/lib/apps/browser/stores/api.filesFoldersDeleter.test.d.ts +1 -0
  11. package/lib/apps/browser/stores/app.d.ts +5 -0
  12. package/lib/apps/browser/stores/app.selectionPruneScope.test.d.ts +1 -0
  13. package/lib/apps/browser/stores/upload.d.ts +26 -1
  14. package/lib/apps/browser/stores/upload.types.d.ts +9 -0
  15. package/lib/apps/browser/util/lifecycle.d.ts +57 -0
  16. package/lib/apps/browser/util/lifecycle.test.d.ts +1 -0
  17. package/lib/apps/canvas-builder/components/container/PopupApps/PopupAppModal.spec.d.ts +1 -0
  18. package/lib/apps/canvas-builder/components/container/PresentationTools/PresentationToolsButtons.spec.d.ts +1 -0
  19. package/lib/apps/canvas-builder/components/ui/BottomSheetModal/BottomSheetModal.integration.spec.d.ts +1 -0
  20. package/lib/apps/canvas-builder/components/ui/BottomSheetModal/BottomSheetModal.spec.d.ts +1 -0
  21. package/lib/apps/canvas-builder/components/ui/DynamicContent/section-component-bindings.util.d.ts +32 -0
  22. package/lib/apps/canvas-builder/components/ui/DynamicContent/useDynamicContent.d.ts +6 -0
  23. package/lib/apps/canvas-builder/components/ui/Link/Link.util.d.ts +8 -1
  24. package/lib/apps/canvas-builder/components/ui/Link/Link.util.test.d.ts +1 -0
  25. package/lib/apps/canvas-builder/components/ui/Multimedia/Multimedia.ldAsset.spec.d.ts +1 -0
  26. package/lib/apps/canvas-builder/components/ui/SectionList/SectionItemModal.spec.d.ts +1 -0
  27. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +286 -10
  28. package/lib/apps/canvas-builder/composables/useCanvas.saveEcho.spec.d.ts +1 -0
  29. package/lib/apps/canvas-builder/composables/useCanvasBlocks.d.ts +40 -2
  30. package/lib/apps/canvas-builder/composables/useCanvasExit.d.ts +1 -0
  31. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +38 -2
  32. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +4 -2
  33. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +8 -1
  34. package/lib/apps/canvas-builder/composables/useInstalledEmbeddables.d.ts +1 -1
  35. package/lib/apps/canvas-builder/composables/useNavigatorDrawer.d.ts +27 -0
  36. package/lib/apps/canvas-builder/composables/useNavigatorDrawer.spec.d.ts +1 -0
  37. package/lib/apps/canvas-builder/composables/usePopupApps.d.ts +43 -4
  38. package/lib/apps/canvas-builder/composables/usePopupApps.spec.d.ts +1 -0
  39. package/lib/apps/canvas-builder/composables/usePresentationTools.d.ts +112 -0
  40. package/lib/apps/canvas-builder/composables/usePresentationTools.spec.d.ts +1 -0
  41. package/lib/apps/canvas-builder/types/canvas.d.ts +66 -3
  42. package/lib/apps/canvas-builder/util/canvas.util.d.ts +12 -0
  43. package/lib/apps/canvas-builder/util/completionWizard.util.d.ts +347 -0
  44. package/lib/apps/canvas-builder/util/completionWizard.util.test.d.ts +1 -0
  45. package/lib/apps/canvas-builder/util/fullscreenMode.util.d.ts +7 -0
  46. package/lib/apps/canvas-builder/util/fullscreenMode.util.test.d.ts +1 -0
  47. package/lib/apps/canvas-builder/util/iframe.util.d.ts +24 -2
  48. package/lib/apps/canvas-builder/util/iframe.util.test.d.ts +1 -0
  49. package/lib/apps/canvas-builder/util/lazySections.util.d.ts +35 -0
  50. package/lib/apps/canvas-builder/util/lazySections.util.test.d.ts +1 -0
  51. package/lib/apps/canvas-selector/stores/app.d.ts +14 -0
  52. package/lib/apps/collection-player/components/AppHeader.spec.d.ts +1 -0
  53. package/lib/apps/collection-player/composables/collection-navigation.util.d.ts +27 -0
  54. package/lib/apps/collection-player/composables/collection-navigation.util.spec.d.ts +1 -0
  55. package/lib/apps/collection-player/composables/speaker-notes.use.d.ts +14 -0
  56. package/lib/apps/collection-player/composables/speaker-notes.use.spec.d.ts +1 -0
  57. package/lib/apps/collection-player/stores/app.store.d.ts +8 -1
  58. package/lib/apps/collection-player/stores/showNotesToggle.spec.d.ts +1 -0
  59. package/lib/apps/content-selector/appTypes.d.ts +16 -0
  60. package/lib/apps/content-selector/components/Assets.uploaderRefresh.spec.d.ts +1 -0
  61. package/lib/apps/content-selector/components/Content/AllContent/List/expandFileGuard.spec.d.ts +1 -0
  62. package/lib/apps/content-selector/stores/app.d.ts +1 -1
  63. package/lib/apps/notes/NotesApp.accountNotes.spec.d.ts +1 -0
  64. package/lib/apps/notes/NotesApp.speakerNotes.spec.d.ts +1 -0
  65. package/lib/apps/notes/composables/useAccountNotes.d.ts +14 -0
  66. package/lib/apps/notes/composables/useAccountNotes.spec.d.ts +1 -0
  67. package/lib/apps/notes/composables/useAccountOnlyNotesGate.d.ts +21 -0
  68. package/lib/apps/notes/composables/useAccountOnlyNotesGate.spec.d.ts +1 -0
  69. package/lib/apps/notes/composables/useActiveSlideNotes.d.ts +42 -0
  70. package/lib/apps/notes/composables/useActiveSlideNotes.spec.d.ts +1 -0
  71. package/lib/components/CFileAccessManagement/collaborationApi.d.ts +2 -0
  72. package/lib/components/CFilePanel/Details.spec.d.ts +1 -0
  73. package/lib/components/CFilePanel/KeyMessages.spec.d.ts +1 -0
  74. package/lib/components/CFilePanel/Summary.spec.d.ts +1 -0
  75. package/lib/components/CFileViewer/pdf/CFileViewer.pdf.annotations.use.d.ts +5 -1
  76. package/lib/components/CFileViewer/pdf/CFileViewer.pdf.formFields.use.d.ts +8 -0
  77. package/lib/components/CFileViewer/pdf/CFileViewer.pdf.link.use.d.ts +1 -1
  78. package/lib/components/CFileViewer/pdf/CFileViewer.pdf.overlayItems.use.d.ts +1 -1
  79. package/lib/components/CFileViewer/pdf/CFileViewer.pdf.use.d.ts +4 -9
  80. package/lib/components/CFileViewer/pdf/CFileViewer.pdf.util.d.ts +53 -1
  81. package/lib/components/CFileViewer/pdf/CFileViewerFullscreen.pdf.use.d.ts +1 -1
  82. package/lib/components/CFileViewer/pdf/__tests__/CFileViewer.pdf.annotations.text.test.d.ts +1 -0
  83. package/lib/components/CGlobalLoader/CGlobalLoaderMark.spec.d.ts +1 -0
  84. package/lib/components/CGlobalLoader/globalLoader.paths.d.ts +2 -0
  85. package/lib/components/CGlobalSearch/globalSearchTarget.util.d.ts +31 -0
  86. package/lib/components/CGlobalSearch/globalSearchTarget.util.test.d.ts +1 -0
  87. package/lib/components/CRichTextEditor/extensions/paragraphExtended.d.ts +7 -1
  88. package/lib/components/CRichTextEditor/extensions/paragraphExtended.test.d.ts +1 -0
  89. package/lib/components/canvases/CanvasesManagementBulk.use.d.ts +12 -2
  90. package/lib/components/masterCanvases/CMasterCanvasesManagement.use.d.ts +86 -0
  91. package/lib/components/masterCanvases/CMasterCanvasesManagement.use.spec.d.ts +1 -0
  92. package/lib/components/masterCanvases/CMasterCanvasesPendingShareCell.spec.d.ts +1 -0
  93. package/lib/components/masterCanvases/CMasterCanvasesSharedWithCell.use.d.ts +39 -0
  94. package/lib/components/masterCanvases/CMasterCanvasesSharedWithCell.use.spec.d.ts +1 -0
  95. package/lib/components/masterCanvases/createFromMaster.use.d.ts +255 -0
  96. package/lib/components/masterCanvases/createFromMaster.use.spec.d.ts +1 -0
  97. package/lib/components/masterCanvases/masterCanvasDocuments.use.d.ts +56 -0
  98. package/lib/components/masterCanvases/masterCanvasDocuments.use.spec.d.ts +1 -0
  99. package/lib/components/masterCanvases/masterCanvasShares.use.d.ts +103 -0
  100. package/lib/components/masterCanvases/masterCanvasShares.use.spec.d.ts +1 -0
  101. package/lib/components/masterCanvases/masterFromCanvas.use.d.ts +122 -0
  102. package/lib/components/masterCanvases/masterFromCanvas.use.spec.d.ts +1 -0
  103. package/lib/components/masterCanvases/masterFromTemplate.use.d.ts +50 -0
  104. package/lib/components/masterCanvases/masterFromTemplate.use.spec.d.ts +1 -0
  105. package/lib/components/savedCanvases/CSavedCanvasesManagement.use.d.ts +204 -0
  106. package/lib/components/savedCanvases/savedCanvasDocuments.use.d.ts +111 -0
  107. package/lib/components/savedCanvases/savedCanvasDocuments.use.spec.d.ts +1 -0
  108. package/lib/components/savedCanvases/smartFolders/SmartFolders.use.d.ts +4 -0
  109. package/lib/composables/useCourseOnlyApps.d.ts +1 -1
  110. package/lib/composables/usePdfInterpolation.d.ts +2 -2
  111. package/lib/composables/useWindowEvents.d.ts +1 -1
  112. package/lib/constants/cdp.const.d.ts +2 -0
  113. package/lib/constants/translationLanguages.const.d.ts +150 -0
  114. package/lib/constants/translationLanguages.const.spec.d.ts +1 -0
  115. package/lib/main.lib.d.ts +7 -0
  116. package/lib/sdk/api/HighLevelApi.d.ts +19 -6
  117. package/lib/sdk/api/modules/ai.d.ts +43 -1
  118. package/lib/sdk/api/modules/ai.spec.d.ts +1 -0
  119. package/lib/sdk/api/modules/appsDb.d.ts +4 -4
  120. package/lib/sdk/api/modules/canvas.d.ts +20 -0
  121. package/lib/sdk/api/modules/ui/types.ui.d.ts +25 -0
  122. package/lib/sdk/interfaces.d.ts +31 -1
  123. package/lib/sdk/main.d.ts +46 -0
  124. package/lib/sdk/payload.types.d.ts +149 -0
  125. package/lib/sdk/platform.d.ts +27 -0
  126. package/lib/sdk/platform.spec.d.ts +1 -0
  127. package/lib/sdk/singleton-scope.spec.d.ts +1 -0
  128. package/lib/sdk/utils/httpFetch.spec.d.ts +1 -0
  129. package/lib/theme/canvasUiUnoPreset.test.d.ts +1 -0
  130. package/lib/types/ai-tasks.const.d.ts +39 -1
  131. package/lib/types/app.d.ts +55 -1
  132. package/lib/types/call.d.ts +14 -0
  133. package/lib/types/canvases.d.ts +15 -0
  134. package/lib/types/launchDarkly.types.d.ts +8 -3
  135. package/lib/types/organizationSettings.types.d.ts +39 -0
  136. package/lib/util/aiSummary.d.ts +30 -0
  137. package/lib/util/aiSummary.spec.d.ts +1 -0
  138. package/lib/util/network.d.ts +35 -0
  139. package/lib/util/user.d.ts +18 -0
  140. package/lib/util/user.test.d.ts +1 -0
  141. package/package.json +1 -1
  142. package/types/openapi/models/Canvas.d.ts +1 -0
  143. package/types/openapi/models/CanvasCreate.d.ts +1 -0
  144. package/types/openapi/models/CanvasCreateRequest.d.ts +1 -0
  145. package/types/openapi/models/CanvasRecommendedFile.d.ts +1 -1
  146. package/types/openapi/models/CanvasRetrieve.d.ts +1 -0
  147. package/types/openapi/models/CanvasUpdate.d.ts +1 -0
  148. package/types/openapi/models/CanvasUpdateRequest.d.ts +1 -0
  149. package/types/openapi/models/DeletedCanvas.d.ts +1 -0
  150. package/types/openapi/models/DeletedEnvironment.d.ts +0 -1
  151. package/types/openapi/models/Environment.d.ts +0 -1
  152. package/types/openapi/models/EnvironmentRequest.d.ts +0 -1
  153. package/types/openapi/models/File.d.ts +3 -1
  154. package/types/openapi/models/FileRetrieve.d.ts +2 -0
  155. package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +1 -0
  156. package/types/openapi/models/PatchedEnvironmentRequest.d.ts +0 -1
  157. package/types/openapi/models/SharedLink.d.ts +6 -0
  158. package/types/openapi/models/SharedLinkCreateRequest.d.ts +5 -0
@@ -11,6 +11,7 @@ export type Canvas = {
11
11
  is_template?: boolean;
12
12
  is_section?: boolean;
13
13
  is_block?: boolean;
14
+ is_master?: boolean;
14
15
  is_editable?: boolean;
15
16
  is_default?: boolean;
16
17
  metadata?: any;
@@ -16,6 +16,7 @@ export type CanvasCreate = {
16
16
  is_template?: boolean;
17
17
  is_section?: boolean;
18
18
  is_block?: boolean;
19
+ is_master?: boolean;
19
20
  is_editable?: boolean;
20
21
  is_default?: boolean;
21
22
  metadata?: any;
@@ -11,6 +11,7 @@ export type CanvasCreateRequest = {
11
11
  is_template?: boolean;
12
12
  is_section?: boolean;
13
13
  is_block?: boolean;
14
+ is_master?: boolean;
14
15
  is_editable?: boolean;
15
16
  is_default?: boolean;
16
17
  metadata?: any;
@@ -45,5 +45,5 @@ export type CanvasRecommendedFile = {
45
45
  readonly created_at: string;
46
46
  readonly created_by: MiniUser;
47
47
  readonly modified_at: string;
48
- readonly modified_by: MiniUser;
48
+ readonly modified_by: MiniUser | null;
49
49
  };
@@ -16,6 +16,7 @@ export type CanvasRetrieve = {
16
16
  is_template?: boolean;
17
17
  is_section?: boolean;
18
18
  is_block?: boolean;
19
+ is_master?: boolean;
19
20
  is_editable?: boolean;
20
21
  is_default?: boolean;
21
22
  metadata?: any;
@@ -16,6 +16,7 @@ export type CanvasUpdate = {
16
16
  is_template?: boolean;
17
17
  is_section?: boolean;
18
18
  is_block?: boolean;
19
+ is_master?: boolean;
19
20
  is_editable?: boolean;
20
21
  is_default?: boolean;
21
22
  metadata?: any;
@@ -10,6 +10,7 @@ export type CanvasUpdateRequest = {
10
10
  is_template?: boolean;
11
11
  is_section?: boolean;
12
12
  is_block?: boolean;
13
+ is_master?: boolean;
13
14
  is_editable?: boolean;
14
15
  is_default?: boolean;
15
16
  metadata?: any;
@@ -11,6 +11,7 @@ export type DeletedCanvas = {
11
11
  is_template?: boolean;
12
12
  is_section?: boolean;
13
13
  is_block?: boolean;
14
+ is_master?: boolean;
14
15
  is_editable?: boolean;
15
16
  is_default?: boolean;
16
17
  metadata?: any;
@@ -2,7 +2,6 @@ import { MiniUser } from './MiniUser';
2
2
  export type DeletedEnvironment = {
3
3
  readonly id: number;
4
4
  name: string;
5
- next_environment_ids?: Array<number>;
6
5
  color?: string | null;
7
6
  readonly created_at: string;
8
7
  readonly created_by: MiniUser;
@@ -2,7 +2,6 @@ import { MiniUser } from './MiniUser';
2
2
  export type Environment = {
3
3
  readonly id: number;
4
4
  name: string;
5
- next_environment_ids?: Array<number>;
6
5
  color?: string | null;
7
6
  readonly created_at: string;
8
7
  readonly created_by: MiniUser;
@@ -1,5 +1,4 @@
1
1
  export type EnvironmentRequest = {
2
2
  name: string;
3
- next_environment_ids?: Array<number>;
4
3
  color?: string | null;
5
4
  };
@@ -23,6 +23,8 @@ export type File = {
23
23
  readonly original_url: string | null;
24
24
  readonly thumbnail_url: string | null;
25
25
  download_type?: DownloadTypeEnum;
26
+ /** iOS bridge only — not returned by the REST API. */
27
+ readonly downloaded_at?: string | null;
26
28
  readonly zip_size: number | null;
27
29
  readonly zip_url: string | null;
28
30
  access_type?: AccessTypeEnum;
@@ -45,5 +47,5 @@ export type File = {
45
47
  readonly created_at: string;
46
48
  readonly created_by: MiniUser;
47
49
  readonly modified_at: string;
48
- readonly modified_by: MiniUser;
50
+ readonly modified_by: MiniUser | null;
49
51
  };
@@ -26,6 +26,8 @@ export type FileRetrieve = {
26
26
  readonly original_url: string | null;
27
27
  readonly thumbnail_url: string | null;
28
28
  download_type?: DownloadTypeEnum;
29
+ /** iOS bridge only — not returned by the REST API. */
30
+ readonly downloaded_at?: string | null;
29
31
  readonly zip_size: number | null;
30
32
  readonly zip_url: string | null;
31
33
  access_type?: AccessTypeEnum;
@@ -10,6 +10,7 @@ export type PatchedCanvasUpdateRequest = {
10
10
  is_template?: boolean;
11
11
  is_section?: boolean;
12
12
  is_block?: boolean;
13
+ is_master?: boolean;
13
14
  is_editable?: boolean;
14
15
  is_default?: boolean;
15
16
  metadata?: any;
@@ -1,5 +1,4 @@
1
1
  export type PatchedEnvironmentRequest = {
2
2
  name?: string;
3
- next_environment_ids?: Array<number>;
4
3
  color?: string | null;
5
4
  };
@@ -11,4 +11,10 @@ export type SharedLink = {
11
11
  readonly status: string;
12
12
  readonly url: string;
13
13
  short_url?: string | null;
14
+ /**
15
+ * PIT-7682 - CLIENT-SET, never returned by the API. Marks a link that was re-created without
16
+ * the rep's chosen brand after the server rejected it, so the UI can say the pick was not
17
+ * applied. Set by `canvas.api.ts` on web and by the iOS bridge handler (`brand_fallback_applied`).
18
+ */
19
+ brand_fallback_applied?: boolean;
14
20
  };
@@ -2,4 +2,9 @@ export type SharedLinkCreateRequest = {
2
2
  short_url?: string | null;
3
3
  file_id?: string;
4
4
  canvas_id?: string;
5
+ /**
6
+ * PIT-7682 - id of an entry in the instance's `shared_link_brands` setting. Canvas links only;
7
+ * applies at creation, max 64 chars. Unknown or unusable ids are rejected with 400.
8
+ */
9
+ brand_id?: string;
5
10
  };