@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,56 +1,188 @@
1
- import { MiniPage, File, Canvas } from '../../types/openapi';
1
+ import { MiniPage, File, CanvasRetrieve } from '../../types/openapi';
2
2
 
3
+ /**
4
+ * Payload for getting instance metadata templates.
5
+ */
3
6
  export interface GetInstanceMetadataTemplatesPayload {
7
+ /**
8
+ * Ordering of the metadata templates. String containing field name to order by.
9
+ */
4
10
  ordering?: string;
11
+ /**
12
+ * Page number for pagination.
13
+ */
5
14
  page?: number;
15
+ /**
16
+ * Number of items per page.
17
+ */
6
18
  page_size?: number;
19
+ /**
20
+ * Search query for filtering metadata templates.
21
+ */
7
22
  search?: string;
8
23
  }
24
+ /**
25
+ * Payload for listing files with optional filters.
26
+ */
9
27
  export type ListFilesPayload = Partial<Omit<File, 'type'>> & {
28
+ /**
29
+ * Range filter for creation date.
30
+ */
10
31
  created_at__range?: string;
32
+ /**
33
+ * Range filter for expiration date.
34
+ */
11
35
  expires_at__range?: string;
36
+ /**
37
+ * Range filter for update date.
38
+ */
12
39
  updated_at__range?: string;
40
+ /**
41
+ * Filter for file IDs.
42
+ */
13
43
  id__in?: string;
44
+ /**
45
+ * Filter for file types.
46
+ */
14
47
  type?: File['type'] | File['type'][];
48
+ /**
49
+ * Filter for content types.
50
+ */
15
51
  content_type?: File['content_type'] | File['content_type'][];
16
52
  };
53
+ /**
54
+ * Payload for getting recent files.
55
+ */
17
56
  export type GetRecentFilesPayload = {
57
+ /**
58
+ * Number of recent files to retrieve.
59
+ */
18
60
  size?: number;
19
61
  };
62
+ /**
63
+ * Payload for sending a notification.
64
+ */
20
65
  export interface NotificationPayload {
66
+ /**
67
+ * Content of the notification.
68
+ */
21
69
  content: string;
70
+ /**
71
+ * Type of the notification.
72
+ */
22
73
  type?: 'native' | 'alert';
23
74
  }
75
+ /**
76
+ * Payload for executing a query.
77
+ */
24
78
  export interface QueryPayload {
79
+ /**
80
+ * The query string to execute.
81
+ */
25
82
  query: string;
83
+ /**
84
+ * Optional arguments for the query.
85
+ */
26
86
  args?: string[][];
27
87
  }
88
+ /**
89
+ * Payload for submitting user feedback.
90
+ */
28
91
  export interface SubmitUserFeedbackPayload {
92
+ /**
93
+ * Type of feedback being submitted.
94
+ */
29
95
  type: 'bug' | 'feedback';
96
+ /**
97
+ * Data associated with the feedback.
98
+ */
30
99
  data: Record<string, any>;
31
100
  }
101
+ /**
102
+ * Payload object for opening a file.
103
+ */
32
104
  export interface OpenRequestPayload {
105
+ /**
106
+ * Id of the file to open.
107
+ */
33
108
  fileId?: File['id'];
34
- fromCanvasId?: Canvas['id'];
109
+ /**
110
+ * Id of the canvas from which the file is opened.
111
+ */
112
+ fromCanvasId?: CanvasRetrieve['id'];
113
+ /**
114
+ * Optional, page index to open. Default is `null`.
115
+ */
35
116
  pageIndex?: MiniPage['page_index'];
117
+ /**
118
+ * URL of the file content.
119
+ */
36
120
  url?: File['content_url'];
121
+ /**
122
+ * Indicates if the canvas is in view.
123
+ */
37
124
  canvasInView?: boolean;
125
+ /**
126
+ * Indicates if the user is in a call.
127
+ */
38
128
  isInCall?: boolean;
129
+ /**
130
+ * Optional, overrides over the context of the current canvas, useful for injecting file annotation data. Default is {}.
131
+ */
39
132
  context?: Record<string, any>;
133
+ /**
134
+ * Search query string within the file.
135
+ */
40
136
  search?: string;
137
+ /**
138
+ * Indicates if the file should be opened in a new tab.
139
+ */
41
140
  newTab?: boolean;
42
141
  }
