@pitcher/js-api 1.19.0 → 1.20.0-beta.14

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.esm.d.ts +1 -0
  2. package/js-api.esm.js +3643 -0
  3. package/js-api.esm.js.map +1 -0
  4. package/js-api.umd.min.js +10 -10
  5. package/js-api.umd.min.js.map +1 -1
  6. package/lib/api/apps/apps.queries.d.ts +3 -0
  7. package/lib/api/canvases/canvases.queries.d.ts +15 -0
  8. package/lib/api/events/events.helpers.d.ts +29 -0
  9. package/lib/api/events/events.queries.d.ts +10 -0
  10. package/lib/api/users/users.queries.d.ts +5 -0
  11. package/lib/apps/browser/composables/useAppEmit.d.ts +3 -0
  12. package/lib/apps/browser/stores/api.d.ts +646 -0
  13. package/lib/apps/browser/stores/api.test.d.ts +1 -0
  14. package/lib/apps/browser/stores/app.d.ts +94 -0
  15. package/lib/apps/browser/stores/app.test.d.ts +1 -0
  16. package/lib/apps/browser/stores/upload.d.ts +111 -0
  17. package/lib/apps/browser/stores/upload.types.d.ts +18 -0
  18. package/lib/apps/browser/util/file.d.ts +3 -0
  19. package/lib/apps/canvas-builder/App.helpers.d.ts +12 -0
  20. package/lib/apps/canvas-builder/components/ui/Link/Link.util.d.ts +13 -0
  21. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +12724 -0
  22. package/lib/apps/canvas-builder/composables/useCanvasDnd.d.ts +12 -0
  23. package/lib/apps/canvas-builder/composables/useCanvasExit.d.ts +3 -0
  24. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +1782 -0
  25. package/lib/apps/canvas-builder/composables/useCanvasHooks.d.ts +25 -0
  26. package/lib/apps/canvas-builder/composables/useCanvasPages.d.ts +35 -0
  27. package/lib/apps/canvas-builder/composables/useCanvasPages.spec.d.ts +1 -0
  28. package/lib/apps/canvas-builder/composables/useCanvasSectionOverrides.d.ts +30 -0
  29. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +85 -0
  30. package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts +9 -0
  31. package/lib/apps/canvas-builder/composables/useCollapsibles.d.ts +14 -0
  32. package/lib/apps/canvas-builder/composables/useComponentPermissions.d.ts +14 -0
  33. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +51 -0
  34. package/lib/apps/canvas-builder/composables/useFetchSectionAnalytics.d.ts +3 -0
  35. package/lib/apps/canvas-builder/composables/useInstalledEmbeddables.d.ts +12 -0
  36. package/lib/apps/canvas-builder/composables/useNavigatorDrawer.d.ts +6 -0
  37. package/lib/apps/canvas-builder/composables/usePitcherEvents.d.ts +5 -0
  38. package/lib/apps/canvas-builder/composables/useRecommendations.d.ts +53 -0
  39. package/lib/apps/canvas-builder/composables/useReorderComponent.d.ts +16 -0
  40. package/lib/apps/canvas-builder/composables/useSectionNavigation.d.ts +16 -0
  41. package/lib/apps/canvas-builder/composables/useSectionPopularity.d.ts +34 -0
  42. package/lib/apps/canvas-builder/constants/canvas.const.d.ts +15 -0
  43. package/lib/apps/canvas-builder/constants/defaults.const.d.ts +1 -0
  44. package/lib/apps/canvas-builder/constants/index.d.ts +3 -0
  45. package/lib/apps/canvas-builder/constants/sizes.d.ts +2 -0
  46. package/lib/apps/canvas-builder/types/canvas.d.ts +467 -0
  47. package/lib/apps/canvas-builder/types/font-awesome.types.d.ts +2 -0
  48. package/lib/apps/canvas-builder/types/recommendations.types.d.ts +28 -0
  49. package/lib/apps/canvas-builder/util/canvas.util.d.ts +44 -0
  50. package/lib/apps/canvas-builder/util/canvas.util.test.d.ts +1 -0
  51. package/lib/apps/canvas-builder/util/clone.d.ts +1 -0
  52. package/lib/apps/canvas-builder/util/file.util.d.ts +6 -0
  53. package/lib/apps/canvas-builder/util/tree.d.ts +25 -0
  54. package/lib/apps/canvas-builder/util/tree.test.d.ts +1 -0
  55. package/lib/apps/canvas-builder/util/url.d.ts +5 -0
  56. package/lib/apps/canvas-builder/util/url.test.d.ts +1 -0
  57. package/lib/apps/content-selector/appTypes.d.ts +44 -0
  58. package/lib/apps/content-selector/stores/app.d.ts +83 -0
  59. package/lib/apps/content-selector/util/file.d.ts +3 -0
  60. package/lib/apps/content-selector/util/media-type.util.d.ts +1 -0
  61. package/lib/apps/notes/composables/useFullscreenNotesHeartbeat.d.ts +3 -0
  62. package/lib/apps/notes/composables/useNotesApp.d.ts +3 -0
  63. package/lib/components/CCatalogIqSwitcher/CCatalogIqSwitcher.types.d.ts +7 -0
  64. package/lib/components/CConfigEditor/CConfigEditor.types.d.ts +7 -0
  65. package/lib/components/CConfigEditor/CConfigEditor.validators.d.ts +4 -0
  66. package/lib/components/CContactSelector/CContactSelector.types.d.ts +4 -0
  67. package/lib/components/CDataTable/CDataTableEdit.use.d.ts +22 -0
  68. package/lib/components/CFileViewer/CFileViewer.types.d.ts +7 -0
  69. package/lib/components/CFileViewer/CFileViewer.use.d.ts +47 -0
  70. package/lib/components/CFileViewer/CFileViewerFullScreen.use.d.ts +16 -0
  71. package/lib/components/CFileViewer/pageThumbnailFavorite.use.d.ts +10 -0
  72. package/lib/components/CFileViewer/pdfEvents.use.d.ts +4 -0
  73. package/lib/components/CGlobalSearch/CGlobalSearch.types.d.ts +23 -0
  74. package/lib/components/CGlobalSearch/GlobalSearch.use.d.ts +24 -0
  75. package/lib/components/CGlobalSearch/Shortcuts.use.d.ts +11 -0
  76. package/lib/components/CMultiSelect/CMultiSelect.test.d.ts +1 -0
  77. package/lib/components/CQuickFilters/CQuickFilters.types.d.ts +4 -0
  78. package/lib/components/CRichTextEditor/constants.d.ts +1 -0
  79. package/lib/components/CRichTextEditor/extensions/bulletListExtended.d.ts +16 -0
  80. package/lib/components/CRichTextEditor/extensions/headingExtended.d.ts +10 -0
  81. package/lib/components/CRichTextEditor/extensions/mentionSuggestions.d.ts +11 -0
  82. package/lib/components/CRichTextEditor/extensions/paragraphExtended.d.ts +26 -0
  83. package/lib/components/CRichTextEditor/extensions/textStyleExtended.d.ts +10 -0
  84. package/lib/components/CSingleSelect/CSingleSelect.test.d.ts +1 -0
  85. package/lib/components/CUsersGroupsAccessManage/CUsersGroupsAccessManage.types.d.ts +56 -0
  86. package/lib/components/CVirtualTable/CVirtualTable.test.d.ts +1 -0
  87. package/lib/components/CVirtualTable/CVirtualTableRow.test.d.ts +1 -0
  88. package/lib/components/canvases/CanvasesManagementBulk.use.d.ts +40 -0
  89. package/lib/components/canvases/CanvasesManagementFilters.use.d.ts +7 -0
  90. package/lib/components/canvases/CanvasesManagementToolbarFilters.use.d.ts +20 -0
  91. package/lib/components/filters/CDateRangeFilter.test.d.ts +1 -0
  92. package/lib/components/filters/CSelectFilter.test.d.ts +1 -0
  93. package/lib/components/filters/filter.const.d.ts +1 -0
  94. package/lib/components/filters/filter.util.d.ts +2 -0
  95. package/lib/components/filters/filter.util.spec.d.ts +1 -0
  96. package/lib/components/savedCanvases/CSavedCanvasesManagement.use.d.ts +11 -0
  97. package/lib/components/savedCanvases/CSavedCanvasesManagementShareCanvas.use.d.ts +9 -0
  98. package/lib/composables/appEmit.use.d.ts +3 -0
  99. package/lib/composables/bulkActions.use.d.ts +12 -0
  100. package/lib/composables/fileViewerSettings.use.d.ts +8 -0
  101. package/lib/composables/recentFiles.use.d.ts +12 -0
  102. package/lib/composables/useAssetUpload.d.ts +6 -0
  103. package/lib/composables/useBindValidation.d.ts +206 -0
  104. package/lib/composables/useCanvasOverlay.d.ts +20 -0
  105. package/lib/composables/useCanvasTablesPagination.d.ts +13 -0
  106. package/lib/composables/useConfirmation.d.ts +23 -0
  107. package/lib/composables/useConnectUpload.d.ts +5 -0
  108. package/lib/composables/useDetailsView.d.ts +19 -0
  109. package/lib/composables/useFetchUsers.d.ts +18 -0
  110. package/lib/composables/useInfiniteScroll.d.ts +13 -0
  111. package/lib/composables/useInstalledApps.d.ts +3 -0
  112. package/lib/composables/useLocation.d.ts +26 -0
  113. package/lib/composables/useLocationAPI.d.ts +39 -0
  114. package/lib/composables/useLocationListeners.d.ts +8 -0
  115. package/lib/composables/useLocationManipulation.d.ts +37 -0
  116. package/lib/composables/usePdfInterpolation.d.ts +9 -0
  117. package/lib/composables/useTheme.d.ts +9 -0
  118. package/lib/composables/useThemeVars.d.ts +30 -0
  119. package/lib/composables/useToast.d.ts +14 -0
  120. package/lib/composables/useWindowEvents.d.ts +20 -0
  121. package/lib/constants/cdp.const.d.ts +41 -0
  122. package/lib/constants/config.const.d.ts +1 -0
  123. package/lib/constants/conventions.const.d.ts +3 -0
  124. package/lib/constants/i18n.const.d.ts +13 -0
  125. package/lib/constants/modal.const.d.ts +9 -0
  126. package/lib/constants/more.const.d.ts +1 -0
  127. package/lib/constants/recentFiles.const.d.ts +4 -0
  128. package/lib/constants/tables.const.d.ts +4 -0
  129. package/lib/constants/timers.const.d.ts +1 -0
  130. package/lib/constants/uploads.const.d.ts +8 -0
  131. package/lib/constants/url.const.d.ts +2 -0
  132. package/lib/custom-naive-locales/el.d.ts +124 -0
  133. package/lib/directives/autofocus.d.ts +4 -0
  134. package/lib/directives/clickOutside.d.ts +8 -0
  135. package/lib/directives/draggable.d.ts +4 -0
  136. package/lib/directives/tooltip.d.ts +4 -0
  137. package/lib/main.lib.d.ts +182 -0
  138. package/lib/plugins/vueQuery.d.ts +3 -0
  139. package/lib/sdk/api/HighLevelApi.d.ts +130 -0
  140. package/lib/sdk/api/HighLevelApi.spec.d.ts +1 -0
  141. package/lib/sdk/api/LowLevelApi.d.ts +18 -0
  142. package/lib/sdk/api/LowLevelApi.spec.d.ts +1 -0
  143. package/lib/sdk/api/modules/admin/canvas.admin.d.ts +89 -0
  144. package/lib/sdk/api/modules/admin/env.admin.d.ts +10 -0
  145. package/lib/sdk/api/modules/admin/files.admin.d.ts +49 -0
  146. package/lib/sdk/api/modules/admin/index.d.ts +40 -0
  147. package/lib/sdk/api/modules/admin/metadataTemplates.admin.d.ts +11 -0
  148. package/lib/sdk/api/modules/admin/types.admin.d.ts +67 -0
  149. package/lib/sdk/api/modules/canvas.d.ts +56 -0
  150. package/lib/sdk/api/modules/dsr/env.dsr.d.ts +10 -0
  151. package/lib/sdk/api/modules/dsr/index.d.ts +9 -0
  152. package/lib/sdk/api/modules/dsr/loading.dsr.d.ts +1 -0
  153. package/lib/sdk/api/modules/dsr/types.dsr.d.ts +39 -0
  154. package/lib/sdk/api/modules/env.d.ts +7 -0
  155. package/lib/sdk/api/modules/events.d.ts +7 -0
  156. package/lib/sdk/api/modules/favorites.d.ts +8 -0
  157. package/lib/sdk/api/modules/feedback.d.ts +3 -0
  158. package/lib/sdk/api/modules/files.d.ts +35 -0
  159. package/lib/sdk/api/modules/folders.d.ts +21 -0
  160. package/lib/sdk/api/modules/index.d.ts +19 -0
  161. package/lib/sdk/api/modules/languages.d.ts +8 -0
  162. package/lib/sdk/api/modules/metadataTemplates.d.ts +4 -0
  163. package/lib/sdk/api/modules/notifications.d.ts +3 -0
  164. package/lib/sdk/api/modules/open.d.ts +4 -0
  165. package/lib/sdk/api/modules/pspdfkit.d.ts +23 -0
  166. package/lib/sdk/api/modules/query.d.ts +3 -0
  167. package/lib/sdk/api/modules/search.d.ts +4 -0
  168. package/lib/sdk/api/modules/sync.d.ts +9 -0
  169. package/lib/sdk/api/modules/toast.d.ts +4 -0
  170. package/lib/sdk/api/modules/track.d.ts +4 -0
  171. package/lib/sdk/api/modules/ui/app-errors.ui.d.ts +3 -0
  172. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +29 -0
  173. package/lib/sdk/api/modules/ui/content.ui.d.ts +24 -0
  174. package/lib/sdk/api/modules/ui/index.d.ts +44 -0
  175. package/lib/sdk/api/modules/ui/loading.ui.d.ts +1 -0
  176. package/lib/sdk/api/modules/ui/location.ui.d.ts +3 -0
  177. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +6 -0
  178. package/lib/sdk/api/modules/ui/types.ui.d.ts +115 -0
  179. package/lib/sdk/api/modules/users.d.ts +7 -0
  180. package/lib/sdk/api/modules/webView.d.ts +4 -0
  181. package/lib/sdk/api/onlineRestApiHandlers.d.ts +4 -0
  182. package/lib/sdk/interfaces.d.ts +232 -0
  183. package/lib/sdk/main.d.ts +564 -0
  184. package/lib/sdk/main.spec.d.ts +1 -0
  185. package/lib/sdk/main.umd-esm.d.ts +1 -0
  186. package/lib/sdk/payload.types.d.ts +56 -0
  187. package/lib/sdk/utils/assert.d.ts +3 -0
  188. package/lib/sdk/utils/assert.spec.d.ts +1 -0
  189. package/lib/sdk/utils/cleanUrl.d.ts +1 -0
  190. package/lib/sdk/utils/eventEmitter.d.ts +17 -0
  191. package/lib/sdk/utils/eventEmitter.spec.d.ts +1 -0
  192. package/lib/sdk/utils/httpFetch.d.ts +15 -0
  193. package/lib/sdk/utils/isodate.d.ts +1 -0
  194. package/lib/sdk/utils/isodate.spec.d.ts +1 -0
  195. package/lib/sdk/utils/object.d.ts +1 -0
  196. package/lib/sdk/utils/object.spec.d.ts +1 -0
  197. package/lib/sdk/utils/postrobot.d.ts +1 -0
  198. package/lib/theme/canvasUiUnoPreset.d.ts +4 -0
  199. package/lib/theme/daisyUi.d.ts +1 -0
  200. package/lib/theme/light.const.d.ts +4 -0
  201. package/lib/theme/light.d.ts +2185 -0
  202. package/lib/theme/main.d.ts +3 -0
  203. package/lib/theme/theme-overrides.d.ts +1 -0
  204. package/lib/theme/theme.types.d.ts +29 -0
  205. package/lib/theme/theme.utils.d.ts +3 -0
  206. package/lib/types/app.d.ts +59 -0
  207. package/lib/types/call.d.ts +43 -0
  208. package/lib/types/canvasActions.d.ts +12 -0
  209. package/lib/types/canvases.d.ts +23 -0
  210. package/lib/types/dataTable.d.ts +6 -0
  211. package/lib/types/favorites.d.ts +5 -0
  212. package/lib/types/fileViewerSettings.types.d.ts +3 -0
  213. package/lib/types/files.d.ts +38 -0
  214. package/lib/types/i18n.types.d.ts +1 -0
  215. package/lib/types/iframes.d.ts +24 -0
  216. package/lib/types/instance.types.d.ts +18 -0
  217. package/lib/types/instanceSettings.types.d.ts +23 -0
  218. package/lib/types/launchDarkly.types.d.ts +40 -0
  219. package/lib/types/organization.types.d.ts +14 -0
  220. package/lib/types/organizationMetadata.types.d.ts +4 -0
  221. package/lib/types/organizationSettings.types.d.ts +3 -0
  222. package/lib/types/paginatedData.d.ts +6 -0
  223. package/lib/types/recentFiles.types.d.ts +4 -0
  224. package/lib/types/sectionPopularity.d.ts +30 -0
  225. package/lib/types/sfdc.d.ts +125 -0
  226. package/lib/types/toast.d.ts +4 -0
  227. package/lib/types/translations.d.ts +5 -0
  228. package/lib/types/ts.d.ts +10 -0
  229. package/lib/types/users.d.ts +12 -0
  230. package/lib/types/vueVirtualScroller.d.ts +4 -0
  231. package/lib/util/anchor.d.ts +2 -0
  232. package/lib/util/array.d.ts +5 -0
  233. package/lib/util/array.spec.d.ts +1 -0
  234. package/lib/util/canvas-manager.util.d.ts +4 -0
  235. package/lib/util/casing.d.ts +4 -0
  236. package/lib/util/casing.spec.d.ts +1 -0
  237. package/lib/util/color.d.ts +4 -0
  238. package/lib/util/date.d.ts +12 -0
  239. package/lib/util/date.spec.d.ts +1 -0
  240. package/lib/util/dev.util.d.ts +2 -0
  241. package/lib/util/dom.d.ts +15 -0
  242. package/lib/util/font.spec.d.ts +1 -0
  243. package/lib/util/font.util.d.ts +7 -0
  244. package/lib/util/fullscreen.util.d.ts +16 -0
  245. package/lib/util/handlebars.d.ts +1 -0
  246. package/lib/util/image.d.ts +1 -0
  247. package/lib/util/location.spec.d.ts +1 -0
  248. package/lib/util/location.util.d.ts +1 -0
  249. package/lib/util/message-event.d.ts +1 -0
  250. package/lib/util/message-event.spec.d.ts +1 -0
  251. package/lib/util/navigation.util.d.ts +7 -0
  252. package/lib/util/network.d.ts +16 -0
  253. package/lib/util/network.spec.d.ts +1 -0
  254. package/lib/util/number.d.ts +4 -0
  255. package/lib/util/number.spec.d.ts +1 -0
  256. package/lib/util/object.d.ts +1 -0
  257. package/lib/util/object.spec.d.ts +1 -0
  258. package/lib/util/query.d.ts +6 -0
  259. package/lib/util/reactive.d.ts +4 -0
  260. package/lib/util/reactive.spec.d.ts +1 -0
  261. package/lib/util/string.d.ts +4 -0
  262. package/lib/util/timer.d.ts +2 -0
  263. package/lib/util/timer.spec.d.ts +1 -0
  264. package/lib/util/translations.d.ts +8 -0
  265. package/lib/util/translations.spec.d.ts +1 -0
  266. package/lib/util/tsHelpers.d.ts +14 -0
  267. package/lib/util/user.d.ts +4 -0
  268. package/lib/util/userAgents.d.ts +8 -0
  269. package/package.json +7 -2
  270. package/types/openapi/index.d.ts +255 -0
  271. package/types/openapi/models/AccessTypeEnum.d.ts +8 -0
  272. package/types/openapi/models/Account.d.ts +4 -0
  273. package/types/openapi/models/AccountRequest.d.ts +4 -0
  274. package/types/openapi/models/App.d.ts +21 -0
  275. package/types/openapi/models/AppInstallationRequest.d.ts +4 -0
  276. package/types/openapi/models/AppOrganization.d.ts +4 -0
  277. package/types/openapi/models/AppOrganizationRequest.d.ts +4 -0
  278. package/types/openapi/models/AppPublish.d.ts +8 -0
  279. package/types/openapi/models/AppRelease.d.ts +10 -0
  280. package/types/openapi/models/AppRequest.d.ts +9 -0
  281. package/types/openapi/models/AppTypeEnum.d.ts +8 -0
  282. package/types/openapi/models/AppsDBEntry.d.ts +4 -0
  283. package/types/openapi/models/AppsDBEntryRequest.d.ts +3 -0
  284. package/types/openapi/models/AuthToken.d.ts +7 -0
  285. package/types/openapi/models/AuthTokenRequest.d.ts +7 -0
  286. package/types/openapi/models/BulkDeleteErrorDetail.d.ts +5 -0
  287. package/types/openapi/models/BulkDeleteRequest.d.ts +6 -0
  288. package/types/openapi/models/BulkDeleteResponse.d.ts +6 -0
  289. package/types/openapi/models/BulkUpdateMetadata.d.ts +6 -0
  290. package/types/openapi/models/BulkUpdateMetadataOperationEnum.d.ts +8 -0
  291. package/types/openapi/models/BulkUpdateMetadataRequest.d.ts +9 -0
  292. package/types/openapi/models/BulkUpdateMetadataResult.d.ts +4 -0
  293. package/types/openapi/models/BulkUpdateTags.d.ts +6 -0
  294. package/types/openapi/models/BulkUpdateTagsOperationEnum.d.ts +8 -0
  295. package/types/openapi/models/BulkUpdateTagsRequest.d.ts +9 -0
  296. package/types/openapi/models/BulkUpdateTagsResult.d.ts +4 -0
  297. package/types/openapi/models/Canvas.d.ts +29 -0
  298. package/types/openapi/models/CanvasCreate.d.ts +36 -0
  299. package/types/openapi/models/CanvasCreateRequest.d.ts +25 -0
  300. package/types/openapi/models/CanvasRecommendedFile.d.ts +46 -0
  301. package/types/openapi/models/CanvasRecommendedFiles.d.ts +5 -0
  302. package/types/openapi/models/CanvasRetrieve.d.ts +36 -0
  303. package/types/openapi/models/CanvasSection.d.ts +10 -0
  304. package/types/openapi/models/CanvasUpdate.d.ts +36 -0
  305. package/types/openapi/models/CanvasUpdateRequest.d.ts +22 -0
  306. package/types/openapi/models/Collaboration.d.ts +16 -0
  307. package/types/openapi/models/CollaborationCreate.d.ts +16 -0
  308. package/types/openapi/models/CollaborationCreateRequest.d.ts +10 -0
  309. package/types/openapi/models/CollaborationRequest.d.ts +5 -0
  310. package/types/openapi/models/CollaborationRoleEnum.d.ts +4 -0
  311. package/types/openapi/models/ConnectedService.d.ts +9 -0
  312. package/types/openapi/models/ContentDistributionGroup.d.ts +12 -0
  313. package/types/openapi/models/ContentDistributionGroupCreate.d.ts +13 -0
  314. package/types/openapi/models/ContentDistributionGroupCreateRequest.d.ts +5 -0
  315. package/types/openapi/models/ContentDistributionGroupMembership.d.ts +8 -0
  316. package/types/openapi/models/ContentDistributionGroupMembershipCreate.d.ts +8 -0
  317. package/types/openapi/models/ContentDistributionGroupMembershipCreateRequest.d.ts +4 -0
  318. package/types/openapi/models/ContentDistributionGroupRequest.d.ts +4 -0
  319. package/types/openapi/models/DefaultExpiresAtEnum.d.ts +16 -0
  320. package/types/openapi/models/DeletedApp.d.ts +23 -0
  321. package/types/openapi/models/DeletedCanvas.d.ts +31 -0
  322. package/types/openapi/models/DeletedContentDistributionGroup.d.ts +15 -0
  323. package/types/openapi/models/DeletedEnvironment.d.ts +15 -0
  324. package/types/openapi/models/DeletedFavorite.d.ts +20 -0
  325. package/types/openapi/models/DeletedFile.d.ts +48 -0
  326. package/types/openapi/models/DeletedFolder.d.ts +18 -0
  327. package/types/openapi/models/DeletedInstance.d.ts +25 -0
  328. package/types/openapi/models/DeletedInstanceAssignmentGroup.d.ts +15 -0
  329. package/types/openapi/models/DeletedMetadataTemplate.d.ts +18 -0
  330. package/types/openapi/models/DeletedRegion.d.ts +13 -0
  331. package/types/openapi/models/DownloadTypeEnum.d.ts +10 -0
  332. package/types/openapi/models/Environment.d.ts +13 -0
  333. package/types/openapi/models/EnvironmentRequest.d.ts +5 -0
  334. package/types/openapi/models/Event.d.ts +18 -0
  335. package/types/openapi/models/EventAttendee.d.ts +5 -0
  336. package/types/openapi/models/EventAttendeeRequest.d.ts +5 -0
  337. package/types/openapi/models/EventExternalObject.d.ts +10 -0
  338. package/types/openapi/models/EventExternalObjectContentTypeEnum.d.ts +12 -0
  339. package/types/openapi/models/EventExternalObjectRequest.d.ts +10 -0
  340. package/types/openapi/models/EventRequest.d.ts +17 -0
  341. package/types/openapi/models/EventStatusEnum.d.ts +10 -0
  342. package/types/openapi/models/Favorite.d.ts +18 -0
  343. package/types/openapi/models/FavoriteCreate.d.ts +12 -0
  344. package/types/openapi/models/FavoriteCreateRequest.d.ts +7 -0
  345. package/types/openapi/models/FavoriteFile.d.ts +6 -0
  346. package/types/openapi/models/FavoriteFileRequest.d.ts +3 -0
  347. package/types/openapi/models/FavoriteUpdate.d.ts +12 -0
  348. package/types/openapi/models/FavoriteUpdateRequest.d.ts +6 -0
  349. package/types/openapi/models/File.d.ts +46 -0
  350. package/types/openapi/models/FileAnalytics.d.ts +16 -0
  351. package/types/openapi/models/FileAnalyticsResult.d.ts +9 -0
  352. package/types/openapi/models/FileContentTypeEnum.d.ts +16 -0
  353. package/types/openapi/models/FileCreate.d.ts +51 -0
  354. package/types/openapi/models/FileCreateRequest.d.ts +27 -0
  355. package/types/openapi/models/FilePermission.d.ts +4 -0
  356. package/types/openapi/models/FilePermissionRequest.d.ts +4 -0
  357. package/types/openapi/models/FileRequest.d.ts +16 -0
  358. package/types/openapi/models/FileRetrieve.d.ts +51 -0
  359. package/types/openapi/models/FileRevision.d.ts +8 -0
  360. package/types/openapi/models/FileRevisionRequest.d.ts +3 -0
  361. package/types/openapi/models/FileStatusEnum.d.ts +8 -0
  362. package/types/openapi/models/FileTypeEnum.d.ts +10 -0
  363. package/types/openapi/models/FileUpdate.d.ts +51 -0
  364. package/types/openapi/models/FileUpdateRequest.d.ts +20 -0
  365. package/types/openapi/models/FileVersion.d.ts +5 -0
  366. package/types/openapi/models/Folder.d.ts +16 -0
  367. package/types/openapi/models/FolderCreate.d.ts +32 -0
  368. package/types/openapi/models/FolderCreateRequest.d.ts +19 -0
  369. package/types/openapi/models/FolderFile.d.ts +15 -0
  370. package/types/openapi/models/FolderFolder.d.ts +8 -0
  371. package/types/openapi/models/FolderRetrieve.d.ts +25 -0
  372. package/types/openapi/models/FolderUpdate.d.ts +32 -0
  373. package/types/openapi/models/FolderUpdateRequest.d.ts +16 -0
  374. package/types/openapi/models/Instance.d.ts +23 -0
  375. package/types/openapi/models/InstanceAnalytics.d.ts +18 -0
  376. package/types/openapi/models/InstanceAnalyticsChangePercentages.d.ts +5 -0
  377. package/types/openapi/models/InstanceAnalyticsCurrentPeriod.d.ts +13 -0
  378. package/types/openapi/models/InstanceAnalyticsFile.d.ts +5 -0
  379. package/types/openapi/models/InstanceAnalyticsFileActivity.d.ts +5 -0
  380. package/types/openapi/models/InstanceAnalyticsFileRequest.d.ts +3 -0
  381. package/types/openapi/models/InstanceAnalyticsInactiveUsers.d.ts +5 -0
  382. package/types/openapi/models/InstanceAnalyticsInactiveUsersRequest.d.ts +4 -0
  383. package/types/openapi/models/InstanceAnalyticsLoginResult.d.ts +5 -0
  384. package/types/openapi/models/InstanceAssignmentGroup.d.ts +12 -0
  385. package/types/openapi/models/InstanceAssignmentGroupMembership.d.ts +8 -0
  386. package/types/openapi/models/InstanceAssignmentGroupMembershipCreate.d.ts +8 -0
  387. package/types/openapi/models/InstanceAssignmentGroupMembershipCreateRequest.d.ts +4 -0
  388. package/types/openapi/models/InstanceAssignmentGroupRequest.d.ts +4 -0
  389. package/types/openapi/models/InstanceMembership.d.ts +12 -0
  390. package/types/openapi/models/InstanceMembershipCreate.d.ts +12 -0
  391. package/types/openapi/models/InstanceMembershipCreateRequest.d.ts +8 -0
  392. package/types/openapi/models/InstanceMembershipGroup.d.ts +11 -0
  393. package/types/openapi/models/InstanceMembershipGroupRequest.d.ts +3 -0
  394. package/types/openapi/models/InstanceMembershipRequest.d.ts +5 -0
  395. package/types/openapi/models/InstanceMembershipRoleEnum.d.ts +8 -0
  396. package/types/openapi/models/InstanceMembershipUser.d.ts +10 -0
  397. package/types/openapi/models/InstanceMembershipUserRequest.d.ts +4 -0
  398. package/types/openapi/models/InstanceMembershipUserStatusEnum.d.ts +6 -0
  399. package/types/openapi/models/InstanceRequest.d.ts +11 -0
  400. package/types/openapi/models/InstanceUpdate.d.ts +19 -0
  401. package/types/openapi/models/InstanceUpdateRequest.d.ts +8 -0
  402. package/types/openapi/models/Invitation.d.ts +11 -0
  403. package/types/openapi/models/InvitationRequest.d.ts +3 -0
  404. package/types/openapi/models/InvitationStatusEnum.d.ts +4 -0
  405. package/types/openapi/models/LanguageEnum.d.ts +12 -0
  406. package/types/openapi/models/MetadataTemplate.d.ts +16 -0
  407. package/types/openapi/models/MetadataTemplateField.d.ts +14 -0
  408. package/types/openapi/models/MetadataTemplateFieldRequest.d.ts +14 -0
  409. package/types/openapi/models/MetadataTemplateFieldTypeEnum.d.ts +16 -0
  410. package/types/openapi/models/MetadataTemplateOption.d.ts +4 -0
  411. package/types/openapi/models/MetadataTemplateOptionRequest.d.ts +4 -0
  412. package/types/openapi/models/MetadataTemplateRequest.d.ts +7 -0
  413. package/types/openapi/models/MetadataTemplateSection.d.ts +6 -0
  414. package/types/openapi/models/MetadataTemplateSectionRequest.d.ts +6 -0
  415. package/types/openapi/models/MiniCanvas.d.ts +4 -0
  416. package/types/openapi/models/MiniCanvasRequest.d.ts +3 -0
  417. package/types/openapi/models/MiniContentDistributionGroup.d.ts +5 -0
  418. package/types/openapi/models/MiniContentDistributionGroupRequest.d.ts +3 -0
  419. package/types/openapi/models/MiniEnvironment.d.ts +5 -0
  420. package/types/openapi/models/MiniEnvironmentRequest.d.ts +4 -0
  421. package/types/openapi/models/MiniEvent.d.ts +5 -0
  422. package/types/openapi/models/MiniEventRequest.d.ts +4 -0
  423. package/types/openapi/models/MiniFile.d.ts +4 -0
  424. package/types/openapi/models/MiniFileRequest.d.ts +3 -0
  425. package/types/openapi/models/MiniFolder.d.ts +4 -0
  426. package/types/openapi/models/MiniFolderRequest.d.ts +3 -0
  427. package/types/openapi/models/MiniInstance.d.ts +4 -0
  428. package/types/openapi/models/MiniInstanceRequest.d.ts +3 -0
  429. package/types/openapi/models/MiniPage.d.ts +4 -0
  430. package/types/openapi/models/MiniPageRequest.d.ts +3 -0
  431. package/types/openapi/models/MiniRegion.d.ts +4 -0
  432. package/types/openapi/models/MiniRegionRequest.d.ts +3 -0
  433. package/types/openapi/models/MiniSharedLink.d.ts +4 -0
  434. package/types/openapi/models/MiniSharedLinkRequest.d.ts +3 -0
  435. package/types/openapi/models/MiniUser.d.ts +5 -0
  436. package/types/openapi/models/MiniUserRequest.d.ts +3 -0
  437. package/types/openapi/models/MostActiveUser.d.ts +7 -0
  438. package/types/openapi/models/OfflineSyncFolder.d.ts +17 -0
  439. package/types/openapi/models/Organization.d.ts +10 -0
  440. package/types/openapi/models/OrganizationAnalytics.d.ts +16 -0
  441. package/types/openapi/models/OrganizationAnalyticsCurrentPeriod.d.ts +13 -0
  442. package/types/openapi/models/OrganizationAnalyticsInactiveUsers.d.ts +5 -0
  443. package/types/openapi/models/OrganizationAnalyticsInactiveUsersRequest.d.ts +4 -0
  444. package/types/openapi/models/OrganizationAnalyticsInstance.d.ts +10 -0
  445. package/types/openapi/models/OrganizationAnalyticsLoginResult.d.ts +5 -0
  446. package/types/openapi/models/OrganizationAnalyticsTop3Instances.d.ts +13 -0
  447. package/types/openapi/models/OrganizationBranding.d.ts +6 -0
  448. package/types/openapi/models/OrganizationBrandingColors.d.ts +4 -0
  449. package/types/openapi/models/OrganizationChangePercentages.d.ts +6 -0
  450. package/types/openapi/models/OrganizationUpdate.d.ts +8 -0
  451. package/types/openapi/models/OrganizationUpdateRequest.d.ts +8 -0
  452. package/types/openapi/models/PSPDFKitAuthPayload.d.ts +3 -0
  453. package/types/openapi/models/PSPDFKitAuthPayloadRequest.d.ts +3 -0
  454. package/types/openapi/models/PSPDFKitToken.d.ts +7 -0
  455. package/types/openapi/models/PSPDFKitTokenRequest.d.ts +3 -0
  456. package/types/openapi/models/PaginatedAppList.d.ts +8 -0
  457. package/types/openapi/models/PaginatedAppReleaseList.d.ts +8 -0
  458. package/types/openapi/models/PaginatedAuthTokenList.d.ts +8 -0
  459. package/types/openapi/models/PaginatedCanvasList.d.ts +8 -0
  460. package/types/openapi/models/PaginatedCollaborationList.d.ts +8 -0
  461. package/types/openapi/models/PaginatedContentDistributionGroupList.d.ts +8 -0
  462. package/types/openapi/models/PaginatedContentDistributionGroupMembershipList.d.ts +8 -0
  463. package/types/openapi/models/PaginatedEnvironmentList.d.ts +8 -0
  464. package/types/openapi/models/PaginatedEventList.d.ts +8 -0
  465. package/types/openapi/models/PaginatedFavoriteList.d.ts +8 -0
  466. package/types/openapi/models/PaginatedFileList.d.ts +8 -0
  467. package/types/openapi/models/PaginatedFileRevisionList.d.ts +8 -0
  468. package/types/openapi/models/PaginatedFolderList.d.ts +8 -0
  469. package/types/openapi/models/PaginatedInstanceAssignmentGroupList.d.ts +8 -0
  470. package/types/openapi/models/PaginatedInstanceAssignmentGroupMembershipList.d.ts +8 -0
  471. package/types/openapi/models/PaginatedInstanceList.d.ts +8 -0
  472. package/types/openapi/models/PaginatedInstanceMembershipList.d.ts +8 -0
  473. package/types/openapi/models/PaginatedInvitationList.d.ts +8 -0
  474. package/types/openapi/models/PaginatedMetadataTemplateList.d.ts +8 -0
  475. package/types/openapi/models/PaginatedOfflineSyncFolderList.d.ts +8 -0
  476. package/types/openapi/models/PaginatedRegionList.d.ts +8 -0
  477. package/types/openapi/models/PaginatedRevisionList.d.ts +8 -0
  478. package/types/openapi/models/PaginatedSearchResultList.d.ts +9 -0
  479. package/types/openapi/models/PaginatedStorageRegionList.d.ts +8 -0
  480. package/types/openapi/models/PaginatedUserList.d.ts +8 -0
  481. package/types/openapi/models/PatchedAppRequest.d.ts +9 -0
  482. package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +22 -0
  483. package/types/openapi/models/PatchedCollaborationRequest.d.ts +5 -0
  484. package/types/openapi/models/PatchedContentDistributionGroupRequest.d.ts +4 -0
  485. package/types/openapi/models/PatchedEnvironmentRequest.d.ts +5 -0
  486. package/types/openapi/models/PatchedEventRequest.d.ts +17 -0
  487. package/types/openapi/models/PatchedFavoriteUpdateRequest.d.ts +6 -0
  488. package/types/openapi/models/PatchedFileRequest.d.ts +16 -0
  489. package/types/openapi/models/PatchedFileRevisionRequest.d.ts +3 -0
  490. package/types/openapi/models/PatchedFileUpdateRequest.d.ts +20 -0
  491. package/types/openapi/models/PatchedFolderUpdateRequest.d.ts +16 -0
  492. package/types/openapi/models/PatchedInstanceAssignmentGroupRequest.d.ts +4 -0
  493. package/types/openapi/models/PatchedInstanceMembershipRequest.d.ts +5 -0
  494. package/types/openapi/models/PatchedInstanceUpdateRequest.d.ts +8 -0
  495. package/types/openapi/models/PatchedMetadataTemplateRequest.d.ts +7 -0
  496. package/types/openapi/models/PatchedOrganizationUpdateRequest.d.ts +8 -0
  497. package/types/openapi/models/PatchedRegionRequest.d.ts +3 -0
  498. package/types/openapi/models/PatchedUserRequest.d.ts +12 -0
  499. package/types/openapi/models/Region.d.ts +11 -0
  500. package/types/openapi/models/RegionRequest.d.ts +3 -0
  501. package/types/openapi/models/Revision.d.ts +8 -0
  502. package/types/openapi/models/RevisionRequest.d.ts +3 -0
  503. package/types/openapi/models/SearchApp.d.ts +6 -0
  504. package/types/openapi/models/SearchCanvas.d.ts +5 -0
  505. package/types/openapi/models/SearchContentDistributionGroup.d.ts +11 -0
  506. package/types/openapi/models/SearchFile.d.ts +9 -0
  507. package/types/openapi/models/SearchInstanceAssignmentGroup.d.ts +11 -0
  508. package/types/openapi/models/SearchResult.d.ts +8 -0
  509. package/types/openapi/models/SearchUser.d.ts +5 -0
  510. package/types/openapi/models/SharedLink.d.ts +16 -0
  511. package/types/openapi/models/SharedLinkCanvas.d.ts +11 -0
  512. package/types/openapi/models/SharedLinkCanvasRequest.d.ts +8 -0
  513. package/types/openapi/models/SharedLinkCreate.d.ts +16 -0
  514. package/types/openapi/models/SharedLinkCreateRequest.d.ts +6 -0
  515. package/types/openapi/models/SharedLinkInstance.d.ts +6 -0
  516. package/types/openapi/models/SharedLinkInstanceRequest.d.ts +5 -0
  517. package/types/openapi/models/SharedLinkOrganization.d.ts +6 -0
  518. package/types/openapi/models/SharedLinkOrganizationRequest.d.ts +6 -0
  519. package/types/openapi/models/StorageRegion.d.ts +5 -0
  520. package/types/openapi/models/StorageRegionEnum.d.ts +10 -0
  521. package/types/openapi/models/Tag.d.ts +3 -0
  522. package/types/openapi/models/UploadCreate.d.ts +8 -0
  523. package/types/openapi/models/UploadCreateRequest.d.ts +5 -0
  524. package/types/openapi/models/User.d.ts +23 -0
  525. package/types/openapi/models/UserRequest.d.ts +12 -0
