@pitcher/js-api 1.22.0-alpha.6 → 1.22.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (188) hide show
  1. package/README.md +4 -2
  2. package/js-api.esm.js +472 -139
  3. package/js-api.esm.js.map +1 -1
  4. package/js-api.umd.min.js +10 -10
  5. package/js-api.umd.min.js.map +1 -1
  6. package/lib/api/canvases/canvases.queries.d.ts +5 -5
  7. package/lib/apps/browser/stores/api.d.ts +215 -84
  8. package/lib/apps/browser/stores/app.d.ts +7 -26
  9. package/lib/apps/browser/stores/upload.d.ts +34 -24
  10. package/lib/apps/browser/util/file.d.ts +2 -2
  11. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +550 -460
  12. package/lib/apps/canvas-builder/composables/useCanvasExit.d.ts +3 -0
  13. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +86 -74
  14. package/lib/apps/canvas-builder/composables/useCanvasHooks.d.ts +4 -4
  15. package/lib/apps/canvas-builder/composables/useCanvasPages.d.ts +3 -3
  16. package/lib/apps/canvas-builder/composables/useCanvasSectionOverrides.d.ts +3 -3
  17. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +24 -17
  18. package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts +2 -2
  19. package/lib/apps/canvas-builder/composables/useCollapsibles.d.ts +3 -3
  20. package/lib/apps/canvas-builder/composables/useComponentPermissions.d.ts +2 -2
  21. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +6 -4
  22. package/lib/apps/canvas-builder/composables/useInstalledEmbeddables.d.ts +15 -0
  23. package/lib/apps/canvas-builder/composables/useRecommendations.d.ts +5 -5
  24. package/lib/apps/canvas-builder/composables/useSectionPopularity.d.ts +2 -2
  25. package/lib/apps/canvas-builder/types/canvas.d.ts +19 -18
  26. package/lib/apps/canvas-builder/types/recommendations.types.d.ts +3 -3
  27. package/lib/apps/canvas-builder/util/canvas.util.d.ts +5 -4
  28. package/lib/apps/canvas-selector/appTypes.d.ts +13 -0
  29. package/lib/apps/canvas-selector/constants/index.d.ts +3 -0
  30. package/lib/apps/canvas-selector/stores/app.d.ts +415 -0
  31. package/lib/apps/content-selector/appTypes.d.ts +1 -0
  32. package/lib/apps/content-selector/stores/app.d.ts +8 -1
  33. package/lib/components/CFileViewer/CFileViewer.use.d.ts +2 -4
  34. package/lib/components/CFileViewer/CFileViewerFullScreen.use.d.ts +1 -1
  35. package/lib/components/canvases/CanvasesManagementBulk.use.d.ts +5 -5
  36. package/lib/components/filters/filter.util.d.ts +1 -1
  37. package/lib/components/savedCanvases/CSavedCanvasesManagementShareCanvas.use.d.ts +5 -3
  38. package/lib/composables/instanceTagsActions.use.d.ts +14 -0
  39. package/lib/composables/recentFiles.use.d.ts +1 -1
  40. package/lib/composables/suggestedTags.use.d.ts +3 -0
  41. package/lib/composables/tableColumnsSettings.use.d.ts +25 -0
  42. package/lib/composables/useCanvasOverlay.d.ts +20 -0
  43. package/lib/composables/useCanvasTablesPagination.d.ts +13 -0
  44. package/lib/composables/useConfirmation.d.ts +1 -0
  45. package/lib/composables/useElementHeightResize.d.ts +5 -0
  46. package/lib/composables/useFiles.d.ts +11 -0
  47. package/lib/constants/pitcherSettings.const.d.ts +4 -0
  48. package/lib/main.lib.d.ts +32 -21
  49. package/lib/sdk/api/HighLevelApi.d.ts +112 -14
  50. package/lib/sdk/api/modules/admin/canvas.admin.d.ts +53 -15
  51. package/lib/sdk/api/modules/admin/env.admin.d.ts +3 -2
  52. package/lib/sdk/api/modules/admin/files.admin.d.ts +43 -4
  53. package/lib/sdk/api/modules/admin/index.d.ts +53 -5
  54. package/lib/sdk/api/modules/admin/metadataTemplates.admin.d.ts +1 -2
  55. package/lib/sdk/api/modules/admin/types.admin.d.ts +131 -3
  56. package/lib/sdk/api/modules/canvas.d.ts +12 -14
  57. package/lib/sdk/api/modules/dsr/env.dsr.d.ts +4 -3
  58. package/lib/sdk/api/modules/dsr/index.d.ts +14 -3
  59. package/lib/sdk/api/modules/dsr/loading.dsr.d.ts +7 -1
  60. package/lib/sdk/api/modules/env.d.ts +16 -0
  61. package/lib/sdk/api/modules/favorites.d.ts +9 -0
  62. package/lib/sdk/api/modules/feedback.d.ts +3 -0
  63. package/lib/sdk/api/modules/files.d.ts +7 -4
  64. package/lib/sdk/api/modules/folders.d.ts +29 -0
  65. package/lib/sdk/api/modules/open.d.ts +6 -0
  66. package/lib/sdk/api/modules/sync.d.ts +1 -2
  67. package/lib/sdk/api/modules/ui/app-errors.ui.d.ts +13 -1
  68. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +102 -8
  69. package/lib/sdk/api/modules/ui/content.ui.d.ts +52 -2
  70. package/lib/sdk/api/modules/ui/index.d.ts +150 -13
  71. package/lib/sdk/api/modules/ui/loading.ui.d.ts +9 -1
  72. package/lib/sdk/api/modules/ui/location.ui.d.ts +18 -1
  73. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +35 -4
  74. package/lib/sdk/api/modules/ui/types.ui.d.ts +85 -8
  75. package/lib/sdk/api/modules/users.d.ts +6 -1
  76. package/lib/sdk/interfaces.d.ts +122 -3
  77. package/lib/sdk/main.d.ts +297 -151
  78. package/lib/sdk/payload.types.d.ts +134 -2
  79. package/lib/sdk/utils/httpFetch.d.ts +1 -1
  80. package/lib/sdk/utils/object.d.ts +1 -0
  81. package/lib/sdk/utils/object.spec.d.ts +1 -0
  82. package/lib/theme/light.d.ts +12 -0
  83. package/lib/types/app.d.ts +11 -0
  84. package/lib/types/call.d.ts +4 -3
  85. package/lib/types/files.d.ts +27 -1
  86. package/lib/types/filter.d.ts +5 -0
  87. package/lib/types/instance.types.d.ts +18 -0
  88. package/lib/types/{instanceSettings.d.ts → instanceSettings.types.d.ts} +10 -2
  89. package/lib/types/launchDarkly.types.d.ts +4 -4
  90. package/lib/types/organization.types.d.ts +2 -2
  91. package/lib/types/organizationSettings.types.d.ts +4 -0
  92. package/lib/types/recentFiles.types.d.ts +4 -1
  93. package/lib/types/users.d.ts +13 -0
  94. package/lib/util/fullscreen.util.d.ts +1 -1
  95. package/lib/util/string.d.ts +1 -0
  96. package/package.json +1 -1
  97. package/types/openapi/index.d.ts +23 -17
  98. package/types/openapi/models/AccessTypeEnum.d.ts +3 -1
  99. package/types/openapi/models/App.d.ts +1 -0
  100. package/types/openapi/models/AppRelease.d.ts +1 -0
  101. package/types/openapi/models/AppsDBEntry.d.ts +4 -0
  102. package/types/openapi/models/AppsDBEntryRequest.d.ts +3 -0
  103. package/types/openapi/models/Canvas.d.ts +10 -15
  104. package/types/openapi/models/CanvasCreate.d.ts +14 -12
  105. package/types/openapi/models/CanvasCreateRequest.d.ts +6 -5
  106. package/types/openapi/models/CanvasRecommendedFile.d.ts +6 -0
  107. package/types/openapi/models/CanvasRetrieve.d.ts +15 -13
  108. package/types/openapi/models/CanvasSection.d.ts +5 -2
  109. package/types/openapi/models/CanvasUpdate.d.ts +14 -12
  110. package/types/openapi/models/CanvasUpdateRequest.d.ts +5 -4
  111. package/types/openapi/models/CollaborationRoleEnum.d.ts +0 -4
  112. package/types/openapi/models/ContentDistributionGroupCreate.d.ts +1 -0
  113. package/types/openapi/models/DeletedApp.d.ts +1 -0
  114. package/types/openapi/models/{CanvasList.d.ts → DeletedCanvas.d.ts} +13 -9
  115. package/types/openapi/models/DeletedContentDistributionGroup.d.ts +1 -0
  116. package/types/openapi/models/DeletedEnvironment.d.ts +1 -0
  117. package/types/openapi/models/DeletedFavorite.d.ts +1 -0
  118. package/types/openapi/models/DeletedFile.d.ts +6 -0
  119. package/types/openapi/models/DeletedFolder.d.ts +4 -3
  120. package/types/openapi/models/DeletedInstance.d.ts +1 -0
  121. package/types/openapi/models/DeletedInstanceAssignmentGroup.d.ts +1 -0
  122. package/types/openapi/models/DeletedMetadataTemplate.d.ts +1 -0
  123. package/types/openapi/models/DeletedRegion.d.ts +1 -0
  124. package/types/openapi/models/Environment.d.ts +1 -0
  125. package/types/openapi/models/Favorite.d.ts +1 -0
  126. package/types/openapi/models/File.d.ts +6 -0
  127. package/types/openapi/models/FileCreate.d.ts +8 -0
  128. package/types/openapi/models/FileCreateRequest.d.ts +3 -0
  129. package/types/openapi/models/FilePermission.d.ts +4 -0
  130. package/types/openapi/models/FilePermissionRequest.d.ts +4 -0
  131. package/types/openapi/models/FileRetrieve.d.ts +8 -0
  132. package/types/openapi/models/FileRevision.d.ts +8 -0
  133. package/types/openapi/models/FileRevisionRequest.d.ts +3 -0
  134. package/types/openapi/models/FileUpdate.d.ts +8 -0
  135. package/types/openapi/models/FileUpdateRequest.d.ts +3 -0
  136. package/types/openapi/models/FileVersion.d.ts +5 -0
  137. package/types/openapi/models/Folder.d.ts +4 -3
  138. package/types/openapi/models/FolderCanvas.d.ts +11 -0
  139. package/types/openapi/models/FolderCreate.d.ts +8 -7
  140. package/types/openapi/models/FolderCreateRequest.d.ts +4 -2
  141. package/types/openapi/models/FolderFile.d.ts +3 -0
  142. package/types/openapi/models/FolderFolder.d.ts +5 -1
  143. package/types/openapi/models/FolderRetrieve.d.ts +8 -8
  144. package/types/openapi/models/FolderRule.d.ts +7 -0
  145. package/types/openapi/models/FolderRuleRequest.d.ts +7 -0
  146. package/types/openapi/models/FolderUpdate.d.ts +8 -8
  147. package/types/openapi/models/FolderUpdateRequest.d.ts +3 -0
  148. package/types/openapi/models/Instance.d.ts +1 -0
  149. package/types/openapi/models/InstanceUpdate.d.ts +1 -0
  150. package/types/openapi/models/MetadataTemplate.d.ts +1 -0
  151. package/types/openapi/models/OfflineSyncFolder.d.ts +17 -0
  152. package/types/openapi/models/OperatorEnum.d.ts +64 -0
  153. package/types/openapi/models/PaginatedCanvasList.d.ts +8 -0
  154. package/types/openapi/models/PaginatedFileRevisionList.d.ts +8 -0
  155. package/types/openapi/models/PaginatedOfflineSyncFolderList.d.ts +8 -0
  156. package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +5 -4
  157. package/types/openapi/models/PatchedFileRequest.d.ts +3 -0
  158. package/types/openapi/models/PatchedFileRevisionRequest.d.ts +3 -0
  159. package/types/openapi/models/PatchedFileUpdateRequest.d.ts +3 -0
  160. package/types/openapi/models/PatchedFolderUpdateRequest.d.ts +3 -0
  161. package/types/openapi/models/Region.d.ts +1 -0
  162. package/types/openapi/models/SearchFile.d.ts +3 -0
  163. package/types/openapi/models/SharedLink.d.ts +6 -5
  164. package/types/openapi/models/SharedLinkCanvas.d.ts +11 -0
  165. package/types/openapi/models/SharedLinkCanvasRequest.d.ts +8 -0
  166. package/types/openapi/models/SharedLinkCreate.d.ts +6 -5
  167. package/types/openapi/models/{SharedLinkInstanceSerialzier.d.ts → SharedLinkInstance.d.ts} +1 -1
  168. package/types/openapi/models/SharedLinkInstanceRequest.d.ts +5 -0
  169. package/types/openapi/models/{SharedLinkOrganizationSerialzier.d.ts → SharedLinkOrganization.d.ts} +1 -1
  170. package/types/openapi/models/SharedLinkOrganizationRequest.d.ts +6 -0
  171. package/lib/apps/canvas-builder/util/tsUtils.d.ts +0 -3
  172. package/lib/composables/useDetailsView.d.ts +0 -19
  173. package/lib/types/templateActions.d.ts +0 -10
  174. package/lib/util/gesture.util.d.ts +0 -6
  175. package/types/openapi/models/AppsDBGlobalEntry.d.ts +0 -8
  176. package/types/openapi/models/AppsDBGlobalEntryRequest.d.ts +0 -3
  177. package/types/openapi/models/AppsDBUserEntry.d.ts +0 -9
  178. package/types/openapi/models/AppsDBUserEntryRequest.d.ts +0 -3
  179. package/types/openapi/models/CanvasSectionRetrieve.d.ts +0 -7
  180. package/types/openapi/models/CanvasSectionRetrieveRequest.d.ts +0 -5
  181. package/types/openapi/models/FileRequest.d.ts +0 -13
  182. package/types/openapi/models/InstanceStorageCredentials.d.ts +0 -6
  183. package/types/openapi/models/MiniAccount.d.ts +0 -4
  184. package/types/openapi/models/PSPDFKitAuthPayload.d.ts +0 -3
  185. package/types/openapi/models/PSPDFKitAuthPayloadRequest.d.ts +0 -3
  186. package/types/openapi/models/PSPDFKitToken.d.ts +0 -7
  187. package/types/openapi/models/PSPDFKitTokenRequest.d.ts +0 -3
  188. package/types/openapi/models/PaginatedCanvasListList.d.ts +0 -8