142
+ /**
143
+ * Payload object for opening an external URL.
144
+ */
43
145
  export interface OpenExternalUrlRequestPayload {
146
+ /**
147
+ * The URL to open.
148
+ */
44
149
  url: string;
150
+ /**
151
+ * The target where the URL should be opened. Defaults to '_blank'.
152
+ */
45
153
  target?: '_self' | '_blank';
154
+ /**
155
+ * Additional options for opening the URL.
156
+ */
46
157
  options?: string;
47
158
  }
159
+ /**
160
+ * Payload object for opening a web view that is always on top.
161
+ */
48
162
  export interface OpenWebViewAlwaysOnTop {
163
+ /**
164
+ * The URL to open in the web view.
165
+ */
49
166
  url: string;
167
+ /**
168
+ * Settings for the modal window.
169
+ */
50
170
  modal_settings: {
171
+ /**
172
+ * The width of the modal window.
173
+ */
51
174
  width: number;
175
+ /**
176
+ * The height of the modal window.
177
+ */
52
178
  height: number;
179
+ /**
180
+ * The y-coordinate of the modal window.
181
+ */
53
182
  y: number;
183
+ /**
184
+ * The x-coordinate of the modal window.
185
+ */
54
186
  x: number;
55
187
  };
56
188
  }
