@pitcher/js-api 1.21.0-beta.8 → 1.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (177) hide show
  1. package/js-api.esm.js +274 -92
  2. package/js-api.esm.js.map +1 -1
  3. package/js-api.umd.min.js +9 -9
  4. package/js-api.umd.min.js.map +1 -1
  5. package/lib/api/canvases/canvases.queries.d.ts +5 -5
  6. package/lib/apps/browser/stores/api.d.ts +215 -84
  7. package/lib/apps/browser/stores/app.d.ts +7 -26
  8. package/lib/apps/browser/stores/upload.d.ts +34 -24
  9. package/lib/apps/browser/util/file.d.ts +2 -2
  10. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +550 -460
  11. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +86 -74
  12. package/lib/apps/canvas-builder/composables/useCanvasHooks.d.ts +4 -4
  13. package/lib/apps/canvas-builder/composables/useCanvasPages.d.ts +3 -3
  14. package/lib/apps/canvas-builder/composables/useCanvasSectionOverrides.d.ts +3 -3
  15. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +24 -17
  16. package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts +2 -2
  17. package/lib/apps/canvas-builder/composables/useCollapsibles.d.ts +3 -3
  18. package/lib/apps/canvas-builder/composables/useComponentPermissions.d.ts +2 -2
  19. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +6 -4
  20. package/lib/apps/canvas-builder/composables/useInstalledEmbeddables.d.ts +4 -1
  21. package/lib/apps/canvas-builder/composables/useRecommendations.d.ts +4 -4
  22. package/lib/apps/canvas-builder/composables/useSectionPopularity.d.ts +2 -2
  23. package/lib/apps/canvas-builder/types/canvas.d.ts +19 -18
  24. package/lib/apps/canvas-builder/types/recommendations.types.d.ts +3 -3
  25. package/lib/apps/canvas-builder/util/canvas.util.d.ts +5 -4
  26. package/lib/apps/content-selector/appTypes.d.ts +1 -0
  27. package/lib/apps/content-selector/stores/app.d.ts +8 -1
  28. package/lib/components/CFileViewer/CFileViewer.use.d.ts +2 -4
  29. package/lib/components/CFileViewer/CFileViewerFullScreen.use.d.ts +1 -1
  30. package/lib/components/canvases/CanvasesManagementBulk.use.d.ts +5 -5
  31. package/lib/components/filters/filter.util.d.ts +1 -1
  32. package/lib/components/savedCanvases/CSavedCanvasesManagementShareCanvas.use.d.ts +2 -2
  33. package/lib/composables/instanceTagsActions.use.d.ts +14 -0
  34. package/lib/composables/recentFiles.use.d.ts +1 -1
  35. package/lib/composables/suggestedTags.use.d.ts +3 -0
  36. package/lib/composables/tableColumnsSettings.use.d.ts +25 -0
  37. package/lib/composables/useCanvasOverlay.d.ts +20 -0
  38. package/lib/composables/useConfirmation.d.ts +1 -0
  39. package/lib/composables/useElementHeightResize.d.ts +5 -0
  40. package/lib/composables/useFiles.d.ts +11 -0
  41. package/lib/constants/pitcherSettings.const.d.ts +4 -0
  42. package/lib/main.lib.d.ts +27 -20
  43. package/lib/sdk/api/HighLevelApi.d.ts +106 -12
  44. package/lib/sdk/api/modules/admin/canvas.admin.d.ts +31 -15
  45. package/lib/sdk/api/modules/admin/env.admin.d.ts +3 -2
  46. package/lib/sdk/api/modules/admin/files.admin.d.ts +43 -4
  47. package/lib/sdk/api/modules/admin/index.d.ts +52 -5
  48. package/lib/sdk/api/modules/admin/metadataTemplates.admin.d.ts +1 -2
  49. package/lib/sdk/api/modules/admin/types.admin.d.ts +117 -3
  50. package/lib/sdk/api/modules/canvas.d.ts +12 -14
  51. package/lib/sdk/api/modules/dsr/env.dsr.d.ts +4 -3
  52. package/lib/sdk/api/modules/dsr/index.d.ts +14 -3
  53. package/lib/sdk/api/modules/dsr/loading.dsr.d.ts +6 -0
  54. package/lib/sdk/api/modules/env.d.ts +16 -0
  55. package/lib/sdk/api/modules/favorites.d.ts +9 -0
  56. package/lib/sdk/api/modules/feedback.d.ts +3 -0
  57. package/lib/sdk/api/modules/files.d.ts +3 -3
  58. package/lib/sdk/api/modules/folders.d.ts +29 -0
  59. package/lib/sdk/api/modules/open.d.ts +6 -0
  60. package/lib/sdk/api/modules/sync.d.ts +1 -2
  61. package/lib/sdk/api/modules/ui/app-errors.ui.d.ts +12 -0
  62. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +75 -2
  63. package/lib/sdk/api/modules/ui/content.ui.d.ts +50 -0
  64. package/lib/sdk/api/modules/ui/index.d.ts +149 -13
  65. package/lib/sdk/api/modules/ui/loading.ui.d.ts +15 -0
  66. package/lib/sdk/api/modules/ui/location.ui.d.ts +17 -0
  67. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +25 -0
  68. package/lib/sdk/api/modules/ui/types.ui.d.ts +69 -6
  69. package/lib/sdk/api/modules/users.d.ts +4 -0
  70. package/lib/sdk/interfaces.d.ts +119 -2
  71. package/lib/sdk/main.d.ts +275 -141
  72. package/lib/sdk/payload.types.d.ts +134 -2
  73. package/lib/theme/light.d.ts +12 -0
  74. package/lib/types/app.d.ts +11 -0
  75. package/lib/types/call.d.ts +2 -2
  76. package/lib/types/files.d.ts +27 -1
  77. package/lib/types/filter.d.ts +5 -0
  78. package/lib/types/instanceSettings.types.d.ts +8 -2
  79. package/lib/types/launchDarkly.types.d.ts +4 -4
  80. package/lib/types/organizationSettings.types.d.ts +4 -0
  81. package/lib/types/recentFiles.types.d.ts +4 -1
  82. package/lib/types/users.d.ts +13 -0
  83. package/lib/util/fullscreen.util.d.ts +1 -1
  84. package/lib/util/string.d.ts +1 -0
  85. package/package.json +1 -1
  86. package/types/openapi/index.d.ts +23 -17
  87. package/types/openapi/models/AccessTypeEnum.d.ts +3 -1
  88. package/types/openapi/models/App.d.ts +1 -0
  89. package/types/openapi/models/AppRelease.d.ts +1 -0
  90. package/types/openapi/models/AppsDBEntry.d.ts +4 -0
  91. package/types/openapi/models/AppsDBEntryRequest.d.ts +3 -0
  92. package/types/openapi/models/Canvas.d.ts +10 -15
  93. package/types/openapi/models/CanvasCreate.d.ts +14 -12
  94. package/types/openapi/models/CanvasCreateRequest.d.ts +6 -5
  95. package/types/openapi/models/CanvasRecommendedFile.d.ts +6 -0
  96. package/types/openapi/models/CanvasRetrieve.d.ts +15 -13
  97. package/types/openapi/models/CanvasSection.d.ts +5 -2
  98. package/types/openapi/models/CanvasUpdate.d.ts +14 -12
  99. package/types/openapi/models/CanvasUpdateRequest.d.ts +5 -4
  100. package/types/openapi/models/CollaborationRoleEnum.d.ts +0 -4
  101. package/types/openapi/models/ContentDistributionGroupCreate.d.ts +1 -0
  102. package/types/openapi/models/DeletedApp.d.ts +1 -0
  103. package/types/openapi/models/{CanvasList.d.ts → DeletedCanvas.d.ts} +13 -9
  104. package/types/openapi/models/DeletedContentDistributionGroup.d.ts +1 -0
  105. package/types/openapi/models/DeletedEnvironment.d.ts +1 -0
  106. package/types/openapi/models/DeletedFavorite.d.ts +1 -0
  107. package/types/openapi/models/DeletedFile.d.ts +6 -0
  108. package/types/openapi/models/DeletedFolder.d.ts +4 -3
  109. package/types/openapi/models/DeletedInstance.d.ts +1 -0
  110. package/types/openapi/models/DeletedInstanceAssignmentGroup.d.ts +1 -0
  111. package/types/openapi/models/DeletedMetadataTemplate.d.ts +1 -0
  112. package/types/openapi/models/DeletedRegion.d.ts +1 -0
  113. package/types/openapi/models/Environment.d.ts +1 -0
  114. package/types/openapi/models/Favorite.d.ts +1 -0
  115. package/types/openapi/models/File.d.ts +6 -0
  116. package/types/openapi/models/FileCreate.d.ts +8 -0
  117. package/types/openapi/models/FileCreateRequest.d.ts +3 -0
  118. package/types/openapi/models/FilePermission.d.ts +4 -0
  119. package/types/openapi/models/FilePermissionRequest.d.ts +4 -0
  120. package/types/openapi/models/FileRetrieve.d.ts +8 -0
  121. package/types/openapi/models/FileRevision.d.ts +8 -0
  122. package/types/openapi/models/FileRevisionRequest.d.ts +3 -0
  123. package/types/openapi/models/FileUpdate.d.ts +8 -0
  124. package/types/openapi/models/FileUpdateRequest.d.ts +3 -0
  125. package/types/openapi/models/FileVersion.d.ts +5 -0
  126. package/types/openapi/models/Folder.d.ts +4 -3
  127. package/types/openapi/models/FolderCanvas.d.ts +11 -0
  128. package/types/openapi/models/FolderCreate.d.ts +8 -7
  129. package/types/openapi/models/FolderCreateRequest.d.ts +4 -2
  130. package/types/openapi/models/FolderFile.d.ts +3 -0
  131. package/types/openapi/models/FolderFolder.d.ts +5 -1
  132. package/types/openapi/models/FolderRetrieve.d.ts +8 -8
  133. package/types/openapi/models/FolderRule.d.ts +7 -0
  134. package/types/openapi/models/FolderRuleRequest.d.ts +7 -0
  135. package/types/openapi/models/FolderUpdate.d.ts +8 -8
  136. package/types/openapi/models/FolderUpdateRequest.d.ts +3 -0
  137. package/types/openapi/models/Instance.d.ts +1 -0
  138. package/types/openapi/models/InstanceUpdate.d.ts +1 -0
  139. package/types/openapi/models/MetadataTemplate.d.ts +1 -0
  140. package/types/openapi/models/OfflineSyncFolder.d.ts +17 -0
  141. package/types/openapi/models/OperatorEnum.d.ts +64 -0
  142. package/types/openapi/models/PaginatedCanvasList.d.ts +8 -0
  143. package/types/openapi/models/PaginatedFileRevisionList.d.ts +8 -0
  144. package/types/openapi/models/PaginatedOfflineSyncFolderList.d.ts +8 -0
  145. package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +5 -4
  146. package/types/openapi/models/PatchedFileRequest.d.ts +3 -0
  147. package/types/openapi/models/PatchedFileRevisionRequest.d.ts +3 -0
  148. package/types/openapi/models/PatchedFileUpdateRequest.d.ts +3 -0
  149. package/types/openapi/models/PatchedFolderUpdateRequest.d.ts +3 -0
  150. package/types/openapi/models/Region.d.ts +1 -0
  151. package/types/openapi/models/SearchFile.d.ts +3 -0
  152. package/types/openapi/models/SharedLink.d.ts +6 -5
  153. package/types/openapi/models/SharedLinkCanvas.d.ts +11 -0
  154. package/types/openapi/models/SharedLinkCanvasRequest.d.ts +8 -0
  155. package/types/openapi/models/SharedLinkCreate.d.ts +6 -5
  156. package/types/openapi/models/{SharedLinkInstanceSerialzier.d.ts → SharedLinkInstance.d.ts} +1 -1
  157. package/types/openapi/models/SharedLinkInstanceRequest.d.ts +5 -0
  158. package/types/openapi/models/{SharedLinkOrganizationSerialzier.d.ts → SharedLinkOrganization.d.ts} +1 -1
  159. package/types/openapi/models/SharedLinkOrganizationRequest.d.ts +6 -0
  160. package/lib/apps/canvas-builder/util/tsUtils.d.ts +0 -3
  161. package/lib/composables/useDetailsView.d.ts +0 -19
  162. package/lib/types/templateActions.d.ts +0 -10
  163. package/lib/util/gesture.util.d.ts +0 -6
  164. package/types/openapi/models/AppsDBGlobalEntry.d.ts +0 -8
  165. package/types/openapi/models/AppsDBGlobalEntryRequest.d.ts +0 -3
  166. package/types/openapi/models/AppsDBUserEntry.d.ts +0 -9
  167. package/types/openapi/models/AppsDBUserEntryRequest.d.ts +0 -3
  168. package/types/openapi/models/CanvasSectionRetrieve.d.ts +0 -7
  169. package/types/openapi/models/CanvasSectionRetrieveRequest.d.ts +0 -5
  170. package/types/openapi/models/FileRequest.d.ts +0 -13
  171. package/types/openapi/models/InstanceStorageCredentials.d.ts +0 -6
  172. package/types/openapi/models/MiniAccount.d.ts +0 -4
  173. package/types/openapi/models/PSPDFKitAuthPayload.d.ts +0 -3
  174. package/types/openapi/models/PSPDFKitAuthPayloadRequest.d.ts +0 -3
  175. package/types/openapi/models/PSPDFKitToken.d.ts +0 -7
  176. package/types/openapi/models/PSPDFKitTokenRequest.d.ts +0 -3
  177. package/types/openapi/models/PaginatedCanvasListList.d.ts +0 -8
