@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.
- package/js-api.esm.js +274 -92
- package/js-api.esm.js.map +1 -1
- package/js-api.umd.min.js +9 -9
- package/js-api.umd.min.js.map +1 -1
- package/lib/api/canvases/canvases.queries.d.ts +5 -5
- package/lib/apps/browser/stores/api.d.ts +215 -84
- package/lib/apps/browser/stores/app.d.ts +7 -26
- package/lib/apps/browser/stores/upload.d.ts +34 -24
- package/lib/apps/browser/util/file.d.ts +2 -2
- package/lib/apps/canvas-builder/composables/useCanvas.d.ts +550 -460
- package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +86 -74
- package/lib/apps/canvas-builder/composables/useCanvasHooks.d.ts +4 -4
- package/lib/apps/canvas-builder/composables/useCanvasPages.d.ts +3 -3
- package/lib/apps/canvas-builder/composables/useCanvasSectionOverrides.d.ts +3 -3
- package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +24 -17
- package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts +2 -2
- package/lib/apps/canvas-builder/composables/useCollapsibles.d.ts +3 -3
- package/lib/apps/canvas-builder/composables/useComponentPermissions.d.ts +2 -2
- package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +6 -4
- package/lib/apps/canvas-builder/composables/useInstalledEmbeddables.d.ts +4 -1
- package/lib/apps/canvas-builder/composables/useRecommendations.d.ts +4 -4
- package/lib/apps/canvas-builder/composables/useSectionPopularity.d.ts +2 -2
- package/lib/apps/canvas-builder/types/canvas.d.ts +19 -18
- package/lib/apps/canvas-builder/types/recommendations.types.d.ts +3 -3
- package/lib/apps/canvas-builder/util/canvas.util.d.ts +5 -4
- package/lib/apps/content-selector/appTypes.d.ts +1 -0
- package/lib/apps/content-selector/stores/app.d.ts +8 -1
- package/lib/components/CFileViewer/CFileViewer.use.d.ts +2 -4
- package/lib/components/CFileViewer/CFileViewerFullScreen.use.d.ts +1 -1
- package/lib/components/canvases/CanvasesManagementBulk.use.d.ts +5 -5
- package/lib/components/filters/filter.util.d.ts +1 -1
- package/lib/components/savedCanvases/CSavedCanvasesManagementShareCanvas.use.d.ts +2 -2
- package/lib/composables/instanceTagsActions.use.d.ts +14 -0
- package/lib/composables/recentFiles.use.d.ts +1 -1
- package/lib/composables/suggestedTags.use.d.ts +3 -0
- package/lib/composables/tableColumnsSettings.use.d.ts +25 -0
- package/lib/composables/useCanvasOverlay.d.ts +20 -0
- package/lib/composables/useConfirmation.d.ts +1 -0
- package/lib/composables/useElementHeightResize.d.ts +5 -0
- package/lib/composables/useFiles.d.ts +11 -0
- package/lib/constants/pitcherSettings.const.d.ts +4 -0
- package/lib/main.lib.d.ts +27 -20
- package/lib/sdk/api/HighLevelApi.d.ts +106 -12
- package/lib/sdk/api/modules/admin/canvas.admin.d.ts +31 -15
- package/lib/sdk/api/modules/admin/env.admin.d.ts +3 -2
- package/lib/sdk/api/modules/admin/files.admin.d.ts +43 -4
- package/lib/sdk/api/modules/admin/index.d.ts +52 -5
- package/lib/sdk/api/modules/admin/metadataTemplates.admin.d.ts +1 -2
- package/lib/sdk/api/modules/admin/types.admin.d.ts +117 -3
- package/lib/sdk/api/modules/canvas.d.ts +12 -14
- package/lib/sdk/api/modules/dsr/env.dsr.d.ts +4 -3
- package/lib/sdk/api/modules/dsr/index.d.ts +14 -3
- package/lib/sdk/api/modules/dsr/loading.dsr.d.ts +6 -0
- package/lib/sdk/api/modules/env.d.ts +16 -0
- package/lib/sdk/api/modules/favorites.d.ts +9 -0
- package/lib/sdk/api/modules/feedback.d.ts +3 -0
- package/lib/sdk/api/modules/files.d.ts +3 -3
- package/lib/sdk/api/modules/folders.d.ts +29 -0
- package/lib/sdk/api/modules/open.d.ts +6 -0
- package/lib/sdk/api/modules/sync.d.ts +1 -2
- package/lib/sdk/api/modules/ui/app-errors.ui.d.ts +12 -0
- package/lib/sdk/api/modules/ui/canvas.ui.d.ts +75 -2
- package/lib/sdk/api/modules/ui/content.ui.d.ts +50 -0
- package/lib/sdk/api/modules/ui/index.d.ts +149 -13
- package/lib/sdk/api/modules/ui/loading.ui.d.ts +15 -0
- package/lib/sdk/api/modules/ui/location.ui.d.ts +17 -0
- package/lib/sdk/api/modules/ui/post-call.ui.d.ts +25 -0
- package/lib/sdk/api/modules/ui/types.ui.d.ts +69 -6
- package/lib/sdk/api/modules/users.d.ts +4 -0
- package/lib/sdk/interfaces.d.ts +119 -2
- package/lib/sdk/main.d.ts +275 -141
- package/lib/sdk/payload.types.d.ts +134 -2
- package/lib/theme/light.d.ts +12 -0
- package/lib/types/app.d.ts +11 -0
- package/lib/types/call.d.ts +2 -2
- package/lib/types/files.d.ts +27 -1
- package/lib/types/filter.d.ts +5 -0
- package/lib/types/instanceSettings.types.d.ts +8 -2
- package/lib/types/launchDarkly.types.d.ts +4 -4
- package/lib/types/organizationSettings.types.d.ts +4 -0
- package/lib/types/recentFiles.types.d.ts +4 -1
- package/lib/types/users.d.ts +13 -0
- package/lib/util/fullscreen.util.d.ts +1 -1
- package/lib/util/string.d.ts +1 -0
- package/package.json +1 -1
- package/types/openapi/index.d.ts +23 -17
- package/types/openapi/models/AccessTypeEnum.d.ts +3 -1
- package/types/openapi/models/App.d.ts +1 -0
- package/types/openapi/models/AppRelease.d.ts +1 -0
- package/types/openapi/models/AppsDBEntry.d.ts +4 -0
- package/types/openapi/models/AppsDBEntryRequest.d.ts +3 -0
- package/types/openapi/models/Canvas.d.ts +10 -15
- package/types/openapi/models/CanvasCreate.d.ts +14 -12
- package/types/openapi/models/CanvasCreateRequest.d.ts +6 -5
- package/types/openapi/models/CanvasRecommendedFile.d.ts +6 -0
- package/types/openapi/models/CanvasRetrieve.d.ts +15 -13
- package/types/openapi/models/CanvasSection.d.ts +5 -2
- package/types/openapi/models/CanvasUpdate.d.ts +14 -12
- package/types/openapi/models/CanvasUpdateRequest.d.ts +5 -4
- package/types/openapi/models/CollaborationRoleEnum.d.ts +0 -4
- package/types/openapi/models/ContentDistributionGroupCreate.d.ts +1 -0
- package/types/openapi/models/DeletedApp.d.ts +1 -0
- package/types/openapi/models/{CanvasList.d.ts → DeletedCanvas.d.ts} +13 -9
- package/types/openapi/models/DeletedContentDistributionGroup.d.ts +1 -0
- package/types/openapi/models/DeletedEnvironment.d.ts +1 -0
- package/types/openapi/models/DeletedFavorite.d.ts +1 -0
- package/types/openapi/models/DeletedFile.d.ts +6 -0
- package/types/openapi/models/DeletedFolder.d.ts +4 -3
- package/types/openapi/models/DeletedInstance.d.ts +1 -0
- package/types/openapi/models/DeletedInstanceAssignmentGroup.d.ts +1 -0
- package/types/openapi/models/DeletedMetadataTemplate.d.ts +1 -0
- package/types/openapi/models/DeletedRegion.d.ts +1 -0
- package/types/openapi/models/Environment.d.ts +1 -0
- package/types/openapi/models/Favorite.d.ts +1 -0
- package/types/openapi/models/File.d.ts +6 -0
- package/types/openapi/models/FileCreate.d.ts +8 -0
- package/types/openapi/models/FileCreateRequest.d.ts +3 -0
- package/types/openapi/models/FilePermission.d.ts +4 -0
- package/types/openapi/models/FilePermissionRequest.d.ts +4 -0
- package/types/openapi/models/FileRetrieve.d.ts +8 -0
- package/types/openapi/models/FileRevision.d.ts +8 -0
- package/types/openapi/models/FileRevisionRequest.d.ts +3 -0
- package/types/openapi/models/FileUpdate.d.ts +8 -0
- package/types/openapi/models/FileUpdateRequest.d.ts +3 -0
- package/types/openapi/models/FileVersion.d.ts +5 -0
- package/types/openapi/models/Folder.d.ts +4 -3
- package/types/openapi/models/FolderCanvas.d.ts +11 -0
- package/types/openapi/models/FolderCreate.d.ts +8 -7
- package/types/openapi/models/FolderCreateRequest.d.ts +4 -2
- package/types/openapi/models/FolderFile.d.ts +3 -0
- package/types/openapi/models/FolderFolder.d.ts +5 -1
- package/types/openapi/models/FolderRetrieve.d.ts +8 -8
- package/types/openapi/models/FolderRule.d.ts +7 -0
- package/types/openapi/models/FolderRuleRequest.d.ts +7 -0
- package/types/openapi/models/FolderUpdate.d.ts +8 -8
- package/types/openapi/models/FolderUpdateRequest.d.ts +3 -0
- package/types/openapi/models/Instance.d.ts +1 -0
- package/types/openapi/models/InstanceUpdate.d.ts +1 -0
- package/types/openapi/models/MetadataTemplate.d.ts +1 -0
- package/types/openapi/models/OfflineSyncFolder.d.ts +17 -0
- package/types/openapi/models/OperatorEnum.d.ts +64 -0
- package/types/openapi/models/PaginatedCanvasList.d.ts +8 -0
- package/types/openapi/models/PaginatedFileRevisionList.d.ts +8 -0
- package/types/openapi/models/PaginatedOfflineSyncFolderList.d.ts +8 -0
- package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +5 -4
- package/types/openapi/models/PatchedFileRequest.d.ts +3 -0
- package/types/openapi/models/PatchedFileRevisionRequest.d.ts +3 -0
- package/types/openapi/models/PatchedFileUpdateRequest.d.ts +3 -0
- package/types/openapi/models/PatchedFolderUpdateRequest.d.ts +3 -0
- package/types/openapi/models/Region.d.ts +1 -0
- package/types/openapi/models/SearchFile.d.ts +3 -0
- package/types/openapi/models/SharedLink.d.ts +6 -5
- package/types/openapi/models/SharedLinkCanvas.d.ts +11 -0
- package/types/openapi/models/SharedLinkCanvasRequest.d.ts +8 -0
- package/types/openapi/models/SharedLinkCreate.d.ts +6 -5
- package/types/openapi/models/{SharedLinkInstanceSerialzier.d.ts → SharedLinkInstance.d.ts} +1 -1
- package/types/openapi/models/SharedLinkInstanceRequest.d.ts +5 -0
- package/types/openapi/models/{SharedLinkOrganizationSerialzier.d.ts → SharedLinkOrganization.d.ts} +1 -1
- package/types/openapi/models/SharedLinkOrganizationRequest.d.ts +6 -0
- package/lib/apps/canvas-builder/util/tsUtils.d.ts +0 -3
- package/lib/composables/useDetailsView.d.ts +0 -19
- package/lib/types/templateActions.d.ts +0 -10
- package/lib/util/gesture.util.d.ts +0 -6
- package/types/openapi/models/AppsDBGlobalEntry.d.ts +0 -8
- package/types/openapi/models/AppsDBGlobalEntryRequest.d.ts +0 -3
- package/types/openapi/models/AppsDBUserEntry.d.ts +0 -9
- package/types/openapi/models/AppsDBUserEntryRequest.d.ts +0 -3
- package/types/openapi/models/CanvasSectionRetrieve.d.ts +0 -7
- package/types/openapi/models/CanvasSectionRetrieveRequest.d.ts +0 -5
- package/types/openapi/models/FileRequest.d.ts +0 -13
- package/types/openapi/models/InstanceStorageCredentials.d.ts +0 -6
- package/types/openapi/models/MiniAccount.d.ts +0 -4
- package/types/openapi/models/PSPDFKitAuthPayload.d.ts +0 -3
- package/types/openapi/models/PSPDFKitAuthPayloadRequest.d.ts +0 -3
- package/types/openapi/models/PSPDFKitToken.d.ts +0 -7
- package/types/openapi/models/PSPDFKitTokenRequest.d.ts +0 -3
- 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 {
|
|
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:
|
|
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:
|
|
368
|
+
activeCanvas: CanvasRetrieve;
|
|
368
369
|
templates?: never;
|
|
369
370
|
onExit: () => void;
|
|
370
371
|
onSave?: never;
|
|
371
372
|
onEnter?: () => void;
|
|
372
|
-
onComponentEnter?: (data: ComponentNode |
|
|
373
|
-
onComponentExit?: (data: ComponentNode |
|
|
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:
|
|
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:
|
|
421
|
+
activeCanvas: CanvasRetrieve;
|
|
421
422
|
templates: {
|
|
422
|
-
label:
|
|
423
|
-
value:
|
|
423
|
+
label: CanvasRetrieve['name'];
|
|
424
|
+
value: CanvasRetrieve['id'];
|
|
424
425
|
}[];
|
|
425
426
|
onExit: () => void;
|
|
426
427
|
onEnter?: () => void;
|
|
427
|
-
onComponentEnter?: (data: ComponentNode |
|
|
428
|
-
onComponentExit?: (data: ComponentNode |
|
|
429
|
-
onSave: (canvasId:
|
|
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<
|
|
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<
|
|
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:
|
|
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:
|
|
448
|
+
onTrackShare?: (canvasId: CanvasRetrieve['id']) => Promise<void>;
|
|
448
449
|
onOpenExternalUrl: (payload: OpenExternalUrlRequestPayload) => Promise<void>;
|
|
449
|
-
share?: (canvasId:
|
|
450
|
+
share?: (canvasId: CanvasRetrieve['id']) => Promise<SharedLink>;
|
|
450
451
|
isCRM: boolean;
|
|
451
452
|
onDownloadFile?: (file: File | ContentGridFileProps | ContentGridCommonFileProps) => Promise<void>;
|
|
452
|
-
onDownloadCanvas?: (canvas:
|
|
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 {
|
|
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:
|
|
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:
|
|
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 {
|
|
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
|
|
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?:
|
|
36
|
+
export declare function isTextComponentEmpty(component: ComponentNode, overrides?: SectionComponentOverrides, sectionId?: CanvasRetrieve['id']): boolean;
|
|
36
37
|
type FoundComponent = {
|
|
37
|
-
sectionId?:
|
|
38
|
+
sectionId?: CanvasRetrieve['id'];
|
|
38
39
|
sectionListId?: ComponentNode['id'];
|
|
39
40
|
componentId: ComponentNode['id'];
|
|
40
41
|
} | null;
|
|
@@ -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: ({
|
|
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
|
-
|
|
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;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Ref, ComputedRef } from 'vue';
|
|
2
2
|
import { GetInstanceMetadataTemplatesPayload } from '../../sdk/payload.types';
|
|
3
3
|
import { CanvasType } from '../../types/canvases';
|
|
4
|
-
import { PaginatedMetadataTemplateList,
|
|
4
|
+
import { PaginatedMetadataTemplateList, CanvasRetrieve } from '../../../types/openapi';
|
|
5
5
|
|
|
6
6
|
interface BaseBulkProps {
|
|
7
7
|
selectedRows: Ref<Record<string, boolean>>;
|
|
@@ -18,17 +18,17 @@ interface BulkUpdateMetadataDialogProps extends BaseBulkProps {
|
|
|
18
18
|
canvasType: Extract<CanvasType, 'canvas' | 'section'>;
|
|
19
19
|
}
|
|
20
20
|
interface BulkDeleteDialogProps extends BaseBulkProps {
|
|
21
|
-
filteredData: ComputedRef<
|
|
21
|
+
filteredData: ComputedRef<CanvasRetrieve[]>;
|
|
22
22
|
isBulkDeleting: Ref<boolean>;
|
|
23
23
|
canvasType: CanvasType;
|
|
24
|
-
isReadonly?: (canvas:
|
|
24
|
+
isReadonly?: (canvas: CanvasRetrieve) => boolean;
|
|
25
25
|
content?: string;
|
|
26
26
|
}
|
|
27
27
|
interface BulkTagsProps extends BaseBulkProps {
|
|
28
|
-
filteredData: ComputedRef<
|
|
28
|
+
filteredData: ComputedRef<CanvasRetrieve[]>;
|
|
29
29
|
isBulkUpdating: Ref<boolean>;
|
|
30
30
|
canvasType: CanvasType;
|
|
31
|
-
isReadonly?: (canvas:
|
|
31
|
+
isReadonly?: (canvas: CanvasRetrieve) => boolean;
|
|
32
32
|
content?: string;
|
|
33
33
|
}
|
|
34
34
|
export default function useCanvasesManagementBulk(): {
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export declare function normalizeFilterParams(params: Record<string, any>): Record<string, any>;
|
|
2
|
-
export declare function normalizeNetworkFilterParams(params
|
|
2
|
+
export declare function normalizeNetworkFilterParams(params?: Record<string, any> | null): Record<string, any>;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { CanvasRetrieve, Canvas, SharedLink } from '../../../types/openapi';
|
|
2
2
|
|
|
3
3
|
export type SharingHandler = (canvasId: string) => Promise<SharedLink>;
|
|
4
4
|
declare const _default: (sharingHandler: SharingHandler, options?: {
|
|
5
5
|
useShortUrl?: boolean;
|
|
6
6
|
}) => {
|
|
7
|
-
copySharingUrlToClipboard: (canvas:
|
|
7
|
+
copySharingUrlToClipboard: (canvas: CanvasRetrieve | Canvas) => Promise<void>;
|
|
8
8
|
};
|
|
9
9
|
export default _default;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { Tag, Instance } from '../../types/openapi';
|
|
2
|
+
|
|
3
|
+
export default function useInstanceTagsActions(): {
|
|
4
|
+
fetchInstanceTags: ({ search, instanceId, page, pageSize, }: {
|
|
5
|
+
search: string;
|
|
6
|
+
instanceId?: Instance["id"];
|
|
7
|
+
page?: number;
|
|
8
|
+
pageSize?: number;
|
|
9
|
+
}) => Promise<Tag[]>;
|
|
10
|
+
fetchAllInstanceTags: ({ search, instanceId }: {
|
|
11
|
+
search?: string;
|
|
12
|
+
instanceId?: Instance["id"];
|
|
13
|
+
}) => Promise<Tag[]>;
|
|
14
|
+
};
|
|
@@ -8,5 +8,5 @@ export default function useRecentFiles({ instanceId, app, }: {
|
|
|
8
8
|
}): {
|
|
9
9
|
addRecentFile: (file: RecentFile) => void;
|
|
10
10
|
instanceRecentFiles: ComputedRef<RecentFile[]>;
|
|
11
|
-
updateRecentFiles: (files:
|
|
11
|
+
updateRecentFiles: (files: Partial<RecentFile>[]) => void;
|
|
12
12
|
};
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { ColumnDef } from '@tanstack/vue-table';
|
|
2
|
+
import { ComputedRef } from 'vue';
|
|
3
|
+
import { TableColumnSetting } from '../components/CTableColumnsSettings/CTableColumnsSettings.vue';
|
|
4
|
+
|
|
5
|
+
export type TableSettings = {
|
|
6
|
+
columns: {
|
|
7
|
+
[key: string]: {
|
|
8
|
+
visible: boolean;
|
|
9
|
+
order: number;
|
|
10
|
+
};
|
|
11
|
+
};
|
|
12
|
+
};
|
|
13
|
+
export declare function useTableColumnsSettings(tableSettingsKey: string, columns: ColumnDef<Record<string, any>, any>[], excludeColumnIds?: string[]): {
|
|
14
|
+
tableColumnsSettings: ComputedRef<TableColumnSetting[]>;
|
|
15
|
+
columnsFromSettings: ComputedRef<ColumnDef<Record<string, any>, any>[]>;
|
|
16
|
+
onColumnsMove: ({ targetItemId, itemId }: {
|
|
17
|
+
targetItemId: string;
|
|
18
|
+
itemId: string;
|
|
19
|
+
}) => void;
|
|
20
|
+
onColumnsSelect: ({ id, checked }: {
|
|
21
|
+
id: string;
|
|
22
|
+
checked: boolean;
|
|
23
|
+
}) => void;
|
|
24
|
+
restoreColumns: () => void;
|
|
25
|
+
};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
interface CanvasOverlay {
|
|
2
|
+
id: string;
|
|
3
|
+
fullscreen?: boolean;
|
|
4
|
+
edit_mode?: boolean;
|
|
5
|
+
component_id?: string;
|
|
6
|
+
section_id?: string;
|
|
7
|
+
}
|
|
8
|
+
declare const _default: () => {
|
|
9
|
+
isCanvasOverlayOpen: import('vue').ComputedRef<boolean>;
|
|
10
|
+
initialCanvas: import('vue').ComputedRef<{
|
|
11
|
+
id: string;
|
|
12
|
+
fullscreen?: boolean | undefined;
|
|
13
|
+
edit_mode?: boolean | undefined;
|
|
14
|
+
component_id?: string | undefined;
|
|
15
|
+
section_id?: string | undefined;
|
|
16
|
+
} | undefined>;
|
|
17
|
+
openCanvasOverlay: ({ id, fullscreen, edit_mode, component_id, section_id }: CanvasOverlay) => void;
|
|
18
|
+
closeCanvasOverlay: () => void;
|
|
19
|
+
};
|
|
20
|
+
export default _default;
|
|
@@ -18,6 +18,7 @@ declare const _default: () => {
|
|
|
18
18
|
create: (options: ConfirmationOptions) => import('naive-ui').DialogReactive;
|
|
19
19
|
warning: (options: ConfirmationOptions) => import('naive-ui').DialogReactive;
|
|
20
20
|
error: (options: ConfirmationOptions) => import('naive-ui').DialogReactive;
|
|
21
|
+
danger: (options: ConfirmationOptions) => import('naive-ui').DialogReactive;
|
|
21
22
|
info: (options: ConfirmationOptions) => import('naive-ui').DialogReactive;
|
|
22
23
|
};
|
|
23
24
|
export default _default;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { ViewCompactFolder } from '../types/files';
|
|
2
|
+
import { FileContentTypeEnum } from '../../types/openapi';
|
|
3
|
+
|
|
4
|
+
export declare function renderContentType(contentType: FileContentTypeEnum): import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
|
|
5
|
+
[key: string]: any;
|
|
6
|
+
}>;
|
|
7
|
+
export declare function getFolderDescription(item: Partial<ViewCompactFolder>): string;
|
|
8
|
+
export default function useFiles(): {
|
|
9
|
+
getFolderDescription: typeof getFolderDescription;
|
|
10
|
+
renderContentType: typeof renderContentType;
|
|
11
|
+
};
|
package/lib/main.lib.d.ts
CHANGED
|
@@ -18,6 +18,7 @@ export { default as CDrawer } from './components/CDrawer/CDrawer.vue';
|
|
|
18
18
|
export { default as CDrawerContent } from './components/CDrawerContent/CDrawerContent.vue';
|
|
19
19
|
export { default as CDropdown } from './components/CDropdown/CDropdown.vue';
|
|
20
20
|
export { default as CErrorFullScreen } from './components/CError/CErrorFullScreen.vue';
|
|
21
|
+
export { default as CFileThumbnail } from './components/CFileThumbnail/CFileThumbnail.vue';
|
|
21
22
|
export { default as CIcon, type Props as CIconProps } from './components/CIcon/CIcon.vue';
|
|
22
23
|
export { default as CImage } from './components/CImage/CImage.vue';
|
|
23
24
|
export { default as CInput } from './components/CInput/CInput.vue';
|
|
@@ -88,6 +89,8 @@ export { default as CMovableWidget } from './components/CMovableWidget/CMovableW
|
|
|
88
89
|
export { default as CUserMenu } from './components/CUserMenu/CUserMenu.vue';
|
|
89
90
|
export { default as CList } from './components/CList/CList.vue';
|
|
90
91
|
export { default as CKnockNotificationsAppWrapper } from './components/CKnockNotificationsAppWrapper/CKnockNotificationsAppWrapper.vue';
|
|
92
|
+
export { default as CChip } from './components/CChip/CChip.vue';
|
|
93
|
+
export { default as CSettingsEditor } from './components/CSettingsEditor/CSettingsEditor.vue';
|
|
91
94
|
export { default as CanvasBuilderApp } from '@canvas-builder/App.vue';
|
|
92
95
|
export { type CanvasBuilderProps, CanvasBuilderMode } from '@canvas-builder/types/canvas';
|
|
93
96
|
export { default as Browser } from '@browser/App.vue';
|
|
@@ -99,44 +102,46 @@ export { default as useNotesApp } from '@notes/composables/useNotesApp';
|
|
|
99
102
|
export { default as useTheme } from './composables/useTheme';
|
|
100
103
|
export { default as useThemeVars } from './composables/useThemeVars';
|
|
101
104
|
export { default as useBindValidation } from './composables/useBindValidation';
|
|
105
|
+
export { default as useCanvasOverlay } from './composables/useCanvasOverlay';
|
|
102
106
|
export { default as useInfiniteScroll } from './composables/useInfiniteScroll';
|
|
103
107
|
export { default as useWindowEvents } from './composables/useWindowEvents';
|
|
104
|
-
export { default as useDetailsView } from './composables/useDetailsView';
|
|
105
108
|
export { default as useConfirmation } from './composables/useConfirmation';
|
|
106
109
|
export { default as useLocation } from './composables/useLocation';
|
|
107
110
|
export { default as useRecentFiles } from './composables/recentFiles.use';
|
|
108
111
|
export { default as useToast } from './composables/useToast';
|
|
112
|
+
export { default as useSuggestedTags } from './composables/suggestedTags.use';
|
|
109
113
|
export * from './plugins/vueQuery';
|
|
114
|
+
export * from './apps/canvas-builder/util/canvas.util';
|
|
115
|
+
export * from './apps/canvas-builder/util/tree';
|
|
116
|
+
export * from './components/filters/filter.util';
|
|
117
|
+
export * from './util/anchor';
|
|
110
118
|
export * from './util/array';
|
|
111
|
-
export * from './util/object';
|
|
112
|
-
export * from './util/userAgents';
|
|
113
|
-
export * from './util/image';
|
|
114
119
|
export * from './util/casing';
|
|
115
|
-
export * from './util/query';
|
|
116
|
-
export * from './util/reactive';
|
|
117
|
-
export * from './util/date';
|
|
118
|
-
export * from './util/number';
|
|
119
|
-
export * from './util/network';
|
|
120
|
-
export * from './util/tsHelpers';
|
|
121
120
|
export * from './util/color';
|
|
122
|
-
export * from './util/
|
|
121
|
+
export * from './util/date';
|
|
122
|
+
export * from './util/dev.util';
|
|
123
123
|
export * from './util/dom';
|
|
124
|
-
export * from './util/anchor';
|
|
125
|
-
export * from './util/translations';
|
|
126
|
-
export * from './util/message-event';
|
|
127
124
|
export * from './util/font.util';
|
|
128
|
-
export * from './util/timer';
|
|
129
|
-
export * from './components/filters/filter.util';
|
|
130
|
-
export * from './apps/canvas-builder/util/tree';
|
|
131
|
-
export * from './apps/canvas-builder/util/canvas.util';
|
|
132
|
-
export * from './util/navigation.util';
|
|
133
125
|
export * from './util/fullscreen.util';
|
|
126
|
+
export * from './util/image';
|
|
134
127
|
export * from './util/location.util';
|
|
135
|
-
export * from './util/
|
|
128
|
+
export * from './util/message-event';
|
|
129
|
+
export * from './util/navigation.util';
|
|
130
|
+
export * from './util/network';
|
|
131
|
+
export * from './util/number';
|
|
132
|
+
export * from './util/object';
|
|
133
|
+
export * from './util/query';
|
|
134
|
+
export * from './util/reactive';
|
|
135
|
+
export * from './util/timer';
|
|
136
|
+
export * from './util/translations';
|
|
137
|
+
export * from './util/tsHelpers';
|
|
138
|
+
export * from './util/user';
|
|
139
|
+
export * from './util/userAgents';
|
|
136
140
|
export * from './sdk/main';
|
|
137
141
|
export * from '../types/openapi';
|
|
138
142
|
export * from './components/CGlobalSearch/CGlobalSearch.types';
|
|
139
143
|
export * from './types/dataTable';
|
|
144
|
+
export * from './types/filter';
|
|
140
145
|
export * from './types/sfdc';
|
|
141
146
|
export * from './types/ts';
|
|
142
147
|
export * from './types/paginatedData';
|
|
@@ -158,6 +163,7 @@ export * from './types/call';
|
|
|
158
163
|
export * from './types/launchDarkly.types';
|
|
159
164
|
export * from './types/toast';
|
|
160
165
|
export * from './types/instanceSettings.types';
|
|
166
|
+
export * from './types/organizationSettings.types';
|
|
161
167
|
export * from './components/CConfigEditor/CConfigEditor.types';
|
|
162
168
|
export * from './constants/cdp.const';
|
|
163
169
|
export * from './constants/uploads.const';
|
|
@@ -166,6 +172,7 @@ export * from './constants/timers.const';
|
|
|
166
172
|
export * from './constants/url.const';
|
|
167
173
|
export * from './constants/conventions.const';
|
|
168
174
|
export * from './constants/config.const';
|
|
175
|
+
export * from './constants/pitcherSettings.const';
|
|
169
176
|
export * from './api/events/events.queries';
|
|
170
177
|
export * from './api/users/users.queries';
|
|
171
178
|
export * from './api/canvases/canvases.queries';
|