@pitcher/js-api 1.20.0-beta.15 → 1.20.1

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 (525) hide show
  1. package/js-api.umd.min.js +10 -10
  2. package/js-api.umd.min.js.map +1 -1
  3. package/package.json +2 -7
  4. package/js-api.esm.d.ts +0 -1
  5. package/js-api.esm.js +0 -3643
  6. package/js-api.esm.js.map +0 -1
  7. package/lib/api/apps/apps.queries.d.ts +0 -3
  8. package/lib/api/canvases/canvases.queries.d.ts +0 -15
  9. package/lib/api/events/events.helpers.d.ts +0 -29
  10. package/lib/api/events/events.queries.d.ts +0 -10
  11. package/lib/api/users/users.queries.d.ts +0 -5
  12. package/lib/apps/browser/composables/useAppEmit.d.ts +0 -3
  13. package/lib/apps/browser/stores/api.d.ts +0 -646
  14. package/lib/apps/browser/stores/api.test.d.ts +0 -1
  15. package/lib/apps/browser/stores/app.d.ts +0 -94
  16. package/lib/apps/browser/stores/app.test.d.ts +0 -1
  17. package/lib/apps/browser/stores/upload.d.ts +0 -111
  18. package/lib/apps/browser/stores/upload.types.d.ts +0 -18
  19. package/lib/apps/browser/util/file.d.ts +0 -3
  20. package/lib/apps/canvas-builder/App.helpers.d.ts +0 -12
  21. package/lib/apps/canvas-builder/components/ui/Link/Link.util.d.ts +0 -13
  22. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +0 -12724
  23. package/lib/apps/canvas-builder/composables/useCanvasDnd.d.ts +0 -12
  24. package/lib/apps/canvas-builder/composables/useCanvasExit.d.ts +0 -3
  25. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +0 -1782
  26. package/lib/apps/canvas-builder/composables/useCanvasHooks.d.ts +0 -25
  27. package/lib/apps/canvas-builder/composables/useCanvasPages.d.ts +0 -35
  28. package/lib/apps/canvas-builder/composables/useCanvasPages.spec.d.ts +0 -1
  29. package/lib/apps/canvas-builder/composables/useCanvasSectionOverrides.d.ts +0 -30
  30. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +0 -85
  31. package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts +0 -9
  32. package/lib/apps/canvas-builder/composables/useCollapsibles.d.ts +0 -14
  33. package/lib/apps/canvas-builder/composables/useComponentPermissions.d.ts +0 -14
  34. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +0 -51
  35. package/lib/apps/canvas-builder/composables/useFetchSectionAnalytics.d.ts +0 -3
  36. package/lib/apps/canvas-builder/composables/useInstalledEmbeddables.d.ts +0 -12
  37. package/lib/apps/canvas-builder/composables/useNavigatorDrawer.d.ts +0 -6
  38. package/lib/apps/canvas-builder/composables/usePitcherEvents.d.ts +0 -5
  39. package/lib/apps/canvas-builder/composables/useRecommendations.d.ts +0 -53
  40. package/lib/apps/canvas-builder/composables/useReorderComponent.d.ts +0 -16
  41. package/lib/apps/canvas-builder/composables/useSectionNavigation.d.ts +0 -16
  42. package/lib/apps/canvas-builder/composables/useSectionPopularity.d.ts +0 -34
  43. package/lib/apps/canvas-builder/constants/canvas.const.d.ts +0 -15
  44. package/lib/apps/canvas-builder/constants/defaults.const.d.ts +0 -1
  45. package/lib/apps/canvas-builder/constants/index.d.ts +0 -3
  46. package/lib/apps/canvas-builder/constants/sizes.d.ts +0 -2
  47. package/lib/apps/canvas-builder/types/canvas.d.ts +0 -467
  48. package/lib/apps/canvas-builder/types/font-awesome.types.d.ts +0 -2
  49. package/lib/apps/canvas-builder/types/recommendations.types.d.ts +0 -28
  50. package/lib/apps/canvas-builder/util/canvas.util.d.ts +0 -44
  51. package/lib/apps/canvas-builder/util/canvas.util.test.d.ts +0 -1
  52. package/lib/apps/canvas-builder/util/clone.d.ts +0 -1
  53. package/lib/apps/canvas-builder/util/file.util.d.ts +0 -6
  54. package/lib/apps/canvas-builder/util/tree.d.ts +0 -25
  55. package/lib/apps/canvas-builder/util/tree.test.d.ts +0 -1
  56. package/lib/apps/canvas-builder/util/url.d.ts +0 -5
  57. package/lib/apps/canvas-builder/util/url.test.d.ts +0 -1
  58. package/lib/apps/content-selector/appTypes.d.ts +0 -44
  59. package/lib/apps/content-selector/stores/app.d.ts +0 -83
  60. package/lib/apps/content-selector/util/file.d.ts +0 -3
  61. package/lib/apps/content-selector/util/media-type.util.d.ts +0 -1
  62. package/lib/apps/notes/composables/useFullscreenNotesHeartbeat.d.ts +0 -3
  63. package/lib/apps/notes/composables/useNotesApp.d.ts +0 -3
  64. package/lib/components/CCatalogIqSwitcher/CCatalogIqSwitcher.types.d.ts +0 -7
  65. package/lib/components/CConfigEditor/CConfigEditor.types.d.ts +0 -7
  66. package/lib/components/CConfigEditor/CConfigEditor.validators.d.ts +0 -4
  67. package/lib/components/CContactSelector/CContactSelector.types.d.ts +0 -4
  68. package/lib/components/CDataTable/CDataTableEdit.use.d.ts +0 -22
  69. package/lib/components/CFileViewer/CFileViewer.types.d.ts +0 -7
  70. package/lib/components/CFileViewer/CFileViewer.use.d.ts +0 -47
  71. package/lib/components/CFileViewer/CFileViewerFullScreen.use.d.ts +0 -16
  72. package/lib/components/CFileViewer/pageThumbnailFavorite.use.d.ts +0 -10
  73. package/lib/components/CFileViewer/pdfEvents.use.d.ts +0 -4
  74. package/lib/components/CGlobalSearch/CGlobalSearch.types.d.ts +0 -23
  75. package/lib/components/CGlobalSearch/GlobalSearch.use.d.ts +0 -24
  76. package/lib/components/CGlobalSearch/Shortcuts.use.d.ts +0 -11
  77. package/lib/components/CMultiSelect/CMultiSelect.test.d.ts +0 -1
  78. package/lib/components/CQuickFilters/CQuickFilters.types.d.ts +0 -4
  79. package/lib/components/CRichTextEditor/constants.d.ts +0 -1
  80. package/lib/components/CRichTextEditor/extensions/bulletListExtended.d.ts +0 -16
  81. package/lib/components/CRichTextEditor/extensions/headingExtended.d.ts +0 -10
  82. package/lib/components/CRichTextEditor/extensions/mentionSuggestions.d.ts +0 -11
  83. package/lib/components/CRichTextEditor/extensions/paragraphExtended.d.ts +0 -26
  84. package/lib/components/CRichTextEditor/extensions/textStyleExtended.d.ts +0 -10
  85. package/lib/components/CSingleSelect/CSingleSelect.test.d.ts +0 -1
  86. package/lib/components/CUsersGroupsAccessManage/CUsersGroupsAccessManage.types.d.ts +0 -56
  87. package/lib/components/CVirtualTable/CVirtualTable.test.d.ts +0 -1
  88. package/lib/components/CVirtualTable/CVirtualTableRow.test.d.ts +0 -1
  89. package/lib/components/canvases/CanvasesManagementBulk.use.d.ts +0 -40
  90. package/lib/components/canvases/CanvasesManagementFilters.use.d.ts +0 -7
  91. package/lib/components/canvases/CanvasesManagementToolbarFilters.use.d.ts +0 -20
  92. package/lib/components/filters/CDateRangeFilter.test.d.ts +0 -1
  93. package/lib/components/filters/CSelectFilter.test.d.ts +0 -1
  94. package/lib/components/filters/filter.const.d.ts +0 -1
  95. package/lib/components/filters/filter.util.d.ts +0 -2
  96. package/lib/components/filters/filter.util.spec.d.ts +0 -1
  97. package/lib/components/savedCanvases/CSavedCanvasesManagement.use.d.ts +0 -11
  98. package/lib/components/savedCanvases/CSavedCanvasesManagementShareCanvas.use.d.ts +0 -9
  99. package/lib/composables/appEmit.use.d.ts +0 -3
  100. package/lib/composables/bulkActions.use.d.ts +0 -12
  101. package/lib/composables/fileViewerSettings.use.d.ts +0 -8
  102. package/lib/composables/recentFiles.use.d.ts +0 -12
  103. package/lib/composables/useAssetUpload.d.ts +0 -6
  104. package/lib/composables/useBindValidation.d.ts +0 -206
  105. package/lib/composables/useCanvasOverlay.d.ts +0 -20
  106. package/lib/composables/useCanvasTablesPagination.d.ts +0 -13
  107. package/lib/composables/useConfirmation.d.ts +0 -23
  108. package/lib/composables/useConnectUpload.d.ts +0 -5
  109. package/lib/composables/useDetailsView.d.ts +0 -19
  110. package/lib/composables/useFetchUsers.d.ts +0 -18
  111. package/lib/composables/useInfiniteScroll.d.ts +0 -13
  112. package/lib/composables/useInstalledApps.d.ts +0 -3
  113. package/lib/composables/useLocation.d.ts +0 -26
  114. package/lib/composables/useLocationAPI.d.ts +0 -39
  115. package/lib/composables/useLocationListeners.d.ts +0 -8
  116. package/lib/composables/useLocationManipulation.d.ts +0 -37
  117. package/lib/composables/usePdfInterpolation.d.ts +0 -9
  118. package/lib/composables/useTheme.d.ts +0 -9
  119. package/lib/composables/useThemeVars.d.ts +0 -30
  120. package/lib/composables/useToast.d.ts +0 -14
  121. package/lib/composables/useWindowEvents.d.ts +0 -20
  122. package/lib/constants/cdp.const.d.ts +0 -41
  123. package/lib/constants/config.const.d.ts +0 -1
  124. package/lib/constants/conventions.const.d.ts +0 -3
  125. package/lib/constants/i18n.const.d.ts +0 -13
  126. package/lib/constants/modal.const.d.ts +0 -9
  127. package/lib/constants/more.const.d.ts +0 -1
  128. package/lib/constants/recentFiles.const.d.ts +0 -4
  129. package/lib/constants/tables.const.d.ts +0 -4
  130. package/lib/constants/timers.const.d.ts +0 -1
  131. package/lib/constants/uploads.const.d.ts +0 -8
  132. package/lib/constants/url.const.d.ts +0 -2
  133. package/lib/custom-naive-locales/el.d.ts +0 -124
  134. package/lib/directives/autofocus.d.ts +0 -4
  135. package/lib/directives/clickOutside.d.ts +0 -8
  136. package/lib/directives/draggable.d.ts +0 -4
  137. package/lib/directives/tooltip.d.ts +0 -4
  138. package/lib/main.lib.d.ts +0 -182
  139. package/lib/plugins/vueQuery.d.ts +0 -3
  140. package/lib/sdk/api/HighLevelApi.d.ts +0 -130
  141. package/lib/sdk/api/HighLevelApi.spec.d.ts +0 -1
  142. package/lib/sdk/api/LowLevelApi.d.ts +0 -18
  143. package/lib/sdk/api/LowLevelApi.spec.d.ts +0 -1
  144. package/lib/sdk/api/modules/admin/canvas.admin.d.ts +0 -89
  145. package/lib/sdk/api/modules/admin/env.admin.d.ts +0 -10
  146. package/lib/sdk/api/modules/admin/files.admin.d.ts +0 -49
  147. package/lib/sdk/api/modules/admin/index.d.ts +0 -40
  148. package/lib/sdk/api/modules/admin/metadataTemplates.admin.d.ts +0 -11
  149. package/lib/sdk/api/modules/admin/types.admin.d.ts +0 -67
  150. package/lib/sdk/api/modules/canvas.d.ts +0 -56
  151. package/lib/sdk/api/modules/dsr/env.dsr.d.ts +0 -10
  152. package/lib/sdk/api/modules/dsr/index.d.ts +0 -9
  153. package/lib/sdk/api/modules/dsr/loading.dsr.d.ts +0 -1
  154. package/lib/sdk/api/modules/dsr/types.dsr.d.ts +0 -39
  155. package/lib/sdk/api/modules/env.d.ts +0 -7
  156. package/lib/sdk/api/modules/events.d.ts +0 -7
  157. package/lib/sdk/api/modules/favorites.d.ts +0 -8
  158. package/lib/sdk/api/modules/feedback.d.ts +0 -3
  159. package/lib/sdk/api/modules/files.d.ts +0 -35
  160. package/lib/sdk/api/modules/folders.d.ts +0 -21
  161. package/lib/sdk/api/modules/index.d.ts +0 -19
  162. package/lib/sdk/api/modules/languages.d.ts +0 -8
  163. package/lib/sdk/api/modules/metadataTemplates.d.ts +0 -4
  164. package/lib/sdk/api/modules/notifications.d.ts +0 -3
  165. package/lib/sdk/api/modules/open.d.ts +0 -4
  166. package/lib/sdk/api/modules/pspdfkit.d.ts +0 -23
  167. package/lib/sdk/api/modules/query.d.ts +0 -3
  168. package/lib/sdk/api/modules/search.d.ts +0 -4
  169. package/lib/sdk/api/modules/sync.d.ts +0 -9
  170. package/lib/sdk/api/modules/toast.d.ts +0 -4
  171. package/lib/sdk/api/modules/track.d.ts +0 -4
  172. package/lib/sdk/api/modules/ui/app-errors.ui.d.ts +0 -3
  173. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +0 -29
  174. package/lib/sdk/api/modules/ui/content.ui.d.ts +0 -24
  175. package/lib/sdk/api/modules/ui/index.d.ts +0 -44
  176. package/lib/sdk/api/modules/ui/loading.ui.d.ts +0 -1
  177. package/lib/sdk/api/modules/ui/location.ui.d.ts +0 -3
  178. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +0 -6
  179. package/lib/sdk/api/modules/ui/types.ui.d.ts +0 -115
  180. package/lib/sdk/api/modules/users.d.ts +0 -7
  181. package/lib/sdk/api/modules/webView.d.ts +0 -4
  182. package/lib/sdk/api/onlineRestApiHandlers.d.ts +0 -4
  183. package/lib/sdk/interfaces.d.ts +0 -232
  184. package/lib/sdk/main.d.ts +0 -564
  185. package/lib/sdk/main.spec.d.ts +0 -1
  186. package/lib/sdk/main.umd-esm.d.ts +0 -1
  187. package/lib/sdk/payload.types.d.ts +0 -56
  188. package/lib/sdk/utils/assert.d.ts +0 -3
  189. package/lib/sdk/utils/assert.spec.d.ts +0 -1
  190. package/lib/sdk/utils/cleanUrl.d.ts +0 -1
  191. package/lib/sdk/utils/eventEmitter.d.ts +0 -17
  192. package/lib/sdk/utils/eventEmitter.spec.d.ts +0 -1
  193. package/lib/sdk/utils/httpFetch.d.ts +0 -15
  194. package/lib/sdk/utils/isodate.d.ts +0 -1
  195. package/lib/sdk/utils/isodate.spec.d.ts +0 -1
  196. package/lib/sdk/utils/object.d.ts +0 -1
  197. package/lib/sdk/utils/object.spec.d.ts +0 -1
  198. package/lib/sdk/utils/postrobot.d.ts +0 -1
  199. package/lib/theme/canvasUiUnoPreset.d.ts +0 -4
  200. package/lib/theme/daisyUi.d.ts +0 -1
  201. package/lib/theme/light.const.d.ts +0 -4
  202. package/lib/theme/light.d.ts +0 -2185
  203. package/lib/theme/main.d.ts +0 -3
  204. package/lib/theme/theme-overrides.d.ts +0 -1
  205. package/lib/theme/theme.types.d.ts +0 -29
  206. package/lib/theme/theme.utils.d.ts +0 -3
  207. package/lib/types/app.d.ts +0 -59
  208. package/lib/types/call.d.ts +0 -43
  209. package/lib/types/canvasActions.d.ts +0 -12
  210. package/lib/types/canvases.d.ts +0 -23
  211. package/lib/types/dataTable.d.ts +0 -6
  212. package/lib/types/favorites.d.ts +0 -5
  213. package/lib/types/fileViewerSettings.types.d.ts +0 -3
  214. package/lib/types/files.d.ts +0 -38
  215. package/lib/types/i18n.types.d.ts +0 -1
  216. package/lib/types/iframes.d.ts +0 -24
  217. package/lib/types/instance.types.d.ts +0 -18
  218. package/lib/types/instanceSettings.types.d.ts +0 -23
  219. package/lib/types/launchDarkly.types.d.ts +0 -40
  220. package/lib/types/organization.types.d.ts +0 -14
  221. package/lib/types/organizationMetadata.types.d.ts +0 -4
  222. package/lib/types/organizationSettings.types.d.ts +0 -3
  223. package/lib/types/paginatedData.d.ts +0 -6
  224. package/lib/types/recentFiles.types.d.ts +0 -4
  225. package/lib/types/sectionPopularity.d.ts +0 -30
  226. package/lib/types/sfdc.d.ts +0 -125
  227. package/lib/types/toast.d.ts +0 -4
  228. package/lib/types/translations.d.ts +0 -5
  229. package/lib/types/ts.d.ts +0 -10
  230. package/lib/types/users.d.ts +0 -12
  231. package/lib/types/vueVirtualScroller.d.ts +0 -4
  232. package/lib/util/anchor.d.ts +0 -2
  233. package/lib/util/array.d.ts +0 -5
  234. package/lib/util/array.spec.d.ts +0 -1
  235. package/lib/util/canvas-manager.util.d.ts +0 -4
  236. package/lib/util/casing.d.ts +0 -4
  237. package/lib/util/casing.spec.d.ts +0 -1
  238. package/lib/util/color.d.ts +0 -4
  239. package/lib/util/date.d.ts +0 -12
  240. package/lib/util/date.spec.d.ts +0 -1
  241. package/lib/util/dev.util.d.ts +0 -2
  242. package/lib/util/dom.d.ts +0 -15
  243. package/lib/util/font.spec.d.ts +0 -1
  244. package/lib/util/font.util.d.ts +0 -7
  245. package/lib/util/fullscreen.util.d.ts +0 -16
  246. package/lib/util/handlebars.d.ts +0 -1
  247. package/lib/util/image.d.ts +0 -1
  248. package/lib/util/location.spec.d.ts +0 -1
  249. package/lib/util/location.util.d.ts +0 -1
  250. package/lib/util/message-event.d.ts +0 -1
  251. package/lib/util/message-event.spec.d.ts +0 -1
  252. package/lib/util/navigation.util.d.ts +0 -7
  253. package/lib/util/network.d.ts +0 -16
  254. package/lib/util/network.spec.d.ts +0 -1
  255. package/lib/util/number.d.ts +0 -4
  256. package/lib/util/number.spec.d.ts +0 -1
  257. package/lib/util/object.d.ts +0 -1
  258. package/lib/util/object.spec.d.ts +0 -1
  259. package/lib/util/query.d.ts +0 -6
  260. package/lib/util/reactive.d.ts +0 -4
  261. package/lib/util/reactive.spec.d.ts +0 -1
  262. package/lib/util/string.d.ts +0 -4
  263. package/lib/util/timer.d.ts +0 -2
  264. package/lib/util/timer.spec.d.ts +0 -1
  265. package/lib/util/translations.d.ts +0 -8
  266. package/lib/util/translations.spec.d.ts +0 -1
  267. package/lib/util/tsHelpers.d.ts +0 -14
  268. package/lib/util/user.d.ts +0 -4
  269. package/lib/util/userAgents.d.ts +0 -8
  270. package/types/openapi/index.d.ts +0 -255
  271. package/types/openapi/models/AccessTypeEnum.d.ts +0 -8
  272. package/types/openapi/models/Account.d.ts +0 -4
  273. package/types/openapi/models/AccountRequest.d.ts +0 -4
  274. package/types/openapi/models/App.d.ts +0 -21
  275. package/types/openapi/models/AppInstallationRequest.d.ts +0 -4
  276. package/types/openapi/models/AppOrganization.d.ts +0 -4
  277. package/types/openapi/models/AppOrganizationRequest.d.ts +0 -4
  278. package/types/openapi/models/AppPublish.d.ts +0 -8
  279. package/types/openapi/models/AppRelease.d.ts +0 -10
  280. package/types/openapi/models/AppRequest.d.ts +0 -9
  281. package/types/openapi/models/AppTypeEnum.d.ts +0 -8
  282. package/types/openapi/models/AppsDBEntry.d.ts +0 -4
  283. package/types/openapi/models/AppsDBEntryRequest.d.ts +0 -3
  284. package/types/openapi/models/AuthToken.d.ts +0 -7
  285. package/types/openapi/models/AuthTokenRequest.d.ts +0 -7
  286. package/types/openapi/models/BulkDeleteErrorDetail.d.ts +0 -5
  287. package/types/openapi/models/BulkDeleteRequest.d.ts +0 -6
  288. package/types/openapi/models/BulkDeleteResponse.d.ts +0 -6
  289. package/types/openapi/models/BulkUpdateMetadata.d.ts +0 -6
  290. package/types/openapi/models/BulkUpdateMetadataOperationEnum.d.ts +0 -8
  291. package/types/openapi/models/BulkUpdateMetadataRequest.d.ts +0 -9
  292. package/types/openapi/models/BulkUpdateMetadataResult.d.ts +0 -4
  293. package/types/openapi/models/BulkUpdateTags.d.ts +0 -6
  294. package/types/openapi/models/BulkUpdateTagsOperationEnum.d.ts +0 -8
  295. package/types/openapi/models/BulkUpdateTagsRequest.d.ts +0 -9
  296. package/types/openapi/models/BulkUpdateTagsResult.d.ts +0 -4
  297. package/types/openapi/models/Canvas.d.ts +0 -29
  298. package/types/openapi/models/CanvasCreate.d.ts +0 -36
  299. package/types/openapi/models/CanvasCreateRequest.d.ts +0 -25
  300. package/types/openapi/models/CanvasRecommendedFile.d.ts +0 -46
  301. package/types/openapi/models/CanvasRecommendedFiles.d.ts +0 -5
  302. package/types/openapi/models/CanvasRetrieve.d.ts +0 -36
  303. package/types/openapi/models/CanvasSection.d.ts +0 -10
  304. package/types/openapi/models/CanvasUpdate.d.ts +0 -36
  305. package/types/openapi/models/CanvasUpdateRequest.d.ts +0 -22
  306. package/types/openapi/models/Collaboration.d.ts +0 -16
  307. package/types/openapi/models/CollaborationCreate.d.ts +0 -16
  308. package/types/openapi/models/CollaborationCreateRequest.d.ts +0 -10
  309. package/types/openapi/models/CollaborationRequest.d.ts +0 -5
  310. package/types/openapi/models/CollaborationRoleEnum.d.ts +0 -4
  311. package/types/openapi/models/ConnectedService.d.ts +0 -9
  312. package/types/openapi/models/ContentDistributionGroup.d.ts +0 -12
  313. package/types/openapi/models/ContentDistributionGroupCreate.d.ts +0 -13
  314. package/types/openapi/models/ContentDistributionGroupCreateRequest.d.ts +0 -5
  315. package/types/openapi/models/ContentDistributionGroupMembership.d.ts +0 -8
  316. package/types/openapi/models/ContentDistributionGroupMembershipCreate.d.ts +0 -8
  317. package/types/openapi/models/ContentDistributionGroupMembershipCreateRequest.d.ts +0 -4
  318. package/types/openapi/models/ContentDistributionGroupRequest.d.ts +0 -4
  319. package/types/openapi/models/DefaultExpiresAtEnum.d.ts +0 -16
  320. package/types/openapi/models/DeletedApp.d.ts +0 -23
  321. package/types/openapi/models/DeletedCanvas.d.ts +0 -31
  322. package/types/openapi/models/DeletedContentDistributionGroup.d.ts +0 -15
  323. package/types/openapi/models/DeletedEnvironment.d.ts +0 -15
  324. package/types/openapi/models/DeletedFavorite.d.ts +0 -20
  325. package/types/openapi/models/DeletedFile.d.ts +0 -48
  326. package/types/openapi/models/DeletedFolder.d.ts +0 -18
  327. package/types/openapi/models/DeletedInstance.d.ts +0 -25
  328. package/types/openapi/models/DeletedInstanceAssignmentGroup.d.ts +0 -15
  329. package/types/openapi/models/DeletedMetadataTemplate.d.ts +0 -18
  330. package/types/openapi/models/DeletedRegion.d.ts +0 -13
  331. package/types/openapi/models/DownloadTypeEnum.d.ts +0 -10
  332. package/types/openapi/models/Environment.d.ts +0 -13
  333. package/types/openapi/models/EnvironmentRequest.d.ts +0 -5
  334. package/types/openapi/models/Event.d.ts +0 -18
  335. package/types/openapi/models/EventAttendee.d.ts +0 -5
  336. package/types/openapi/models/EventAttendeeRequest.d.ts +0 -5
  337. package/types/openapi/models/EventExternalObject.d.ts +0 -10
  338. package/types/openapi/models/EventExternalObjectContentTypeEnum.d.ts +0 -12
  339. package/types/openapi/models/EventExternalObjectRequest.d.ts +0 -10
  340. package/types/openapi/models/EventRequest.d.ts +0 -17
  341. package/types/openapi/models/EventStatusEnum.d.ts +0 -10
  342. package/types/openapi/models/Favorite.d.ts +0 -18
  343. package/types/openapi/models/FavoriteCreate.d.ts +0 -12
  344. package/types/openapi/models/FavoriteCreateRequest.d.ts +0 -7
  345. package/types/openapi/models/FavoriteFile.d.ts +0 -6
  346. package/types/openapi/models/FavoriteFileRequest.d.ts +0 -3
  347. package/types/openapi/models/FavoriteUpdate.d.ts +0 -12
  348. package/types/openapi/models/FavoriteUpdateRequest.d.ts +0 -6
  349. package/types/openapi/models/File.d.ts +0 -46
  350. package/types/openapi/models/FileAnalytics.d.ts +0 -16
  351. package/types/openapi/models/FileAnalyticsResult.d.ts +0 -9
  352. package/types/openapi/models/FileContentTypeEnum.d.ts +0 -16
  353. package/types/openapi/models/FileCreate.d.ts +0 -51
  354. package/types/openapi/models/FileCreateRequest.d.ts +0 -27
  355. package/types/openapi/models/FilePermission.d.ts +0 -4
  356. package/types/openapi/models/FilePermissionRequest.d.ts +0 -4
  357. package/types/openapi/models/FileRequest.d.ts +0 -16
  358. package/types/openapi/models/FileRetrieve.d.ts +0 -51
  359. package/types/openapi/models/FileRevision.d.ts +0 -8
  360. package/types/openapi/models/FileRevisionRequest.d.ts +0 -3
  361. package/types/openapi/models/FileStatusEnum.d.ts +0 -8
  362. package/types/openapi/models/FileTypeEnum.d.ts +0 -10
  363. package/types/openapi/models/FileUpdate.d.ts +0 -51
  364. package/types/openapi/models/FileUpdateRequest.d.ts +0 -20
  365. package/types/openapi/models/FileVersion.d.ts +0 -5
  366. package/types/openapi/models/Folder.d.ts +0 -16
  367. package/types/openapi/models/FolderCreate.d.ts +0 -32
  368. package/types/openapi/models/FolderCreateRequest.d.ts +0 -19
  369. package/types/openapi/models/FolderFile.d.ts +0 -15
  370. package/types/openapi/models/FolderFolder.d.ts +0 -8
  371. package/types/openapi/models/FolderRetrieve.d.ts +0 -25
  372. package/types/openapi/models/FolderUpdate.d.ts +0 -32
  373. package/types/openapi/models/FolderUpdateRequest.d.ts +0 -16
  374. package/types/openapi/models/Instance.d.ts +0 -23
  375. package/types/openapi/models/InstanceAnalytics.d.ts +0 -18
  376. package/types/openapi/models/InstanceAnalyticsChangePercentages.d.ts +0 -5
  377. package/types/openapi/models/InstanceAnalyticsCurrentPeriod.d.ts +0 -13
  378. package/types/openapi/models/InstanceAnalyticsFile.d.ts +0 -5
  379. package/types/openapi/models/InstanceAnalyticsFileActivity.d.ts +0 -5
  380. package/types/openapi/models/InstanceAnalyticsFileRequest.d.ts +0 -3
  381. package/types/openapi/models/InstanceAnalyticsInactiveUsers.d.ts +0 -5
  382. package/types/openapi/models/InstanceAnalyticsInactiveUsersRequest.d.ts +0 -4
  383. package/types/openapi/models/InstanceAnalyticsLoginResult.d.ts +0 -5
  384. package/types/openapi/models/InstanceAssignmentGroup.d.ts +0 -12
  385. package/types/openapi/models/InstanceAssignmentGroupMembership.d.ts +0 -8
  386. package/types/openapi/models/InstanceAssignmentGroupMembershipCreate.d.ts +0 -8
  387. package/types/openapi/models/InstanceAssignmentGroupMembershipCreateRequest.d.ts +0 -4
  388. package/types/openapi/models/InstanceAssignmentGroupRequest.d.ts +0 -4
  389. package/types/openapi/models/InstanceMembership.d.ts +0 -12
  390. package/types/openapi/models/InstanceMembershipCreate.d.ts +0 -12
  391. package/types/openapi/models/InstanceMembershipCreateRequest.d.ts +0 -8
  392. package/types/openapi/models/InstanceMembershipGroup.d.ts +0 -11
  393. package/types/openapi/models/InstanceMembershipGroupRequest.d.ts +0 -3
  394. package/types/openapi/models/InstanceMembershipRequest.d.ts +0 -5
  395. package/types/openapi/models/InstanceMembershipRoleEnum.d.ts +0 -8
  396. package/types/openapi/models/InstanceMembershipUser.d.ts +0 -10
  397. package/types/openapi/models/InstanceMembershipUserRequest.d.ts +0 -4
  398. package/types/openapi/models/InstanceMembershipUserStatusEnum.d.ts +0 -6
  399. package/types/openapi/models/InstanceRequest.d.ts +0 -11
  400. package/types/openapi/models/InstanceUpdate.d.ts +0 -19
  401. package/types/openapi/models/InstanceUpdateRequest.d.ts +0 -8
  402. package/types/openapi/models/Invitation.d.ts +0 -11
  403. package/types/openapi/models/InvitationRequest.d.ts +0 -3
  404. package/types/openapi/models/InvitationStatusEnum.d.ts +0 -4
  405. package/types/openapi/models/LanguageEnum.d.ts +0 -12
  406. package/types/openapi/models/MetadataTemplate.d.ts +0 -16
  407. package/types/openapi/models/MetadataTemplateField.d.ts +0 -14
  408. package/types/openapi/models/MetadataTemplateFieldRequest.d.ts +0 -14
  409. package/types/openapi/models/MetadataTemplateFieldTypeEnum.d.ts +0 -16
  410. package/types/openapi/models/MetadataTemplateOption.d.ts +0 -4
  411. package/types/openapi/models/MetadataTemplateOptionRequest.d.ts +0 -4
  412. package/types/openapi/models/MetadataTemplateRequest.d.ts +0 -7
  413. package/types/openapi/models/MetadataTemplateSection.d.ts +0 -6
  414. package/types/openapi/models/MetadataTemplateSectionRequest.d.ts +0 -6
  415. package/types/openapi/models/MiniCanvas.d.ts +0 -4
  416. package/types/openapi/models/MiniCanvasRequest.d.ts +0 -3
  417. package/types/openapi/models/MiniContentDistributionGroup.d.ts +0 -5
  418. package/types/openapi/models/MiniContentDistributionGroupRequest.d.ts +0 -3
  419. package/types/openapi/models/MiniEnvironment.d.ts +0 -5
  420. package/types/openapi/models/MiniEnvironmentRequest.d.ts +0 -4
  421. package/types/openapi/models/MiniEvent.d.ts +0 -5
  422. package/types/openapi/models/MiniEventRequest.d.ts +0 -4
  423. package/types/openapi/models/MiniFile.d.ts +0 -4
  424. package/types/openapi/models/MiniFileRequest.d.ts +0 -3
  425. package/types/openapi/models/MiniFolder.d.ts +0 -4
  426. package/types/openapi/models/MiniFolderRequest.d.ts +0 -3
  427. package/types/openapi/models/MiniInstance.d.ts +0 -4
  428. package/types/openapi/models/MiniInstanceRequest.d.ts +0 -3
  429. package/types/openapi/models/MiniPage.d.ts +0 -4
  430. package/types/openapi/models/MiniPageRequest.d.ts +0 -3
  431. package/types/openapi/models/MiniRegion.d.ts +0 -4
  432. package/types/openapi/models/MiniRegionRequest.d.ts +0 -3
  433. package/types/openapi/models/MiniSharedLink.d.ts +0 -4
  434. package/types/openapi/models/MiniSharedLinkRequest.d.ts +0 -3
  435. package/types/openapi/models/MiniUser.d.ts +0 -5
  436. package/types/openapi/models/MiniUserRequest.d.ts +0 -3
  437. package/types/openapi/models/MostActiveUser.d.ts +0 -7
  438. package/types/openapi/models/OfflineSyncFolder.d.ts +0 -17
  439. package/types/openapi/models/Organization.d.ts +0 -10
  440. package/types/openapi/models/OrganizationAnalytics.d.ts +0 -16
  441. package/types/openapi/models/OrganizationAnalyticsCurrentPeriod.d.ts +0 -13
  442. package/types/openapi/models/OrganizationAnalyticsInactiveUsers.d.ts +0 -5
  443. package/types/openapi/models/OrganizationAnalyticsInactiveUsersRequest.d.ts +0 -4
  444. package/types/openapi/models/OrganizationAnalyticsInstance.d.ts +0 -10
  445. package/types/openapi/models/OrganizationAnalyticsLoginResult.d.ts +0 -5
  446. package/types/openapi/models/OrganizationAnalyticsTop3Instances.d.ts +0 -13
  447. package/types/openapi/models/OrganizationBranding.d.ts +0 -6
  448. package/types/openapi/models/OrganizationBrandingColors.d.ts +0 -4
  449. package/types/openapi/models/OrganizationChangePercentages.d.ts +0 -6
  450. package/types/openapi/models/OrganizationUpdate.d.ts +0 -8
  451. package/types/openapi/models/OrganizationUpdateRequest.d.ts +0 -8
  452. package/types/openapi/models/PSPDFKitAuthPayload.d.ts +0 -3
  453. package/types/openapi/models/PSPDFKitAuthPayloadRequest.d.ts +0 -3
  454. package/types/openapi/models/PSPDFKitToken.d.ts +0 -7
  455. package/types/openapi/models/PSPDFKitTokenRequest.d.ts +0 -3
  456. package/types/openapi/models/PaginatedAppList.d.ts +0 -8
  457. package/types/openapi/models/PaginatedAppReleaseList.d.ts +0 -8
  458. package/types/openapi/models/PaginatedAuthTokenList.d.ts +0 -8
  459. package/types/openapi/models/PaginatedCanvasList.d.ts +0 -8
  460. package/types/openapi/models/PaginatedCollaborationList.d.ts +0 -8
  461. package/types/openapi/models/PaginatedContentDistributionGroupList.d.ts +0 -8
  462. package/types/openapi/models/PaginatedContentDistributionGroupMembershipList.d.ts +0 -8
  463. package/types/openapi/models/PaginatedEnvironmentList.d.ts +0 -8
  464. package/types/openapi/models/PaginatedEventList.d.ts +0 -8
  465. package/types/openapi/models/PaginatedFavoriteList.d.ts +0 -8
  466. package/types/openapi/models/PaginatedFileList.d.ts +0 -8
  467. package/types/openapi/models/PaginatedFileRevisionList.d.ts +0 -8
  468. package/types/openapi/models/PaginatedFolderList.d.ts +0 -8
  469. package/types/openapi/models/PaginatedInstanceAssignmentGroupList.d.ts +0 -8
  470. package/types/openapi/models/PaginatedInstanceAssignmentGroupMembershipList.d.ts +0 -8
  471. package/types/openapi/models/PaginatedInstanceList.d.ts +0 -8
  472. package/types/openapi/models/PaginatedInstanceMembershipList.d.ts +0 -8
  473. package/types/openapi/models/PaginatedInvitationList.d.ts +0 -8
  474. package/types/openapi/models/PaginatedMetadataTemplateList.d.ts +0 -8
  475. package/types/openapi/models/PaginatedOfflineSyncFolderList.d.ts +0 -8
  476. package/types/openapi/models/PaginatedRegionList.d.ts +0 -8
  477. package/types/openapi/models/PaginatedRevisionList.d.ts +0 -8
  478. package/types/openapi/models/PaginatedSearchResultList.d.ts +0 -9
  479. package/types/openapi/models/PaginatedStorageRegionList.d.ts +0 -8
  480. package/types/openapi/models/PaginatedUserList.d.ts +0 -8
  481. package/types/openapi/models/PatchedAppRequest.d.ts +0 -9
  482. package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +0 -22
  483. package/types/openapi/models/PatchedCollaborationRequest.d.ts +0 -5
  484. package/types/openapi/models/PatchedContentDistributionGroupRequest.d.ts +0 -4
  485. package/types/openapi/models/PatchedEnvironmentRequest.d.ts +0 -5
  486. package/types/openapi/models/PatchedEventRequest.d.ts +0 -17
  487. package/types/openapi/models/PatchedFavoriteUpdateRequest.d.ts +0 -6
  488. package/types/openapi/models/PatchedFileRequest.d.ts +0 -16
  489. package/types/openapi/models/PatchedFileRevisionRequest.d.ts +0 -3
  490. package/types/openapi/models/PatchedFileUpdateRequest.d.ts +0 -20
  491. package/types/openapi/models/PatchedFolderUpdateRequest.d.ts +0 -16
  492. package/types/openapi/models/PatchedInstanceAssignmentGroupRequest.d.ts +0 -4
  493. package/types/openapi/models/PatchedInstanceMembershipRequest.d.ts +0 -5
  494. package/types/openapi/models/PatchedInstanceUpdateRequest.d.ts +0 -8
  495. package/types/openapi/models/PatchedMetadataTemplateRequest.d.ts +0 -7
  496. package/types/openapi/models/PatchedOrganizationUpdateRequest.d.ts +0 -8
  497. package/types/openapi/models/PatchedRegionRequest.d.ts +0 -3
  498. package/types/openapi/models/PatchedUserRequest.d.ts +0 -12
  499. package/types/openapi/models/Region.d.ts +0 -11
  500. package/types/openapi/models/RegionRequest.d.ts +0 -3
  501. package/types/openapi/models/Revision.d.ts +0 -8
  502. package/types/openapi/models/RevisionRequest.d.ts +0 -3
  503. package/types/openapi/models/SearchApp.d.ts +0 -6
  504. package/types/openapi/models/SearchCanvas.d.ts +0 -5
  505. package/types/openapi/models/SearchContentDistributionGroup.d.ts +0 -11
  506. package/types/openapi/models/SearchFile.d.ts +0 -9
  507. package/types/openapi/models/SearchInstanceAssignmentGroup.d.ts +0 -11
  508. package/types/openapi/models/SearchResult.d.ts +0 -8
  509. package/types/openapi/models/SearchUser.d.ts +0 -5
  510. package/types/openapi/models/SharedLink.d.ts +0 -16
  511. package/types/openapi/models/SharedLinkCanvas.d.ts +0 -11
  512. package/types/openapi/models/SharedLinkCanvasRequest.d.ts +0 -8
  513. package/types/openapi/models/SharedLinkCreate.d.ts +0 -16
  514. package/types/openapi/models/SharedLinkCreateRequest.d.ts +0 -6
  515. package/types/openapi/models/SharedLinkInstance.d.ts +0 -6
  516. package/types/openapi/models/SharedLinkInstanceRequest.d.ts +0 -5
  517. package/types/openapi/models/SharedLinkOrganization.d.ts +0 -6
  518. package/types/openapi/models/SharedLinkOrganizationRequest.d.ts +0 -6
  519. package/types/openapi/models/StorageRegion.d.ts +0 -5
  520. package/types/openapi/models/StorageRegionEnum.d.ts +0 -10
  521. package/types/openapi/models/Tag.d.ts +0 -3
  522. package/types/openapi/models/UploadCreate.d.ts +0 -8
  523. package/types/openapi/models/UploadCreateRequest.d.ts +0 -5
  524. package/types/openapi/models/User.d.ts +0 -23
  525. package/types/openapi/models/UserRequest.d.ts +0 -12
