@pitcher/js-api 1.22.0-alpha.5 → 1.22.0-beta.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 (187) hide show
  1. package/js-api.esm.js +693 -184
  2. package/js-api.esm.js.map +1 -1
  3. package/js-api.umd.min.js +10 -10
  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/useCanvasExit.d.ts +3 -0
  12. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +86 -74
  13. package/lib/apps/canvas-builder/composables/useCanvasHooks.d.ts +4 -4
  14. package/lib/apps/canvas-builder/composables/useCanvasPages.d.ts +3 -3
  15. package/lib/apps/canvas-builder/composables/useCanvasSectionOverrides.d.ts +3 -3
  16. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +24 -17
  17. package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts +2 -2
  18. package/lib/apps/canvas-builder/composables/useCollapsibles.d.ts +3 -3
  19. package/lib/apps/canvas-builder/composables/useComponentPermissions.d.ts +2 -2
  20. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +6 -4
  21. package/lib/apps/canvas-builder/composables/useInstalledEmbeddables.d.ts +15 -0
  22. package/lib/apps/canvas-builder/composables/useRecommendations.d.ts +6 -5
  23. package/lib/apps/canvas-builder/composables/useSectionPopularity.d.ts +2 -2
  24. package/lib/apps/canvas-builder/types/canvas.d.ts +19 -18
  25. package/lib/apps/canvas-builder/types/recommendations.types.d.ts +3 -3
  26. package/lib/apps/canvas-builder/util/canvas.util.d.ts +5 -4
  27. package/lib/apps/canvas-selector/appTypes.d.ts +9 -0
  28. package/lib/apps/content-selector/appTypes.d.ts +1 -0
  29. package/lib/apps/content-selector/stores/app.d.ts +8 -1
  30. package/lib/components/CFileViewer/CFileViewer.use.d.ts +2 -4
  31. package/lib/components/CFileViewer/CFileViewerFullScreen.use.d.ts +1 -1
  32. package/lib/components/canvases/CanvasesManagementBulk.use.d.ts +5 -5
  33. package/lib/components/filters/filter.util.d.ts +1 -1
  34. package/lib/components/savedCanvases/CSavedCanvasesManagementShareCanvas.use.d.ts +5 -3
  35. package/lib/composables/instanceTagsActions.use.d.ts +14 -0
  36. package/lib/composables/recentFiles.use.d.ts +1 -1
  37. package/lib/composables/suggestedTags.use.d.ts +3 -0
  38. package/lib/composables/tableColumnsSettings.use.d.ts +25 -0
  39. package/lib/composables/useCanvasOverlay.d.ts +20 -0
  40. package/lib/composables/useCanvasTablesPagination.d.ts +13 -0
  41. package/lib/composables/useConfirmation.d.ts +1 -0
  42. package/lib/composables/useElementHeightResize.d.ts +5 -0
  43. package/lib/composables/useFiles.d.ts +11 -0
  44. package/lib/composables/useWindowEvents.d.ts +1 -1
  45. package/lib/constants/pitcherSettings.const.d.ts +4 -0
  46. package/lib/main.lib.d.ts +31 -21
  47. package/lib/sdk/api/HighLevelApi.d.ts +112 -14
  48. package/lib/sdk/api/modules/admin/canvas.admin.d.ts +53 -15
  49. package/lib/sdk/api/modules/admin/env.admin.d.ts +3 -2
  50. package/lib/sdk/api/modules/admin/files.admin.d.ts +43 -4
  51. package/lib/sdk/api/modules/admin/index.d.ts +53 -5
  52. package/lib/sdk/api/modules/admin/metadataTemplates.admin.d.ts +1 -2
  53. package/lib/sdk/api/modules/admin/types.admin.d.ts +132 -3
  54. package/lib/sdk/api/modules/canvas.d.ts +12 -14
  55. package/lib/sdk/api/modules/dsr/env.dsr.d.ts +4 -3
  56. package/lib/sdk/api/modules/dsr/index.d.ts +14 -3
  57. package/lib/sdk/api/modules/dsr/loading.dsr.d.ts +7 -1
  58. package/lib/sdk/api/modules/env.d.ts +16 -0
  59. package/lib/sdk/api/modules/favorites.d.ts +9 -0
  60. package/lib/sdk/api/modules/feedback.d.ts +3 -0
  61. package/lib/sdk/api/modules/files.d.ts +7 -4
  62. package/lib/sdk/api/modules/folders.d.ts +29 -0
  63. package/lib/sdk/api/modules/open.d.ts +6 -0
  64. package/lib/sdk/api/modules/sync.d.ts +1 -2
  65. package/lib/sdk/api/modules/ui/app-errors.ui.d.ts +13 -1
  66. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +102 -8
  67. package/lib/sdk/api/modules/ui/content.ui.d.ts +52 -2
  68. package/lib/sdk/api/modules/ui/index.d.ts +150 -13
  69. package/lib/sdk/api/modules/ui/loading.ui.d.ts +9 -1
  70. package/lib/sdk/api/modules/ui/location.ui.d.ts +18 -1
  71. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +35 -4
  72. package/lib/sdk/api/modules/ui/types.ui.d.ts +86 -8
  73. package/lib/sdk/api/modules/users.d.ts +6 -1
  74. package/lib/sdk/api/onlineRestApiHandlers.d.ts +4 -0
  75. package/lib/sdk/interfaces.d.ts +124 -3
  76. package/lib/sdk/main.d.ts +297 -151
  77. package/lib/sdk/payload.types.d.ts +134 -2
  78. package/lib/sdk/utils/httpFetch.d.ts +15 -0
  79. package/lib/sdk/utils/object.d.ts +1 -0
  80. package/lib/sdk/utils/object.spec.d.ts +1 -0
  81. package/lib/theme/light.d.ts +12 -0
  82. package/lib/types/app.d.ts +11 -0
  83. package/lib/types/call.d.ts +4 -3
  84. package/lib/types/files.d.ts +27 -1
  85. package/lib/types/filter.d.ts +5 -0
  86. package/lib/types/instance.types.d.ts +18 -0
  87. package/lib/types/{instanceSettings.d.ts → instanceSettings.types.d.ts} +10 -2
  88. package/lib/types/launchDarkly.types.d.ts +4 -4
  89. package/lib/types/organization.types.d.ts +2 -2
  90. package/lib/types/organizationSettings.types.d.ts +4 -0
  91. package/lib/types/recentFiles.types.d.ts +4 -1
  92. package/lib/types/users.d.ts +13 -0
  93. package/lib/util/fullscreen.util.d.ts +1 -1
  94. package/lib/util/string.d.ts +1 -0
  95. package/package.json +1 -1
  96. package/types/openapi/index.d.ts +23 -17
  97. package/types/openapi/models/AccessTypeEnum.d.ts +3 -1
  98. package/types/openapi/models/App.d.ts +1 -0
  99. package/types/openapi/models/AppRelease.d.ts +1 -0
  100. package/types/openapi/models/AppsDBEntry.d.ts +4 -0
  101. package/types/openapi/models/AppsDBEntryRequest.d.ts +3 -0
  102. package/types/openapi/models/Canvas.d.ts +10 -15
  103. package/types/openapi/models/CanvasCreate.d.ts +14 -12
  104. package/types/openapi/models/CanvasCreateRequest.d.ts +6 -5
  105. package/types/openapi/models/CanvasRecommendedFile.d.ts +6 -0
  106. package/types/openapi/models/CanvasRetrieve.d.ts +15 -13
  107. package/types/openapi/models/CanvasSection.d.ts +5 -2
  108. package/types/openapi/models/CanvasUpdate.d.ts +14 -12
  109. package/types/openapi/models/CanvasUpdateRequest.d.ts +5 -4
  110. package/types/openapi/models/CollaborationRoleEnum.d.ts +0 -4
  111. package/types/openapi/models/ContentDistributionGroupCreate.d.ts +1 -0
  112. package/types/openapi/models/DeletedApp.d.ts +1 -0
  113. package/types/openapi/models/{CanvasList.d.ts → DeletedCanvas.d.ts} +13 -9
  114. package/types/openapi/models/DeletedContentDistributionGroup.d.ts +1 -0
  115. package/types/openapi/models/DeletedEnvironment.d.ts +1 -0
  116. package/types/openapi/models/DeletedFavorite.d.ts +1 -0
  117. package/types/openapi/models/DeletedFile.d.ts +6 -0
  118. package/types/openapi/models/DeletedFolder.d.ts +4 -3
  119. package/types/openapi/models/DeletedInstance.d.ts +1 -0
  120. package/types/openapi/models/DeletedInstanceAssignmentGroup.d.ts +1 -0
  121. package/types/openapi/models/DeletedMetadataTemplate.d.ts +1 -0
  122. package/types/openapi/models/DeletedRegion.d.ts +1 -0
  123. package/types/openapi/models/Environment.d.ts +1 -0
  124. package/types/openapi/models/Favorite.d.ts +1 -0
  125. package/types/openapi/models/File.d.ts +6 -0
  126. package/types/openapi/models/FileCreate.d.ts +8 -0
  127. package/types/openapi/models/FileCreateRequest.d.ts +3 -0
  128. package/types/openapi/models/FilePermission.d.ts +4 -0
  129. package/types/openapi/models/FilePermissionRequest.d.ts +4 -0
  130. package/types/openapi/models/FileRetrieve.d.ts +8 -0
  131. package/types/openapi/models/FileRevision.d.ts +8 -0
  132. package/types/openapi/models/FileRevisionRequest.d.ts +3 -0
  133. package/types/openapi/models/FileUpdate.d.ts +8 -0
  134. package/types/openapi/models/FileUpdateRequest.d.ts +3 -0
  135. package/types/openapi/models/FileVersion.d.ts +5 -0
  136. package/types/openapi/models/Folder.d.ts +4 -3
  137. package/types/openapi/models/FolderCanvas.d.ts +11 -0
  138. package/types/openapi/models/FolderCreate.d.ts +8 -7
  139. package/types/openapi/models/FolderCreateRequest.d.ts +4 -2
  140. package/types/openapi/models/FolderFile.d.ts +3 -0
  141. package/types/openapi/models/FolderFolder.d.ts +5 -1
  142. package/types/openapi/models/FolderRetrieve.d.ts +8 -8
  143. package/types/openapi/models/FolderRule.d.ts +7 -0
  144. package/types/openapi/models/FolderRuleRequest.d.ts +7 -0
  145. package/types/openapi/models/FolderUpdate.d.ts +8 -8
  146. package/types/openapi/models/FolderUpdateRequest.d.ts +3 -0
  147. package/types/openapi/models/Instance.d.ts +1 -0
  148. package/types/openapi/models/InstanceUpdate.d.ts +1 -0
  149. package/types/openapi/models/MetadataTemplate.d.ts +1 -0
  150. package/types/openapi/models/OfflineSyncFolder.d.ts +17 -0
  151. package/types/openapi/models/OperatorEnum.d.ts +64 -0
  152. package/types/openapi/models/PaginatedCanvasList.d.ts +8 -0
  153. package/types/openapi/models/PaginatedFileRevisionList.d.ts +8 -0
  154. package/types/openapi/models/PaginatedOfflineSyncFolderList.d.ts +8 -0
  155. package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +5 -4
  156. package/types/openapi/models/PatchedFileRequest.d.ts +3 -0
  157. package/types/openapi/models/PatchedFileRevisionRequest.d.ts +3 -0
  158. package/types/openapi/models/PatchedFileUpdateRequest.d.ts +3 -0
  159. package/types/openapi/models/PatchedFolderUpdateRequest.d.ts +3 -0
  160. package/types/openapi/models/Region.d.ts +1 -0
  161. package/types/openapi/models/SearchFile.d.ts +3 -0
  162. package/types/openapi/models/SharedLink.d.ts +6 -5
  163. package/types/openapi/models/SharedLinkCanvas.d.ts +11 -0
  164. package/types/openapi/models/SharedLinkCanvasRequest.d.ts +8 -0
  165. package/types/openapi/models/SharedLinkCreate.d.ts +6 -5
  166. package/types/openapi/models/{SharedLinkInstanceSerialzier.d.ts → SharedLinkInstance.d.ts} +1 -1
  167. package/types/openapi/models/SharedLinkInstanceRequest.d.ts +5 -0
  168. package/types/openapi/models/{SharedLinkOrganizationSerialzier.d.ts → SharedLinkOrganization.d.ts} +1 -1
  169. package/types/openapi/models/SharedLinkOrganizationRequest.d.ts +6 -0
  170. package/lib/apps/canvas-builder/util/tsUtils.d.ts +0 -3
  171. package/lib/composables/useDetailsView.d.ts +0 -19
  172. package/lib/types/templateActions.d.ts +0 -10
  173. package/lib/util/gesture.util.d.ts +0 -6
  174. package/types/openapi/models/AppsDBGlobalEntry.d.ts +0 -8
  175. package/types/openapi/models/AppsDBGlobalEntryRequest.d.ts +0 -3
  176. package/types/openapi/models/AppsDBUserEntry.d.ts +0 -9
  177. package/types/openapi/models/AppsDBUserEntryRequest.d.ts +0 -3
  178. package/types/openapi/models/CanvasSectionRetrieve.d.ts +0 -7
  179. package/types/openapi/models/CanvasSectionRetrieveRequest.d.ts +0 -5
  180. package/types/openapi/models/FileRequest.d.ts +0 -13
  181. package/types/openapi/models/InstanceStorageCredentials.d.ts +0 -6
  182. package/types/openapi/models/MiniAccount.d.ts +0 -4
  183. package/types/openapi/models/PSPDFKitAuthPayload.d.ts +0 -3
  184. package/types/openapi/models/PSPDFKitAuthPayloadRequest.d.ts +0 -3
  185. package/types/openapi/models/PSPDFKitToken.d.ts +0 -7
  186. package/types/openapi/models/PSPDFKitTokenRequest.d.ts +0 -3
  187. package/types/openapi/models/PaginatedCanvasListList.d.ts +0 -8