@@ -969,9 +969,11 @@ export declare const lightThemeOverrides: import('vue').ComputedRef<{
969
969
  fontSizeLarge: string;
970
970
  borderColor: string;
971
971
  tdColorHover: string;
972
+ tdColorSorting: string;
972
973
  tdColorStriped: string;
973
974
  thColor: string;
974
975
  thColorHover: string;
976
+ thColorSorting: string;
975
977
  tdColor: string;
976
978
  tdTextColor: string;
977
979
  thTextColor: string;
@@ -981,15 +983,19 @@ export declare const lightThemeOverrides: import('vue').ComputedRef<{
981
983
  thIconColorActive: string;
982
984
  borderColorModal: string;
983
985
  tdColorHoverModal: string;
986
+ tdColorSortingModal: string;
984
987
  tdColorStripedModal: string;
985
988
  thColorModal: string;
986
989
  thColorHoverModal: string;
990
+ thColorSortingModal: string;
987
991
  tdColorModal: string;
988
992
  borderColorPopover: string;
989
993
  tdColorHoverPopover: string;
994
+ tdColorSortingPopover: string;
990
995
  tdColorStripedPopover: string;
991
996
  thColorPopover: string;
992
997
  thColorHoverPopover: string;
998
+ thColorSortingPopover: string;
993
999
  tdColorPopover: string;
994
1000
  boxShadowBefore: string;
995
1001
  boxShadowAfter: string;
@@ -1019,9 +1025,11 @@ export declare const lightThemeOverrides: import('vue').ComputedRef<{
1019
1025
  fontSizeLarge: string;
1020
1026
  borderColor: string;
1021
1027
  tdColorHover: string;
1028
+ tdColorSorting: string;
1022
1029
  tdColorStriped: string;
1023
1030
  thColor: string;
1024
1031
  thColorHover: string;
1032
+ thColorSorting: string;
1025
1033
  tdColor: string;
1026
1034
  tdTextColor: string;
1027
1035
  thTextColor: string;
@@ -1031,15 +1039,19 @@ export declare const lightThemeOverrides: import('vue').ComputedRef<{
1031
1039
  thIconColorActive: string;
1032
1040
  borderColorModal: string;
1033
1041
  tdColorHoverModal: string;
1042
+ tdColorSortingModal: string;
1034
1043
  tdColorStripedModal: string;
1035
1044
  thColorModal: string;
1036
1045
  thColorHoverModal: string;
1046
+ thColorSortingModal: string;
1037
1047
  tdColorModal: string;
1038
1048
  borderColorPopover: string;
1039
1049
  tdColorHoverPopover: string;
1050
+ tdColorSortingPopover: string;
1040
1051
  tdColorStripedPopover: string;
1041
1052
  thColorPopover: string;
1042
1053
  thColorHoverPopover: string;
1054
+ thColorSortingPopover: string;
1043
1055
  tdColorPopover: string;
1044
1056
  boxShadowBefore: string;
1045
1057
  boxShadowAfter: string;
@@ -23,6 +23,16 @@ export type ModuleSettings = {
23
23
  export type EmbeddedLocationProperties = {
24
24
  start_in_loading_mode?: boolean;
25
25
  };
26
+ export type EmbeddedAppShortcut = {
27
+ id: string;
28
+ order_override?: number;
29
+ icon?: string;
30
+ };
31
+ export type EmbeddedAppShortcutsDict = {
32
+ fullscreen: EmbeddedAppShortcut[];
33
+ presentation: EmbeddedAppShortcut[];
34
+ edit: EmbeddedAppShortcut[];
35
+ };
26
36
  export type Module = {
27
37
  enabled: boolean;
28
38
  headless?: boolean;
@@ -36,6 +46,7 @@ export type Module = {
36
46
  };
37
47
  settings?: Record<string, unknown>;
38
48
  };
49
+ shortcuts: EmbeddedAppShortcutsDict;
39
50
  } & EmbeddedLocationProperties;
40
51
  export type AppJson = {
41
52
  name: string;
@@ -1,6 +1,6 @@
1
1
  import { RouteLocation } from 'vue-router';
2
2
  import { SfEventExtended, SfAccountMini, SfAccount, SfUser, SfContactBasic } from './sfdc';
3
- import { Canvas } from '../../types/openapi';
3
+ import { CanvasRetrieve } from '../../types/openapi';
4
4
 
5
5
  export declare const CALL_STORAGE_KEY = "call";
6
6
  export interface EventDate {
@@ -31,7 +31,7 @@ export interface Call {
31
31
  selectedContacts: SfContactBasic[];
32
32
  selectedUsers: SfUser[];
33
33
  accountPreselected: boolean;
34
- selectedCanvas: Canvas | null;
34
+ selectedCanvas: CanvasRetrieve | null;
35
35
  callState: CallState;
36
36
  callStoppedAt: RouteLocation | null;
37
37
  eventDate: EventDate;
@@ -1,12 +1,38 @@
1
- import { FileCreateRequest } from '../../types/openapi';
1
+ import { Favorite, FileCreateRequest } from '../../types/openapi';
2
+ import { RecentFile } from './recentFiles.types';
3
+ import { CompactFile, CompactFolder } from '@browser/stores/api';
2
4
 
3
5
  export interface DeviceFileCreateRequest extends Omit<FileCreateRequest, 'content'> {
4
6
  path: string;
5
7
  }
6
8
  export type AllFileCreateRequest = FileCreateRequest | DeviceFileCreateRequest;
9
+ export declare enum ViewCompactItemType {
10
+ File = "file",
11
+ Folder = "folder"
12
+ }
13
+ export type ViewCompactFile = Omit<CompactFile, 'created_by'> & {
14
+ type: ViewCompactItemType.File;
15
+ favoriteId?: Favorite['id'];
16
+ createdBy: string;
17
+ content_type?: string;
18
+ };
19
+ export type ViewCompactFolder = Omit<CompactFolder, 'created_by'> & {
20
+ type: ViewCompactItemType.Folder;
21
+ favoriteId?: Favorite['id'];
22
+ content_type?: null;
23
+ thubmnail_url?: null;
24
+ file_thumbnail_urls?: string[];
25
+ folders_count?: number;
26
+ files_count?: number;
27
+ };
7
28
  export interface DeviceFile {
8
29
  name: string;
9
30
  type: string;
10
31
  path: string;
11
32
  size: number;
12
33
  }
34
+ export type ViewCompactFileFolder = ViewCompactFolder | ViewCompactFile;
35
+ export type RenderableFile = (Favorite & {
36
+ thumbnail_url?: string;
37
+ file_thumbnail_urls?: string[];
38
+ }) | RecentFile | ViewCompactFileFolder;
@@ -0,0 +1,5 @@
1
+ import { MetadataTemplateField } from '../../types/openapi';
2
+
3
+ export type MetadataTemplateFieldWithComponentName = MetadataTemplateField & {
4
+ componentName: string;
5
+ };
@@ -1,4 +1,5 @@
1
1
  import { ComponentTypes } from '../apps/canvas-builder/types/canvas';
2
+ import { OrganizationSettings } from './organizationSettings.types';
2
3
 
3
4
  export declare enum CanvasExcludedComponentTypesEnum {
4
5
  Root = "Root",
@@ -11,13 +12,18 @@ export type CanvasComponentTypes = Exclude<keyof typeof ComponentTypes, CanvasEx
11
12
  export type CanvasComponentAvailability = {
12
13
  [component in CanvasComponentTypes]: boolean;
13
14
  };
14
- export type InstanceSettings = {
15
- impact_show_only_saved_canvases_in_canvas_manager?: boolean;
15
+ export type AutohideSectionOnCreated = {
16
+ autohide_in_shared_link?: string;
17
+ start_date?: Date;
18
+ };
19
+ export type InstanceSettings = OrganizationSettings & {
16
20
  canvas?: {
21
+ autohide_section_on_created?: AutohideSectionOnCreated;
17
22
  component_availability?: CanvasComponentAvailability & {
18
23
  apps?: Record<string, boolean>;
19
24
  };
20
25
  content_grid_autofill_files_filter_iteratee?: string;
21
26
  section_content_grid_autofill_files_filter_iteratee?: string;
27
+ show_extra_exit_button_in_fullscreen_mode?: boolean;
22
28
  };
23
29
  };
@@ -1,11 +1,9 @@
1
- import { TranslationOverrides } from './translations';
2
-
3
- export type LaunchDarklyBooleanFlagKey = 'allow_ai_prompts_in_canvas_text' | 'allow_bulk_actions_canvases_files' | 'allow_canvas_duplication' | 'allow_canvas_history' | 'allow_canvas_ownership_change' | 'allow_content_grid_autofill' | 'allow_creating_canvas_with_no_template' | 'allow_embeddable_hiding' | 'allow_note_taking' | 'allow_rep_canvas_metadata_edit' | 'allow_rep_file_upload' | 'are_sections_system_controlled' | 'copy_context_to_canvas' | 'copy_template_metadata_to_canvas' | 'disable_canvas_edit_for_reps' | 'disable_file_edit_content' | 'disable_fullscreen_canvas_builder' | 'disable_impact_web_browser_fullscreen' | 'display_section_list_name' | 'enable_analytics' | 'enable_canvas_node_debugging' | 'enable_experimental_canvas_builder_dnd' | 'enable_knock_notifications' | 'hide_asset_uploader' | 'interpolate_rep_canvases_on_edit_mode' | 'is_fe_sentry_enabled' | 'is_meeting_bar_account_selection_disabled' | 'is_meeting_bar_hidden' | 'is_rep_canvas_creation_disabled' | 'is_shared_link_creation_disabled' | 'is_timeline_component_allowed' | 'launch_in_full_screen_on_present_mode' | 'launch_in_present_mode_on_creation' | 'reorder_component_in_drawer' | 'show_asset_manager_for_multimedia' | 'show_popularity_icons' | 'show_system_filters' | 'prefer_online_handlers' | 'use_short_url_for_shared_link';
1
+ export type LaunchDarklyBooleanFlagKey = 'allow_ai_prompts_in_canvas_text' | 'allow_bulk_actions_canvases_files' | 'allow_canvas_duplication' | 'allow_canvas_history' | 'allow_canvas_ownership_change' | 'allow_content_grid_autofill' | 'allow_creating_canvas_with_no_template' | 'allow_embeddable_hiding' | 'allow_note_taking' | 'allow_rep_canvas_metadata_edit' | 'allow_rep_file_upload' | 'are_sections_system_controlled' | 'copy_context_to_canvas' | 'copy_template_metadata_to_canvas' | 'disable_canvas_edit_for_reps' | 'disable_file_edit_content' | 'disable_fullscreen_canvas_builder' | 'disable_impact_web_browser_fullscreen' | 'display_section_list_name' | 'enable_analytics' | 'enable_canvas_node_debugging' | 'enable_experimental_canvas_builder_dnd' | 'enable_knock_notifications' | 'hide_asset_uploader' | 'interpolate_rep_canvases_on_edit_mode' | 'is_fe_sentry_enabled' | 'is_meeting_bar_account_selection_disabled' | 'is_meeting_bar_hidden' | 'is_rep_canvas_creation_disabled' | 'is_shared_link_creation_disabled' | 'is_timeline_component_allowed' | 'launch_in_full_screen_on_present_mode' | 'launch_in_present_mode_on_creation' | 'reorder_component_in_drawer' | 'show_asset_manager_for_multimedia' | 'show_content_selector_list_view' | 'show_popularity_icons' | 'show_system_filters' | 'allow_canvases_tables_columns_settings' | 'prefer_online_handlers' | 'use_short_url_for_shared_link' | 'enable_suggested_tags' | 'enable_folder_details_edit' | 'enable_file_revisions';
2
+ export type LaunchDarklyNumberFlagKey = 'canvas_section_selector_page_size' | 'canvas_section_selector_selected_items_with_thumbnail_size';
4
3
  type LaunchDarklyObjectFlags = {
5
4
  canvas_table_pagination: CanvasTablePagination;
6
5
  canvas_manager_table_columns: CanvasManagerTableColumns;
7
6
  context_crm_shape: Record<string, any>;
8
- translation_overrides: TranslationOverrides;
9
7
  };
10
8
  export type LaunchDarklyObjectFlagKey = keyof LaunchDarklyObjectFlags;
11
9
  export type LaunchDarklyStringFlagKey = keyof typeof LaunchDarklyStringFlags;
@@ -32,6 +30,8 @@ export type LaunchDarklyEnv = {
32
30
  [K in LaunchDarklyBooleanFlagKey]?: boolean;
33
31
  } & {
34
32
  [K in LaunchDarklyStringFlagKey]?: LaunchDarklyStringFlagValue<K>;
33
+ } & {
34
+ [K in LaunchDarklyNumberFlagKey]?: number;
35
35
  } & {
36
36
  [K in keyof LaunchDarklyObjectFlags]?: LaunchDarklyObjectFlags[K];
37
37
  } & {
@@ -1,3 +1,7 @@
1
+ import { TranslationOverrides } from './translations';
2
+
1
3
  export type OrganizationSettings = {
2
4
  impact_show_only_saved_canvases_in_canvas_manager?: boolean;
5
+ translation_overrides?: TranslationOverrides;
6
+ file_annotations?: 'admin' | 'personal';
3
7
  };
@@ -1,4 +1,7 @@
1
1
  import { Instance, File } from '../../types/openapi';
2
2
 
3
- export type RecentFile = Pick<File, 'id' | 'name' | 'content_type' | 'thumbnail_url' | 'instance_id'>;
3
+ export type RecentFile = Pick<File, 'id' | 'name' | 'content_type' | 'instance_id'> & {
4
+ tags?: Readonly<File['tags']>;
5
+ thumbnail_url?: string | null;
6
+ };
4
7
  export type InstanceRecentFilesMap = Record<Instance['id'], RecentFile[]>;
@@ -1,12 +1,25 @@
1
1
  import { Ref } from 'vue';
2
2
 
3
+ /**
4
+ * Parameters for getting users
5
+ */
3
6
  export interface GetUsersParams {
7
+ /** Search term, can be a string or a Vue ref to a string */
4
8
  search?: Ref<string> | string;
9
+ /** Filters for the user query, can be any type of Vue ref */
5
10
  filters?: Ref<any>;
6
11
  }
12
+ /**
13
+ * Request parameters for refreshing a service token
14
+ */
7
15
  export interface RefreshServiceTokenRequest {
16
+ /** Optional provider for the service token */
8
17
  provider?: string;
9
18
  }
19
+ /**
20
+ * Response from refreshing a service token
21
+ */
10
22
  export interface RefreshServiceTokenResponse {
23
+ /** The new access token */
11
24
  access_token: string;
12
25
  }
@@ -11,6 +11,6 @@ export type DocumentWithFullscreen = Document & {
11
11
  msExitFullscreen?: () => Promise<void>;
12
12
  };
13
13
  export declare function requestFullscreen(el?: FullscreenElement | null): Promise<void>;
14
- export declare function exitFullscreen(): void;
14
+ export declare function exitFullscreen(): Promise<void>;
15
15
  export declare function toggleFullscreen(element: FullscreenElement): void;
16
16
  export declare function isFullscreen(): boolean;
@@ -1,4 +1,5 @@
1
1
  export declare function highlight(input: string, search: string): string;
2
2
  export declare function prefixHttps(url: string): string;
3
3
  export declare function stripHtmlTags(htmlString: string | undefined): string;
4
+ export declare function stripHtmlPreservingLineBreaks(htmlString: string | undefined): string;
4
5
  export declare function stripHtmlTagsAndTrim(htmlString: string | undefined): string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pitcher/js-api",
3
- "version": "1.21.0-beta.8",
3
+ "version": "1.21.0",
4
4
  "type": "module",
5
5
  "main": "js-api.umd.min.js",
6
6
  "module": "js-api.esm.js",
@@ -8,10 +8,8 @@ export type { AppOrganizationRequest } from './models/AppOrganizationRequest';
8
8
  export type { AppPublish } from './models/AppPublish';
9
9
  export type { AppRelease } from './models/AppRelease';
10
10
  export type { AppRequest } from './models/AppRequest';
11
- export type { AppsDBGlobalEntry } from './models/AppsDBGlobalEntry';
12
- export type { AppsDBGlobalEntryRequest } from './models/AppsDBGlobalEntryRequest';
13
- export type { AppsDBUserEntry } from './models/AppsDBUserEntry';
14
- export type { AppsDBUserEntryRequest } from './models/AppsDBUserEntryRequest';
11
+ export type { AppsDBEntry } from './models/AppsDBEntry';
12
+ export type { AppsDBEntryRequest } from './models/AppsDBEntryRequest';
15
13
  export { AppTypeEnum } from './models/AppTypeEnum';
16
14
  export type { AuthToken } from './models/AuthToken';
17
15
  export type { AuthTokenRequest } from './models/AuthTokenRequest';
@@ -29,13 +27,10 @@ export type { BulkUpdateTagsResult } from './models/BulkUpdateTagsResult';
29
27
  export type { Canvas } from './models/Canvas';
30
28
  export type { CanvasCreate } from './models/CanvasCreate';
31
29
  export type { CanvasCreateRequest } from './models/CanvasCreateRequest';
32
- export type { CanvasList } from './models/CanvasList';
33
30
  export type { CanvasRecommendedFile } from './models/CanvasRecommendedFile';
34
31
  export type { CanvasRecommendedFiles } from './models/CanvasRecommendedFiles';
35
32
  export type { CanvasRetrieve } from './models/CanvasRetrieve';
36
33
  export type { CanvasSection } from './models/CanvasSection';
37
- export type { CanvasSectionRetrieve } from './models/CanvasSectionRetrieve';
38
- export type { CanvasSectionRetrieveRequest } from './models/CanvasSectionRetrieveRequest';
39
34
  export type { CanvasUpdate } from './models/CanvasUpdate';
40
35
  export type { CanvasUpdateRequest } from './models/CanvasUpdateRequest';
41
36
  export type { Collaboration } from './models/Collaboration';
@@ -53,6 +48,7 @@ export type { ContentDistributionGroupMembershipCreateRequest } from './models/C
53
48
  export type { ContentDistributionGroupRequest } from './models/ContentDistributionGroupRequest';
54
49
  export { DefaultExpiresAtEnum } from './models/DefaultExpiresAtEnum';
55
50
  export type { DeletedApp } from './models/DeletedApp';
51
+ export type { DeletedCanvas } from './models/DeletedCanvas';
56
52
  export type { DeletedContentDistributionGroup } from './models/DeletedContentDistributionGroup';
57
53
  export type { DeletedEnvironment } from './models/DeletedEnvironment';
58
54
  export type { DeletedFavorite } from './models/DeletedFavorite';
@@ -86,18 +82,25 @@ export type { FileAnalyticsResult } from './models/FileAnalyticsResult';
86
82
  export { FileContentTypeEnum } from './models/FileContentTypeEnum';
87
83
  export type { FileCreate } from './models/FileCreate';
88
84
  export type { FileCreateRequest } from './models/FileCreateRequest';
89
- export type { FileRequest } from './models/FileRequest';
85
+ export type { FilePermission } from './models/FilePermission';
86
+ export type { FilePermissionRequest } from './models/FilePermissionRequest';
90
87
  export type { FileRetrieve } from './models/FileRetrieve';
88
+ export type { FileRevision } from './models/FileRevision';
89
+ export type { FileRevisionRequest } from './models/FileRevisionRequest';
91
90
  export { FileStatusEnum } from './models/FileStatusEnum';
92
91
  export { FileTypeEnum } from './models/FileTypeEnum';
93
92
  export type { FileUpdate } from './models/FileUpdate';
94
93
  export type { FileUpdateRequest } from './models/FileUpdateRequest';
94
+ export type { FileVersion } from './models/FileVersion';
95
95
  export type { Folder } from './models/Folder';
96
+ export type { FolderCanvas } from './models/FolderCanvas';
96
97
  export type { FolderCreate } from './models/FolderCreate';
97
98
  export type { FolderCreateRequest } from './models/FolderCreateRequest';
98
99
  export type { FolderFile } from './models/FolderFile';
99
100
  export type { FolderFolder } from './models/FolderFolder';
100
101
  export type { FolderRetrieve } from './models/FolderRetrieve';
102
+ export type { FolderRule } from './models/FolderRule';
103
+ export type { FolderRuleRequest } from './models/FolderRuleRequest';
101
104
  export type { FolderUpdate } from './models/FolderUpdate';
102
105
  export type { FolderUpdateRequest } from './models/FolderUpdateRequest';
103
106
  export type { Instance } from './models/Instance';
@@ -126,7 +129,6 @@ export type { InstanceMembershipUser } from './models/InstanceMembershipUser';
126
129
  export type { InstanceMembershipUserRequest } from './models/InstanceMembershipUserRequest';
127
130
  export { InstanceMembershipUserStatusEnum } from './models/InstanceMembershipUserStatusEnum';
128
131
  export type { InstanceRequest } from './models/InstanceRequest';
129
- export type { InstanceStorageCredentials } from './models/InstanceStorageCredentials';
130
132
  export type { InstanceUpdate } from './models/InstanceUpdate';
131
133
  export type { InstanceUpdateRequest } from './models/InstanceUpdateRequest';
132
134
  export type { Invitation } from './models/Invitation';
@@ -142,7 +144,6 @@ export type { MetadataTemplateOptionRequest } from './models/MetadataTemplateOpt
142
144
  export type { MetadataTemplateRequest } from './models/MetadataTemplateRequest';
143
145
  export type { MetadataTemplateSection } from './models/MetadataTemplateSection';
144
146
  export type { MetadataTemplateSectionRequest } from './models/MetadataTemplateSectionRequest';
145
- export type { MiniAccount } from './models/MiniAccount';
146
147
  export type { MiniCanvas } from './models/MiniCanvas';
147
148
  export type { MiniCanvasRequest } from './models/MiniCanvasRequest';
148
149
  export type { MiniContentDistributionGroup } from './models/MiniContentDistributionGroup';
@@ -166,6 +167,8 @@ export type { MiniSharedLinkRequest } from './models/MiniSharedLinkRequest';
166
167
  export type { MiniUser } from './models/MiniUser';
167
168
  export type { MiniUserRequest } from './models/MiniUserRequest';
168
169
  export type { MostActiveUser } from './models/MostActiveUser';
170
+ export type { OfflineSyncFolder } from './models/OfflineSyncFolder';
171
+ export { OperatorEnum } from './models/OperatorEnum';
169
172
  export type { Organization } from './models/Organization';
170
173
  export type { OrganizationAnalytics } from './models/OrganizationAnalytics';
171
174
  export type { OrganizationAnalyticsCurrentPeriod } from './models/OrganizationAnalyticsCurrentPeriod';
@@ -182,7 +185,7 @@ export type { OrganizationUpdateRequest } from './models/OrganizationUpdateReque
182
185
  export type { PaginatedAppList } from './models/PaginatedAppList';
183
186
  export type { PaginatedAppReleaseList } from './models/PaginatedAppReleaseList';
184
187
  export type { PaginatedAuthTokenList } from './models/PaginatedAuthTokenList';
185
- export type { PaginatedCanvasListList } from './models/PaginatedCanvasListList';
188
+ export type { PaginatedCanvasList } from './models/PaginatedCanvasList';
186
189
  export type { PaginatedCollaborationList } from './models/PaginatedCollaborationList';
187
190
  export type { PaginatedContentDistributionGroupList } from './models/PaginatedContentDistributionGroupList';
188
191
  export type { PaginatedContentDistributionGroupMembershipList } from './models/PaginatedContentDistributionGroupMembershipList';
@@ -190,6 +193,7 @@ export type { PaginatedEnvironmentList } from './models/PaginatedEnvironmentList
190
193
  export type { PaginatedEventList } from './models/PaginatedEventList';
191
194
  export type { PaginatedFavoriteList } from './models/PaginatedFavoriteList';
192
195
  export type { PaginatedFileList } from './models/PaginatedFileList';
196
+ export type { PaginatedFileRevisionList } from './models/PaginatedFileRevisionList';
193
197
  export type { PaginatedFolderList } from './models/PaginatedFolderList';
194
198
  export type { PaginatedInstanceAssignmentGroupList } from './models/PaginatedInstanceAssignmentGroupList';
195
199
  export type { PaginatedInstanceAssignmentGroupMembershipList } from './models/PaginatedInstanceAssignmentGroupMembershipList';
@@ -197,6 +201,7 @@ export type { PaginatedInstanceList } from './models/PaginatedInstanceList';
197
201
  export type { PaginatedInstanceMembershipList } from './models/PaginatedInstanceMembershipList';
198
202
  export type { PaginatedInvitationList } from './models/PaginatedInvitationList';
199
203
  export type { PaginatedMetadataTemplateList } from './models/PaginatedMetadataTemplateList';
204
+ export type { PaginatedOfflineSyncFolderList } from './models/PaginatedOfflineSyncFolderList';
200
205
  export type { PaginatedRegionList } from './models/PaginatedRegionList';
201
206
  export type { PaginatedRevisionList } from './models/PaginatedRevisionList';
202
207
  export type { PaginatedSearchResultList } from './models/PaginatedSearchResultList';
@@ -210,6 +215,7 @@ export type { PatchedEnvironmentRequest } from './models/PatchedEnvironmentReque
210
215
  export type { PatchedEventRequest } from './models/PatchedEventRequest';
211
216
  export type { PatchedFavoriteUpdateRequest } from './models/PatchedFavoriteUpdateRequest';
212
217
  export type { PatchedFileRequest } from './models/PatchedFileRequest';
218
+ export type { PatchedFileRevisionRequest } from './models/PatchedFileRevisionRequest';
213
219
  export type { PatchedFileUpdateRequest } from './models/PatchedFileUpdateRequest';
214
220
  export type { PatchedFolderUpdateRequest } from './models/PatchedFolderUpdateRequest';
215
221
  export type { PatchedInstanceAssignmentGroupRequest } from './models/PatchedInstanceAssignmentGroupRequest';
@@ -219,10 +225,6 @@ export type { PatchedMetadataTemplateRequest } from './models/PatchedMetadataTem
219
225
  export type { PatchedOrganizationUpdateRequest } from './models/PatchedOrganizationUpdateRequest';
220
226
  export type { PatchedRegionRequest } from './models/PatchedRegionRequest';
221
227
  export type { PatchedUserRequest } from './models/PatchedUserRequest';
222
- export type { PSPDFKitAuthPayload } from './models/PSPDFKitAuthPayload';
223
- export type { PSPDFKitAuthPayloadRequest } from './models/PSPDFKitAuthPayloadRequest';
224
- export type { PSPDFKitToken } from './models/PSPDFKitToken';
225
- export type { PSPDFKitTokenRequest } from './models/PSPDFKitTokenRequest';
226
228
  export type { Region } from './models/Region';
227
229
  export type { RegionRequest } from './models/RegionRequest';
228
230
  export type { Revision } from './models/Revision';
@@ -235,10 +237,14 @@ export type { SearchInstanceAssignmentGroup } from './models/SearchInstanceAssig
235
237
  export type { SearchResult } from './models/SearchResult';
236
238
  export type { SearchUser } from './models/SearchUser';
237
239
  export type { SharedLink } from './models/SharedLink';
240
+ export type { SharedLinkCanvas } from './models/SharedLinkCanvas';
241
+ export type { SharedLinkCanvasRequest } from './models/SharedLinkCanvasRequest';
238
242
  export type { SharedLinkCreate } from './models/SharedLinkCreate';
239
243
  export type { SharedLinkCreateRequest } from './models/SharedLinkCreateRequest';
240
- export type { SharedLinkInstanceSerialzier } from './models/SharedLinkInstanceSerialzier';
241
- export type { SharedLinkOrganizationSerialzier } from './models/SharedLinkOrganizationSerialzier';
244
+ export type { SharedLinkInstance } from './models/SharedLinkInstance';
245
+ export type { SharedLinkInstanceRequest } from './models/SharedLinkInstanceRequest';
246
+ export type { SharedLinkOrganization } from './models/SharedLinkOrganization';
247
+ export type { SharedLinkOrganizationRequest } from './models/SharedLinkOrganizationRequest';
242
248
  export type { StorageRegion } from './models/StorageRegion';
243
249
  export { StorageRegionEnum } from './models/StorageRegionEnum';
244
250
  export type { Tag } from './models/Tag';
@@ -1,8 +1,10 @@
1
1
  /**
2
2
  * * `public` - Public
3
3
  * * `restricted` - Restricted
4
+ * * `personal` - Personal
4
5
  */
5
6
  export declare enum AccessTypeEnum {
6
7
  PUBLIC = "public",
7
- RESTRICTED = "restricted"
8
+ RESTRICTED = "restricted",
9
+ PERSONAL = "personal"
8
10
  }
@@ -17,4 +17,5 @@ export type App = {
17
17
  readonly created_by: MiniUser;
18
18
  readonly modified_at: string;
19
19
  readonly modified_by: MiniUser;
20
+ readonly owned_by: MiniUser;
20
21
  };
@@ -6,4 +6,5 @@ export type AppRelease = {
6
6
  readonly created_at: string;
7
7
  readonly modified_at: string;
8
8
  readonly modified_by: MiniUser;
9
+ readonly owned_by: MiniUser;
9
10
  };
@@ -0,0 +1,4 @@
1
+ export type AppsDBEntry = {
2
+ value: string | null;
3
+ readonly modified_at: string;
4
+ };
@@ -0,0 +1,3 @@
1
+ export type AppsDBEntryRequest = {
2
+ value: string | null;
3
+ };