@@ -1,7 +1,7 @@
1
1
  import { CSSProperties, Ref } from 'vue';
2
2
  import { MaybeRef } from '@vueuse/core';
3
3
  import { CanvasActions } from '../../../main.lib';
4
- import { Canvas, CanvasRetrieve, File, FileContentTypeEnum, FileRetrieve, Folder, FolderRetrieve, MetadataTemplate, PatchedCanvasUpdateRequest, SharedLink, User } from '../../../../types/openapi';
4
+ import { CanvasRetrieve, File, FileContentTypeEnum, FileRetrieve, Folder, FolderRetrieve, MetadataTemplate, PatchedCanvasUpdateRequest, SharedLink, User } from '../../../../types/openapi';
5
5
  import { PaginatedData } from '../../../types/paginatedData';
6
6
  import { OpenExternalUrlRequestPayload, PitcherEnv } from '../../../sdk/main';
7
7
  import { EmbedLocation, EmbeddedLocationProperties } from '../../../types/app';
@@ -108,6 +108,7 @@ type ContentGridCommonFileProps = {
108
108
  content_url?: FileRetrieve['content_url'];
109
109
  content_type?: FileContentTypeEnum | null;
110
110
  content_extension?: FileRetrieve['content_extension'];
111
+ permissions?: FileRetrieve['permissions'];
111
112
  };