@@ -1,8 +0,0 @@
1
- export type AppsDBGlobalEntry = {
2
- readonly store_name: string;
3
- readonly instance_id: string;
4
- readonly scope: string;
5
- readonly key: string;
6
- value: string;
7
- readonly modified_at: string;
8
- };
@@ -1,3 +0,0 @@
1
- export type AppsDBGlobalEntryRequest = {
2
- value: string;
3
- };
@@ -1,9 +0,0 @@
1
- export type AppsDBUserEntry = {
2
- readonly store_name: string;
3
- readonly instance_id: string;
4
- readonly scope: string;
5
- readonly user_id: string;
6
- readonly key: string;
7
- value: string;
8
- readonly modified_at: string;
9
- };
@@ -1,3 +0,0 @@
1
- export type AppsDBUserEntryRequest = {
2
- value: string;
3
- };
@@ -1,7 +0,0 @@
1
- export type CanvasSectionRetrieve = {
2
- readonly id: string;
3
- name: string;
4
- metadata?: Record<string, any>;
5
- readonly content: Record<string, any>;
6
- theme?: any;
7
- };
@@ -1,5 +0,0 @@
1
- export type CanvasSectionRetrieveRequest = {
2
- name: string;
3
- metadata?: Record<string, any>;
4
- theme?: any;
5
- };
@@ -1,13 +0,0 @@
1
- import { AccessTypeEnum } from './AccessTypeEnum';
2
- import { DownloadTypeEnum } from './DownloadTypeEnum';
3
-
4
- export type FileRequest = {
5
- name?: string;
6
- download_type?: DownloadTypeEnum;
7
- access_type?: AccessTypeEnum;
8
- metadata?: Record<string, any>;
9
- app_metadata?: Record<string, any>;
10
- tags?: Array<string>;
11
- expires_at?: string | null;
12
- folder_id?: string;
13
- };
@@ -1,6 +0,0 @@
1
- export type InstanceStorageCredentials = {
2
- base_url: string;
3
- policy: string;
4
- signature: string;
5
- key_pair_id: string;
6
- };
@@ -1,4 +0,0 @@
1
- export type MiniAccount = {
2
- id: string;
3
- name: string;
4
- };
@@ -1,3 +0,0 @@
1
- export type PSPDFKitAuthPayload = {
2
- jwt: string;
3
- };
@@ -1,3 +0,0 @@
1
- export type PSPDFKitAuthPayloadRequest = {
2
- jwt: string;
3
- };
@@ -1,7 +0,0 @@
1
- import { PSPDFKitAuthPayload } from './PSPDFKitAuthPayload';
2
-
3
- export type PSPDFKitToken = {
4
- readonly documentId: string;
5
- readonly authPayload: PSPDFKitAuthPayload;
6
- readonly instant: boolean;
7
- };
@@ -1,3 +0,0 @@
1
- export type PSPDFKitTokenRequest = {
2
- file_id: string;
3
- };
@@ -1,8 +0,0 @@
1
- import { CanvasList } from './CanvasList';
2
-
3
- export type PaginatedCanvasListList = {
4
- count?: number;
5
- next?: string | null;
6
- previous?: string | null;
7
- results?: Array<CanvasList>;
8
- };