@@ -0,0 +1,40 @@
1
+ import { AdminToastRequest, ADMIN_MESSAGE_TYPES, AdminMessagePayloads } from './types.admin';
2
+
3
+ declare function on(type: (typeof ADMIN_MESSAGE_TYPES)[keyof typeof ADMIN_MESSAGE_TYPES], handler: (data: AdminMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
4
+ declare function toast(payload: AdminToastRequest): Promise<void>;
5
+ declare const _default: {
6
+ getAppConfig(payload: {
7
+ app_name: string;
8
+ }): Promise<Record<string, any>>;
9
+ getFile(payload: {
10
+ id: import('../../../../main.lib').File["id"];
11
+ }): Promise<import('../../../../main.lib').File>;
12
+ getFiles(payload: Record<string, any>): Promise<import('../../../../main.lib').PaginatedFileList>;
13
+ selectContent(payload: import('./types.admin').AdminSelectContentRequest): Promise<import('./types.admin').AdminSelectContentResponse>;
14
+ getInstanceMetadataTemplates(payload?: import('../../../payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../../../../main.lib').PaginatedMetadataTemplateList>;
15
+ createCanvas(payload: import('../../../../main.lib').CanvasCreateRequest): Promise<import('../../../../main.lib').CanvasRetrieve>;
16
+ getCanvases(payload: import('../../../../main.lib').GetCanvasesParams & {
17
+ filters?: Record<string, any>;
18
+ fields?: string;
19
+ }): Promise<import('../../../../main.lib').PaginatedData<import('../../../../main.lib').CanvasRetrieve>>;
20
+ getCanvas(payload: {
21
+ id: import('../../../../main.lib').CanvasRetrieve["id"];
22
+ fields?: string;
23
+ }): Promise<import('../../../../main.lib').CanvasRetrieve>;
24
+ updateCanvas(payload: import('../../../../main.lib').PatchedCanvasUpdateRequest & {
25
+ id: import('../../../../main.lib').CanvasRetrieve["id"];
26
+ instance_id?: import('../../../../main.lib').Instance["id"];
27
+ fields?: string;
28
+ }): Promise<import('../../../../main.lib').CanvasRetrieve>;
29
+ openCanvasOverlay(payload: {
30
+ id: import('../../../../main.lib').CanvasRetrieve["id"];
31
+ edit_mode?: boolean;
32
+ fullscreen?: boolean;
33
+ component_id?: string;
34
+ section_id?: string;
35
+ }): Promise<void>;
36
+ getEnv(): Promise<import('./types.admin').AdminEnv>;
37
+ on: typeof on;
38
+ toast: typeof toast;
39
+ };
40
+ export default _default;
@@ -0,0 +1,11 @@
1
+ import { PaginatedMetadataTemplateList } from '../../../../../types/openapi';
2
+ import { GetInstanceMetadataTemplatesPayload } from '../../../payload.types';
3
+
4
+ /**
5
+ * Fetches a list of metadata templates to use in your app. Instance is auto-injected by admin app if in instance scope.
6
+ *
7
+ * ```
8
+ * adminApi.getInstanceMetadataTemplates()
9
+ * ```
10
+ **/
11
+ export declare function getInstanceMetadataTemplates(payload?: GetInstanceMetadataTemplatesPayload): Promise<PaginatedMetadataTemplateList>;
@@ -0,0 +1,67 @@
1
+ import { PitcherEnv } from '../../../interfaces';
2
+ import { SelectedPage as ContentSelectorSelectedPage, SelectedFile as ContentSelectorSelectedFile } from '@content-selector/stores/app';
3
+
4
+ export declare const ADMIN_MESSAGE: "ADMIN_MESSAGE";
5
+ export declare const ADMIN_MESSAGE_TYPES: {
6
+ readonly ENV_CHANGED: "admin_env_changed";
7
+ };
8
+ export declare const ADMIN_API_TYPES: {
9
+ readonly ADMIN_REQUEST: "ADMIN_REQUEST";
10
+ readonly ADMIN_RESPONSE: "ADMIN_RESPONSE";
11
+ };
12
+ export declare const ADMIN_API_METHOD_TYPES: {
13
+ readonly CREATE_CANVAS: "admin_create_canvas";
14
+ readonly GET_APP_CONFIG: "admin_get_app_config";
15
+ readonly GET_CANVAS: "admin_get_canvas";
16
+ readonly GET_CANVASES: "admin_get_canvases";
17
+ readonly OPEN_CANVAS_OVERLAY: "admin_open_canvas_overlay";
18
+ readonly GET_ENV: "admin_get_env";
19
+ readonly GET_FILE: "admin_get_file";
20
+ readonly GET_FILES: "admin_get_files";
21
+ readonly GET_INSTANCE_METADATA_TEMPLATES: "admin_get_instance_metadata_templates";
22
+ readonly TOAST: "admin_toast";
23
+ readonly UPDATE_CANVAS: "admin_update_canvas";
24
+ readonly SELECT_CONTENT: "admin_select_content";
25
+ };
26
+ export type AdminMessagePayloads = {
27
+ [ADMIN_MESSAGE_TYPES.ENV_CHANGED]: AdminEnv;
28
+ };
29
+ export type AdminRequest<Payload = any> = {
30
+ id: string;
31
+ type: (typeof ADMIN_API_TYPES)['ADMIN_REQUEST'];
32
+ body: {
33
+ type: (typeof ADMIN_API_METHOD_TYPES)[keyof typeof ADMIN_API_METHOD_TYPES];
34
+ data: Payload;
35
+ };
36
+ };
37
+ export interface AdminToastRequest {
38
+ type: 'info' | 'error' | 'warning' | 'success' | 'loading';
39
+ message: string;
40
+ duration?: number;
41
+ closable?: boolean;
42
+ keepAliveOnHover?: boolean;
43
+ showIcon?: boolean;
44
+ }
45
+ export type AdminSelectContentRequest = {
46
+ selections?: Selection[];
47
+ };
48
+ export type AdminSelectContentResponse = {
49
+ user_action: 'cancelled' | 'selected';
50
+ content?: (ContentSelectorSelectedFile | ContentSelectorSelectedPage)[];
51
+ };
52
+ export type AdminResponse<Response = any> = {
53
+ id: string;
54
+ type: (typeof ADMIN_API_TYPES)['ADMIN_RESPONSE'];
55
+ body: Response;
56
+ };
57
+ export type AdminMessage<Payload = any> = {
58
+ id: string;
59
+ type: typeof ADMIN_MESSAGE;
60
+ body: {
61
+ type: (typeof ADMIN_MESSAGE_TYPES)[keyof typeof ADMIN_MESSAGE_TYPES];
62
+ data: Payload;
63
+ };
64
+ };
65
+ export type AdminEnv = {
66
+ pitcher: PitcherEnv['pitcher'];
67
+ };
@@ -0,0 +1,56 @@
1
+ import { CanvasRetrieve, CanvasCreateRequest, PatchedCanvasUpdateRequest, SharedLink, Instance } from '../../../../types/openapi';
2
+ import { GetCanvasesParams } from '../../../types/canvases';
3
+ import { PaginatedData } from '../../../types/paginatedData';
4
+
5
+ /**
6
+ * Fetches a list of canvases to use in your app.
7
+ *
8
+ * ```
9
+ * // The `filters` object is a reserved payload key to transfer the metadata dict over the wire.
10
+ * api.getCanvases({
11
+ * search: 'my search query',
12
+ * ordering: '-created_at',
13
+ * filters: {
14
+ * metadata__mydaterangefiltername__range: ['2023-12-10', '2023-12-22'],
15
+ * metadata__mymultiselectfiltername: ['optionAValue', 'optionCValue'],
16
+ * },
17
+ * fields: 'id,name,metadata',
18
+ * })
19
+ * ```
20
+ */
21
+ export declare function getCanvases(payload: GetCanvasesParams & {
22
+ filters?: Record<string, any>;
23
+ fields?: string;
24
+ }): Promise<PaginatedData<CanvasRetrieve>>;
25
+ export declare function createCanvas(payload: Omit<CanvasCreateRequest, 'instance_id'>): Promise<CanvasRetrieve>;
26
+ export declare function deleteCanvas(payload: {
27
+ id: CanvasRetrieve['id'];
28
+ }): Promise<CanvasRetrieve>;
29
+ /**
30
+ * Updates a canvas by ID
31
+ *
32
+ * ```
33
+ * // The fields param is appended to the URL as a query param.
34
+ * onMounted(() => {
35
+ * PitcherAPI.updateCanvas({
36
+ * id: '01HH4RCBH631K4JDHWAQB0RPR6',
37
+ * fields: 'id,name',
38
+ * name: 'To 3!',
39
+ * }).then((res) => {
40
+ * console.log(res) // logs: { id: '01HH4RCBH631K4JDHWAQB0RPR6', name: 'To 3!' }
41
+ * })
42
+ * })
43
+ * ```
44
+ */
45
+ export declare function updateCanvas(payload: PatchedCanvasUpdateRequest & {
46
+ id: CanvasRetrieve['id'];
47
+ instance_id?: Instance['id'];
48
+ fields?: string;
49
+ }): Promise<CanvasRetrieve>;
50
+ export declare function getCanvas(payload: {
51
+ id: CanvasRetrieve['id'];
52
+ fields?: string;
53
+ }): Promise<CanvasRetrieve>;
54
+ export declare function shareCanvas(payload: {
55
+ id: CanvasRetrieve['id'];
56
+ }): Promise<SharedLink>;
@@ -0,0 +1,10 @@
1
+ import { DsrEnv } from './types.dsr';
2
+
3
+ /**
4
+ * Fetches the necessary info for the app to know where it is embedded. LaunchDarkly flags are omitted for now as they are not yet used.
5
+ *
6
+ * ```
7
+ * useDsr().getEnv()
8
+ * ```
9
+ */
10
+ export declare function getEnv(): Promise<DsrEnv>;
@@ -0,0 +1,9 @@
1
+ import { DSR_MESSAGE_TYPES, DsrMessagePayloads } from './types.dsr';
2
+
3
+ declare function on(type: (typeof DSR_MESSAGE_TYPES)[keyof typeof DSR_MESSAGE_TYPES], handler: (data: DsrMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
4
+ declare const _default: {
5
+ embeddable_ready(): Promise<void>;
6
+ getEnv(): Promise<import('./types.dsr').DsrEnv>;
7
+ on: typeof on;
8
+ };
9
+ export default _default;
@@ -0,0 +1 @@
1
+ export declare function embeddable_ready(): Promise<void>;
@@ -0,0 +1,39 @@
1
+ import { PitcherEnv } from '../../../interfaces';
2
+
3
+ export declare const DSR_MESSAGE: "DSR_MESSAGE";
4
+ export declare const DSR_MESSAGE_TYPES: {
5
+ readonly ENV_CHANGED: "dsr_env_changed";
6
+ };
7
+ export declare const DSR_API_TYPES: {
8
+ readonly DSR_REQUEST: "DSR_REQUEST";
9
+ readonly DSR_RESPONSE: "DSR_RESPONSE";
10
+ };
11
+ export declare const DSR_API_METHOD_TYPES: {
12
+ readonly GET_ENV: "dsr_get_env";
13
+ readonly DSR_EMBEDDABLE_READY: "dsr_embeddable_ready";
14
+ };
15
+ export type DsrMessagePayloads = {
16
+ [DSR_MESSAGE_TYPES.ENV_CHANGED]: DsrEnv;
17
+ };
18
+ export type DsrRequest<Payload = any> = {
19
+ id: string;
20
+ type: (typeof DSR_API_TYPES)['DSR_REQUEST'];
21
+ body: {
22
+ type: (typeof DSR_API_METHOD_TYPES)[keyof typeof DSR_API_METHOD_TYPES];
23
+ data: Payload;
24
+ };
25
+ };
26
+ export type DsrResponse<Response = any> = {
27
+ id: string;
28
+ type: (typeof DSR_API_TYPES)['DSR_RESPONSE'];
29
+ body: Response;
30
+ };
31
+ export type DsrMessage<Payload = any> = {
32
+ id: string;
33
+ type: typeof DSR_MESSAGE;
34
+ body: {
35
+ type: (typeof DSR_MESSAGE_TYPES)[keyof typeof DSR_MESSAGE_TYPES];
36
+ data: Payload;
37
+ };
38
+ };
39
+ export type DsrEnv = Pick<PitcherEnv, 'mode' | 'launch_darkly' | 'client_type'>;
@@ -0,0 +1,7 @@
1
+ import { PitcherEnv } from '../../interfaces';
2
+ import { User } from '../../../../types/openapi';
3
+
4
+ export declare function getEnv(): Promise<PitcherEnv>;
5
+ type UpdateEnvParams = Pick<User, 'language' | 'dark_mode'>;
6
+ export declare function updateMyUser(payload: UpdateEnvParams): Promise<User>;
7
+ export {};
@@ -0,0 +1,7 @@
1
+ import { PaginatedData } from '../../../types/paginatedData';
2
+ import { Event, EventRequest, PatchedEventRequest } from '../../../../types/openapi';
3
+
4
+ export declare function getEvents(payload: Partial<EventRequest>): Promise<PaginatedData<Event>>;
5
+ export declare function createEvent(payload: EventRequest): Promise<Event>;
6
+ export declare function updateEvent(payload: PatchedEventRequest): Promise<Event>;
7
+ export declare function deleteEvent(payload: Partial<Event>): Promise<void>;
@@ -0,0 +1,8 @@
1
+ import { Favorite, FavoriteCreateRequest, PaginatedFavoriteList } from '../../../../types/openapi';
2
+ import { GetFavoritesParams } from '../../../types/favorites';
3
+
4
+ export declare function getFavorites(payload?: GetFavoritesParams): Promise<PaginatedFavoriteList>;
5
+ export declare function createFavorite(payload: FavoriteCreateRequest): Promise<Favorite>;
6
+ export declare function deleteFavorite(payload: {
7
+ favorite_id: Favorite['id'];
8
+ }): Promise<void>;
@@ -0,0 +1,3 @@
1
+ import { SubmitUserFeedbackPayload } from '../../payload.types';
2
+
3
+ export declare function submitUserFeedback(payload: SubmitUserFeedbackPayload): Promise<any>;
@@ -0,0 +1,35 @@
1
+ import { File, FileRetrieve, PaginatedFileList, FileUpdateRequest } from '../../../../types/openapi';
2
+ import { GetRecentFilesPayload, ListFilesPayload } from '../../payload.types';
3
+ import { AllFileCreateRequest, DeviceFile } from '../../../types/files';
4
+
5
+ export declare function getFiles(payload: ListFilesPayload & {
6
+ filters?: Record<string, any>;
7
+ fields?: string;
8
+ }): Promise<PaginatedFileList>;
9
+ export declare function getRecentFiles(payload?: GetRecentFilesPayload): Promise<File[]>;
10
+ export declare function downloadFile(payload: {
11
+ file_id: File['id'];
12
+ }): Promise<null>;
13
+ export declare function getAppConfig(payload: {
14
+ app_name: string;
15
+ }): Promise<Record<string, any>>;
16
+ export declare function getFile(payload: {
17
+ id?: FileRetrieve['id'];
18
+ file_id?: FileRetrieve['id'];
19
+ }): Promise<FileRetrieve>;
20
+ export declare function updateFile(payload: FileUpdateRequest & {
21
+ id: File['id'];
22
+ }): Promise<FileRetrieve>;
23
+ export declare function deleteFile(payload: {
24
+ file_id: File['id'];
25
+ }): Promise<File['id']>;
26
+ export declare function createFile(payload: Omit<AllFileCreateRequest, 'instance_id'>): Promise<FileRetrieve>;
27
+ /**
28
+ * Dispatches iOS native file selector and returns the selected file.
29
+ *
30
+ * ```
31
+ * // iOS only method to select a file from the device.
32
+ * api.selectDeviceFile()
33
+ * ```
34
+ */
35
+ export declare function selectDeviceFile(): Promise<DeviceFile>;
@@ -0,0 +1,21 @@
1
+ import { File, Folder, FolderRetrieve, FolderCreateRequest, FolderUpdateRequest } from '../../../../types/openapi';
2
+
3
+ export declare function getFolder(payload?: {
4
+ id: FolderRetrieve['id'];
5
+ }): Promise<FolderRetrieve>;
6
+ export declare function createFolder(payload: Omit<FolderCreateRequest, 'instance_id'>): Promise<FolderRetrieve>;
7
+ type UpdateFolderPayload = FolderUpdateRequest & {
8
+ id: Folder['id'];
9
+ };
10
+ export declare function updateFolder(payload: UpdateFolderPayload): Promise<FolderRetrieve>;
11
+ export declare function deleteFolder(payload: {
12
+ folder_id: FolderRetrieve['id'];
13
+ }): Promise<void>;
14
+ export declare function moveFolderItems(payload: {
15
+ target_folder_id: Folder['id'];
16
+ items: {
17
+ id: File['id'] | Folder['id'];
18
+ type: 'folder' | 'file';
19
+ }[];
20
+ }): Promise<FolderRetrieve>;
21
+ export {};
@@ -0,0 +1,19 @@
1
+ export * from './open';
2
+ export * from './env';
3
+ export * from './languages';
4
+ export * from './events';
5
+ export * from './canvas';
6
+ export * from './files';
7
+ export * from './search';
8
+ export * from './users';
9
+ export * from './pspdfkit';
10
+ export * from './toast';
11
+ export * from './query';
12
+ export * from './folders';
13
+ export * from './favorites';
14
+ export * from './notifications';
15
+ export * from './track';
16
+ export * from './metadataTemplates';
17
+ export * from './sync';
18
+ export * from './feedback';
19
+ export * from './webView';
@@ -0,0 +1,8 @@
1
+ export type Language = [
2
+ string,
3
+ string
4
+ ];
5
+ /**
6
+ * Fetches available languages for the logged-in user
7
+ */
8
+ export declare function getLanguages(): Promise<Language[]>;
@@ -0,0 +1,4 @@
1
+ import { PaginatedMetadataTemplateList } from '../../../../types/openapi';
2
+ import { GetInstanceMetadataTemplatesPayload } from '../../payload.types';
3
+
4
+ export declare function getInstanceMetadataTemplates(payload?: GetInstanceMetadataTemplatesPayload): Promise<PaginatedMetadataTemplateList>;
@@ -0,0 +1,3 @@
1
+ import { NotificationPayload } from '../../payload.types';
2
+
3
+ export declare function notify(payload: NotificationPayload): Promise<void>;
@@ -0,0 +1,4 @@
1
+ import { OpenExternalUrlRequestPayload, OpenRequestPayload } from '../../payload.types';
2
+
3
+ export declare function open(payload?: OpenRequestPayload): Promise<string>;
4
+ export declare function openExternalUrl(payload: OpenExternalUrlRequestPayload): Promise<void>;
@@ -0,0 +1,23 @@
1
+ import { File } from '../../../../types/openapi';
2
+
3
+ /**
4
+ * @deprecated - not used anymore
5
+ */
6
+ export declare function fetchDocumentInfo(payload: {
7
+ fileId: File['id'];
8
+ }): Promise<{
9
+ pageCount: number;
10
+ [key: string]: unknown;
11
+ }>;
12
+ /**
13
+ * @deprecated - use thumbnails instead
14
+ */
15
+ export declare function renderPageAsImage(payload: {
16
+ fileId: File['id'];
17
+ pageNumber: number;
18
+ params: {
19
+ width: number;
20
+ } | {
21
+ height: number;
22
+ };
23
+ }): Promise<ArrayBuffer>;
@@ -0,0 +1,3 @@
1
+ import { QueryPayload } from '../../payload.types';
2
+
3
+ export declare function query(payload: QueryPayload): Promise<any>;
@@ -0,0 +1,4 @@
1
+ export declare function search(payload: {
2
+ query: string;
3
+ includeExpired?: boolean;
4
+ }): Promise<any>;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Dispatches iOS only sync method for non-files.
3
+ *
4
+ * ```
5
+ * // iOS only method to sync non-files from the server.
6
+ * api.triggerNonFilesSync()
7
+ * ```
8
+ */
9
+ export declare function triggerNonFilesSync(): Promise<void>;
@@ -0,0 +1,4 @@
1
+ export declare function toast(payload: {
2
+ type: string;
3
+ message: string;
4
+ }): Promise<void>;
@@ -0,0 +1,4 @@
1
+ export declare function track(payload: {
2
+ event_name: string;
3
+ payload: any;
4
+ }): Promise<any>;
@@ -0,0 +1,3 @@
1
+ import { UiCaptureAppErrorRequest } from './types.ui';
2
+
3
+ export declare function capture_app_error(payload: UiCaptureAppErrorRequest): Promise<void>;
@@ -0,0 +1,29 @@
1
+ import { CanvasRetrieve } from '../../../../../types/openapi';
2
+ import { UiAppResizeRequest, UiCanvasNavigatePageReuqest, UiUpdateCanvasRequest } from './types.ui';
3
+
4
+ export declare function update_canvas(payload: UiUpdateCanvasRequest): Promise<CanvasRetrieve>;
5
+ export declare function app_loaded(): Promise<void>;
6
+ export declare function app_resize(payload: UiAppResizeRequest): Promise<void>;
7
+ export declare function canvas_navigate_next_page(): Promise<void>;
8
+ export declare function canvas_navigate_previous_page(): Promise<void>;
9
+ export declare function canvas_navigate_page(payload: UiCanvasNavigatePageReuqest): Promise<void>;
10
+ /**
11
+ * Opens a modal to view a canvas by ID.
12
+ *
13
+ * ```
14
+ * onMounted(() => {
15
+ * uiApi.openCanvasOverlay({
16
+ * id: '01HH4RCBH631K4JDHWAQB0RPR6',
17
+ * edit_mode: false,
18
+ * fullscreen: true,
19
+ * })
20
+ * })
21
+ * ```
22
+ */
23
+ export declare function openCanvasOverlay(payload: {
24
+ id: CanvasRetrieve['id'];
25
+ edit_mode?: boolean;
26
+ fullscreen?: boolean;
27
+ component_id?: string;
28
+ section_id?: string;
29
+ }): Promise<void>;
@@ -0,0 +1,24 @@
1
+ import { UiSelectContentRequest, UiSelectContentResponse, UiOpenRequest, UiToastRequest, UiPreselectSfdcMeetingIdRequest, UiPreselectSfdcMeetingIdResponse } from './types.ui';
2
+
3
+ export declare function ui_select_content(payload?: UiSelectContentRequest): Promise<UiSelectContentResponse>;
4
+ /**
5
+ * Allows you to select (and preselect) content from your Pitcher content.
6
+ * ```
7
+ * const api = useApi() // or useUi() if you know that you 're in UI context
8
+ * api
9
+ * .select_content({
10
+ * selections: [
11
+ * { fileId: "01HCZ623YYRFJQ0F7B69VWE510", type: "file" },
12
+ * {
13
+ * fileId: "01HD3XGZ5FN90QJGK7CH8TBZDF",
14
+ * type: "page",
15
+ * pageIndex: 2,
16
+ * },
17
+ * ],
18
+ * })
19
+ * ```
20
+ */
21
+ export declare function select_content(payload?: UiSelectContentRequest): Promise<UiSelectContentResponse>;
22
+ export declare function open(payload: UiOpenRequest): Promise<void>;
23
+ export declare function toast(payload: UiToastRequest): Promise<void>;
24
+ export declare function preselect_sfdc_meeting_id(payload: UiPreselectSfdcMeetingIdRequest): Promise<UiPreselectSfdcMeetingIdResponse>;
@@ -0,0 +1,44 @@
1
+ import { UiMeetingCanceledPayload, UiCanvasUpdatedPayload, UiSectionListUpdatedPayload, UiAppSetDataPayload, UiAppUpdateDataPayload, UiBroadcastRequest, UiMessagePayloads } from './types.ui';
2
+
3
+ declare function on<T extends keyof UiMessagePayloads>(type: T, handler: (data: UiMessagePayloads[T]) => Promise<void>): Promise<() => void>;
4
+ declare function on_meeting_canceled(handler: (data: UiMeetingCanceledPayload) => Promise<void>): Promise<() => void>;
5
+ declare function on_canvas_updated(handler: (data: UiCanvasUpdatedPayload) => Promise<void>): Promise<() => void>;
6
+ declare function on_section_list_updated(handler: (data: UiSectionListUpdatedPayload) => Promise<void>): Promise<() => void>;
7
+ declare function on_app_set_data(handler: (data: UiAppSetDataPayload) => Promise<void>): Promise<() => void>;
8
+ declare function on_app_update_data(handler: (data: UiAppUpdateDataPayload) => Promise<void>): Promise<() => void>;
9
+ declare function ui_broadcast(payload: UiBroadcastRequest): Promise<void>;
10
+ declare const _default: {
11
+ complete_postcall(payload: import('../../../../main.lib').UiCompletePostcallRequest): Promise<void>;
12
+ enable_postcall_submit(): Promise<void>;
13
+ disable_postcall_submit(): Promise<void>;
14
+ set_postcall_style(payload: import('../../../../main.lib').UiSetPostcallStyleRequest): Promise<void>;
15
+ update_canvas(payload: import('../../../../main.lib').UiUpdateCanvasRequest): Promise<import('../../../../main.lib').CanvasRetrieve>;
16
+ app_loaded(): Promise<void>;
17
+ app_resize(payload: import('../../../../main.lib').UiAppResizeRequest): Promise<void>;
18
+ canvas_navigate_next_page(): Promise<void>;
19
+ canvas_navigate_previous_page(): Promise<void>;
20
+ canvas_navigate_page(payload: import('../../../../main.lib').UiCanvasNavigatePageReuqest): Promise<void>;
21
+ openCanvasOverlay(payload: {
22
+ id: import('../../../../main.lib').CanvasRetrieve["id"];
23
+ edit_mode?: boolean;
24
+ fullscreen?: boolean;
25
+ component_id?: string;
26
+ section_id?: string;
27
+ }): Promise<void>;
28
+ capture_app_error(payload: import('../../../../main.lib').UiCaptureAppErrorRequest): Promise<void>;
29
+ update_location(payload: import('../../../../main.lib').UpdateLocationPitcherEvent): Promise<any>;
30
+ embeddable_ready(): Promise<void>;
31
+ ui_select_content(payload?: import('../../../../main.lib').UiSelectContentRequest): Promise<import('../../../../main.lib').UiSelectContentResponse>;
32
+ select_content(payload?: import('../../../../main.lib').UiSelectContentRequest): Promise<import('../../../../main.lib').UiSelectContentResponse>;
33
+ open(payload: import('../../../../main.lib').UiOpenRequest): Promise<void>;
34
+ toast(payload: import('../../../../main.lib').UiToastRequest): Promise<void>;
35
+ preselect_sfdc_meeting_id(payload: import('../../../../main.lib').UiPreselectSfdcMeetingIdRequest): Promise<import('../../../../main.lib').UiPreselectSfdcMeetingIdResponse>;
36
+ on: typeof on;
37
+ on_meeting_canceled: typeof on_meeting_canceled;
38
+ on_canvas_updated: typeof on_canvas_updated;
39
+ on_section_list_updated: typeof on_section_list_updated;
40
+ on_app_set_data: typeof on_app_set_data;
41
+ on_app_update_data: typeof on_app_update_data;
42
+ ui_broadcast: typeof ui_broadcast;
43
+ };
44
+ export default _default;
@@ -0,0 +1 @@
1
+ export declare function embeddable_ready(): Promise<void>;
@@ -0,0 +1,3 @@
1
+ import { UpdateLocationPitcherEvent } from '../../../interfaces';
2
+
3
+ export declare function update_location(payload: UpdateLocationPitcherEvent): Promise<any>;
@@ -0,0 +1,6 @@
1
+ import { UiCompletePostcallRequest, UiSetPostcallStyleRequest } from './types.ui';
2
+
3
+ export declare function complete_postcall(payload: UiCompletePostcallRequest): Promise<void>;
4
+ export declare function enable_postcall_submit(): Promise<void>;
5
+ export declare function disable_postcall_submit(): Promise<void>;
6
+ export declare function set_postcall_style(payload: UiSetPostcallStyleRequest): Promise<void>;