@@ -0,0 +1,3 @@
1
+ export default function useCanvasExit(): {
2
+ onExitClick: () => void;
3
+ };
@@ -3,10 +3,10 @@ import { ComponentNode, CanvasHistoryAction, ComponentTypes } from '@canvas-buil
3
3
  export default function useCanvasHistory(): {
4
4
  activeHistoryItemIndex: import('vue').ComputedRef<number>;
5
5
  canvasHistory: import('vue').Ref<{
6
- active?: boolean;
6
+ active?: boolean | undefined;
7
7
  action: CanvasHistoryAction;
8
8
  componentType: ComponentTypes;
9
- icon?: string;
9
+ icon?: string | undefined;
10
10
  id: string;
11
11
  snapshot: {
12
12
  id: string;
@@ -18,153 +18,165 @@ export default function useCanvasHistory(): {
18
18
  pdf: boolean;
19
19
  web: boolean;
20
20
  } | undefined;
21
- allow_admins_to_overwrite?: boolean;
22
- autofill?: "off" | "ai" | "matching_metadata" | "matching_tags" | "matching_metadata_or_tags";
23
- autofill_content_types?: import('../../../main.lib').FileContentTypeEnum[] | null;
21
+ allow_admins_to_overwrite?: boolean | undefined;
22
+ autofill?: ("off" | "ai" | "matching_metadata" | "matching_tags" | "matching_metadata_or_tags") | undefined;
23
+ autofill_content_types?: (import('../../../main.lib').FileContentTypeEnum[] | null) | undefined;
24
24
  data?: import('@canvas-builder/types/canvas').PageBreakProps | {
25
25
  layout_type: import('@canvas-builder/types/canvas').GridLayoutTypes;
26
26
  columns: number;
27
27
  } | {
28
28
  span: number;
29
29
  tooltips?: {
30
- content?: string;
31
- content_style?: Record<string, any>;
32
- trigger?: string;
33
- trigger_style?: Record<string, any>;
30
+ content?: string | undefined;
31
+ content_style?: Record<string, any> | undefined;
32
+ trigger?: string | undefined;
33
+ trigger_style?: Record<string, any> | undefined;
34
34
  }[] | undefined;
35
35
  } | {
36
- content?: string;
36
+ content?: string | undefined;
37
37
  } | {
38
38
  images?: {
39
39
  url: string;
40
- is_uploaded_asset?: boolean;
40
+ is_uploaded_asset?: boolean | undefined;
41
41
  }[] | undefined;
42
- placeholder_height?: string;
43
- include_all_images_in_pdf?: boolean;
42
+ placeholder_height?: string | undefined;
43
+ include_all_images_in_pdf?: boolean | undefined;
44
44
  } | {
45
45
  asset_type: "external";
46
46
  external_url: string;
47
47
  type: "image" | "video";
48
- horizontal_alignment?: import('@canvas-builder/types/canvas').MultimediaHorizontalAlignmentOptions;
48
+ horizontal_alignment?: import('@canvas-builder/types/canvas').MultimediaHorizontalAlignmentOptions | undefined;
49
49
  } | {
50
50
  asset_type: "pitcher_asset";
51
51
  file: {
52
52
  id: import('../../../main.lib').File["id"];
53
53
  name: import('../../../main.lib').File["name"];
54
- content_url?: import('../../../main.lib').File["content_url"];
54
+ content_url?: import('../../../main.lib').File["content_url"] | undefined;
55
55
  };
56
56
  type: "image" | "video";
57
- horizontal_alignment?: import('@canvas-builder/types/canvas').MultimediaHorizontalAlignmentOptions;
57
+ horizontal_alignment?: import('@canvas-builder/types/canvas').MultimediaHorizontalAlignmentOptions | undefined;
58
58
  } | {
59
59
  type: "app";
60
60
  app_name: string;
61
61
  src: string | null;
62
- height?: string;
63
- width?: string;
64
- embed_locations?: import('../../../main.lib').EmbedLocation[];
65
- headless_locations?: import('../../../main.lib').EmbedLocation[];
62
+ height?: string | undefined;
63
+ width?: string | undefined;
64
+ embed_locations?: import('../../../main.lib').EmbedLocation[] | undefined;
65
+ headless_locations?: import('../../../main.lib').EmbedLocation[] | undefined;
66
66
  properties_by_embed_location?: {
67
67
  canvas?: {
68
- start_in_loading_mode?: boolean;
68
+ start_in_loading_mode?: boolean | undefined;
69
69
  } | undefined;
70
70
  dsr?: {
71
- start_in_loading_mode?: boolean;
71
+ start_in_loading_mode?: boolean | undefined;
72
72
  } | undefined;
73
73
  ui_app?: {
74
- start_in_loading_mode?: boolean;
74
+ start_in_loading_mode?: boolean | undefined;
75
75
  } | undefined;
76
76
  admin_instance?: {
77
- start_in_loading_mode?: boolean;
77
+ start_in_loading_mode?: boolean | undefined;
78
78
  } | undefined;
79
79
  } | undefined;
80
80
  file: {
81
81
  id: import('../../../main.lib').FileRetrieve["id"];
82
- snapshot_id?: import('../../../main.lib').FileRetrieve["id"];
82
+ snapshot_id?: import('../../../main.lib').FileRetrieve["id"] | undefined;
83
83
  name: import('../../../main.lib').FileRetrieve["name"];
84
- is_deleted?: boolean;
84
+ is_deleted?: boolean | undefined;
85
85
  content_url: import('../../../main.lib').FileRetrieve["content_url"];
86
86
  content_type: import('../../../main.lib').FileContentTypeEnum | null;
87
87
  content_extension: import('../../../main.lib').FileRetrieve["content_extension"];
88
- thumbnail_url?: import('../../../main.lib').FileRetrieve["thumbnail_url"];
88
+ permissions?: {
89
+ can_download?: boolean | undefined;
90
+ can_share?: boolean | undefined;
91
+ } | undefined;
92
+ thumbnail_url?: import('../../../main.lib').FileRetrieve["thumbnail_url"] | undefined;
89
93
  content_length: import('../../../main.lib').FileRetrieve["content_length"];
90
- content_thumbnails?: import('../../../main.lib').FileRetrieve["content_thumbnails"] | null;
91
- readonly pspdfkit_server_url?: import('../../../components/CFileViewer/CFileViewer.types').FileModel["pspdfkit_server_url"];
92
- readonly pspdfkit_auth_payload?: import('../../../components/CFileViewer/CFileViewer.types').FileModel["pspdfkit_auth_payload"];
94
+ content_thumbnails?: (import('../../../main.lib').FileRetrieve["content_thumbnails"] | null) | undefined;
95
+ readonly pspdfkit_server_url?: import('../../../components/CFileViewer/CFileViewer.types').FileModel["pspdfkit_server_url"] | undefined;
96
+ readonly pspdfkit_auth_payload?: import('../../../components/CFileViewer/CFileViewer.types').FileModel["pspdfkit_auth_payload"] | undefined;
93
97
  } | null;
94
- settings?: Record<string, unknown>;
98
+ settings?: Record<string, unknown> | undefined;
95
99
  } | {
96
100
  items: ({
97
101
  file: {
98
102
  id: import('../../../main.lib').FileRetrieve["id"];
99
- snapshot_id?: import('../../../main.lib').FileRetrieve["id"];
103
+ snapshot_id?: import('../../../main.lib').FileRetrieve["id"] | undefined;
100
104
  name: import('../../../main.lib').FileRetrieve["name"];
101
- is_deleted?: boolean;
102
- content_url?: import('../../../main.lib').FileRetrieve["content_url"];
103
- content_type?: import('../../../main.lib').FileContentTypeEnum | null;
104
- content_extension?: import('../../../main.lib').FileRetrieve["content_extension"];
105
+ is_deleted?: boolean | undefined;
106
+ content_url?: import('../../../main.lib').FileRetrieve["content_url"] | undefined;
107
+ content_type?: (import('../../../main.lib').FileContentTypeEnum | null) | undefined;
108
+ content_extension?: import('../../../main.lib').FileRetrieve["content_extension"] | undefined;
109
+ permissions?: {
110
+ can_download?: boolean | undefined;
111
+ can_share?: boolean | undefined;
112
+ } | undefined;
105
113
  };
106
114
  slide: {
107
115
  index: number;
108
- url?: import('../../../main.lib').FileRetrieve["content_thumbnails"][number];
116
+ url?: import('../../../main.lib').FileRetrieve["content_thumbnails"][number] | undefined;
109
117
  };
110
118
  type: "slide";
111
119
  } | {
112
120
  file: {
113
121
  id: import('../../../main.lib').FileRetrieve["id"];
114
- snapshot_id?: import('../../../main.lib').FileRetrieve["id"];
122
+ snapshot_id?: import('../../../main.lib').FileRetrieve["id"] | undefined;
115
123
  name: import('../../../main.lib').FileRetrieve["name"];
116
- is_deleted?: boolean;
124
+ is_deleted?: boolean | undefined;
117
125
  content_url: import('../../../main.lib').FileRetrieve["content_url"];
118
126
  content_type: import('../../../main.lib').FileContentTypeEnum | null;
119
127
  content_extension: import('../../../main.lib').FileRetrieve["content_extension"];
120
- thumbnail_url?: import('../../../main.lib').FileRetrieve["thumbnail_url"];
128
+ permissions?: {
129
+ can_download?: boolean | undefined;
130
+ can_share?: boolean | undefined;
131
+ } | undefined;
132
+ thumbnail_url?: import('../../../main.lib').FileRetrieve["thumbnail_url"] | undefined;
121
133
  content_length: import('../../../main.lib').FileRetrieve["content_length"];
122
- content_thumbnails?: import('../../../main.lib').FileRetrieve["content_thumbnails"] | null;
123
- readonly pspdfkit_server_url?: import('../../../components/CFileViewer/CFileViewer.types').FileModel["pspdfkit_server_url"];
124
- readonly pspdfkit_auth_payload?: import('../../../components/CFileViewer/CFileViewer.types').FileModel["pspdfkit_auth_payload"];
134
+ content_thumbnails?: (import('../../../main.lib').FileRetrieve["content_thumbnails"] | null) | undefined;
135
+ readonly pspdfkit_server_url?: import('../../../components/CFileViewer/CFileViewer.types').FileModel["pspdfkit_server_url"] | undefined;
136
+ readonly pspdfkit_auth_payload?: import('../../../components/CFileViewer/CFileViewer.types').FileModel["pspdfkit_auth_payload"] | undefined;
125
137
  };
126
138
  type: "file";
127
139
  })[];
128
- size?: "medium";
129
- layout_type?: import('@canvas-builder/types/canvas').ContentGridLayoutTypes;
140
+ size?: "medium" | undefined;
141
+ layout_type?: import('@canvas-builder/types/canvas').ContentGridLayoutTypes | undefined;
130
142
  } | {
131
143
  sections: {
132
144
  id: string;
133
- style?: Record<string, any>;
134
- aspect_ratio?: "unlocked" | "16:9" | "16:10" | "4:3" | "1:1";
135
- background_video_url?: string;
145
+ style?: Record<string, any> | undefined;
146
+ aspect_ratio?: ("unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
147
+ background_video_url?: string | undefined;
136
148
  }[];
137
- animation_in?: string;
149
+ animation_in?: string | undefined;
138
150
  } | {
139
151
  html: string;
140
152
  } | {
141
- alignment?: import('@canvas-builder/types/canvas').LinkAlignmentTypes;
142
- background_color?: string;
143
- canvas_anchor?: string;
144
- color?: string;
145
- display_text?: string;
146
- font_family?: string;
147
- font_size?: number;
148
- link_type?: import('@canvas-builder/types/canvas').LinkAnchorTypes;
149
- preview_type?: import('@canvas-builder/types/canvas').LinkPreviewTypes;
150
- target?: "_self" | "_blank";
151
- url?: string;
153
+ alignment?: import('@canvas-builder/types/canvas').LinkAlignmentTypes | undefined;
154
+ background_color?: string | undefined;
155
+ canvas_anchor?: string | undefined;
156
+ color?: string | undefined;
157
+ display_text?: string | undefined;
158
+ font_family?: string | undefined;
159
+ font_size?: number | undefined;
160
+ link_type?: import('@canvas-builder/types/canvas').LinkAnchorTypes | undefined;
161
+ preview_type?: import('@canvas-builder/types/canvas').LinkPreviewTypes | undefined;
162
+ target?: ("_self" | "_blank") | undefined;
163
+ url?: string | undefined;
152
164
  } | {
153
- aspect_ratio?: "unlocked" | "16:9" | "16:10" | "4:3" | "1:1";
154
- background_video_url?: string;
165
+ aspect_ratio?: ("unlocked" | "16:9" | "16:10" | "4:3" | "1:1") | undefined;
166
+ background_video_url?: string | undefined;
155
167
  } | {
156
168
  events: {
157
- top_hint?: string;
158
- top_hint_style?: Record<string, any>;
159
- title?: string;
160
- title_style?: Record<string, any>;
161
- description?: string;
162
- description_style?: Record<string, any>;
163
- image_url?: string;
164
- image_style?: Record<string, any>;
165
- icon?: string;
166
- icon_style?: Record<string, any>;
167
- card_style?: Record<string, any>;
169
+ top_hint?: string | undefined;
170
+ top_hint_style?: Record<string, any> | undefined;
171
+ title?: string | undefined;
172
+ title_style?: Record<string, any> | undefined;
173
+ description?: string | undefined;
174
+ description_style?: Record<string, any> | undefined;
175
+ image_url?: string | undefined;
176
+ image_style?: Record<string, any> | undefined;
177
+ icon?: string | undefined;
178
+ icon_style?: Record<string, any> | undefined;
179
+ card_style?: Record<string, any> | undefined;
168
180
  }[];
169
181
  layout: "vertical" | "horizontal";
170
182
  } | undefined;
@@ -1767,7 +1779,7 @@ export default function useCanvasHistory(): {
1767
1779
  "text-anchor"?: import("csstype").Property.TextAnchor | undefined;
1768
1780
  "vector-effect"?: import("csstype").Property.VectorEffect | undefined;
1769
1781
  } | undefined;
1770
- tags?: string[];
1782
+ tags?: string[] | undefined;
1771
1783
  }[];
1772
1784
  timestamp: string;
1773
1785
  }[]>;
@@ -1,16 +1,16 @@
1
1
  import { ComponentNode } from '@canvas-builder/types/canvas';
2
- import { Canvas } from '../../../../types/openapi';
2
+ import { CanvasRetrieve } from '../../../../types/openapi';
3
3
  import { AppFile } from '../../../types/app';
4
4
 
5
5
  declare function onSectionListUpdateHook({ sectionHookIframes, sectionListIds, sectionListComponentId, activeCanvas, }: {
6
6
  sectionHookIframes?: Record<string, HTMLIFrameElement>;
7
- sectionListIds: Canvas['id'][];
7
+ sectionListIds: CanvasRetrieve['id'][];
8
8
  sectionListComponentId: ComponentNode['id'];
9
- activeCanvas: Canvas;
9
+ activeCanvas: CanvasRetrieve;
10
10
  }): void;
11
11
  declare function onCanvasUpdatedHook({ hookIframes, activeCanvas, }: {
12
12
  hookIframes?: Record<string, HTMLIFrameElement>;
13
- activeCanvas: Canvas;
13
+ activeCanvas: CanvasRetrieve;
14
14
  }): void;
15
15
  declare function getEmbeddableSrc(app: AppFile): string | undefined;
16
16
  declare function setHookRefs(iframeEl: HTMLIFrameElement | null, app: AppFile, hookEvent: string): void;
@@ -1,17 +1,17 @@
1
1
  import { ComputedRef } from 'vue';
2
2
  import { ComponentNode, SectionListProps } from '@canvas-builder/types/canvas';
3
- import { Canvas } from '../../../../types/openapi';
3
+ import { CanvasRetrieve } from '../../../../types/openapi';
4
4
 
5
5
  type AnimationDirection = 'Left' | 'Right';
6
6
  declare function goToNextPage(): void;
7
7
  declare function goToPreviousPage(): void;
8
- declare function goToPage(componentId: ComponentNode['id'], sectionId?: Canvas['id'], options?: {
8
+ declare function goToPage(componentId: ComponentNode['id'], sectionId?: CanvasRetrieve['id'], options?: {
9
9
  scrollToTop: boolean;
10
10
  }): void;
11
11
  declare function reset(): void;
12
12
  export default function useCanvasPages(): {
13
13
  activeSectionId: ComputedRef<string | null>;
14
- activeSectionTheme: ComputedRef<any>;
14
+ activeSectionTheme: ComputedRef<Record<string, any> | null>;
15
15
  canvasPages: ComputedRef<ComponentNode<import('@canvas-builder/types/canvas').GridProps | import('@canvas-builder/types/canvas').GridItemProps | import('@canvas-builder/types/canvas').TextProps | import('@canvas-builder/types/canvas').CarouselProps | import('@canvas-builder/types/canvas').MultimediaProps | import('@canvas-builder/types/canvas').EmbeddableProps | import('@canvas-builder/types/canvas').ContentGridProps | SectionListProps | import('@canvas-builder/types/canvas').HtmlProps | import('@canvas-builder/types/canvas').LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>[][]>;
16
16
  currentPageIndex: import('vue').Ref<number>;
17
17
  currentSectionList: ComputedRef<{
@@ -1,5 +1,5 @@
1
1
  import { Ref } from 'vue';
2
- import { Canvas } from '../../../../types/openapi';
2
+ import { CanvasRetrieve } from '../../../../types/openapi';
3
3
  import { ComponentNode, SectionComponentOverrides } from '@canvas-builder/types/canvas';
4
4
 
5
5
  declare function discardOverridesConfirmationOptions(t: (input: string) => string, callback: () => void): {
@@ -12,13 +12,13 @@ declare function discardOverridesConfirmationOptions(t: (input: string) => strin
12
12
  };
13
13
  declare function cleanup(): void;
14
14
  export default function useCanvasSectionOverrides(): {
15
- getComponentOverrides: (data: Ref<ComponentNode["data"]>, id: Ref<ComponentNode["id"]>, sectionId?: Ref<Canvas["id"]>) => import('vue').ComputedRef<{
15
+ getComponentOverrides: (data: Ref<ComponentNode["data"]>, id: Ref<ComponentNode["id"]>, sectionId?: Ref<CanvasRetrieve["id"]>) => import('vue').ComputedRef<{
16
16
  data: (import('@canvas-builder/types/canvas').GridProps | import('@canvas-builder/types/canvas').GridItemProps | import('@canvas-builder/types/canvas').TextProps | import('@canvas-builder/types/canvas').CarouselProps | import('@canvas-builder/types/canvas').MultimediaProps | import('@canvas-builder/types/canvas').EmbeddableProps | import('@canvas-builder/types/canvas').ContentGridProps | import('@canvas-builder/types/canvas').SectionListProps | import('@canvas-builder/types/canvas').HtmlProps | import('@canvas-builder/types/canvas').LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps) | undefined;
17
17
  is_removed: boolean;
18
18
  }>;
19
19
  discardOverridesConfirmationOptions: typeof discardOverridesConfirmationOptions;
20
20
  overrideSectionComponentData: ({ usedInSectionId, componentId, componentData, afterSiblingId, remove, }: {
21
- usedInSectionId: Canvas["id"];
21
+ usedInSectionId: CanvasRetrieve["id"];
22
22
  componentId: ComponentNode["id"];
23
23
  componentData?: ComponentNode["data"];
24
24
  afterSiblingId?: ComponentNode["id"];
@@ -1,4 +1,4 @@
1
- import { File, FileTypeEnum } from '../../../../types/openapi/index';
1
+ import { FileTypeEnum, File } from '../../../../types/openapi';
2
2
  import { CanvasTheme } from '../../../main.lib';
3
3
 
4
4
  export declare enum ThemeComponentOptionEnum {
@@ -15,7 +15,6 @@ export interface ThemePadding {
15
15
  export declare const DEFAULT_GLOBAL_COMPONENT_SPACING = 32;
16
16
  export declare const DEFAULT_GLOBAL_COMPONENT_SPACING_INTERVAL = 4;
17
17
  declare function cleanup(): void;
18
- declare function addFontStyleElements(fontName?: string, url?: string): Promise<void>;
19
18
  declare function loadCustomFonts(listFiles: (params: any) => Promise<File[]>): Promise<void>;
20
19
  declare function setFontAndFetchAsset(fontName?: string, url?: string): Promise<void>;
21
20
  declare function updateThemeProperties(theme: Partial<CanvasTheme>): void;
@@ -26,48 +25,56 @@ export default function useCanvasTheme(): {
26
25
  customFonts: import('vue').Ref<{
27
26
  readonly id: string;
28
27
  readonly global_id: string;
29
- name?: string;
28
+ name?: string | undefined;
30
29
  readonly type: FileTypeEnum;
31
30
  readonly size: number | null;
32
- readonly status: import('../../../../types/openapi/index').FileStatusEnum;
33
- readonly content_type: import('../../../../types/openapi/index').FileContentTypeEnum;
31
+ readonly status: import('../../../../types/openapi').FileStatusEnum;
32
+ readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
34
33
  readonly content_extension: string | null;
35
34
  readonly content_length: number | null;
36
35
  readonly content_url: string | null;
37
36
  readonly original_extension: string | null;
38
37
  readonly thumbnail_url: string | null;
39
- download_type?: import('../../../../types/openapi/index').DownloadTypeEnum;
38
+ download_type?: import('../../../../types/openapi').DownloadTypeEnum | undefined;
40
39
  readonly zip_size: number | null;
41
40
  readonly zip_url: string | null;
42
- access_type?: import('../../../../types/openapi/index').AccessTypeEnum;
43
- readonly role: import('../../../../types/openapi/index').CollaborationRoleEnum;
44
- metadata?: Record<string, any>;
45
- app_metadata?: Record<string, any>;
46
- tags?: Array<string>;
41
+ access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
42
+ readonly role: import('../../../../types/openapi').CollaborationRoleEnum;
43
+ permissions?: {
44
+ can_download?: boolean | undefined;
45
+ can_share?: boolean | undefined;
46
+ } | undefined;
47
+ metadata?: Record<string, any> | undefined;
48
+ app_metadata?: Record<string, any> | undefined;
49
+ tags?: Array<string> | undefined;
47
50
  readonly published_at: string | null;
48
- expires_at?: string | null;
51
+ expires_at?: (string | null) | undefined;
49
52
  readonly instance_id: string;
50
- folder_id?: string;
53
+ folder_id?: string | undefined;
51
54
  readonly shared_link: {
52
55
  readonly url: string;
53
- short_url?: string | null;
56
+ short_url?: (string | null) | undefined;
57
+ };
58
+ readonly owned_by: {
59
+ readonly id: number;
60
+ readonly name: string;
61
+ email?: string | undefined;
54
62
  };
55
63
  readonly created_at: string;
56
64
  readonly created_by: {
57
65
  readonly id: number;
58
66
  readonly name: string;
59
- email?: string;
67
+ email?: string | undefined;
60
68
  };
61
69
  readonly modified_at: string;
62
70
  readonly modified_by: {
63
71
  readonly id: number;
64
72
  readonly name: string;
65
- email?: string;
73
+ email?: string | undefined;
66
74
  };
67
75
  }[]>;
68
76
  isEditingCanvasTheme: import('vue').Ref<boolean>;
69
77
  isFluid: import('vue').Ref<boolean>;
70
- addFontStyleElements: typeof addFontStyleElements;
71
78
  loadCustomFonts: typeof loadCustomFonts;
72
79
  setFontAndFetchAsset: typeof setFontAndFetchAsset;
73
80
  cleanup: typeof cleanup;
@@ -1,9 +1,9 @@
1
- import { Canvas } from '../../../../types/openapi';
1
+ import { CanvasRetrieve } from '../../../../types/openapi';
2
2
  import { ComponentNode, ComponentNodeVisible } from '@canvas-builder/types/canvas';
3
3
 
4
4
  export default function useCanvasVisibility(): {
5
5
  getComponentDefaultVisibility: (type: ComponentNode["type"], mode?: keyof ComponentNodeVisible) => boolean;
6
6
  getVisibleCanvasContent: (data: ComponentNode[], mode?: keyof ComponentNodeVisible) => ComponentNode<import('@canvas-builder/types/canvas').GridProps | import('@canvas-builder/types/canvas').GridItemProps | import('@canvas-builder/types/canvas').TextProps | import('@canvas-builder/types/canvas').CarouselProps | import('@canvas-builder/types/canvas').MultimediaProps | import('@canvas-builder/types/canvas').EmbeddableProps | import('@canvas-builder/types/canvas').ContentGridProps | import('@canvas-builder/types/canvas').SectionListProps | import('@canvas-builder/types/canvas').HtmlProps | import('@canvas-builder/types/canvas').LinkProps | import('@canvas-builder/types/canvas').PageBreakProps | import('@canvas-builder/types/canvas').PageProps | import('@canvas-builder/types/canvas').TimelineProps>[];
7
7
  getVisibleKey: () => keyof ComponentNodeVisible | undefined;
8
- shouldRenderComponentWrapper: (c: ComponentNode, sectionId?: Canvas["id"]) => boolean | undefined;
8
+ shouldRenderComponentWrapper: (c: ComponentNode, sectionId?: CanvasRetrieve["id"]) => boolean | undefined;
9
9
  };
@@ -1,12 +1,12 @@
1
1
  import { ComponentNode } from '@canvas-builder/types/canvas';
2
- import { Canvas } from '../../../../types/openapi';
2
+ import { CanvasRetrieve } from '../../../../types/openapi';
3
3
 
4
4
  declare function resetClickedOnSection(): void;
5
- declare function setClickedOnSection(sectionListId: ComponentNode['id'], sectionId: Canvas['id']): void;
5
+ declare function setClickedOnSection(sectionListId: ComponentNode['id'], sectionId: CanvasRetrieve['id']): void;
6
6
  export default function useCanvasTheme(): {
7
7
  clickedOnSection: Readonly<import('vue').Ref<{
8
8
  readonly sectionListId: ComponentNode["id"];
9
- readonly sectionId: Canvas["id"];
9
+ readonly sectionId: CanvasRetrieve["id"];
10
10
  } | undefined>>;
11
11
  resetClickedOnSection: typeof resetClickedOnSection;
12
12
  setClickedOnSection: typeof setClickedOnSection;
@@ -1,10 +1,10 @@
1
1
  import { Ref } from 'vue';
2
2
  import { ComponentNode } from '@canvas-builder/types/canvas';
3
- import { Canvas } from '../../../../types/openapi';
3
+ import { CanvasRetrieve } from '../../../../types/openapi';
4
4
 
5
5
  export default function ({ id, usedInSectionId, when_used_in_section, }: {
6
6
  id: Ref<ComponentNode['id']>;
7
- usedInSectionId: Ref<Canvas['id']>;
7
+ usedInSectionId: Ref<CanvasRetrieve['id']>;
8
8
  when_used_in_section: Ref<ComponentNode['when_used_in_section']>;
9
9
  }): import('vue').ComputedRef<{
10
10
  hasSomethingEditable: boolean;
@@ -9,6 +9,7 @@ type ContentSelectorPayload = {
9
9
  selections?: Selection[];
10
10
  allowedSelectorTypes?: SelectorType[];
11
11
  allowedContentTypes?: FileContentTypeEnum[];
12
+ allowedAssetContentTypes?: FileContentTypeEnum[];
12
13
  maxSelections?: number;
13
14
  };
14
15
  declare function clearContentSelectorMode(): void;
@@ -29,7 +30,7 @@ export default function (): {
29
30
  selections?: ({
30
31
  fileId: FileRetrieve["id"];
31
32
  type: "file" | "page";
32
- pageIndex?: number;
33
+ pageIndex?: number | undefined;
33
34
  } | {
34
35
  url: string;
35
36
  type: "external_link";
@@ -38,9 +39,10 @@ export default function (): {
38
39
  fileId: FileRetrieve["id"];
39
40
  type: "asset";
40
41
  })[] | undefined;
41
- allowedSelectorTypes?: SelectorType[];
42
- allowedContentTypes?: FileContentTypeEnum[];
43
- maxSelections?: number;
42
+ allowedSelectorTypes?: SelectorType[] | undefined;
43
+ allowedContentTypes?: FileContentTypeEnum[] | undefined;
44
+ allowedAssetContentTypes?: FileContentTypeEnum[] | undefined;
45
+ maxSelections?: number | undefined;
44
46
  }>;
45
47
  setContentSelectorMode: typeof setContentSelectorMode;
46
48
  prepareContentGridNodeData: typeof prepareContentGridNodeData;
@@ -0,0 +1,15 @@
1
+ import { ComputedRef } from 'vue';
2
+ import { AppFile, EmbeddedAppShortcut } from '../../../types/app';
3
+
4
+ export declare function useInstalledEmbeddables(): {
5
+ isFetching: import('vue').Ref<boolean>;
6
+ installedEmbeddablesById: import('vue').Ref<Record<string, AppFile> | null>;
7
+ refetchedFor: Record<string, boolean>;
8
+ shouldUseDeviceUrl: ComputedRef<boolean | undefined>;
9
+ shortcuts: ComputedRef<Record<"edit" | "fullscreen" | "presentation", (EmbeddedAppShortcut & {
10
+ appName: string;
11
+ })[]>>;
12
+ refetch: (fileId?: AppFile["id"]) => void;
13
+ cleanup: () => void;
14
+ getDeviceUrl: (fileId?: AppFile["id"]) => string | undefined;
15
+ };
@@ -2,12 +2,12 @@ import { AxiosInstance } from 'axios';
2
2
  import { PitcherInfo } from '../../../types/app';
3
3
  import { ContentGridProps, CanvasBuilderProps } from '@canvas-builder/types/canvas';
4
4
  import { RecommendedContent } from '@canvas-builder/types/recommendations.types';
5
- import { Canvas } from '../../../../types/openapi';
6
- import { InstanceSettings } from '../../../types/instanceSettings';
5
+ import { CanvasRetrieve } from '../../../../types/openapi';
6
+ import { InstanceSettings } from '../../../types/instanceSettings.types';
7
7
 
8
8
  declare function autofillCanvasContentGridsWithAi(filesFetcher: NonNullable<CanvasBuilderProps['listFiles']>): Promise<void>;
9
9
  declare function autofillSectionContentGridsWithAi(filesFetcher: NonNullable<CanvasBuilderProps['listFiles']>): Promise<void>;
10
- declare function autofillSectionContentGridsWithMatchingProperties(sectionId: Canvas['id'], options: {
10
+ declare function autofillSectionContentGridsWithMatchingProperties(sectionId: CanvasRetrieve['id'], options: {
11
11
  filesFetcher: NonNullable<CanvasBuilderProps['listFiles']>;
12
12
  http: AxiosInstance;
13
13
  pitcherInfo: PitcherInfo;
@@ -17,11 +17,12 @@ declare function autofillCanvasContentGridsWithMatchingProperties(options: {
17
17
  filesFetcher: NonNullable<CanvasBuilderProps['listFiles']>;
18
18
  http: AxiosInstance;
19
19
  pitcherInfo: PitcherInfo;
20
+ instanceSettings?: InstanceSettings;
20
21
  }): Promise<void>;
21
22
  declare function cleanup(): void;
22
23
  export default function useRecommendations(): {
23
24
  contextSections: import('vue').ComputedRef<{
24
- id: Canvas["id"];
25
+ id: CanvasRetrieve["id"];
25
26
  list_header_html?: string;
26
27
  recommended?: boolean;
27
28
  removed_by_user?: boolean;
@@ -31,7 +32,7 @@ export default function useRecommendations(): {
31
32
  recommendedContent: import('vue').ComputedRef<{
32
33
  content_grids?: RecommendedContent;
33
34
  sections?: {
34
- [key: Canvas["id"]]: {
35
+ [key: CanvasRetrieve["id"]]: {
35
36
  content_grids?: RecommendedContent;
36
37
  };
37
38
  };
@@ -1,8 +1,8 @@
1
1
  import { ComputedRef } from 'vue';
2
2
  import { SectionPopularityCategory, SectionExtra } from '../../../types/sectionPopularity';
3
- import { Canvas } from '../../../../types/openapi';
3
+ import { CanvasRetrieve } from '../../../../types/openapi';
4
4
 
5
- type SorterFunction = (item: Canvas) => string | number | boolean;
5
+ type SorterFunction = (item: CanvasRetrieve) => string | number | boolean;
6
6
  type OrderDirection = 'asc' | 'desc';
7
7
  declare function calculateTrendline(data: number[]): number;
8
8
  declare function getPopularityCategory(value: number): SectionPopularityCategory.NONE | SectionPopularityCategory.POPULAR;