@@ -1,467 +0,0 @@
1
- import { CSSProperties, Ref } from 'vue';
2
- import { MaybeRef } from '@vueuse/core';
3
- import { CanvasActions } from '../../../main.lib';
4
- import { CanvasRetrieve, File, FileContentTypeEnum, FileRetrieve, Folder, FolderRetrieve, MetadataTemplate, PatchedCanvasUpdateRequest, SharedLink, User } from '../../../../types/openapi';
5
- import { PaginatedData } from '../../../types/paginatedData';
6
- import { OpenExternalUrlRequestPayload, PitcherEnv } from '../../../sdk/main';
7
- import { EmbedLocation, EmbeddedLocationProperties } from '../../../types/app';
8
- import { FileModel } from '../../../components/CFileViewer/CFileViewer.types';
9
- import { aspectRatios } from '@canvas-builder/constants';
10
-
11
- type AvailableAspectRatio = (typeof aspectRatios)[number];
12
- export declare enum HtmlLayoutTypes {
13
- PREVIEW = "preview",
14
- EDIT = "edit"
15
- }
16
- export declare enum ContentGridLayoutTypes {
17
- CAROUSEL = "carousel",
18
- GRID = "grid"
19
- }
20
- export declare enum GridLayoutTypes {
21
- ONE = "one",
22
- TWO_EQUAL = "two-equal",
23
- TWO_LEFT = "two-left",
24
- TWO_RIGHT = "two-right",
25
- THREE_EQUAL = "three-equal",
26
- FOUR_EQUAL = "four-equal"
27
- }
28
- export declare enum LinkAnchorTypes {
29
- WEB = "web",
30
- CANVAS_ANCHOR = "canvas-anchor"
31
- }
32
- export declare enum LinkAlignmentTypes {
33
- LEFT = "left",
34
- CENTER = "center",
35
- RIGHT = "right"
36
- }
37
- export declare enum LinkPreviewTypes {
38
- SOLID_BUTTON = "solid-button",
39
- OUTLINE_BUTTON = "outline-button",
40
- TEXT_LINK = "text-link"
41
- }
42
- export interface EmbeddableProps {
43
- type: 'app';
44
- app_name: string;
45
- src: string | null;
46
- height?: string;
47
- width?: string;
48
- embed_locations?: EmbedLocation[];
49
- headless_locations?: EmbedLocation[];
50
- properties_by_embed_location?: Partial<Record<EmbedLocation, EmbeddedLocationProperties>>;
51
- file: ContentGridFileProps | null;
52
- settings?: Record<string, unknown>;
53
- }
54
- export interface TextProps {
55
- content?: string;
56
- }
57
- export interface CarouselProps {
58
- images?: {
59
- url: string;
60
- is_uploaded_asset?: boolean;
61
- }[];
62
- placeholder_height?: string;
63
- include_all_images_in_pdf?: boolean;
64
- }
65
- export interface CanvasFile {
66
- readonly name: FileModel['name'];
67
- readonly file_id: FileModel['id'];
68
- readonly content_extension: FileModel['content_extension'];
69
- readonly content_type: FileModel['content_type'];
70
- readonly content_url: FileModel['content_url'];
71
- readonly thumbnail_url: FileModel['thumbnail_url'];
72
- readonly content_length: FileModel['content_length'];
73
- readonly content_thumbnails: FileModel['content_thumbnails'];
74
- readonly pspdfkit_server_url?: FileModel['pspdfkit_server_url'];
75
- readonly pspdfkit_auth_payload?: FileModel['pspdfkit_auth_payload'];
76
- }
77
- declare const MULTIMEDIA_IMG_TYPE: {
78
- readonly external: "external";
79
- readonly pitcher_asset: "pitcher_asset";
80
- };
81
- export declare enum MultimediaHorizontalAlignmentOptions {
82
- LEFT = "left",
83
- CENTER = "center",
84
- RIGHT = "right"
85
- }
86
- export type ExternalMultimediaAssetType = {
87
- asset_type: typeof MULTIMEDIA_IMG_TYPE.external;
88
- external_url: string;
89
- type: 'image' | 'video';
90
- horizontal_alignment?: MultimediaHorizontalAlignmentOptions;
91
- };
92
- export type PitcherMultimediaAssetType = {
93
- asset_type: typeof MULTIMEDIA_IMG_TYPE.pitcher_asset;
94
- file: {
95
- id: File['id'];
96
- name: File['name'];
97
- content_url?: File['content_url'];
98
- };
99
- type: 'image' | 'video';
100
- horizontal_alignment?: MultimediaHorizontalAlignmentOptions;
101
- };
102
- export type MultimediaProps = ExternalMultimediaAssetType | PitcherMultimediaAssetType;
103
- type ContentGridCommonFileProps = {
104
- id: FileRetrieve['id'];
105
- snapshot_id?: FileRetrieve['id'];
106
- name: FileRetrieve['name'];
107
- is_deleted?: boolean;
108
- content_url?: FileRetrieve['content_url'];
109
- content_type?: FileContentTypeEnum | null;
110
- content_extension?: FileRetrieve['content_extension'];
111
- };
112
- export type ContentGridFileProps = ContentGridCommonFileProps & {
113
- thumbnail_url?: FileRetrieve['thumbnail_url'];
114
- content_url: FileRetrieve['content_url'];
115
- content_type: FileContentTypeEnum | null;
116
- content_extension: FileRetrieve['content_extension'];
117
- content_length: FileRetrieve['content_length'];
118
- content_thumbnails?: FileRetrieve['content_thumbnails'] | null;
119
- readonly pspdfkit_server_url?: FileModel['pspdfkit_server_url'];
120
- readonly pspdfkit_auth_payload?: FileModel['pspdfkit_auth_payload'];
121
- };
122
- export type ContentGridItemFileProps = {
123
- file: ContentGridFileProps;
124
- type: 'file';
125
- };
126
- export type ContentGridItemSlideProps = {
127
- file: ContentGridCommonFileProps;
128
- slide: {
129
- index: number;
130
- url?: FileRetrieve['content_thumbnails'][number];
131
- };
132
- type: 'slide';
133
- };
134
- export interface ContentGridProps {
135
- items: (ContentGridItemSlideProps | ContentGridItemFileProps)[];
136
- size?: 'medium';
137
- layout_type?: ContentGridLayoutTypes;
138
- }
139
- export interface SectionListSection {
140
- id: string;
141
- style?: Record<string, any>;
142
- aspect_ratio?: AvailableAspectRatio;
143
- background_video_url?: string;
144
- }
145
- export interface SectionListProps {
146
- sections: SectionListSection[];
147
- animation_in?: string;
148
- }
149
- export interface GridItemTooltipProps {
150
- content?: string;
151
- content_style?: Record<string, any>;
152
- trigger?: string;
153
- trigger_style?: Record<string, any>;
154
- }
155
- export interface GridItemProps {
156
- span: number;
157
- tooltips?: GridItemTooltipProps[];
158
- }
159
- export interface GridProps {
160
- layout_type: GridLayoutTypes;
161
- columns: number;
162
- }
163
- export interface HtmlProps {
164
- html: string;
165
- }
166
- export interface LinkProps {
167
- alignment?: LinkAlignmentTypes;
168
- background_color?: string;
169
- canvas_anchor?: string;
170
- color?: string;
171
- display_text?: string;
172
- font_family?: string;
173
- font_size?: number;
174
- link_type?: LinkAnchorTypes;
175
- preview_type?: LinkPreviewTypes;
176
- target?: '_self' | '_blank';
177
- url?: string;
178
- }
179
- export interface PageBreakProps {
180
- }
181
- export interface PageProps {
182
- aspect_ratio?: AvailableAspectRatio;
183
- background_video_url?: string;
184
- }
185
- export interface TimelineEvent {
186
- top_hint?: string;
187
- top_hint_style?: Record<string, any>;
188
- title?: string;
189
- title_style?: Record<string, any>;
190
- description?: string;
191
- description_style?: Record<string, any>;
192
- image_url?: string;
193
- image_style?: Record<string, any>;
194
- icon?: string;
195
- icon_style?: Record<string, any>;
196
- card_style?: Record<string, any>;
197
- }
198
- export interface TimelineProps {
199
- events: TimelineEvent[];
200
- layout: 'vertical' | 'horizontal';
201
- }
202
- type AvailableComponentProps = GridProps | GridItemProps | TextProps | CarouselProps | MultimediaProps | EmbeddableProps | ContentGridProps | SectionListProps | HtmlProps | LinkProps | PageBreakProps | PageProps | TimelineProps;
203
- export interface ComponentNodeVisible {
204
- edit_mode: boolean;
205
- presentation_mode: boolean;
206
- pdf: boolean;
207
- web: boolean;
208
- }
209
- export interface ComponentNode<T = AvailableComponentProps> {
210
- id: string;
211
- type: ComponentTypes;
212
- tracking_id: string;
213
- visible?: ComponentNodeVisible;
214
- allow_admins_to_overwrite?: boolean;
215
- autofill?: 'off' | 'ai' | 'matching_metadata' | 'matching_tags' | 'matching_metadata_or_tags';
216
- autofill_content_types?: FileContentTypeEnum[] | null;
217
- data?: T;
218
- children?: ComponentNode[];
219
- when_used_in_section?: {
220
- is_editable: boolean;
221
- is_removable: boolean;
222
- };
223
- style?: CSSProperties;
224
- tags?: string[];
225
- }
226
- export interface CanvasContent {
227
- data?: ComponentNode[];
228
- overrides?: SectionComponentOverrides;
229
- hidden?: {
230
- dsr: {
231
- sections: HiddenElementsInCanvas;
232
- components: HiddenElementsInCanvas;
233
- };
234
- dsr_print: {
235
- sections: HiddenElementsInCanvas;
236
- components: HiddenElementsInCanvas;
237
- };
238
- };
239
- }
240
- export interface HiddenElementsInCanvas {
241
- [elementId: string]: true;
242
- }
243
- export type SectionComponentOverride = {
244
- node?: ComponentNode;
245
- after_sibling_id?: ComponentNode['id'];
246
- is_removed?: true;
247
- };
248
- export type SectionComponentOverrides = {
249
- [sectionId: CanvasRetrieve['id']]: {
250
- [componentId: ComponentNode['id'] | 'root']: SectionComponentOverride;
251
- };
252
- };
253
- export interface ComponentMeta {
254
- allowedChildren: ComponentTypes[];
255
- defaultChildren: Partial<ComponentNode>[];
256
- defaultData: AvailableComponentProps;
257
- singleton?: boolean;
258
- defaultPrintable: boolean;
259
- }
260
- export declare enum ComponentTypes {
261
- Root = "Root",
262
- ContentGrid = "ContentGrid",
263
- SectionList = "SectionList",
264
- Grid = "Grid",
265
- GridItem = "GridItem",
266
- Multimedia = "Multimedia",
267
- Text = "Text",
268
- Embeddable = "Embeddable",
269
- Carousel = "Carousel",
270
- Html = "Html",
271
- Link = "Link",
272
- PageBreak = "PageBreak",
273
- Page = "Page",
274
- Timeline = "Timeline"
275
- }
276
- export declare enum ComponentIcon {
277
- AR = "cube",
278
- Carousel = "gallery-thumbnails",
279
- Collection = "rectangle-history-circle-plus",
280
- Embeddable = "browser",
281
- File = "file-circle-plus",
282
- ContentGrid = "files",
283
- Grid = "table-columns",
284
- GridItem = "objects-column",
285
- GridParent = "angle-down",
286
- Multimedia = "image",
287
- SectionList = "bring-forward",
288
- Text = "text-size",
289
- Video = "video",
290
- Html = "code",
291
- Link = "hand-pointer",
292
- PageBreak = "arrows-from-line",
293
- Page = "pager",
294
- Timeline = "timeline-arrow"
295
- }
296
- export type CanvasTheme = {
297
- canvas_bg_color?: string;
298
- global_component_spacing?: number;
299
- font?: {
300
- name: string;
301
- url: string;
302
- };
303
- fluid?: boolean;
304
- style?: Record<string, any>;
305
- aspect_ratio?: AvailableAspectRatio;
306
- };
307
- export declare enum CanvasBuilderMode {
308
- ADMIN = "admin",
309
- IMPACT = "impact",
310
- SHARING = "sharing"
311
- }
312
- export interface ComponentTrackingParams {
313
- trackable: boolean;
314
- }
315
- export declare enum CanvasHistoryAction {
316
- ADD = "add",
317
- REMOVE = "remove",
318
- REORDER = "reorder",
319
- OPEN = "open"
320
- }
321
- export interface CanvasHistoryItem {
322
- active?: boolean;
323
- action: CanvasHistoryAction;
324
- componentType: ComponentTypes;
325
- icon?: string;
326
- id: string;
327
- snapshot: ComponentNode[];
328
- timestamp: string;
329
- }
330
- export interface FileProps {
331
- file_id: FileRetrieve['id'];
332
- source_file_id?: FileRetrieve['id'];
333
- name: FileRetrieve['name'];
334
- thumbnail_url?: FileRetrieve['thumbnail_url'];
335
- content_url: FileRetrieve['content_url'];
336
- content_type: FileRetrieve['content_type'];
337
- content_extension: FileRetrieve['content_extension'];
338
- content_length: FileRetrieve['content_length'];
339
- content_thumbnails: FileRetrieve['content_thumbnails'] | null;
340
- is_deleted?: boolean;
341
- readonly pspdfkit_server_url?: FileModel['pspdfkit_server_url'];
342
- readonly pspdfkit_auth_payload?: FileModel['pspdfkit_auth_payload'];
343
- }
344
- type FileOpenParams = (FileProps & {
345
- page_index?: number;
346
- newTab?: boolean;
347
- }) | {
348
- file_id: File['id'];
349
- name?: File['name'];
350
- page_index?: number;
351
- newTab?: boolean;
352
- };
353
- type NoCRMBuilderProps = {
354
- isCRM: false;
355
- onSfdcAccountSearch?: never;
356
- };
357
- export type SharingBuilderProps = NoCRMBuilderProps & {
358
- isFullscreen?: boolean;
359
- displayMode?: 'default' | 'print';
360
- startPage?: number;
361
- endPage?: number;
362
- isRedirectEvent?: never;
363
- mode: CanvasBuilderMode.SHARING;
364
- metadata: {
365
- baseStackingContext?: number;
366
- };
367
- activeCanvas: CanvasRetrieve;
368
- templates?: never;
369
- onExit: () => void;
370
- onSave?: never;
371
- onEnter?: () => void;
372
- onComponentEnter?: (data: ComponentNode | CanvasRetrieve, params: ComponentTrackingParams) => void;
373
- onComponentExit?: (data: ComponentNode | CanvasRetrieve, params: ComponentTrackingParams) => void;
374
- onFileOpen: (file: FileOpenParams) => void;
375
- onOpenExternalUrl: (payload: OpenExternalUrlRequestPayload) => Promise<void>;
376
- deleteFile?: never;
377
- listFiles?: never;
378
- listCanvases?: never;
379
- fetchFolder?: never;
380
- fetchFile?: never;
381
- fetchInstanceMetadataTemplate?: never;
382
- fetchCanvas?: never;
383
- renderPageAsImageUrl?: (fileId: File['id'], pageIndex: number, options: {
384
- width: number;
385
- } | {
386
- height: number;
387
- }) => Promise<string>;
388
- getEnv: () => Promise<PitcherEnv>;
389
- onTrackShare?: never;
390
- share?: never;
391
- onEditMode: never;
392
- inCall?: never;
393
- myUserId?: never;
394
- onDownloadFile?: (file: File | ContentGridFileProps | ContentGridCommonFileProps) => Promise<void>;
395
- onDownloadCanvas?: (canvas: CanvasRetrieve) => Promise<void>;
396
- };
397
- export interface CRMBuilderProps {
398
- isCRM: true;
399
- onSfdcAccountSearch: (searchTerm?: MaybeRef<string>) => {
400
- accountsLoading: Ref<boolean>;
401
- accounts: Ref<{
402
- label: string;
403
- value: string;
404
- }[]>;
405
- };
406
- }
407
- type AdminImpactCommonBuilderProps = {
408
- openOnStart?: {
409
- component?: string;
410
- section?: string;
411
- };
412
- isFullscreen?: boolean;
413
- displayMode?: 'default' | 'print';
414
- startPage?: number;
415
- endPage?: number;
416
- metadata: {
417
- baseStackingContext?: number;
418
- startInMode?: CanvasActions.Present | CanvasActions.Edit;
419
- };
420
- activeCanvas: CanvasRetrieve;
421
- templates: {
422
- label: CanvasRetrieve['name'];
423
- value: CanvasRetrieve['id'];
424
- }[];
425
- onExit: () => void;
426
- onEnter?: () => void;
427
- onComponentEnter?: (data: ComponentNode | CanvasRetrieve, params: ComponentTrackingParams) => void;
428
- onComponentExit?: (data: ComponentNode | CanvasRetrieve, params: ComponentTrackingParams) => void;
429
- onSave: (canvasId: CanvasRetrieve['id'], canvas: PatchedCanvasUpdateRequest & {
430
- fields?: string;
431
- }, showToast?: boolean) => Promise<CanvasRetrieve>;
432
- onFileOpen: (file: FileOpenParams) => void;
433
- deleteFile: (fileId: FileRetrieve['id']) => Promise<string | void>;
434
- listFiles: (params?: any) => Promise<File[]>;
435
- listCanvases: (params?: any) => Promise<PaginatedData<CanvasRetrieve>>;
436
- fetchFolder: (folderId: Folder['id'] | undefined) => Promise<FolderRetrieve>;
437
- fetchFile: (fileId: FileRetrieve['id']) => Promise<FileRetrieve>;
438
- fetchCanvas: (canvasId: CanvasRetrieve['id']) => Promise<CanvasRetrieve>;
439
- fetchInstanceMetadataTemplate: () => Promise<MetadataTemplate>;
440
- renderPageAsImageUrl?: (fileId: File['id'], pageIndex: number, options: {
441
- width: number;
442
- } | {
443
- height: number;
444
- }) => Promise<string>;
445
- getEnv?: () => Promise<PitcherEnv>;
446
- onEditMode?: (isEditMode: boolean) => void;
447
- onTrackShare?: (canvasId: CanvasRetrieve['id']) => Promise<void>;
448
- onOpenExternalUrl: (payload: OpenExternalUrlRequestPayload) => Promise<void>;
449
- share?: (canvasId: CanvasRetrieve['id']) => Promise<SharedLink>;
450
- isCRM: boolean;
451
- onDownloadFile?: (file: File | ContentGridFileProps | ContentGridCommonFileProps) => Promise<void>;
452
- onDownloadCanvas?: (canvas: CanvasRetrieve) => Promise<void>;
453
- };
454
- type AdminBuilderProps = AdminImpactCommonBuilderProps & (CRMBuilderProps | NoCRMBuilderProps) & {
455
- isRedirectEvent?: never;
456
- mode: CanvasBuilderMode.ADMIN;
457
- inCall?: never;
458
- myUserId?: never;
459
- };
460
- type ImpactBuilderProps = AdminImpactCommonBuilderProps & (CRMBuilderProps | NoCRMBuilderProps) & {
461
- isRedirectEvent?: boolean;
462
- mode: CanvasBuilderMode.IMPACT;
463
- inCall?: boolean;
464
- myUserId?: User['id'];
465
- };
466
- export type CanvasBuilderProps = AdminBuilderProps | ImpactBuilderProps | SharingBuilderProps;
467
- export {};
@@ -1,2 +0,0 @@
1
- export type FontAwesomeType = 'fa' | 'far' | 'fas' | 'fal' | 'fab' | 'fa-kit';
2
- export declare function isFontAwesomeType(type: string): type is FontAwesomeType;
@@ -1,28 +0,0 @@
1
- import { CanvasRetrieve, File } from '../../../../types/openapi';
2
-
3
- export type RecommendedContent = {
4
- type: 'file' | 'slide';
5
- file: {
6
- id: File['id'];
7
- };
8
- slide?: {
9
- index: number;
10
- };
11
- }[];
12
- export type Recommendations = {
13
- recommendation_strategy?: 'force' | 'suggest';
14
- sections?: {
15
- id: CanvasRetrieve['id'];
16
- list_header_html?: string;
17
- recommended?: boolean;
18
- removed_by_user?: boolean;
19
- }[];
20
- recommended_content?: {
21
- content_grids?: RecommendedContent;
22
- sections?: {
23
- [key: CanvasRetrieve['id']]: {
24
- content_grids?: RecommendedContent;
25
- };
26
- };
27
- };
28
- };
@@ -1,44 +0,0 @@
1
- import { UnwrapRef } from 'vue';
2
- import { ComponentTypes, CarouselProps, ComponentNode, ContentGridProps, EmbeddableProps, GridItemProps, GridProps, HtmlProps, MultimediaProps, SectionComponentOverrides, SectionListProps, TextProps, CanvasBuilderMode, ComponentNodeVisible, LinkProps } from '@canvas-builder/types/canvas';
3
- import { CanvasRetrieve } from '../../../../types/openapi';
4
- import { EmbedLocation } from '../../../types/app';
5
- import { SectionComponentNodesBySectionId, ComponentNodesById } from '@canvas-builder/composables/useCanvas';
6
-
7
- export declare function createNodeId(type?: ComponentTypes): string;
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;
11
- export declare function getNodeDisplayNameByComponentType(node: ComponentNode | null | undefined): string;
12
- export declare function discardSectionComponentOverride(sectionId: CanvasRetrieve['id'], componentId: ComponentNode['id'], overrides: SectionComponentOverrides): SectionComponentOverrides;
13
- export declare function addCanvasComponent(currentContent: ComponentNode[], add: {
14
- type: ComponentTypes;
15
- parentId?: ComponentNode['id'] | null;
16
- afterSiblingId?: ComponentNode['id'] | null;
17
- condition?: (node: ComponentNode[]) => boolean;
18
- withData?: ComponentNode['data'] | null;
19
- withChildren?: ComponentNode['children'];
20
- withExtraNodeData?: Partial<ComponentNode>;
21
- }): {
22
- newContent: ComponentNode<GridProps | GridItemProps | TextProps | CarouselProps | MultimediaProps | EmbeddableProps | ContentGridProps | SectionListProps | HtmlProps | LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>[];
23
- newComponentId: null;
24
- } | {
25
- newContent: ComponentNode<GridProps | GridItemProps | TextProps | CarouselProps | MultimediaProps | EmbeddableProps | ContentGridProps | SectionListProps | HtmlProps | LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>[];
26
- newComponentId: string;
27
- };
28
- export declare function getAllPages(canvasContent: ComponentNode[], currentEmbedLocation: EmbedLocation, isEditMode?: boolean): ComponentNode<GridProps | GridItemProps | TextProps | CarouselProps | MultimediaProps | EmbeddableProps | ContentGridProps | SectionListProps | HtmlProps | LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>[][];
29
- export declare function getPageQuantity(canvasContent: ComponentNode[][]): number;
30
- export declare const getPageRange: (canvasContent: ComponentNode[], currentEmbedLocation: EmbedLocation, start?: number, end?: number) => ComponentNode[][];
31
- export declare function scrollCanvasToTop(): void;
32
- export declare function shouldShowEmbeddable(isEditMode: boolean, currentEmbedLocation: EmbedLocation, headlessLocations?: string[]): boolean;
33
- export declare const isHeadlessOrNotAvailableApp: (component: ComponentNode, isEditMode: boolean, currentEmbedLocation: EmbedLocation) => boolean;
34
- export declare function shouldDisplayPlaceholderComponent(isEditMode: boolean, mode: (typeof CanvasBuilderMode)[keyof typeof CanvasBuilderMode] | undefined, visibility?: ComponentNodeVisible): boolean;
35
- export declare function isTextComponentEmpty(component: ComponentNode, overrides?: SectionComponentOverrides, sectionId?: CanvasRetrieve['id']): boolean;
36
- type FoundComponent = {
37
- sectionId?: CanvasRetrieve['id'];
38
- sectionListId?: ComponentNode['id'];
39
- componentId: ComponentNode['id'];
40
- } | null;
41
- export declare function findEmbeddableInSectionsContent(canvasPages: ComponentNode[][], sectionComponentNodesBySectionId: UnwrapRef<SectionComponentNodesBySectionId>, appName: string): FoundComponent;
42
- export declare function findEmbeddableInCanvasContent(componentNodesById: UnwrapRef<ComponentNodesById>, appName: string): FoundComponent;
43
- export declare function scrollToComponentById(id: ComponentNode['id'] | null | undefined, delay?: number): void;
44
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1 +0,0 @@
1
- export declare const simpleDeepClone: <T>(o: T) => T;
@@ -1,6 +0,0 @@
1
- import { PitcherInfo } from '../../../types/app';
2
- import { FileRetrieve } from '../../../../types/openapi';
3
-
4
- export declare const getFileNameWithoutExtension: (fileNameWithExtension: string) => string;
5
- export declare function getFileExtension(filename?: string): string;
6
- export declare function waitUntilFileViewable(id: FileRetrieve['id'], pitcherInfo: PitcherInfo): Promise<FileRetrieve>;
@@ -1,25 +0,0 @@
1
- import { ComponentTypes, HiddenElementsInCanvas } from '@canvas-builder/types/canvas';
2
-
3
- type Action<T> = (n: T) => void;
4
- type TreeLike = {
5
- id: string;
6
- children?: TreeLike[];
7
- type?: ComponentTypes;
8
- data?: any;
9
- };
10
- type Predicate<T> = (n: T) => boolean;
11
- export declare function applyToTreeBy<T extends TreeLike>(tree: T[], action: Action<T>, condition?: Predicate<T>): void;
12
- export declare function findNodeInTreeById<T extends TreeLike>(tree: T[], value: string | number, reverse?: boolean): T | null;
13
- export declare function findNodeInTreeByType<T extends TreeLike>(tree: T[], type: ComponentTypes, reverse?: boolean): T | null;
14
- export declare function findNodeInTreeByCondition<T extends TreeLike>(tree: T[], condition: Predicate<T>, reverse?: boolean): T | null;
15
- export declare function filterTreeBy<T extends TreeLike>(tree: T[], condition?: Predicate<T>): T[];
16
- export declare function collectAllNodesByCondition<T extends TreeLike>(tree: T[], condition: Predicate<T>): T[];
17
- export declare function findParentByNodeId<T extends TreeLike>(tree: T[], value: string | number): T | null;
18
- export declare function regenerateTreeIds<T extends TreeLike>(tree: T[]): T[];
19
- export declare function someNodeInTree<T extends TreeLike>(tree: T[], condition?: Predicate<T>): boolean;
20
- export declare function skipElementsInTree<T extends TreeLike>(tree: T[], idsToHide: {
21
- sections: HiddenElementsInCanvas;
22
- components: HiddenElementsInCanvas;
23
- }): T[];
24
- export declare function moveNodeTo<T extends TreeLike>(tree: T[], nodeId: string | number, siblingId?: string | number, insertLocation?: 'before' | 'after'): T[];
25
- export {};
@@ -1 +0,0 @@
1
- export {};
@@ -1,5 +0,0 @@
1
- export declare function stripQueryParams(url?: string): string;
2
- export declare function isValidUrl(urlString: string): boolean;
3
- export declare function extractBaseUrlAndResource(urlString?: string | null): [string, string];
4
- export declare function extractBaseUrl(urlString?: string | null): string;
5
- export declare function extractResource(urlString?: string | null): string;
@@ -1 +0,0 @@
1
- export {};
@@ -1,44 +0,0 @@
1
- import { FolderRetrieve, Folder, File, FileRetrieve, FileContentTypeEnum } from '../../../types/openapi';
2
- import { Range } from '../../util/tsHelpers';
3
- import { SelectorType } from '@content-selector/stores/app';
4
-
5
- type FileFetcher = (fileId: FileRetrieve['id']) => Promise<FileRetrieve>;
6
- type FolderItemsFetcher = (folderId: Folder['id'] | undefined) => Promise<FolderRetrieve>;
7
- type FileListFetcher = (params?: any) => Promise<File[]>;
8
- type FileDeleter = (fileId: FileRetrieve['id']) => Promise<string | void>;
9
- export type ContentSelection = {
10
- fileId: FileRetrieve['id'];
11
- type: 'file' | 'page';
12
- pageIndex?: number;
13
- };
14
- export type ExternalLinkSelection = {
15
- url: string;
16
- type: 'external_link';
17
- content_type: 'video' | 'image';
18
- };
19
- export type AssetSelection = {
20
- fileId: FileRetrieve['id'];
21
- type: 'asset';
22
- };
23
- export type Selection = ContentSelection | ExternalLinkSelection | AssetSelection;
24
- export type AppProps = {
25
- appName: 'impact' | 'admin';
26
- allowedSelectorTypes?: SelectorType[];
27
- allowedContentTypes?: FileContentTypeEnum[];
28
- allowedAssetContentTypes?: FileContentTypeEnum[];
29
- contentType: 'file' | 'slide' | 'content';
30
- onFolderFetch?: FolderItemsFetcher;
31
- onFileDelete?: FileDeleter;
32
- onFileFetch?: FileFetcher;
33
- onFilesList?: FileListFetcher;
34
- onFileOpen?: ({ fileId, pageIndex, newTab, }: {
35
- fileId: FileRetrieve['id'];
36
- pageIndex?: number;
37
- newTab?: boolean;
38
- }) => void;
39
- selections?: Selection[];
40
- primaryActionText?: string;
41
- maxSelections?: number;
42
- minSelections?: Range<0, 999>;
43
- };
44
- export {};