@pitcher/js-api 1.22.0 → 1.23.0-rc.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 (87) hide show
  1. package/js-api.esm.js +52 -43
  2. package/js-api.esm.js.map +1 -1
  3. package/js-api.umd.min.js +9 -9
  4. package/js-api.umd.min.js.map +1 -1
  5. package/lib/apps/browser/stores/api.d.ts +0 -12
  6. package/lib/apps/canvas-builder/App.vue.d.ts +256 -177
  7. package/lib/apps/canvas-builder/components/container/EditableComponent/EditableComponentActionToolbar.vue.d.ts +0 -2
  8. package/lib/apps/canvas-builder/components/ui/Block/Block.vue.d.ts +11 -0
  9. package/lib/apps/canvas-builder/components/ui/CollectionPlayer/composables/tracking.use.d.ts +4 -0
  10. package/lib/apps/canvas-builder/components/ui/CollectionPlayer/utils/type.util.d.ts +4 -4
  11. package/lib/apps/canvas-builder/components/ui/SectionList/Execution/SectionListExecution.vue.d.ts +10 -0
  12. package/lib/apps/canvas-builder/components/ui/SectionList/SectionSelectorItem.vue.d.ts +3 -0
  13. package/lib/apps/canvas-builder/components/ui/SectionList/SectionSelectorToolbar.vue.d.ts +2 -2
  14. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +570 -0
  15. package/lib/apps/canvas-builder/composables/useCanvasBlocks.d.ts +837 -0
  16. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +126 -0
  17. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +9 -5
  18. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +23 -4
  19. package/lib/apps/canvas-builder/types/canvas.d.ts +40 -4
  20. package/lib/apps/canvas-builder/util/canvas.util.d.ts +6 -2
  21. package/lib/apps/canvas-selector/stores/app.d.ts +14 -0
  22. package/lib/apps/content-selector/appTypes.d.ts +2 -0
  23. package/lib/apps/content-selector/stores/app.d.ts +1 -0
  24. package/lib/components/CApexChart/CApexChartLine.vue.d.ts +7 -3
  25. package/lib/components/CConfigEditor/CConfigEditor.validators.d.ts +3 -1
  26. package/lib/components/CConfigEditor/CConfigEditor.vue.d.ts +3 -0
  27. package/lib/components/{CCreateTemplateOrSectionModal/CCreateTemplateOrSectionModal.vue.d.ts → CCreateTemplateSectionBlockModal/CCreateTemplateSectionBlockModal.vue.d.ts} +2 -1
  28. package/lib/components/CFilePanel/CFilePanel.use.d.ts +12 -0
  29. package/lib/components/CFilePanel/CFilePanel.vue.d.ts +14 -0
  30. package/lib/components/CFileViewer/CFileViewer.vue.d.ts +196 -6
  31. package/lib/components/CFileViewer/CFileViewerTop.vue.d.ts +6 -4
  32. package/lib/components/CFileViewer/pdf/CFileViewer.pageThumbMetadata.pdf.use.d.ts +8 -0
  33. package/lib/components/CFileViewer/pdf/CFileViewer.pdf.annotations.use.d.ts +2 -0
  34. package/lib/components/CFileViewer/pdf/CFileViewer.pdf.use.d.ts +4 -2
  35. package/lib/components/CFileViewer/pdf/CFileViewerBottom.pdf.vue.d.ts +5 -4
  36. package/lib/components/CFileViewer/pdf/CFileViewerCopyPagesMetadata.pdf.vue.d.ts +13 -0
  37. package/lib/components/CFileViewer/pdf/CFileViewerPageDrawer.pdf.vue.d.ts +26 -0
  38. package/lib/components/CFileViewer/pdf/CFileViewerPageDrawerSelectPage.vue.d.ts +15 -0
  39. package/lib/components/CInfoBadge/CInfoBadge.vue.d.ts +5 -2
  40. package/lib/components/CJsonEditor/CJsonEditor.vue.d.ts +5 -1
  41. package/lib/components/CRichTextEditor/components/CContentLinkToolbar.vue.d.ts +10 -0
  42. package/lib/components/CRichTextEditor/components/CInsertDropdown.vue.d.ts +2 -0
  43. package/lib/components/CRichTextEditor/extensions/contentLink.d.ts +22 -0
  44. package/lib/components/CSingleFileSelector/CSingleFileSelector.vue.d.ts +28 -0
  45. package/lib/components/CTableInput/CTableInput.vue.d.ts +2 -0
  46. package/lib/components/CTags/CTags.vue.d.ts +1 -0
  47. package/lib/components/CVideo/CVideo.types.d.ts +7 -0
  48. package/lib/components/CVideo/CVideo.vue.d.ts +3 -7
  49. package/lib/components/canvas-blocks/CBlockManagement.vue.d.ts +253 -0
  50. package/lib/components/canvas-blocks/CBlockManagementActionsCell.vue.d.ts +32 -0
  51. package/lib/components/canvas-blocks/CBlockManagementToolbar.vue.d.ts +60 -0
  52. package/lib/components/canvas-templates/CTemplateManagement.vue.d.ts +2 -2
  53. package/lib/components/savedCanvases/CSavedCanvasesManagementIndicatorsCell.vue.d.ts +7 -0
  54. package/lib/components/savedCanvases/smartFolders/SmartFolders.use.d.ts +4 -0
  55. package/lib/constants/cdp.const.d.ts +1 -0
  56. package/lib/main.lib.d.ts +4 -1
  57. package/lib/sdk/api/HighLevelApi.d.ts +5 -0
  58. package/lib/sdk/api/modules/canvas.d.ts +26 -1
  59. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +10 -0
  60. package/lib/sdk/api/modules/ui/index.d.ts +1 -0
  61. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +1 -1
  62. package/lib/sdk/api/modules/ui/types.ui.d.ts +1 -0
  63. package/lib/sdk/main.d.ts +18 -0
  64. package/lib/types/app.d.ts +1 -1
  65. package/lib/types/canvases.d.ts +9 -1
  66. package/lib/types/file.types.d.ts +15 -0
  67. package/lib/types/launchDarkly.types.d.ts +3 -1
  68. package/lib/types/organizationSettings.types.d.ts +1 -0
  69. package/package.json +1 -1
  70. package/types/openapi/index.d.ts +1 -0
  71. package/types/openapi/models/Canvas.d.ts +1 -0
  72. package/types/openapi/models/CanvasCreate.d.ts +1 -0
  73. package/types/openapi/models/CanvasCreateRequest.d.ts +1 -0
  74. package/types/openapi/models/CanvasRetrieve.d.ts +1 -0
  75. package/types/openapi/models/CanvasUpdate.d.ts +1 -0
  76. package/types/openapi/models/CanvasUpdateRequest.d.ts +1 -0
  77. package/types/openapi/models/DeletedCanvas.d.ts +1 -0
  78. package/types/openapi/models/PatchedCanvasIndicatorsRequest.d.ts +3 -0
  79. package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +1 -0
  80. package/lib/apps/browser/components/Content/Panel/FilePanel/FilePanel.vue.d.ts +0 -2
  81. /package/lib/apps/canvas-builder/components/ui/CollectionPlayer/components/{PreviewImage.vue.d.ts → MainImage.vue.d.ts} +0 -0
  82. /package/lib/apps/canvas-builder/components/ui/CollectionPlayer/composables/{cache.use.d.ts → image-cache.use.d.ts} +0 -0
  83. /package/lib/{apps/browser/components/Content/Panel/FilePanel → components/CFilePanel}/BasicInfo.vue.d.ts +0 -0
  84. /package/lib/{apps/browser/components/Content/Panel/FilePanel → components/CFilePanel}/Details.vue.d.ts +0 -0
  85. /package/lib/{apps/browser/components/Content/Panel/FilePanel → components/CFilePanel}/Metadata.vue.d.ts +0 -0
  86. /package/lib/{apps/browser/components/Content/Panel/FilePanel → components/CFilePanel}/Tags.vue.d.ts +0 -0
  87. /package/lib/components/CFileViewer/pdf/{CFileViewer.pageFavorite.pdf.use.d.ts → CFileViewer.pageThumbFavorite.pdf.use.d.ts} +0 -0