112
113
  export type ContentGridFileProps = ContentGridCommonFileProps & {
113
114
  thumbnail_url?: FileRetrieve['thumbnail_url'];
@@ -246,7 +247,7 @@ export type SectionComponentOverride = {
246
247
  is_removed?: true;
247
248
  };
248
249
  export type SectionComponentOverrides = {
249
- [sectionId: Canvas['id']]: {
250
+ [sectionId: CanvasRetrieve['id']]: {
250
251
  [componentId: ComponentNode['id'] | 'root']: SectionComponentOverride;
251
252
  };
252
253
  };
@@ -364,13 +365,13 @@ export type SharingBuilderProps = NoCRMBuilderProps & {
364
365
  metadata: {
365
366
  baseStackingContext?: number;
366
367
  };
367
- activeCanvas: Canvas;
368
+ activeCanvas: CanvasRetrieve;
368
369
  templates?: never;
369
370
  onExit: () => void;
370
371
  onSave?: never;
371
372
  onEnter?: () => void;
372
- onComponentEnter?: (data: ComponentNode | Canvas, params: ComponentTrackingParams) => void;
373
- onComponentExit?: (data: ComponentNode | Canvas, params: ComponentTrackingParams) => void;
373
+ onComponentEnter?: (data: ComponentNode | CanvasRetrieve, params: ComponentTrackingParams) => void;
374
+ onComponentExit?: (data: ComponentNode | CanvasRetrieve, params: ComponentTrackingParams) => void;
374
375
  onFileOpen: (file: FileOpenParams) => void;
375
376
  onOpenExternalUrl: (payload: OpenExternalUrlRequestPayload) => Promise<void>;
376
377
  deleteFile?: never;
@@ -392,7 +393,7 @@ export type SharingBuilderProps = NoCRMBuilderProps & {
392
393
  inCall?: never;
393
394
  myUserId?: never;
394
395
  onDownloadFile?: (file: File | ContentGridFileProps | ContentGridCommonFileProps) => Promise<void>;
395
- onDownloadCanvas?: (canvas: Canvas) => Promise<void>;
396
+ onDownloadCanvas?: (canvas: CanvasRetrieve) => Promise<void>;
396
397
  };
397
398
  export interface CRMBuilderProps {
398
399
  isCRM: true;
@@ -417,25 +418,25 @@ type AdminImpactCommonBuilderProps = {
417
418
  baseStackingContext?: number;
418
419
  startInMode?: CanvasActions.Present | CanvasActions.Edit;
419
420
  };
420
- activeCanvas: Canvas;
421
+ activeCanvas: CanvasRetrieve;
421
422
  templates: {
422
- label: Canvas['name'];
423
- value: Canvas['id'];
423
+ label: CanvasRetrieve['name'];
424
+ value: CanvasRetrieve['id'];
424
425
  }[];
425
426
  onExit: () => void;
426
427
  onEnter?: () => void;
427
- onComponentEnter?: (data: ComponentNode | Canvas, params: ComponentTrackingParams) => void;
428
- onComponentExit?: (data: ComponentNode | Canvas, params: ComponentTrackingParams) => void;
429
- onSave: (canvasId: Canvas['id'], canvas: PatchedCanvasUpdateRequest & {
428
+ onComponentEnter?: (data: ComponentNode | CanvasRetrieve, params: ComponentTrackingParams) => void;
429
+ onComponentExit?: (data: ComponentNode | CanvasRetrieve, params: ComponentTrackingParams) => void;
430
+ onSave: (canvasId: CanvasRetrieve['id'], canvas: PatchedCanvasUpdateRequest & {
430
431
  fields?: string;
431
- }, showToast?: boolean) => Promise<Canvas>;
432
+ }, showToast?: boolean) => Promise<CanvasRetrieve>;
432
433
  onFileOpen: (file: FileOpenParams) => void;
433
434
  deleteFile: (fileId: FileRetrieve['id']) => Promise<string | void>;
434
435
  listFiles: (params?: any) => Promise<File[]>;
435
- listCanvases: (params?: any) => Promise<PaginatedData<Canvas>>;
436
+ listCanvases: (params?: any) => Promise<PaginatedData<CanvasRetrieve>>;
436
437
  fetchFolder: (folderId: Folder['id'] | undefined) => Promise<FolderRetrieve>;
437
438
  fetchFile: (fileId: FileRetrieve['id']) => Promise<FileRetrieve>;
438
- fetchCanvas: (canvasId: Canvas['id']) => Promise<CanvasRetrieve>;
439
+ fetchCanvas: (canvasId: CanvasRetrieve['id']) => Promise<CanvasRetrieve>;
439
440
  fetchInstanceMetadataTemplate: () => Promise<MetadataTemplate>;
440
441
  renderPageAsImageUrl?: (fileId: File['id'], pageIndex: number, options: {
441
442
  width: number;
@@ -444,12 +445,12 @@ type AdminImpactCommonBuilderProps = {
444
445
  }) => Promise<string>;
445
446
  getEnv?: () => Promise<PitcherEnv>;
446
447
  onEditMode?: (isEditMode: boolean) => void;
447
- onTrackShare?: (canvasId: Canvas['id']) => Promise<void>;
448
+ onTrackShare?: (canvasId: CanvasRetrieve['id']) => Promise<void>;
448
449
  onOpenExternalUrl: (payload: OpenExternalUrlRequestPayload) => Promise<void>;
449
- share?: (canvasId: Canvas['id']) => Promise<SharedLink>;
450
+ share?: (canvasId: CanvasRetrieve['id']) => Promise<SharedLink>;
450
451
  isCRM: boolean;
451
452
  onDownloadFile?: (file: File | ContentGridFileProps | ContentGridCommonFileProps) => Promise<void>;
452
- onDownloadCanvas?: (canvas: Canvas) => Promise<void>;
453
+ onDownloadCanvas?: (canvas: CanvasRetrieve) => Promise<void>;
453
454
  };
454
455
  type AdminBuilderProps = AdminImpactCommonBuilderProps & (CRMBuilderProps | NoCRMBuilderProps) & {
455
456
  isRedirectEvent?: never;
@@ -1,4 +1,4 @@
1
- import { Canvas, File } from '../../../../types/openapi';
1
+ import { CanvasRetrieve, File } from '../../../../types/openapi';
2
2
 
3
3
  export type RecommendedContent = {
4
4
  type: 'file' | 'slide';
@@ -12,7 +12,7 @@ export type RecommendedContent = {
12
12
  export type Recommendations = {
13
13
  recommendation_strategy?: 'force' | 'suggest';
14
14
  sections?: {
15
- id: Canvas['id'];
15
+ id: CanvasRetrieve['id'];
16
16
  list_header_html?: string;
17
17
  recommended?: boolean;
18
18
  removed_by_user?: boolean;
@@ -20,7 +20,7 @@ export type Recommendations = {
20
20
  recommended_content?: {
21
21
  content_grids?: RecommendedContent;
22
22
  sections?: {
23
- [key: Canvas['id']]: {
23
+ [key: CanvasRetrieve['id']]: {
24
24
  content_grids?: RecommendedContent;
25
25
  };
26
26
  };
@@ -1,6 +1,6 @@
1
1
  import { UnwrapRef } from 'vue';
2
2
  import { ComponentTypes, CarouselProps, ComponentNode, ContentGridProps, EmbeddableProps, GridItemProps, GridProps, HtmlProps, MultimediaProps, SectionComponentOverrides, SectionListProps, TextProps, CanvasBuilderMode, ComponentNodeVisible, LinkProps } from '@canvas-builder/types/canvas';
3
- import { Canvas } from '../../../../types/openapi';
3
+ import { CanvasRetrieve } from '../../../../types/openapi';
4
4
  import { EmbedLocation } from '../../../types/app';
5
5
  import { SectionComponentNodesBySectionId, ComponentNodesById } from '@canvas-builder/composables/useCanvas';
6
6
 
@@ -9,7 +9,8 @@ export declare function getComponentKeywords(type: ComponentTypes, t: (input: st
9
9
  export declare function getComponentTitle(type: ComponentTypes | string, t: (input: string) => string): string;
10
10
  export declare function getComponentDescription(type: ComponentTypes | string, t: (input: string) => string): string;
11
11
  export declare function getNodeDisplayNameByComponentType(node: ComponentNode | null | undefined): string;
12
- export declare function discardSectionComponentOverride(sectionId: Canvas['id'], componentId: ComponentNode['id'], overrides: SectionComponentOverrides): SectionComponentOverrides;
12
+ export declare function getSectionGlobalComponentSpacing(section: CanvasRetrieve['sections'][number]): string | undefined;
13
+ export declare function discardSectionComponentOverride(sectionId: CanvasRetrieve['id'], componentId: ComponentNode['id'], overrides: SectionComponentOverrides): SectionComponentOverrides;
13
14
  export declare function addCanvasComponent(currentContent: ComponentNode[], add: {
14
15
  type: ComponentTypes;
15
16
  parentId?: ComponentNode['id'] | null;
@@ -32,9 +33,9 @@ export declare function scrollCanvasToTop(): void;
32
33
  export declare function shouldShowEmbeddable(isEditMode: boolean, currentEmbedLocation: EmbedLocation, headlessLocations?: string[]): boolean;
33
34
  export declare const isHeadlessOrNotAvailableApp: (component: ComponentNode, isEditMode: boolean, currentEmbedLocation: EmbedLocation) => boolean;
34
35
  export declare function shouldDisplayPlaceholderComponent(isEditMode: boolean, mode: (typeof CanvasBuilderMode)[keyof typeof CanvasBuilderMode] | undefined, visibility?: ComponentNodeVisible): boolean;
35
- export declare function isTextComponentEmpty(component: ComponentNode, overrides?: SectionComponentOverrides, sectionId?: Canvas['id']): boolean;
36
+ export declare function isTextComponentEmpty(component: ComponentNode, overrides?: SectionComponentOverrides, sectionId?: CanvasRetrieve['id']): boolean;
36
37
  type FoundComponent = {
37
- sectionId?: Canvas['id'];
38
+ sectionId?: CanvasRetrieve['id'];
38
39
  sectionListId?: ComponentNode['id'];
39
40
  componentId: ComponentNode['id'];
40
41
  } | null;
@@ -0,0 +1,13 @@
1
+ import { Canvas, PaginatedCanvasList } from '../../../types/openapi';
2
+
3
+ export type CanvasSelectionType = 'canvas' | 'canvas-template' | 'section' | 'section-template';
4
+ export type CanvasSelection = {
5
+ id: Canvas['id'];
6
+ };
7
+ export type AppProps = {
8
+ appName: 'impact' | 'admin';
9
+ primaryActionText?: string;
10
+ listCanvases: (params: any) => Promise<PaginatedCanvasList>;
11
+ allowedSelectorTypes?: CanvasSelectionType[];
12
+ selections?: CanvasSelection[];
13
+ };
@@ -0,0 +1,3 @@
1
+ import { CanvasSelectionType } from '@canvas-selector/appTypes';
2
+
3
+ export declare const availableSelectorTypes: CanvasSelectionType[];
@@ -0,0 +1,415 @@
1
+ import { CanvasSelectionType } from '@canvas-selector/appTypes';
2
+
3
+ declare function cleanup(): void;
4
+ export default function useApp(): {
5
+ activeSelectionType: import('vue').Ref<CanvasSelectionType | null>;
6
+ data: import('vue').Ref<{
7
+ canvases?: {
8
+ readonly id: string;
9
+ name: string;
10
+ is_draft?: boolean | undefined;
11
+ is_template?: boolean | undefined;
12
+ is_section?: boolean | undefined;
13
+ is_editable?: boolean | undefined;
14
+ is_default?: boolean | undefined;
15
+ metadata?: Record<string, any> | undefined;
16
+ tags?: Array<string> | undefined;
17
+ start_at?: (string | null) | undefined;
18
+ expires_at?: (string | null) | undefined;
19
+ access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
20
+ thumbnail_url?: (string | null) | undefined;
21
+ readonly template: {
22
+ readonly id: string;
23
+ name: string;
24
+ };
25
+ readonly shared_link: {
26
+ readonly url: string;
27
+ short_url?: (string | null) | undefined;
28
+ };
29
+ account?: {
30
+ id: string;
31
+ name: string;
32
+ } | null | undefined;
33
+ folder_id?: (string | null) | undefined;
34
+ readonly owned_by: {
35
+ readonly id: number;
36
+ readonly name: string;
37
+ email?: string | undefined;
38
+ };
39
+ readonly created_at: string;
40
+ readonly created_by: {
41
+ readonly id: number;
42
+ readonly name: string;
43
+ email?: string | undefined;
44
+ };
45
+ readonly modified_at: string;
46
+ readonly modified_by: {
47
+ readonly id: number;
48
+ readonly name: string;
49
+ email?: string | undefined;
50
+ };
51
+ }[] | undefined;
52
+ canvasTemplates?: {
53
+ readonly id: string;
54
+ name: string;
55
+ is_draft?: boolean | undefined;
56
+ is_template?: boolean | undefined;
57
+ is_section?: boolean | undefined;
58
+ is_editable?: boolean | undefined;
59
+ is_default?: boolean | undefined;
60
+ metadata?: Record<string, any> | undefined;
61
+ tags?: Array<string> | undefined;
62
+ start_at?: (string | null) | undefined;
63
+ expires_at?: (string | null) | undefined;
64
+ access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
65
+ thumbnail_url?: (string | null) | undefined;
66
+ readonly template: {
67
+ readonly id: string;
68
+ name: string;
69
+ };
70
+ readonly shared_link: {
71
+ readonly url: string;
72
+ short_url?: (string | null) | undefined;
73
+ };
74
+ account?: {
75
+ id: string;
76
+ name: string;
77
+ } | null | undefined;
78
+ folder_id?: (string | null) | undefined;
79
+ readonly owned_by: {
80
+ readonly id: number;
81
+ readonly name: string;
82
+ email?: string | undefined;
83
+ };
84
+ readonly created_at: string;
85
+ readonly created_by: {
86
+ readonly id: number;
87
+ readonly name: string;
88
+ email?: string | undefined;
89
+ };
90
+ readonly modified_at: string;
91
+ readonly modified_by: {
92
+ readonly id: number;
93
+ readonly name: string;
94
+ email?: string | undefined;
95
+ };
96
+ }[] | undefined;
97
+ sections?: {
98
+ readonly id: string;
99
+ name: string;
100
+ is_draft?: boolean | undefined;
101
+ is_template?: boolean | undefined;
102
+ is_section?: boolean | undefined;
103
+ is_editable?: boolean | undefined;
104
+ is_default?: boolean | undefined;
105
+ metadata?: Record<string, any> | undefined;
106
+ tags?: Array<string> | undefined;
107
+ start_at?: (string | null) | undefined;
108
+ expires_at?: (string | null) | undefined;
109
+ access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
110
+ thumbnail_url?: (string | null) | undefined;
111
+ readonly template: {
112
+ readonly id: string;
113
+ name: string;
114
+ };
115
+ readonly shared_link: {
116
+ readonly url: string;
117
+ short_url?: (string | null) | undefined;
118
+ };
119
+ account?: {
120
+ id: string;
121
+ name: string;
122
+ } | null | undefined;
123
+ folder_id?: (string | null) | undefined;
124
+ readonly owned_by: {
125
+ readonly id: number;
126
+ readonly name: string;
127
+ email?: string | undefined;
128
+ };
129
+ readonly created_at: string;
130
+ readonly created_by: {
131
+ readonly id: number;
132
+ readonly name: string;
133
+ email?: string | undefined;
134
+ };
135
+ readonly modified_at: string;
136
+ readonly modified_by: {
137
+ readonly id: number;
138
+ readonly name: string;
139
+ email?: string | undefined;
140
+ };
141
+ }[] | undefined;
142
+ sectionTemplates?: {
143
+ readonly id: string;
144
+ name: string;
145
+ is_draft?: boolean | undefined;
146
+ is_template?: boolean | undefined;
147
+ is_section?: boolean | undefined;
148
+ is_editable?: boolean | undefined;
149
+ is_default?: boolean | undefined;
150
+ metadata?: Record<string, any> | undefined;
151
+ tags?: Array<string> | undefined;
152
+ start_at?: (string | null) | undefined;
153
+ expires_at?: (string | null) | undefined;
154
+ access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
155
+ thumbnail_url?: (string | null) | undefined;
156
+ readonly template: {
157
+ readonly id: string;
158
+ name: string;
159
+ };
160
+ readonly shared_link: {
161
+ readonly url: string;
162
+ short_url?: (string | null) | undefined;
163
+ };
164
+ account?: {
165
+ id: string;
166
+ name: string;
167
+ } | null | undefined;
168
+ folder_id?: (string | null) | undefined;
169
+ readonly owned_by: {
170
+ readonly id: number;
171
+ readonly name: string;
172
+ email?: string | undefined;
173
+ };
174
+ readonly created_at: string;
175
+ readonly created_by: {
176
+ readonly id: number;
177
+ readonly name: string;
178
+ email?: string | undefined;
179
+ };
180
+ readonly modified_at: string;
181
+ readonly modified_by: {
182
+ readonly id: number;
183
+ readonly name: string;
184
+ email?: string | undefined;
185
+ };
186
+ }[] | undefined;
187
+ } | null>;
188
+ selectedItems: import('vue').Ref<{
189
+ readonly id: string;
190
+ name: string;
191
+ is_draft?: boolean | undefined;
192
+ is_template?: boolean | undefined;
193
+ is_section?: boolean | undefined;
194
+ is_editable?: boolean | undefined;
195
+ is_default?: boolean | undefined;
196
+ metadata?: Record<string, any> | undefined;
197
+ tags?: Array<string> | undefined;
198
+ start_at?: (string | null) | undefined;
199
+ expires_at?: (string | null) | undefined;
200
+ access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
201
+ thumbnail_url?: (string | null) | undefined;
202
+ readonly template: {
203
+ readonly id: string;
204
+ name: string;
205
+ };
206
+ readonly shared_link: {
207
+ readonly url: string;
208
+ short_url?: (string | null) | undefined;
209
+ };
210
+ account?: {
211
+ id: string;
212
+ name: string;
213
+ } | null | undefined;
214
+ folder_id?: (string | null) | undefined;
215
+ readonly owned_by: {
216
+ readonly id: number;
217
+ readonly name: string;
218
+ email?: string | undefined;
219
+ };
220
+ readonly created_at: string;
221
+ readonly created_by: {
222
+ readonly id: number;
223
+ readonly name: string;
224
+ email?: string | undefined;
225
+ };
226
+ readonly modified_at: string;
227
+ readonly modified_by: {
228
+ readonly id: number;
229
+ readonly name: string;
230
+ email?: string | undefined;
231
+ };
232
+ }[]>;
233
+ selectedCanvases: import('vue').ComputedRef<{
234
+ readonly id: string;
235
+ name: string;
236
+ is_draft?: boolean | undefined;
237
+ is_template?: boolean | undefined;
238
+ is_section?: boolean | undefined;
239
+ is_editable?: boolean | undefined;
240
+ is_default?: boolean | undefined;
241
+ metadata?: Record<string, any> | undefined;
242
+ tags?: Array<string> | undefined;
243
+ start_at?: (string | null) | undefined;
244
+ expires_at?: (string | null) | undefined;
245
+ access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
246
+ thumbnail_url?: (string | null) | undefined;
247
+ readonly template: {
248
+ readonly id: string;
249
+ name: string;
250
+ };
251
+ readonly shared_link: {
252
+ readonly url: string;
253
+ short_url?: (string | null) | undefined;
254
+ };
255
+ account?: {
256
+ id: string;
257
+ name: string;
258
+ } | null | undefined;
259
+ folder_id?: (string | null) | undefined;
260
+ readonly owned_by: {
261
+ readonly id: number;
262
+ readonly name: string;
263
+ email?: string | undefined;
264
+ };
265
+ readonly created_at: string;
266
+ readonly created_by: {
267
+ readonly id: number;
268
+ readonly name: string;
269
+ email?: string | undefined;
270
+ };
271
+ readonly modified_at: string;
272
+ readonly modified_by: {
273
+ readonly id: number;
274
+ readonly name: string;
275
+ email?: string | undefined;
276
+ };
277
+ }[]>;
278
+ selectedCanvasTemplates: import('vue').ComputedRef<{
279
+ readonly id: string;
280
+ name: string;
281
+ is_draft?: boolean | undefined;
282
+ is_template?: boolean | undefined;
283
+ is_section?: boolean | undefined;
284
+ is_editable?: boolean | undefined;
285
+ is_default?: boolean | undefined;
286
+ metadata?: Record<string, any> | undefined;
287
+ tags?: Array<string> | undefined;
288
+ start_at?: (string | null) | undefined;
289
+ expires_at?: (string | null) | undefined;
290
+ access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
291
+ thumbnail_url?: (string | null) | undefined;
292
+ readonly template: {
293
+ readonly id: string;
294
+ name: string;
295
+ };
296
+ readonly shared_link: {
297
+ readonly url: string;
298
+ short_url?: (string | null) | undefined;
299
+ };
300
+ account?: {
301
+ id: string;
302
+ name: string;
303
+ } | null | undefined;
304
+ folder_id?: (string | null) | undefined;
305
+ readonly owned_by: {
306
+ readonly id: number;
307
+ readonly name: string;
308
+ email?: string | undefined;
309
+ };
310
+ readonly created_at: string;
311
+ readonly created_by: {
312
+ readonly id: number;
313
+ readonly name: string;
314
+ email?: string | undefined;
315
+ };
316
+ readonly modified_at: string;
317
+ readonly modified_by: {
318
+ readonly id: number;
319
+ readonly name: string;
320
+ email?: string | undefined;
321
+ };
322
+ }[]>;
323
+ selectedSections: import('vue').ComputedRef<{
324
+ readonly id: string;
325
+ name: string;
326
+ is_draft?: boolean | undefined;
327
+ is_template?: boolean | undefined;
328
+ is_section?: boolean | undefined;
329
+ is_editable?: boolean | undefined;
330
+ is_default?: boolean | undefined;
331
+ metadata?: Record<string, any> | undefined;
332
+ tags?: Array<string> | undefined;
333
+ start_at?: (string | null) | undefined;
334
+ expires_at?: (string | null) | undefined;
335
+ access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
336
+ thumbnail_url?: (string | null) | undefined;
337
+ readonly template: {
338
+ readonly id: string;
339
+ name: string;
340
+ };
341
+ readonly shared_link: {
342
+ readonly url: string;
343
+ short_url?: (string | null) | undefined;
344
+ };
345
+ account?: {
346
+ id: string;
347
+ name: string;
348
+ } | null | undefined;
349
+ folder_id?: (string | null) | undefined;
350
+ readonly owned_by: {
351
+ readonly id: number;
352
+ readonly name: string;
353
+ email?: string | undefined;
354
+ };
355
+ readonly created_at: string;
356
+ readonly created_by: {
357
+ readonly id: number;
358
+ readonly name: string;
359
+ email?: string | undefined;
360
+ };
361
+ readonly modified_at: string;
362
+ readonly modified_by: {
363
+ readonly id: number;
364
+ readonly name: string;
365
+ email?: string | undefined;
366
+ };
367
+ }[]>;
368
+ selectedSectionTemplates: import('vue').ComputedRef<{
369
+ readonly id: string;
370
+ name: string;
371
+ is_draft?: boolean | undefined;
372
+ is_template?: boolean | undefined;
373
+ is_section?: boolean | undefined;
374
+ is_editable?: boolean | undefined;
375
+ is_default?: boolean | undefined;
376
+ metadata?: Record<string, any> | undefined;
377
+ tags?: Array<string> | undefined;
378
+ start_at?: (string | null) | undefined;
379
+ expires_at?: (string | null) | undefined;
380
+ access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
381
+ thumbnail_url?: (string | null) | undefined;
382
+ readonly template: {
383
+ readonly id: string;
384
+ name: string;
385
+ };
386
+ readonly shared_link: {
387
+ readonly url: string;
388
+ short_url?: (string | null) | undefined;
389
+ };
390
+ account?: {
391
+ id: string;
392
+ name: string;
393
+ } | null | undefined;
394
+ folder_id?: (string | null) | undefined;
395
+ readonly owned_by: {
396
+ readonly id: number;
397
+ readonly name: string;
398
+ email?: string | undefined;
399
+ };
400
+ readonly created_at: string;
401
+ readonly created_by: {
402
+ readonly id: number;
403
+ readonly name: string;
404
+ email?: string | undefined;
405
+ };
406
+ readonly modified_at: string;
407
+ readonly modified_by: {
408
+ readonly id: number;
409
+ readonly name: string;
410
+ email?: string | undefined;
411
+ };
412
+ }[]>;
413
+ cleanup: typeof cleanup;
414
+ };
415
+ export {};
@@ -25,6 +25,7 @@ export type AppProps = {
25
25
  appName: 'impact' | 'admin';
26
26
  allowedSelectorTypes?: SelectorType[];
27
27
  allowedContentTypes?: FileContentTypeEnum[];
28
+ allowedAssetContentTypes?: FileContentTypeEnum[];
28
29
  contentType: 'file' | 'slide' | 'content';
29
30
  onFolderFetch?: FolderItemsFetcher;
30
31
  onFileDelete?: FileDeleter;
@@ -1,5 +1,5 @@
1
1
  import { Ref, ComputedRef, UnwrapNestedRefs } from 'vue';
2
- import { FolderRetrieve, FolderFile, FileRetrieve, File } from '../../../../types/openapi';
2
+ import { FolderRetrieve, FolderFile, FileRetrieve, File, FolderFolder } from '../../../../types/openapi';
3
3
 
4
4
  export type SelectorType = 'content' | 'assets' | 'external_links';
5
5
  export type SelectedPage = {
@@ -9,12 +9,16 @@ export type SelectedPage = {
9
9
  name: File['name'];
10
10
  };
11
11
  page_index: number;
12
+ permissions?: File['permissions'];
12
13
  thumbnail_url?: string;
13
14
  type: 'page';
14
15
  };
15
16
  export type SelectedFile = FolderFile & {
16
17
  type: 'file';
17
18
  };
19
+ export type SelectedFolder = FolderFolder & {
20
+ type: 'folder';
21
+ };
18
22
  export type SelectedAsset = {
19
23
  id: File['id'];
20
24
  type: 'asset';
@@ -52,6 +56,7 @@ interface State {
52
56
  isFetchingFolderItems: Ref<boolean>;
53
57
  isFetchingFile: Ref<boolean>;
54
58
  }
59
+ declare function deselectAllFiles(f: SelectedFile[] | Pick<FolderFile, 'id'>[]): void;
55
60
  declare function deselectFile(f: SelectedFile | Pick<FolderFile, 'id'>): void;
56
61
  declare function deselectPage(p: SelectedPage): void;
57
62
  declare function deselectAsset(a: SelectedAsset): void;
@@ -61,6 +66,8 @@ export default function (): {
61
66
  setSelectedItems(items: ContentSelectorSelectedItem[]): void;
62
67
  setActiveSelectorType(s?: SelectorType): void;
63
68
  selectItem(i: ContentSelectorSelectedItem): void;
69
+ selectAllFiles(selection: SelectedFile[]): void;
70
+ deselectAllFiles: typeof deselectAllFiles;
64
71
  deselectFile: typeof deselectFile;
65
72
  deselectPage: typeof deselectPage;
66
73
  deselectAsset: typeof deselectAsset;
@@ -12,8 +12,7 @@ interface FileViewerActions {
12
12
  onCloseFile: () => void;
13
13
  onToggleFavoriteFilePage: (pageIndex: number) => void;
14
14
  }
15
- declare const _default: ({ videoPlayerEl, pdfViewerEl, bottomBarRef, i18n, appLocale, actions, filePagesFavorites, assetsPrefix, isFavoriteEnabled, clientType, context, }: {
16
- videoPlayerEl: Ref<HTMLVideoElement | null>;
15
+ declare const _default: ({ pdfViewerEl, bottomBarRef, i18n, appLocale, actions, filePagesFavorites, assetsPrefix, isFavoriteEnabled, clientType, context, }: {
17
16
  pdfViewerEl: Ref<HTMLElement | null>;
18
17
  bottomBarRef: Ref<InstanceType<typeof CFileViewerBottomPdf> | null>;
19
18
  filePagesFavorites: ComputedRef<Favorite[] | null>;
@@ -26,8 +25,7 @@ declare const _default: ({ videoPlayerEl, pdfViewerEl, bottomBarRef, i18n, appLo
26
25
  context?: Record<string, any>;
27
26
  }) => {
28
27
  viewPdf: (file: FileModel | CanvasFile | null, pageIndex: MiniPage["page_index"]) => Promise<void | Instance>;
29
- viewVideo: (file: FileModel | CanvasFile | null) => Promise<void>;
30
- onPdfFullScreen: () => void;
28
+ onPdfFullScreen: (forceEnter?: boolean) => Promise<void>;
31
29
  updateFileViewerSettings: (partialSettings: Partial<import('../../types/fileViewerSettings.types').FileViewerSettings>) => void;
32
30
  cleanupPspdfKit: () => void;
33
31
  isSearchOpen: Ref<boolean>;
@@ -11,6 +11,6 @@ declare const _default: ({ pdfViewerEl, bottomBarRef, instance, isThumbnailsOpen
11
11
  }) => {
12
12
  registerFullscreenChangeEvents: (callback: (event: Event) => void) => void;
13
13
  removeFullscreenChangeEvents: (callback: (event: Event) => void) => void;
14
- onFullScreen: () => void;
14
+ onFullScreen: (forceEnter?: boolean) => Promise<void>;
15
15
  };
16
16
  export default _default;