@@ -0,0 +1,253 @@
1
+ import { ComputedRef } from 'vue';
2
+ import { ColumnDef, PaginationState, SortingState } from '@tanstack/table-core';
3
+ import { PaginatedData } from '../../types/paginatedData';
4
+ import { CLIENT_TYPE } from '../../constants/cdp.const';
5
+ import { GetCanvasesParams } from '../../types/canvases';
6
+ import { CanvasRetrieve, CanvasCreateRequest, PatchedCanvasUpdateRequest, User } from '../../../types/openapi';
7
+ declare function refetch(params: {
8
+ page_size: number;
9
+ page: number;
10
+ ordering: string;
11
+ search: string;
12
+ }): Promise<void>;
13
+ declare function __VLS_template(): {
14
+ slots: {
15
+ default?(_: {}): any;
16
+ };
17
+ refs: {
18
+ toolbarWrapper: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
19
+ hideCreate?: boolean;
20
+ hideView?: boolean;
21
+ isLoadingItems?: boolean;
22
+ modelValue: string;
23
+ filters: {
24
+ tag: import('../canvases/CanvasesManagementToolbarFilters.use').FilterCategory;
25
+ status: import('../canvases/CanvasesManagementToolbarFilters.use').FilterCategory;
26
+ createdBy: import('../canvases/CanvasesManagementToolbarFilters.use').FilterCategory;
27
+ };
28
+ tableColumnsSettings: import('../CTableColumnsSettings/CTableColumnsSettings.vue').TableColumnSetting[];
29
+ }> & Readonly<{
30
+ onSelect?: ((payload: {
31
+ id: import('../CTableColumnsSettings/CTableColumnsSettings.vue').TableColumnSetting["id"];
32
+ checked: boolean;
33
+ }) => any) | undefined;
34
+ "onUpdate:modelValue"?: ((value: string) => any) | undefined;
35
+ onMove?: ((payload: {
36
+ targetItemId: import('../CTableColumnsSettings/CTableColumnsSettings.vue').TableColumnSetting["id"];
37
+ itemId: string;
38
+ }) => any) | undefined;
39
+ "onUpdate:filters"?: ((value: {
40
+ tag: string[];
41
+ status: string[];
42
+ createdBy: string[];
43
+ }) => any) | undefined;
44
+ onRestoreColumns?: (() => any) | undefined;
45
+ "onCreate:block"?: (() => any) | undefined;
46
+ }>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
47
+ select: (payload: {
48
+ id: import('../CTableColumnsSettings/CTableColumnsSettings.vue').TableColumnSetting["id"];
49
+ checked: boolean;
50
+ }) => any;
51
+ "update:modelValue": (value: string) => any;
52
+ move: (payload: {
53
+ targetItemId: import('../CTableColumnsSettings/CTableColumnsSettings.vue').TableColumnSetting["id"];
54
+ itemId: string;
55
+ }) => any;
56
+ "update:filters": (value: {
57
+ tag: string[];
58
+ status: string[];
59
+ createdBy: string[];
60
+ }) => any;
61
+ restoreColumns: () => any;
62
+ "create:block": () => any;
63
+ }, import('vue').PublicProps, {}, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
64
+ P: {};
65
+ B: {};
66
+ D: {};
67
+ C: {};
68
+ M: {};
69
+ Defaults: {};
70
+ }, Readonly<{
71
+ hideCreate?: boolean;
72
+ hideView?: boolean;
73
+ isLoadingItems?: boolean;
74
+ modelValue: string;
75
+ filters: {
76
+ tag: import('../canvases/CanvasesManagementToolbarFilters.use').FilterCategory;
77
+ status: import('../canvases/CanvasesManagementToolbarFilters.use').FilterCategory;
78
+ createdBy: import('../canvases/CanvasesManagementToolbarFilters.use').FilterCategory;
79
+ };
80
+ tableColumnsSettings: import('../CTableColumnsSettings/CTableColumnsSettings.vue').TableColumnSetting[];
81
+ }> & Readonly<{
82
+ onSelect?: ((payload: {
83
+ id: import('../CTableColumnsSettings/CTableColumnsSettings.vue').TableColumnSetting["id"];
84
+ checked: boolean;
85
+ }) => any) | undefined;
86
+ "onUpdate:modelValue"?: ((value: string) => any) | undefined;
87
+ onMove?: ((payload: {
88
+ targetItemId: import('../CTableColumnsSettings/CTableColumnsSettings.vue').TableColumnSetting["id"];
89
+ itemId: string;
90
+ }) => any) | undefined;
91
+ "onUpdate:filters"?: ((value: {
92
+ tag: string[];
93
+ status: string[];
94
+ createdBy: string[];
95
+ }) => any) | undefined;
96
+ onRestoreColumns?: (() => any) | undefined;
97
+ "onCreate:block"?: (() => any) | undefined;
98
+ }>, {}, {}, {}, {}, {}> | null;
99
+ tableRef: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<{
100
+ selectedRows?: Record<string, boolean>;
101
+ scrollerClass?: string;
102
+ columns: ColumnDef<{
103
+ [x: string]: any;
104
+ }, any>[];
105
+ data: {
106
+ [x: string]: any;
107
+ }[];
108
+ initialSorting?: SortingState;
109
+ loading?: boolean;
110
+ pageSize?: number;
111
+ pageSizes?: number[];
112
+ pageIndex?: number;
113
+ totalCount?: number;
114
+ displayedCount?: number;
115
+ serverSide?: boolean;
116
+ scrollerStyle?: import('vue').StyleValue;
117
+ selectable?: boolean;
118
+ }> & Readonly<{
119
+ onSortChanged?: ((s: SortingState) => any) | undefined;
120
+ onPageChanged?: ((p: PaginationState) => any) | undefined;
121
+ onPageSizeChanged?: ((p: number) => any) | undefined;
122
+ "onUpdate:selectedRows"?: ((s: Record<string, boolean>) => any) | undefined;
123
+ }>, {
124
+ isNoneSelected: ComputedRef<boolean>;
125
+ areAllSelected: ComputedRef<boolean>;
126
+ selectAll: () => void;
127
+ selectedRowsCount: ComputedRef<number>;
128
+ pageRowsCount: ComputedRef<number>;
129
+ }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
130
+ sortChanged: (s: SortingState) => any;
131
+ pageChanged: (p: PaginationState) => any;
132
+ pageSizeChanged: (p: number) => any;
133
+ "update:selectedRows": (s: Record<string, boolean>) => any;
134
+ }, import('vue').PublicProps, {
135
+ data: {
136
+ [x: string]: any;
137
+ }[];
138
+ columns: ColumnDef<{
139
+ [x: string]: any;
140
+ }, any>[];
141
+ pageIndex: number;
142
+ loading: boolean;
143
+ pageSize: number;
144
+ initialSorting: SortingState;
145
+ serverSide: boolean;
146
+ }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
147
+ P: {};
148
+ B: {};
149
+ D: {};
150
+ C: {};
151
+ M: {};
152
+ Defaults: {};
153
+ }, Readonly<{
154
+ selectedRows?: Record<string, boolean>;
155
+ scrollerClass?: string;
156
+ columns: ColumnDef<{
157
+ [x: string]: any;
158
+ }, any>[];
159
+ data: {
160
+ [x: string]: any;
161
+ }[];
162
+ initialSorting?: SortingState;
163
+ loading?: boolean;
164
+ pageSize?: number;
165
+ pageSizes?: number[];
166
+ pageIndex?: number;
167
+ totalCount?: number;
168
+ displayedCount?: number;
169
+ serverSide?: boolean;
170
+ scrollerStyle?: import('vue').StyleValue;
171
+ selectable?: boolean;
172
+ }> & Readonly<{
173
+ onSortChanged?: ((s: SortingState) => any) | undefined;
174
+ onPageChanged?: ((p: PaginationState) => any) | undefined;
175
+ onPageSizeChanged?: ((p: number) => any) | undefined;
176
+ "onUpdate:selectedRows"?: ((s: Record<string, boolean>) => any) | undefined;
177
+ }>, {
178
+ isNoneSelected: ComputedRef<boolean>;
179
+ areAllSelected: ComputedRef<boolean>;
180
+ selectAll: () => void;
181
+ selectedRowsCount: ComputedRef<number>;
182
+ pageRowsCount: ComputedRef<number>;
183
+ }, {}, {}, {}, {
184
+ data: {
185
+ [x: string]: any;
186
+ }[];
187
+ columns: ColumnDef<{
188
+ [x: string]: any;
189
+ }, any>[];
190
+ pageIndex: number;
191
+ loading: boolean;
192
+ pageSize: number;
193
+ initialSorting: SortingState;
194
+ serverSide: boolean;
195
+ }> | null;
196
+ };
197
+ attrs: Partial<{}>;
198
+ };
199
+ type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
200
+ declare const __VLS_component: import('vue').DefineComponent<{
201
+ storageKey?: string;
202
+ myUserId?: User["id"];
203
+ updater: (params: PatchedCanvasUpdateRequest & {
204
+ id: CanvasRetrieve["id"];
205
+ fields?: string;
206
+ }) => Promise<CanvasRetrieve>;
207
+ creator: (params: Omit<CanvasCreateRequest, "instance_id">) => Promise<CanvasRetrieve>;
208
+ fetcher: (params: GetCanvasesParams & {
209
+ fields?: string;
210
+ }) => Promise<PaginatedData<CanvasRetrieve>>;
211
+ deleter: (id: CanvasRetrieve["id"]) => Promise<CanvasRetrieve>;
212
+ byIdFetcher: (params: {
213
+ id: CanvasRetrieve["id"];
214
+ fields?: string;
215
+ }) => Promise<CanvasRetrieve>;
216
+ client: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
217
+ }, {
218
+ refetch: typeof refetch;
219
+ }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
220
+ create: () => any;
221
+ edit: (canvas: CanvasRetrieve) => any;
222
+ open: (canvas: CanvasRetrieve, newTab?: boolean | undefined) => any;
223
+ details: (canvas: CanvasRetrieve) => any;
224
+ }, string, import('vue').PublicProps, Readonly<{
225
+ storageKey?: string;
226
+ myUserId?: User["id"];
227
+ updater: (params: PatchedCanvasUpdateRequest & {
228
+ id: CanvasRetrieve["id"];
229
+ fields?: string;
230
+ }) => Promise<CanvasRetrieve>;
231
+ creator: (params: Omit<CanvasCreateRequest, "instance_id">) => Promise<CanvasRetrieve>;
232
+ fetcher: (params: GetCanvasesParams & {
233
+ fields?: string;
234
+ }) => Promise<PaginatedData<CanvasRetrieve>>;
235
+ deleter: (id: CanvasRetrieve["id"]) => Promise<CanvasRetrieve>;
236
+ byIdFetcher: (params: {
237
+ id: CanvasRetrieve["id"];
238
+ fields?: string;
239
+ }) => Promise<CanvasRetrieve>;
240
+ client: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
241
+ }> & Readonly<{
242
+ onCreate?: (() => any) | undefined;
243
+ onEdit?: ((canvas: CanvasRetrieve) => any) | undefined;
244
+ onOpen?: ((canvas: CanvasRetrieve, newTab?: boolean | undefined) => any) | undefined;
245
+ onDetails?: ((canvas: CanvasRetrieve) => any) | undefined;
246
+ }>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
247
+ declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
248
+ export default _default;
249
+ type __VLS_WithTemplateSlots<T, S> = T & {
250
+ new (): {
251
+ $slots: S;
252
+ };
253
+ };
@@ -0,0 +1,32 @@
1
+ declare const _default: import('vue').DefineComponent<{
2
+ hideCopy?: boolean;
3
+ hideEdit?: boolean;
4
+ hideDelete?: boolean;
5
+ hideViewDetails?: boolean;
6
+ hideViewNewTab?: boolean;
7
+ isCopying?: boolean;
8
+ isDeleting?: boolean;
9
+ }, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
10
+ delete: () => any;
11
+ edit: () => any;
12
+ copy: () => any;
13
+ view: () => any;
14
+ viewNewTab: () => any;
15
+ viewDetails: () => any;
16
+ }, string, import('vue').PublicProps, Readonly<{
17
+ hideCopy?: boolean;
18
+ hideEdit?: boolean;
19
+ hideDelete?: boolean;
20
+ hideViewDetails?: boolean;
21
+ hideViewNewTab?: boolean;
22
+ isCopying?: boolean;
23
+ isDeleting?: boolean;
24
+ }> & Readonly<{
25
+ onDelete?: (() => any) | undefined;
26
+ onEdit?: (() => any) | undefined;
27
+ onCopy?: (() => any) | undefined;
28
+ onView?: (() => any) | undefined;
29
+ onViewNewTab?: (() => any) | undefined;
30
+ onViewDetails?: (() => any) | undefined;
31
+ }>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
32
+ export default _default;
@@ -0,0 +1,60 @@
1
+ import { TableColumnSetting } from '../CTableColumnsSettings/CTableColumnsSettings.vue';
2
+ import { FilterCategory } from '../canvases/CanvasesManagementToolbarFilters.use';
3
+ declare const _default: import('vue').DefineComponent<{
4
+ hideCreate?: boolean;
5
+ hideView?: boolean;
6
+ isLoadingItems?: boolean;
7
+ modelValue: string;
8
+ filters: {
9
+ tag: FilterCategory;
10
+ status: FilterCategory;
11
+ createdBy: FilterCategory;
12
+ };
13
+ tableColumnsSettings: TableColumnSetting[];
14
+ }, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
15
+ select: (payload: {
16
+ id: TableColumnSetting["id"];
17
+ checked: boolean;
18
+ }) => any;
19
+ "update:modelValue": (value: string) => any;
20
+ move: (payload: {
21
+ targetItemId: TableColumnSetting["id"];
22
+ itemId: string;
23
+ }) => any;
24
+ "update:filters": (value: {
25
+ tag: string[];
26
+ status: string[];
27
+ createdBy: string[];
28
+ }) => any;
29
+ restoreColumns: () => any;
30
+ "create:block": () => any;
31
+ }, string, import('vue').PublicProps, Readonly<{
32
+ hideCreate?: boolean;
33
+ hideView?: boolean;
34
+ isLoadingItems?: boolean;
35
+ modelValue: string;
36
+ filters: {
37
+ tag: FilterCategory;
38
+ status: FilterCategory;
39
+ createdBy: FilterCategory;
40
+ };
41
+ tableColumnsSettings: TableColumnSetting[];
42
+ }> & Readonly<{
43
+ onSelect?: ((payload: {
44
+ id: TableColumnSetting["id"];
45
+ checked: boolean;
46
+ }) => any) | undefined;
47
+ "onUpdate:modelValue"?: ((value: string) => any) | undefined;
48
+ onMove?: ((payload: {
49
+ targetItemId: TableColumnSetting["id"];
50
+ itemId: string;
51
+ }) => any) | undefined;
52
+ "onUpdate:filters"?: ((value: {
53
+ tag: string[];
54
+ status: string[];
55
+ createdBy: string[];
56
+ }) => any) | undefined;
57
+ onRestoreColumns?: (() => any) | undefined;
58
+ "onCreate:block"?: (() => any) | undefined;
59
+ }>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
60
+ export default _default;
@@ -221,7 +221,7 @@ declare const __VLS_component: import('vue').DefineComponent<{
221
221
  fields?: string;
222
222
  }) => Promise<CanvasRetrieve>;
223
223
  client: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
224
- canvasType: Exclude<CanvasType, "section" | "canvas">;
224
+ canvasType: Exclude<CanvasType, "section" | "canvas" | "block">;
225
225
  }, {
226
226
  refetch: typeof refetch;
227
227
  }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
@@ -247,7 +247,7 @@ declare const __VLS_component: import('vue').DefineComponent<{
247
247
  fields?: string;
248
248
  }) => Promise<CanvasRetrieve>;
249
249
  client: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
250
- canvasType: Exclude<CanvasType, "section" | "canvas">;
250
+ canvasType: Exclude<CanvasType, "section" | "canvas" | "block">;
251
251
  }> & Readonly<{
252
252
  onCreate?: (() => any) | undefined;
253
253
  onEdit?: ((canvas: CanvasRetrieve) => any) | undefined;
@@ -0,0 +1,7 @@
1
+ import { CanvasIndicator } from '../../types/canvases';
2
+ declare const _default: import('vue').DefineComponent<{
3
+ indicators?: Record<string, CanvasIndicator> | null;
4
+ }, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
5
+ indicators?: Record<string, CanvasIndicator> | null;
6
+ }> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
7
+ export default _default;
@@ -67,6 +67,7 @@ export default function useSmartFolders(emit?: (event: 'open', ...args: any[]) =
67
67
  is_draft?: boolean | undefined;
68
68
  is_template?: boolean | undefined;
69
69
  is_section?: boolean | undefined;
70
+ is_block?: boolean | undefined;
70
71
  is_editable?: boolean | undefined;
71
72
  is_default?: boolean | undefined;
72
73
  metadata?: Record<string, any> | undefined;
@@ -147,6 +148,7 @@ export default function useSmartFolders(emit?: (event: 'open', ...args: any[]) =
147
148
  is_draft?: boolean | undefined;
148
149
  is_template?: boolean | undefined;
149
150
  is_section?: boolean | undefined;
151
+ is_block?: boolean | undefined;
150
152
  is_editable?: boolean | undefined;
151
153
  is_default?: boolean | undefined;
152
154
  metadata?: Record<string, any> | undefined;
@@ -207,6 +209,7 @@ export default function useSmartFolders(emit?: (event: 'open', ...args: any[]) =
207
209
  is_draft?: boolean | undefined;
208
210
  is_template?: boolean | undefined;
209
211
  is_section?: boolean | undefined;
212
+ is_block?: boolean | undefined;
210
213
  is_editable?: boolean | undefined;
211
214
  is_default?: boolean | undefined;
212
215
  metadata?: Record<string, any> | undefined;
@@ -268,6 +271,7 @@ export default function useSmartFolders(emit?: (event: 'open', ...args: any[]) =
268
271
  is_draft?: boolean | undefined;
269
272
  is_template?: boolean | undefined;
270
273
  is_section?: boolean | undefined;
274
+ is_block?: boolean | undefined;
271
275
  is_editable?: boolean | undefined;
272
276
  is_default?: boolean | undefined;
273
277
  metadata?: Record<string, any> | undefined;
@@ -22,6 +22,7 @@ export declare const CDP_EVENT_TYPE: {
22
22
  readonly userBugReported: "User Bug Reported";
23
23
  readonly userFileReviewed: "User File Reviewed";
24
24
  readonly hotspotClicked: "Hotspot Clicked";
25
+ readonly collectionPlayerContentChanged: "Collection Player Content Changed";
25
26
  };
26
27
  export declare const CLIENT_TYPE: {
27
28
  readonly admin: "admin";
package/lib/main.lib.d.ts CHANGED
@@ -46,7 +46,7 @@ export { default as CContactSelector } from './components/CContactSelector/CCont
46
46
  export { default as CContactSelectorSelected } from './components/CContactSelector/CContactSelectorSelected.vue';
47
47
  export * from './components/CContactSelector/CContactSelector.types';
48
48
  export { default as CCreateCanvasModal } from './components/CCreateCanvasModal/CCreateCanvasModal.vue';
49
- export { default as CCreateTemplateOrSectionModal } from './components/CCreateTemplateOrSectionModal/CCreateTemplateOrSectionModal.vue';
49
+ export { default as CCreateTemplateSectionBlockModal } from './components/CCreateTemplateSectionBlockModal/CCreateTemplateSectionBlockModal.vue';
50
50
  export { default as CGlobalSearch } from './components/CGlobalSearch/CGlobalSearch.vue';
51
51
  export { default as CComponentListItem } from './components/CComponentListItem/CComponentListItem.vue';
52
52
  export { default as CSecondaryNav } from './components/CSecondaryNav/CSecondaryNav.vue';
@@ -61,6 +61,7 @@ export { default as CToastProvider } from './components/CToastProvider/CToastPro
61
61
  export { default as CCanvasMetadataFilters } from './components/canvases/CCanvasMetadataFilters.vue';
62
62
  export { default as CCanvasDeleteDialogContent } from './components/canvases/CCanvasDeleteDialogContent.vue';
63
63
  export { default as CSectionManagement } from './components/sections/CSectionManagement.vue';
64
+ export { default as CBlockManagement } from './components/canvas-blocks/CBlockManagement.vue';
64
65
  export { default as CTemplateManagement } from './components/canvas-templates/CTemplateManagement.vue';
65
66
  export { default as CSavedCanvasesManagement } from './components/savedCanvases/CSavedCanvasesManagement.vue';
66
67
  export { default as useShareCanvas } from './components/savedCanvases/CSavedCanvasesManagementShareCanvas.use';
@@ -92,6 +93,7 @@ export { default as CList } from './components/CList/CList.vue';
92
93
  export { default as CKnockNotificationsAppWrapper } from './components/CKnockNotificationsAppWrapper/CKnockNotificationsAppWrapper.vue';
93
94
  export { default as CChip } from './components/CChip/CChip.vue';
94
95
  export { default as CSettingsEditor } from './components/CSettingsEditor/CSettingsEditor.vue';
96
+ export { default as CFilePanel } from './components/CFilePanel/CFilePanel.vue';
95
97
  export { default as CanvasBuilderApp } from './apps/canvas-builder/App.vue';
96
98
  export { type CanvasBuilderProps, CanvasBuilderMode } from './apps/canvas-builder/types/canvas';
97
99
  export { type FontAwesomeType } from './apps/canvas-builder/types/font-awesome.types';
@@ -161,6 +163,7 @@ export * from './types/canvases';
161
163
  export * from './types/canvasActions';
162
164
  export * from './types/favorites';
163
165
  export * from './types/files';
166
+ export * from './types/file.types';
164
167
  export * from './types/app';
165
168
  export * from './types/vueVirtualScroller';
166
169
  export * from './components/CUsersGroupsAccessManage/CUsersGroupsAccessManage.types';
@@ -130,6 +130,11 @@ export declare function createHighLevelApi(options?: ApiOptions): {
130
130
  instance_id?: import('../../main.lib').Instance["id"];
131
131
  fields?: string;
132
132
  }): Promise<import('../../main.lib').CanvasRetrieve>;
133
+ updateCanvasIndicators(payload: {
134
+ indicators: Record<string, import('../../main.lib').CanvasIndicator>;
135
+ id: import('../../main.lib').CanvasRetrieve["id"];
136
+ instance_id?: import('../../main.lib').Instance["id"];
137
+ }): Promise<import('../../main.lib').CanvasRetrieve>;
133
138
  getCanvas(payload: {
134
139
  id: import('../../main.lib').CanvasRetrieve["id"];
135
140
  fields?: string;
@@ -1,5 +1,5 @@
1
1
  import { CanvasRetrieve, CanvasCreateRequest, PatchedCanvasUpdateRequest, SharedLink, Instance, CanvasRecommendedFiles } from '../../../../types/openapi';
2
- import { GetCanvasesParams } from '../../../types/canvases';
2
+ import { GetCanvasesParams, CanvasIndicator } from '../../../types/canvases';
3
3
  import { PaginatedData } from '../../../types/paginatedData';
4
4
  /**
5
5
  * Fetches a list of canvases to use in your app.
@@ -44,6 +44,31 @@ export declare function updateCanvas(payload: PatchedCanvasUpdateRequest & {
44
44
  instance_id?: Instance['id'];
45
45
  fields?: string;
46
46
  }): Promise<CanvasRetrieve>;
47
+ /**
48
+ * Updates canvas indicators by canvas ID. It merges the passed object into existing canvas indicators adding new keys if they were empty and overriding pre-existing keys.
49
+ *
50
+ * Indicators can also be updated using updateCanvas API but in this case passed object fully replaces existing indicators.
51
+ *
52
+ * @example
53
+ * // The fields param is appended to the URL as a query param.
54
+ * onMounted(() => {
55
+ * PitcherAPI.updateCanvasIndicators({
56
+ * id: '01J9XT0WVXRTETF4CQZP42CPZP',
57
+ * indicators: {
58
+ * existing: { type: 'info', label: 'new label' }, // will be overriden
59
+ * new: { type: 'info', label: 'INFO' }, // will be added
60
+ * removeExisting: null // will be set to null and ignored, it is the same as removal
61
+ * }
62
+ * }).then((res) => {
63
+ * console.log(res) // entire canvas object, including indicators field
64
+ * })
65
+ * })
66
+ */
67
+ export declare function updateCanvasIndicators(payload: {
68
+ indicators: Record<string, CanvasIndicator>;
69
+ id: CanvasRetrieve['id'];
70
+ instance_id?: Instance['id'];
71
+ }): Promise<CanvasRetrieve>;
47
72
  export declare function getCanvas(payload: {
48
73
  id: CanvasRetrieve['id'];
49
74
  fields?: string;
@@ -25,6 +25,16 @@ export declare function appLoaded(): Promise<void>;
25
25
  * @param payload object containing requested height of the iframe as the number of pixels
26
26
  */
27
27
  export declare function appResize(payload: UiAppResizeRequest): Promise<void>;
28
+ /**
29
+ * Close the Canvas Section Execution modal. Only takes effect for `canvas_section_execution` app modules
30
+ *
31
+ * Note that this method simply closes the modal and will result in the app calling it being unmounted from the DOM and
32
+ * destroyed. Make sure your app has finished updating data before you call this method.
33
+ *
34
+ * @example
35
+ * useUi().closeCanvasSectionExecution()
36
+ */
37
+ export declare function closeCanvasSectionExecution(): Promise<void>;
28
38
  /**
29
39
  * Navigate to the next page in the current canvas. Noop if the current page is the last one.
30
40
  *
@@ -124,6 +124,7 @@ declare const _default: {
124
124
  updateCanvas(payload: import('./types.ui').UiUpdateCanvasRequest): Promise<import('../../../../main.lib').CanvasRetrieve>;
125
125
  appLoaded(): Promise<void>;
126
126
  appResize(payload: import('./types.ui').UiAppResizeRequest): Promise<void>;
127
+ closeCanvasSectionExecution(): Promise<void>;
127
128
  canvasNavigateNextPage(): Promise<void>;
128
129
  canvasNavigatePreviousPage(): Promise<void>;
129
130
  canvasNavigatePage(payload: import('./types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -1,6 +1,6 @@
1
1
  import { UiCompletePostcallRequest, UiSetPostcallStyleRequest } from './types.ui';
2
2
  /**
3
- * Ends current meeting and shows postcall form.
3
+ * Completes the postcall stage (with successful submission or not)
4
4
  *
5
5
  * @example
6
6
  * useUi().completePostcall({ was_successfully_submitted: true })
@@ -33,6 +33,7 @@ export declare const UI_API_METHOD_TYPES: {
33
33
  readonly UI_CANVAS_NAVIGATE_PAGE: "ui_canvas_navigate_page";
34
34
  readonly UI_APP_LOADED: "ui_app_loaded";
35
35
  readonly UI_APP_RESIZE: "ui_app_resize";
36
+ readonly UI_CLOSE_CANVAS_SECTION_EXECUTION: "ui_close_canvas_section_execution";
36
37
  };
37
38
  export declare const UI_MESSAGE_TYPES: {
38
39
  readonly UI_MEETING_CANCELED: "ui_meeting_canceled";
package/lib/sdk/main.d.ts CHANGED
@@ -35,6 +35,7 @@ export declare function useUi(): {
35
35
  updateCanvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
36
36
  appLoaded(): Promise<void>;
37
37
  appResize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
38
+ closeCanvasSectionExecution(): Promise<void>;
38
39
  canvasNavigateNextPage(): Promise<void>;
39
40
  canvasNavigatePreviousPage(): Promise<void>;
40
41
  canvasNavigatePage(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -189,6 +190,11 @@ export declare function useApi(options?: ApiOptions): {
189
190
  instance_id?: import('../main.lib').Instance["id"];
190
191
  fields?: string;
191
192
  }): Promise<import('../main.lib').CanvasRetrieve>;
193
+ updateCanvasIndicators(payload: {
194
+ indicators: Record<string, import('../main.lib').CanvasIndicator>;
195
+ id: import('../main.lib').CanvasRetrieve["id"];
196
+ instance_id?: import('../main.lib').Instance["id"];
197
+ }): Promise<import('../main.lib').CanvasRetrieve>;
192
198
  getCanvas(payload: {
193
199
  id: import('../main.lib').CanvasRetrieve["id"];
194
200
  fields?: string;
@@ -353,6 +359,7 @@ export declare function useApi(options?: ApiOptions): {
353
359
  updateCanvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
354
360
  appLoaded(): Promise<void>;
355
361
  appResize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
362
+ closeCanvasSectionExecution(): Promise<void>;
356
363
  canvasNavigateNextPage(): Promise<void>;
357
364
  canvasNavigatePreviousPage(): Promise<void>;
358
365
  canvasNavigatePage(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -417,6 +424,11 @@ export declare function useApi(options?: ApiOptions): {
417
424
  instance_id?: import('../main.lib').Instance["id"];
418
425
  fields?: string;
419
426
  }): Promise<import('../main.lib').CanvasRetrieve>;
427
+ updateCanvasIndicators(payload: {
428
+ indicators: Record<string, import('../main.lib').CanvasIndicator>;
429
+ id: import('../main.lib').CanvasRetrieve["id"];
430
+ instance_id?: import('../main.lib').Instance["id"];
431
+ }): Promise<import('../main.lib').CanvasRetrieve>;
420
432
  getCanvas(payload: {
421
433
  id: import('../main.lib').CanvasRetrieve["id"];
422
434
  fields?: string;
@@ -533,6 +545,7 @@ export declare function useApi(options?: ApiOptions): {
533
545
  updateCanvas(payload: import('./api/modules/ui/types.ui').UiUpdateCanvasRequest): Promise<import('../main.lib').CanvasRetrieve>;
534
546
  appLoaded(): Promise<void>;
535
547
  appResize(payload: import('./api/modules/ui/types.ui').UiAppResizeRequest): Promise<void>;
548
+ closeCanvasSectionExecution(): Promise<void>;
536
549
  canvasNavigateNextPage(): Promise<void>;
537
550
  canvasNavigatePreviousPage(): Promise<void>;
538
551
  canvasNavigatePage(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageRequest): Promise<void>;
@@ -588,6 +601,11 @@ export declare function useApi(options?: ApiOptions): {
588
601
  deleteCanvas(payload: {
589
602
  id: import('../main.lib').CanvasRetrieve["id"];
590
603
  }): Promise<import('../main.lib').CanvasRetrieve>;
604
+ updateCanvasIndicators(payload: {
605
+ indicators: Record<string, import('../main.lib').CanvasIndicator>;
606
+ id: import('../main.lib').CanvasRetrieve["id"];
607
+ instance_id?: import('../main.lib').Instance["id"];
608
+ }): Promise<import('../main.lib').CanvasRetrieve>;
591
609
  getCanvas(payload: {
592
610
  id: import('../main.lib').CanvasRetrieve["id"];
593
611
  fields?: string;
@@ -1,5 +1,5 @@
1
1
  import { File, MetadataTemplateFieldTypeEnum } from '../../types/openapi';
2
- export type EmbedLocation = 'ui_app' | 'canvas' | 'dsr' | 'admin_instance' | 'overlay_app';
2
+ export type EmbedLocation = 'ui_app' | 'canvas' | 'dsr' | 'admin_instance' | 'overlay_app' | 'canvas_section_execution';
3
3
  export type ModuleSettingsOption = {
4
4
  label: string;
5
5
  value: string;
@@ -21,4 +21,12 @@ export declare enum CanvasStatus {
21
21
  READY = "ready",
22
22
  DRAFT = "draft"
23
23
  }
24
- export type CanvasType = 'template' | 'section-template' | 'section' | 'canvas';
24
+ export type CanvasType = 'template' | 'section-template' | 'section' | 'canvas' | 'block';
25
+ export interface CanvasIndicator {
26
+ icon: string;
27
+ key: string;
28
+ text: string;
29
+ type?: 'default' | 'primary' | 'info' | 'success' | 'warning' | 'error';
30
+ background_color?: string;
31
+ color?: string;
32
+ }
@@ -0,0 +1,15 @@
1
+ import { FileRetrieve } from '../../types/openapi';
2
+ export type FilePageInfo = {
3
+ name?: string | null;
4
+ tags?: string[];
5
+ };
6
+ export type FilePageMetadata = Record<string, any>;
7
+ export type FileMetadata = {
8
+ pagesInfo?: Record<string, FilePageInfo>;
9
+ pagesMetadata?: Record<string, Record<string, any>>;
10
+ [key: string]: any;
11
+ };
12
+ export interface PitcherFile extends Omit<FileRetrieve, 'metadata'> {
13
+ isDeleted?: boolean;
14
+ metadata: FileMetadata;
15
+ }