superdoc 2.29.0 → 2.30.0-next.19

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 (138) hide show
  1. package/README.md +127 -25
  2. package/dist/chunks/{FindReplaceSurface-B_5ggdWg.es.js → FindReplaceSurface-BEnRLpD9.es.js} +1 -1
  3. package/dist/chunks/{FindReplaceSurface-fVHxPXtn.cjs → FindReplaceSurface-DWXgWgg7.cjs} +1 -1
  4. package/dist/chunks/{PasswordPromptSurface-CZqhDQQ1.es.js → PasswordPromptSurface-DjV1JgjD.es.js} +1 -1
  5. package/dist/chunks/{PasswordPromptSurface-x8GNmMJT.cjs → PasswordPromptSurface-VFPnQOML.cjs} +1 -1
  6. package/dist/chunks/{PdfViewer-CW09MNrB.es.js → PdfViewer-C2r-K8zC.es.js} +1 -1
  7. package/dist/chunks/{PdfViewer-CkrAHpC-.cjs → PdfViewer-DYTbPVUr.cjs} +1 -1
  8. package/dist/chunks/{_plugin-vue_export-helper-BkbCxNeT.cjs → _plugin-vue_export-helper-BzM2_tVU.cjs} +9 -0
  9. package/dist/chunks/{_plugin-vue_export-helper-DRPRMkeA.es.js → _plugin-vue_export-helper-CmkaJDnr.es.js} +4 -1
  10. package/dist/chunks/{create-super-doc-ui-L60GhVAX.cjs → create-super-doc-ui-D7uBUZfs.cjs} +14347 -13625
  11. package/dist/chunks/{create-super-doc-ui-Dc8dQAMc.es.js → create-super-doc-ui-_t6kMzLs.es.js} +14076 -13360
  12. package/dist/collaboration-upgrade-engine.cjs +1 -1
  13. package/dist/collaboration-upgrade-engine.es.js +1 -1
  14. package/dist/document-api/src/changes/changes.d.ts +26 -0
  15. package/dist/document-api/src/changes/changes.types.d.ts +156 -0
  16. package/dist/document-api/src/comments/comment-create-attribution.d.ts +4 -0
  17. package/dist/document-api/src/comments/comments.types.d.ts +4 -0
  18. package/dist/document-api/src/content-controls/content-controls.types.d.ts +1 -0
  19. package/dist/document-api/src/contract/command-catalog.d.ts +1 -1
  20. package/dist/document-api/src/contract/operation-definitions.d.ts +76 -8
  21. package/dist/document-api/src/contract/operation-registry.d.ts +2 -2
  22. package/dist/document-api/src/contract/schemas.d.ts +7 -1
  23. package/dist/document-api/src/create/create.d.ts +0 -4
  24. package/dist/document-api/src/diff/diff.types.d.ts +6 -6
  25. package/dist/document-api/src/header-footers/header-footers.d.ts +1 -3
  26. package/dist/document-api/src/index.d.ts +13 -1
  27. package/dist/document-api/src/inline-semantics/token-sets.d.ts +0 -2
  28. package/dist/document-api/src/insert/insert.d.ts +0 -1
  29. package/dist/document-api/src/paragraphs/paragraphs.d.ts +8 -3
  30. package/dist/document-api/src/paragraphs/paragraphs.types.d.ts +49 -5
  31. package/dist/document-api/src/tables/data/table-preset-appearance.generated.d.ts +2 -0
  32. package/dist/document-api/src/tables/table-style-presets.d.ts +73 -0
  33. package/dist/document-api/src/tables/tables.d.ts +4 -1
  34. package/dist/document-api/src/types/sd-props.d.ts +7 -0
  35. package/dist/document-api/src/types/table-operations.types.d.ts +12 -15
  36. package/dist/layout-engine/contracts/src/index.d.ts +4 -1
  37. package/dist/layout-engine/contracts/src/table-cell-vector-overlay.d.ts +2 -0
  38. package/dist/layout-engine/dom-contract/src/data-attrs.d.ts +4 -0
  39. package/dist/layout-engine/layout-bridge/src/coupled-footnote-pagination.d.ts +1 -0
  40. package/dist/layout-engine/layout-bridge/src/footnote-page-certificate.d.ts +1 -0
  41. package/dist/layout-engine/layout-bridge/src/footnote-page-planner.d.ts +5 -0
  42. package/dist/layout-engine/layout-bridge/src/incrementalLayout.d.ts +1 -0
  43. package/dist/layout-engine/layout-engine/src/footnote-page-flow.d.ts +3 -0
  44. package/dist/layout-engine/layout-engine/src/index.d.ts +7 -0
  45. package/dist/layout-engine/layout-engine/src/layout-paragraph.d.ts +5 -0
  46. package/dist/layout-engine/layout-engine/src/layout-table.d.ts +3 -1
  47. package/dist/layout-engine/layout-engine/src/layout-utils.d.ts +0 -4
  48. package/dist/layout-engine/layout-engine/src/paginator.d.ts +4 -0
  49. package/dist/layout-engine/painters/dom/src/index.d.ts +2 -0
  50. package/dist/layout-engine/painters/dom/src/paragraph/list-marker.d.ts +1 -1
  51. package/dist/layout-engine/painters/dom/src/paragraph/renderParagraphContent.d.ts +1 -1
  52. package/dist/layout-engine/painters/dom/src/styles.d.ts +0 -10
  53. package/dist/layout-engine/painters/dom/src/svg-utils.d.ts +1 -13
  54. package/dist/public/ui-react.cjs +1 -1
  55. package/dist/public/ui-react.es.js +1 -1
  56. package/dist/public/ui-vue.cjs +1 -1
  57. package/dist/public/ui-vue.es.js +1 -1
  58. package/dist/public/ui.cjs +1 -1
  59. package/dist/public/ui.es.js +1 -1
  60. package/dist/shared/common/Telemetry.d.ts +50 -0
  61. package/dist/shared/common/event-types.d.ts +13 -0
  62. package/dist/shared/font-system/src/bundled-face-names.d.ts +1 -0
  63. package/dist/shared/font-system/src/resolver.d.ts +1 -0
  64. package/dist/style.css +1 -1
  65. package/dist/style.layered.css +1 -1
  66. package/dist/superdoc/src/components/CommentsLayer/CommentDialog.vue.d.ts +17 -33
  67. package/dist/superdoc/src/components/CommentsLayer/collect-tracked-change-thread.d.ts +6 -4
  68. package/dist/superdoc/src/components/CommentsLayer/comment-params.d.ts +84 -0
  69. package/dist/superdoc/src/components/CommentsLayer/use-comment.d.ts +15 -95
  70. package/dist/superdoc/src/components/Whiteboard/use-whiteboard.d.ts +30 -9
  71. package/dist/superdoc/src/composables/use-comment-sidebar.d.ts +6 -0
  72. package/dist/superdoc/src/composables/use-document.d.ts +51 -99
  73. package/dist/superdoc/src/core/SuperDoc.d.ts +12 -3
  74. package/dist/superdoc/src/core/collaboration/cdn-collaboration-comment-map.d.ts +1 -0
  75. package/dist/superdoc/src/core/collaboration/collaboration-comment-map.d.ts +2 -0
  76. package/dist/superdoc/src/core/collaboration/helpers.d.ts +1 -1
  77. package/dist/superdoc/src/core/config/normalize-interaction-config.d.ts +10 -1
  78. package/dist/superdoc/src/core/document-open-telemetry.d.ts +1 -1
  79. package/dist/superdoc/src/core/editor-runtime/types.d.ts +4 -0
  80. package/dist/superdoc/src/core/editor-runtime/v2/v2-editor-runtime-adapter.d.ts +1 -0
  81. package/dist/superdoc/src/core/types/index.d.ts +110 -42
  82. package/dist/superdoc/src/core/v2-integration/v2-integration.d.ts +6 -0
  83. package/dist/superdoc/src/helpers/deprecation.d.ts +12 -3
  84. package/dist/superdoc/src/helpers/object-guards.d.ts +1 -0
  85. package/dist/superdoc/src/helpers/v2-review-geometry-delivery.d.ts +22 -0
  86. package/dist/superdoc/src/internal/toolbar/built-in/ToolbarButton.vue.d.ts +1 -0
  87. package/dist/superdoc/src/public/content-control-ref.d.ts +12 -0
  88. package/dist/superdoc/src/public/index.d.cts +20 -0
  89. package/dist/superdoc/src/public/index.d.ts +4 -1
  90. package/dist/superdoc/src/public/ui/async-read-cache.d.ts +32 -0
  91. package/dist/superdoc/src/public/ui/block-commands.d.ts +39 -0
  92. package/dist/superdoc/src/public/ui/command-results.d.ts +39 -0
  93. package/dist/superdoc/src/public/ui/commands.d.ts +5 -1
  94. package/dist/superdoc/src/public/ui/content-controls-handle.d.ts +31 -0
  95. package/dist/superdoc/src/public/ui/create-super-doc-ui.d.ts +1 -17
  96. package/dist/superdoc/src/public/ui/document-change-records.d.ts +7 -0
  97. package/dist/superdoc/src/public/ui/entity-rows.d.ts +14 -0
  98. package/dist/superdoc/src/public/ui/font-options.d.ts +7 -0
  99. package/dist/superdoc/src/public/ui/format-painter-paragraph.d.ts +7 -0
  100. package/dist/superdoc/src/public/ui/format-painter-state.d.ts +29 -0
  101. package/dist/superdoc/src/public/ui/heavy-read-gate.d.ts +41 -0
  102. package/dist/superdoc/src/public/ui/heavy-read-policy.d.ts +11 -0
  103. package/dist/superdoc/src/public/ui/host-events.d.ts +3 -0
  104. package/dist/superdoc/src/public/ui/inline-values.d.ts +80 -0
  105. package/dist/superdoc/src/public/ui/loose-record.d.ts +4 -0
  106. package/dist/superdoc/src/public/ui/reasons.d.ts +1 -0
  107. package/dist/superdoc/src/public/ui/search-handle.d.ts +24 -0
  108. package/dist/superdoc/src/public/ui/selection-targets.d.ts +53 -0
  109. package/dist/superdoc/src/public/ui/shared-tracked-changes-catalog.d.ts +16 -0
  110. package/dist/superdoc/src/public/ui/styles-handle.d.ts +54 -0
  111. package/dist/superdoc/src/public/ui/tracked-change-ids.d.ts +51 -0
  112. package/dist/superdoc/src/public/ui/types.d.ts +31 -2
  113. package/dist/superdoc/src/public/ui/ui-bench-timing.d.ts +9 -0
  114. package/dist/superdoc/src/public/ui.d.cts +18 -0
  115. package/dist/superdoc/src/public/ui.d.ts +1 -1
  116. package/dist/superdoc/src/stores/comments-store.d.ts +23052 -537
  117. package/dist/superdoc/src/stores/helpers/comment-grouping.d.ts +1 -1
  118. package/dist/superdoc/src/stores/helpers/comment-identity.d.ts +10 -10
  119. package/dist/superdoc/src/stores/helpers/pending-selection-snapshot.d.ts +3 -3
  120. package/dist/superdoc/src/stores/helpers/review-presentation.d.ts +91 -0
  121. package/dist/superdoc/src/stores/helpers/tracked-change-identity.d.ts +4 -2
  122. package/dist/superdoc/src/stores/helpers/tracked-change-row-values.d.ts +1 -8
  123. package/dist/superdoc/src/stores/helpers/tracked-change-thread-index.d.ts +1 -1
  124. package/dist/superdoc/src/stores/helpers/v2-review-adapters.d.ts +148 -0
  125. package/dist/superdoc/src/stores/superdoc-store.d.ts +12 -2895
  126. package/dist/superdoc.cjs +1000 -566
  127. package/dist/superdoc.es.js +1000 -566
  128. package/dist/word-layout/src/marker-utils.d.ts +0 -5
  129. package/dist/word-layout/src/unit-conversions.d.ts +0 -1
  130. package/dist-cdn/style.layered.css +1 -1
  131. package/dist-cdn/superdoc.min.css +1 -1
  132. package/dist-cdn/superdoc.min.js +38 -42
  133. package/package.json +12 -3
  134. package/dist/document-api/src/diff/index.d.ts +0 -3
  135. package/dist/document-api/src/write/locator.d.ts +0 -24
  136. package/dist/layout-engine/painters/dom/src/features/feature-registry.d.ts +0 -41
  137. package/dist/superdoc/src/internal/toolbar/built-in/format-negation.d.ts +0 -11
  138. package/dist/word-layout/src/tab-layout.d.ts +0 -193
@@ -5,16 +5,16 @@ type PageEntry = {
5
5
  containerBounds?: unknown;
6
6
  container?: Element | null;
7
7
  };
8
- type StoreDocument = RuntimeDocument & Required<Pick<RuntimeDocument, 'getEditor' | 'getDocumentRuntime'>> & {
8
+ export type StoreDocument = RuntimeDocument & Required<Pick<RuntimeDocument, 'getEditor' | 'getDocumentRuntime'>> & {
9
9
  isReady: boolean;
10
10
  pageContainers: PageEntry[];
11
11
  };
12
12
  type StoreExceptionHandler = (payload: SuperDocExceptionStorePayload) => void;
13
- type ActiveSelection = {
13
+ export type ActiveSelection = {
14
14
  documentId?: string | number | null;
15
15
  [key: string]: unknown;
16
16
  };
17
- type SelectionPosition = {
17
+ export type SelectionPosition = {
18
18
  left: number;
19
19
  top: number;
20
20
  width?: number;
@@ -27,970 +27,9 @@ type SelectionPosition = {
27
27
  source: string | null;
28
28
  };
29
29
  export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc", Pick<{
30
- commentsStore: import('pinia').Store<"comments", Pick<{
31
- COMMENT_EVENTS: {
32
- readonly RESOLVED: "resolved";
33
- readonly NEW: "new";
34
- readonly ADD: "add";
35
- readonly UPDATE: "update";
36
- readonly DELETED: "deleted";
37
- readonly PENDING: "pending";
38
- readonly SELECTED: "selected";
39
- readonly COMMENTS_LIST: "comments-list";
40
- readonly CHANGE_ACCEPTED: "change-accepted";
41
- readonly CHANGE_REJECTED: "change-rejected";
42
- };
43
- hasSyncedCollaborationComments: Ref<boolean, boolean>;
44
- editingCommentId: Ref<null, null>;
45
- activeComment: Ref<null, null>;
46
- activeFloatingCommentInstanceId: Ref<null, null>;
47
- suppressInternalExternal: Ref<boolean, boolean>;
48
- pendingComment: Ref<null, null>;
49
- currentCommentText: Ref<string, string>;
50
- currentCommentMentions: Ref<never[], never[]>;
51
- commentsList: Ref<never[], never[]>;
52
- reviewDirectoryList: import('vue').ShallowRef<never[], never[]>;
53
- isCommentsListVisible: Ref<boolean, boolean>;
54
- isReviewDirectoryActive: Ref<boolean, boolean>;
55
- isReviewDirectoryLoading: Ref<boolean, boolean>;
56
- generalCommentIds: Ref<never[], never[]>;
57
- editorCommentIds: Ref<never[], never[]>;
58
- commentsParentElement: Ref<null, null>;
59
- editorCommentPositions: Ref<{}, {}>;
60
- hasInitializedLocations: Ref<boolean, boolean>;
61
- isCommentHighlighted: Ref<boolean, boolean>;
62
- floatingCommentsOffset: Ref<number, number>;
63
- committedReviewPresentations: import('vue').ShallowRef<{}, {}>;
64
- skipSelectionUpdate: Ref<boolean, boolean>;
65
- isFloatingCommentsReady: Ref<boolean, boolean>;
66
- instantSidebarAlignmentTargetY: Ref<null, null>;
67
- instantSidebarAlignmentThreadId: Ref<null, null>;
68
- instantSidebarAlignmentInstanceId: Ref<null, null>;
69
- getConfig: import('vue').ComputedRef<{
70
- name: string;
71
- readOnly: boolean;
72
- allowResolve: boolean;
73
- showResolved: boolean;
74
- }>;
75
- documentsWithConverations: import('vue').ComputedRef<any>;
76
- getGroupedComments: import('vue').ComputedRef<{
77
- parentComments: any[];
78
- resolvedComments: any[];
79
- }>;
80
- getGroupedReviewDirectory: import('vue').ComputedRef<{
81
- parentComments: any[];
82
- resolvedComments: any[];
83
- }>;
84
- hasOpenTrackedChanges: import('vue').ComputedRef<boolean>;
85
- getFloatingComments: import('vue').ComputedRef<any[]>;
86
- getFloatingCommentInstances: import('vue').ComputedRef<{
87
- id: string;
88
- threadId: string | null;
89
- comment: any;
90
- positionKey: string | null;
91
- positionEntry: {
92
- pageIndex?: number | null;
93
- rects?: readonly ({
94
- pageIndex?: number | null;
95
- left?: number;
96
- top?: number;
97
- right?: number;
98
- bottom?: number;
99
- } | null | undefined)[] | null;
100
- bounds?: Partial<{
101
- left: number;
102
- top: number;
103
- right: number;
104
- bottom: number;
105
- width: number;
106
- height: number;
107
- }> | null;
108
- } | null;
109
- pageIndex: number | null;
110
- isPrimary: boolean;
111
- }[]>;
112
- getCommentAliasIds: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined) => string[];
113
- getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
114
- getCommentPositionKey: (commentOrId: import('./helpers/comment-identity.js').CommentIdentityRow | string | null | undefined) => unknown;
115
- getCommentPosition: (commentOrId: Object | string) => Object | null;
116
- resolveCommentPositionEntry: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined, preferredId?: unknown) => {
117
- key: string;
118
- entry: import('./helpers/comment-identity.js').CommentPositionEntry;
119
- } | {
120
- key: null;
121
- entry: null;
122
- };
123
- getCommentDocumentId: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment) => string | null;
124
- belongsToDocument: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment, activeDocumentId: string | null | undefined, options?: import('./helpers/comment-document-scope.js').BelongsToDocumentOptions) => boolean;
125
- viewingVisibility: {
126
- documentMode: string;
127
- commentsVisible: boolean;
128
- trackChangesVisible: boolean;
129
- };
130
- isViewingMode: import('vue').ComputedRef<boolean>;
131
- shouldRenderReviewInViewing: import('vue').ComputedRef<boolean>;
132
- init: (config?: Object) => void;
133
- setViewingVisibility: ({ documentMode, commentsVisible, trackChangesVisible }?: {}) => void;
134
- getComment: (id: unknown) => import('./helpers/comment-identity.js').CommentIdentityRow | null;
135
- setActiveComment: (superdoc: Object | undefined | null, id: string | undefined | null) => void;
136
- getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
137
- selection?: Object | undefined;
138
- documentId?: string | null | undefined;
139
- parentCommentId?: string | null | undefined;
140
- }) => ReturnType<any>;
141
- showAddComment: (superdoc: any, targetClientY?: null) => any;
142
- addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
143
- superdoc: any;
144
- comment: any;
145
- skipEditorUpdate?: boolean | undefined;
146
- broadcastChanges?: boolean | undefined;
147
- }) => {
148
- ok: boolean;
149
- reason?: string;
150
- detail?: string;
151
- code?: string;
152
- } | Promise<{
153
- ok: boolean;
154
- reason?: string;
155
- detail?: string;
156
- code?: string;
157
- }>;
158
- addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
159
- superdoc: any;
160
- comment: any;
161
- skipEditorUpdate?: boolean | undefined;
162
- broadcastChanges?: boolean | undefined;
163
- }) => {
164
- ok: boolean;
165
- reason?: string;
166
- detail?: string;
167
- code?: string;
168
- } | Promise<{
169
- ok: boolean;
170
- reason?: string;
171
- detail?: string;
172
- code?: string;
173
- }>;
174
- cancelComment: (superdoc: any) => void;
175
- deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
176
- commentId: any;
177
- superdoc: any;
178
- }) => Promise<any>;
179
- removePendingComment: (superdoc: any) => void;
180
- removeCommentsForDocument: (documentId: string | null | undefined) => void;
181
- setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
182
- commentItems?: never[] | undefined;
183
- trackedChangeItems?: never[] | undefined;
184
- }) => {
185
- ok: boolean;
186
- reason: string;
187
- count?: undefined;
188
- } | {
189
- ok: boolean;
190
- count: number;
191
- reason?: undefined;
192
- };
193
- clearReviewDirectory: () => void;
194
- handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
195
- retainMissingTrackedChangeGeometry?: boolean;
196
- retainedTrackedChangeIds?: Iterable<string>;
197
- }) => void;
198
- clearEditorCommentPositions: () => void;
199
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
200
- superdoc: Object;
201
- params: Object;
202
- }) => void;
203
- syncResolvedCommentsWithDocument: () => number;
204
- setActiveFloatingCommentInstance: (instanceId?: null) => void;
205
- requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
206
- peekInstantSidebarAlignment: () => null;
207
- clearInstantSidebarAlignment: () => void;
208
- decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
209
- superdoc: Object;
210
- comment: Object;
211
- decision: string;
212
- }) => {
213
- ok: boolean;
214
- success?: boolean;
215
- reason?: string;
216
- } | Promise<{
217
- ok: boolean;
218
- success?: boolean;
219
- reason?: string;
220
- }>;
221
- v2CommentsAdapter: import('vue').ShallowRef<null, null>;
222
- setV2CommentsAdapter: (adapter: any) => void;
223
- getV2CommentsAdapter: (superdoc: any) => any;
224
- applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => {
225
- ok: boolean;
226
- geometryOnly: boolean;
227
- commentItems?: undefined;
228
- trackedItems?: undefined;
229
- reason?: undefined;
230
- detail?: undefined;
231
- } | {
232
- ok: boolean;
233
- commentItems: any;
234
- trackedItems: any;
235
- geometryOnly?: undefined;
236
- reason?: undefined;
237
- detail?: undefined;
238
- } | {
239
- ok: boolean;
240
- reason: any;
241
- geometryOnly?: undefined;
242
- commentItems?: undefined;
243
- trackedItems?: undefined;
244
- detail?: undefined;
245
- } | {
246
- ok: boolean;
247
- reason: string;
248
- detail: any;
249
- geometryOnly?: undefined;
250
- commentItems?: undefined;
251
- trackedItems?: undefined;
252
- };
253
- reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
254
- preparedInputs?: null | undefined;
255
- pruneStale?: boolean | undefined;
256
- }) => {
257
- added: null;
258
- dropped: string;
259
- } | {
260
- added: any;
261
- dropped?: undefined;
262
- };
263
- announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
264
- ok: boolean;
265
- reason: string;
266
- detail?: undefined;
267
- comment?: undefined;
268
- } | {
269
- ok: boolean;
270
- reason: string;
271
- detail: any;
272
- comment?: undefined;
273
- } | {
274
- ok: boolean;
275
- comment: any;
276
- reason?: undefined;
277
- detail?: undefined;
278
- }>;
279
- dropCommentsFromMutationImpact: ({ superdoc, documentId, removedIds }?: {}) => {
280
- ok: boolean;
281
- removedIds: (string | null)[];
282
- };
283
- isV2EditorActive: (superdoc: any) => boolean;
284
- replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
285
- superdoc?: Object | undefined;
286
- parentCommentId?: string | null | undefined;
287
- text?: string | undefined;
288
- mentions?: {
289
- name?: string | null;
290
- email?: string | null;
291
- }[] | undefined;
292
- trackedChangeTarget?: {
293
- kind: "trackedChange";
294
- trackedChangeId: string;
295
- story?: unknown;
296
- side?: import('./helpers/tracked-change-thread-index.js').TrackedChangeSideGroup;
297
- } | undefined;
298
- }) => Promise<any>;
299
- editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
300
- resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
301
- reopenCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
302
- v2TrackedChangesAdapter: import('vue').ShallowRef<null, null>;
303
- setV2TrackedChangesAdapter: (adapter: any) => void;
304
- getV2TrackedChangesAdapter: (superdoc: any) => any;
305
- getV2TrackedChangeRowCount: (documentId?: null) => number;
306
- reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, remappedPairs, allResolved, }?: {
307
- upsertIds?: never[] | undefined;
308
- removedIds?: never[] | undefined;
309
- remappedPairs?: never[] | undefined;
310
- }) => Promise<{
311
- ok: boolean;
312
- reason: string;
313
- items?: undefined;
314
- resolvedIds?: undefined;
315
- unresolvedIds?: undefined;
316
- allResolved?: undefined;
317
- removedRows?: undefined;
318
- removedIds?: undefined;
319
- } | {
320
- ok: boolean;
321
- items: never[];
322
- resolvedIds: never[];
323
- unresolvedIds: never[];
324
- allResolved: boolean;
325
- removedRows: number;
326
- reason?: undefined;
327
- removedIds?: undefined;
328
- } | {
329
- ok: boolean;
330
- items: never[];
331
- resolvedIds: never[];
332
- unresolvedIds: (string | null)[];
333
- removedIds: (string | null)[];
334
- reason?: undefined;
335
- allResolved?: undefined;
336
- removedRows?: undefined;
337
- }>;
338
- reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale, preparedParams, preparedPresentation, previousPreparedPresentation, liveIds: suppliedLiveIds, liveAnchorKeys: suppliedLiveAnchorKeys, hydrationGeneration, }?: {
339
- pruneStale?: boolean | undefined;
340
- preparedParams?: null | undefined;
341
- preparedPresentation?: null | undefined;
342
- previousPreparedPresentation?: null | undefined;
343
- liveIds?: null | undefined;
344
- liveAnchorKeys?: null | undefined;
345
- }) => {
346
- liveIds: Set<any>;
347
- liveAnchorKeys: Set<any>;
348
- appliedCount: number;
349
- } | undefined;
350
- remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
351
- }, "COMMENT_EVENTS" | "hasSyncedCollaborationComments" | "editingCommentId" | "activeComment" | "activeFloatingCommentInstanceId" | "suppressInternalExternal" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "editorCommentPositions" | "hasInitializedLocations" | "isCommentHighlighted" | "floatingCommentsOffset" | "committedReviewPresentations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2CommentsAdapter" | "v2TrackedChangesAdapter">, Pick<{
352
- COMMENT_EVENTS: {
353
- readonly RESOLVED: "resolved";
354
- readonly NEW: "new";
355
- readonly ADD: "add";
356
- readonly UPDATE: "update";
357
- readonly DELETED: "deleted";
358
- readonly PENDING: "pending";
359
- readonly SELECTED: "selected";
360
- readonly COMMENTS_LIST: "comments-list";
361
- readonly CHANGE_ACCEPTED: "change-accepted";
362
- readonly CHANGE_REJECTED: "change-rejected";
363
- };
364
- hasSyncedCollaborationComments: Ref<boolean, boolean>;
365
- editingCommentId: Ref<null, null>;
366
- activeComment: Ref<null, null>;
367
- activeFloatingCommentInstanceId: Ref<null, null>;
368
- suppressInternalExternal: Ref<boolean, boolean>;
369
- pendingComment: Ref<null, null>;
370
- currentCommentText: Ref<string, string>;
371
- currentCommentMentions: Ref<never[], never[]>;
372
- commentsList: Ref<never[], never[]>;
373
- reviewDirectoryList: import('vue').ShallowRef<never[], never[]>;
374
- isCommentsListVisible: Ref<boolean, boolean>;
375
- isReviewDirectoryActive: Ref<boolean, boolean>;
376
- isReviewDirectoryLoading: Ref<boolean, boolean>;
377
- generalCommentIds: Ref<never[], never[]>;
378
- editorCommentIds: Ref<never[], never[]>;
379
- commentsParentElement: Ref<null, null>;
380
- editorCommentPositions: Ref<{}, {}>;
381
- hasInitializedLocations: Ref<boolean, boolean>;
382
- isCommentHighlighted: Ref<boolean, boolean>;
383
- floatingCommentsOffset: Ref<number, number>;
384
- committedReviewPresentations: import('vue').ShallowRef<{}, {}>;
385
- skipSelectionUpdate: Ref<boolean, boolean>;
386
- isFloatingCommentsReady: Ref<boolean, boolean>;
387
- instantSidebarAlignmentTargetY: Ref<null, null>;
388
- instantSidebarAlignmentThreadId: Ref<null, null>;
389
- instantSidebarAlignmentInstanceId: Ref<null, null>;
390
- getConfig: import('vue').ComputedRef<{
391
- name: string;
392
- readOnly: boolean;
393
- allowResolve: boolean;
394
- showResolved: boolean;
395
- }>;
396
- documentsWithConverations: import('vue').ComputedRef<any>;
397
- getGroupedComments: import('vue').ComputedRef<{
398
- parentComments: any[];
399
- resolvedComments: any[];
400
- }>;
401
- getGroupedReviewDirectory: import('vue').ComputedRef<{
402
- parentComments: any[];
403
- resolvedComments: any[];
404
- }>;
405
- hasOpenTrackedChanges: import('vue').ComputedRef<boolean>;
406
- getFloatingComments: import('vue').ComputedRef<any[]>;
407
- getFloatingCommentInstances: import('vue').ComputedRef<{
408
- id: string;
409
- threadId: string | null;
410
- comment: any;
411
- positionKey: string | null;
412
- positionEntry: {
413
- pageIndex?: number | null;
414
- rects?: readonly ({
415
- pageIndex?: number | null;
416
- left?: number;
417
- top?: number;
418
- right?: number;
419
- bottom?: number;
420
- } | null | undefined)[] | null;
421
- bounds?: Partial<{
422
- left: number;
423
- top: number;
424
- right: number;
425
- bottom: number;
426
- width: number;
427
- height: number;
428
- }> | null;
429
- } | null;
430
- pageIndex: number | null;
431
- isPrimary: boolean;
432
- }[]>;
433
- getCommentAliasIds: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined) => string[];
434
- getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
435
- getCommentPositionKey: (commentOrId: import('./helpers/comment-identity.js').CommentIdentityRow | string | null | undefined) => unknown;
436
- getCommentPosition: (commentOrId: Object | string) => Object | null;
437
- resolveCommentPositionEntry: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined, preferredId?: unknown) => {
438
- key: string;
439
- entry: import('./helpers/comment-identity.js').CommentPositionEntry;
440
- } | {
441
- key: null;
442
- entry: null;
443
- };
444
- getCommentDocumentId: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment) => string | null;
445
- belongsToDocument: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment, activeDocumentId: string | null | undefined, options?: import('./helpers/comment-document-scope.js').BelongsToDocumentOptions) => boolean;
446
- viewingVisibility: {
447
- documentMode: string;
448
- commentsVisible: boolean;
449
- trackChangesVisible: boolean;
450
- };
451
- isViewingMode: import('vue').ComputedRef<boolean>;
452
- shouldRenderReviewInViewing: import('vue').ComputedRef<boolean>;
453
- init: (config?: Object) => void;
454
- setViewingVisibility: ({ documentMode, commentsVisible, trackChangesVisible }?: {}) => void;
455
- getComment: (id: unknown) => import('./helpers/comment-identity.js').CommentIdentityRow | null;
456
- setActiveComment: (superdoc: Object | undefined | null, id: string | undefined | null) => void;
457
- getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
458
- selection?: Object | undefined;
459
- documentId?: string | null | undefined;
460
- parentCommentId?: string | null | undefined;
461
- }) => ReturnType<any>;
462
- showAddComment: (superdoc: any, targetClientY?: null) => any;
463
- addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
464
- superdoc: any;
465
- comment: any;
466
- skipEditorUpdate?: boolean | undefined;
467
- broadcastChanges?: boolean | undefined;
468
- }) => {
469
- ok: boolean;
470
- reason?: string;
471
- detail?: string;
472
- code?: string;
473
- } | Promise<{
474
- ok: boolean;
475
- reason?: string;
476
- detail?: string;
477
- code?: string;
478
- }>;
479
- addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
480
- superdoc: any;
481
- comment: any;
482
- skipEditorUpdate?: boolean | undefined;
483
- broadcastChanges?: boolean | undefined;
484
- }) => {
485
- ok: boolean;
486
- reason?: string;
487
- detail?: string;
488
- code?: string;
489
- } | Promise<{
490
- ok: boolean;
491
- reason?: string;
492
- detail?: string;
493
- code?: string;
494
- }>;
495
- cancelComment: (superdoc: any) => void;
496
- deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
497
- commentId: any;
498
- superdoc: any;
499
- }) => Promise<any>;
500
- removePendingComment: (superdoc: any) => void;
501
- removeCommentsForDocument: (documentId: string | null | undefined) => void;
502
- setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
503
- commentItems?: never[] | undefined;
504
- trackedChangeItems?: never[] | undefined;
505
- }) => {
506
- ok: boolean;
507
- reason: string;
508
- count?: undefined;
509
- } | {
510
- ok: boolean;
511
- count: number;
512
- reason?: undefined;
513
- };
514
- clearReviewDirectory: () => void;
515
- handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
516
- retainMissingTrackedChangeGeometry?: boolean;
517
- retainedTrackedChangeIds?: Iterable<string>;
518
- }) => void;
519
- clearEditorCommentPositions: () => void;
520
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
521
- superdoc: Object;
522
- params: Object;
523
- }) => void;
524
- syncResolvedCommentsWithDocument: () => number;
525
- setActiveFloatingCommentInstance: (instanceId?: null) => void;
526
- requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
527
- peekInstantSidebarAlignment: () => null;
528
- clearInstantSidebarAlignment: () => void;
529
- decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
530
- superdoc: Object;
531
- comment: Object;
532
- decision: string;
533
- }) => {
534
- ok: boolean;
535
- success?: boolean;
536
- reason?: string;
537
- } | Promise<{
538
- ok: boolean;
539
- success?: boolean;
540
- reason?: string;
541
- }>;
542
- v2CommentsAdapter: import('vue').ShallowRef<null, null>;
543
- setV2CommentsAdapter: (adapter: any) => void;
544
- getV2CommentsAdapter: (superdoc: any) => any;
545
- applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => {
546
- ok: boolean;
547
- geometryOnly: boolean;
548
- commentItems?: undefined;
549
- trackedItems?: undefined;
550
- reason?: undefined;
551
- detail?: undefined;
552
- } | {
553
- ok: boolean;
554
- commentItems: any;
555
- trackedItems: any;
556
- geometryOnly?: undefined;
557
- reason?: undefined;
558
- detail?: undefined;
559
- } | {
560
- ok: boolean;
561
- reason: any;
562
- geometryOnly?: undefined;
563
- commentItems?: undefined;
564
- trackedItems?: undefined;
565
- detail?: undefined;
566
- } | {
567
- ok: boolean;
568
- reason: string;
569
- detail: any;
570
- geometryOnly?: undefined;
571
- commentItems?: undefined;
572
- trackedItems?: undefined;
573
- };
574
- reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
575
- preparedInputs?: null | undefined;
576
- pruneStale?: boolean | undefined;
577
- }) => {
578
- added: null;
579
- dropped: string;
580
- } | {
581
- added: any;
582
- dropped?: undefined;
583
- };
584
- announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
585
- ok: boolean;
586
- reason: string;
587
- detail?: undefined;
588
- comment?: undefined;
589
- } | {
590
- ok: boolean;
591
- reason: string;
592
- detail: any;
593
- comment?: undefined;
594
- } | {
595
- ok: boolean;
596
- comment: any;
597
- reason?: undefined;
598
- detail?: undefined;
599
- }>;
600
- dropCommentsFromMutationImpact: ({ superdoc, documentId, removedIds }?: {}) => {
601
- ok: boolean;
602
- removedIds: (string | null)[];
603
- };
604
- isV2EditorActive: (superdoc: any) => boolean;
605
- replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
606
- superdoc?: Object | undefined;
607
- parentCommentId?: string | null | undefined;
608
- text?: string | undefined;
609
- mentions?: {
610
- name?: string | null;
611
- email?: string | null;
612
- }[] | undefined;
613
- trackedChangeTarget?: {
614
- kind: "trackedChange";
615
- trackedChangeId: string;
616
- story?: unknown;
617
- side?: import('./helpers/tracked-change-thread-index.js').TrackedChangeSideGroup;
618
- } | undefined;
619
- }) => Promise<any>;
620
- editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
621
- resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
622
- reopenCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
623
- v2TrackedChangesAdapter: import('vue').ShallowRef<null, null>;
624
- setV2TrackedChangesAdapter: (adapter: any) => void;
625
- getV2TrackedChangesAdapter: (superdoc: any) => any;
626
- getV2TrackedChangeRowCount: (documentId?: null) => number;
627
- reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, remappedPairs, allResolved, }?: {
628
- upsertIds?: never[] | undefined;
629
- removedIds?: never[] | undefined;
630
- remappedPairs?: never[] | undefined;
631
- }) => Promise<{
632
- ok: boolean;
633
- reason: string;
634
- items?: undefined;
635
- resolvedIds?: undefined;
636
- unresolvedIds?: undefined;
637
- allResolved?: undefined;
638
- removedRows?: undefined;
639
- removedIds?: undefined;
640
- } | {
641
- ok: boolean;
642
- items: never[];
643
- resolvedIds: never[];
644
- unresolvedIds: never[];
645
- allResolved: boolean;
646
- removedRows: number;
647
- reason?: undefined;
648
- removedIds?: undefined;
649
- } | {
650
- ok: boolean;
651
- items: never[];
652
- resolvedIds: never[];
653
- unresolvedIds: (string | null)[];
654
- removedIds: (string | null)[];
655
- reason?: undefined;
656
- allResolved?: undefined;
657
- removedRows?: undefined;
658
- }>;
659
- reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale, preparedParams, preparedPresentation, previousPreparedPresentation, liveIds: suppliedLiveIds, liveAnchorKeys: suppliedLiveAnchorKeys, hydrationGeneration, }?: {
660
- pruneStale?: boolean | undefined;
661
- preparedParams?: null | undefined;
662
- preparedPresentation?: null | undefined;
663
- previousPreparedPresentation?: null | undefined;
664
- liveIds?: null | undefined;
665
- liveAnchorKeys?: null | undefined;
666
- }) => {
667
- liveIds: Set<any>;
668
- liveAnchorKeys: Set<any>;
669
- appliedCount: number;
670
- } | undefined;
671
- remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
672
- }, "getConfig" | "documentsWithConverations" | "getGroupedComments" | "getGroupedReviewDirectory" | "hasOpenTrackedChanges" | "getFloatingComments" | "getFloatingCommentInstances" | "isViewingMode" | "shouldRenderReviewInViewing">, Pick<{
673
- COMMENT_EVENTS: {
674
- readonly RESOLVED: "resolved";
675
- readonly NEW: "new";
676
- readonly ADD: "add";
677
- readonly UPDATE: "update";
678
- readonly DELETED: "deleted";
679
- readonly PENDING: "pending";
680
- readonly SELECTED: "selected";
681
- readonly COMMENTS_LIST: "comments-list";
682
- readonly CHANGE_ACCEPTED: "change-accepted";
683
- readonly CHANGE_REJECTED: "change-rejected";
684
- };
685
- hasSyncedCollaborationComments: Ref<boolean, boolean>;
686
- editingCommentId: Ref<null, null>;
687
- activeComment: Ref<null, null>;
688
- activeFloatingCommentInstanceId: Ref<null, null>;
689
- suppressInternalExternal: Ref<boolean, boolean>;
690
- pendingComment: Ref<null, null>;
691
- currentCommentText: Ref<string, string>;
692
- currentCommentMentions: Ref<never[], never[]>;
693
- commentsList: Ref<never[], never[]>;
694
- reviewDirectoryList: import('vue').ShallowRef<never[], never[]>;
695
- isCommentsListVisible: Ref<boolean, boolean>;
696
- isReviewDirectoryActive: Ref<boolean, boolean>;
697
- isReviewDirectoryLoading: Ref<boolean, boolean>;
698
- generalCommentIds: Ref<never[], never[]>;
699
- editorCommentIds: Ref<never[], never[]>;
700
- commentsParentElement: Ref<null, null>;
701
- editorCommentPositions: Ref<{}, {}>;
702
- hasInitializedLocations: Ref<boolean, boolean>;
703
- isCommentHighlighted: Ref<boolean, boolean>;
704
- floatingCommentsOffset: Ref<number, number>;
705
- committedReviewPresentations: import('vue').ShallowRef<{}, {}>;
706
- skipSelectionUpdate: Ref<boolean, boolean>;
707
- isFloatingCommentsReady: Ref<boolean, boolean>;
708
- instantSidebarAlignmentTargetY: Ref<null, null>;
709
- instantSidebarAlignmentThreadId: Ref<null, null>;
710
- instantSidebarAlignmentInstanceId: Ref<null, null>;
711
- getConfig: import('vue').ComputedRef<{
712
- name: string;
713
- readOnly: boolean;
714
- allowResolve: boolean;
715
- showResolved: boolean;
716
- }>;
717
- documentsWithConverations: import('vue').ComputedRef<any>;
718
- getGroupedComments: import('vue').ComputedRef<{
719
- parentComments: any[];
720
- resolvedComments: any[];
721
- }>;
722
- getGroupedReviewDirectory: import('vue').ComputedRef<{
723
- parentComments: any[];
724
- resolvedComments: any[];
725
- }>;
726
- hasOpenTrackedChanges: import('vue').ComputedRef<boolean>;
727
- getFloatingComments: import('vue').ComputedRef<any[]>;
728
- getFloatingCommentInstances: import('vue').ComputedRef<{
729
- id: string;
730
- threadId: string | null;
731
- comment: any;
732
- positionKey: string | null;
733
- positionEntry: {
734
- pageIndex?: number | null;
735
- rects?: readonly ({
736
- pageIndex?: number | null;
737
- left?: number;
738
- top?: number;
739
- right?: number;
740
- bottom?: number;
741
- } | null | undefined)[] | null;
742
- bounds?: Partial<{
743
- left: number;
744
- top: number;
745
- right: number;
746
- bottom: number;
747
- width: number;
748
- height: number;
749
- }> | null;
750
- } | null;
751
- pageIndex: number | null;
752
- isPrimary: boolean;
753
- }[]>;
754
- getCommentAliasIds: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined) => string[];
755
- getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
756
- getCommentPositionKey: (commentOrId: import('./helpers/comment-identity.js').CommentIdentityRow | string | null | undefined) => unknown;
757
- getCommentPosition: (commentOrId: Object | string) => Object | null;
758
- resolveCommentPositionEntry: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined, preferredId?: unknown) => {
759
- key: string;
760
- entry: import('./helpers/comment-identity.js').CommentPositionEntry;
761
- } | {
762
- key: null;
763
- entry: null;
764
- };
765
- getCommentDocumentId: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment) => string | null;
766
- belongsToDocument: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment, activeDocumentId: string | null | undefined, options?: import('./helpers/comment-document-scope.js').BelongsToDocumentOptions) => boolean;
767
- viewingVisibility: {
768
- documentMode: string;
769
- commentsVisible: boolean;
770
- trackChangesVisible: boolean;
771
- };
772
- isViewingMode: import('vue').ComputedRef<boolean>;
773
- shouldRenderReviewInViewing: import('vue').ComputedRef<boolean>;
774
- init: (config?: Object) => void;
775
- setViewingVisibility: ({ documentMode, commentsVisible, trackChangesVisible }?: {}) => void;
776
- getComment: (id: unknown) => import('./helpers/comment-identity.js').CommentIdentityRow | null;
777
- setActiveComment: (superdoc: Object | undefined | null, id: string | undefined | null) => void;
778
- getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
779
- selection?: Object | undefined;
780
- documentId?: string | null | undefined;
781
- parentCommentId?: string | null | undefined;
782
- }) => ReturnType<any>;
783
- showAddComment: (superdoc: any, targetClientY?: null) => any;
784
- addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
785
- superdoc: any;
786
- comment: any;
787
- skipEditorUpdate?: boolean | undefined;
788
- broadcastChanges?: boolean | undefined;
789
- }) => {
790
- ok: boolean;
791
- reason?: string;
792
- detail?: string;
793
- code?: string;
794
- } | Promise<{
795
- ok: boolean;
796
- reason?: string;
797
- detail?: string;
798
- code?: string;
799
- }>;
800
- addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
801
- superdoc: any;
802
- comment: any;
803
- skipEditorUpdate?: boolean | undefined;
804
- broadcastChanges?: boolean | undefined;
805
- }) => {
806
- ok: boolean;
807
- reason?: string;
808
- detail?: string;
809
- code?: string;
810
- } | Promise<{
811
- ok: boolean;
812
- reason?: string;
813
- detail?: string;
814
- code?: string;
815
- }>;
816
- cancelComment: (superdoc: any) => void;
817
- deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
818
- commentId: any;
819
- superdoc: any;
820
- }) => Promise<any>;
821
- removePendingComment: (superdoc: any) => void;
822
- removeCommentsForDocument: (documentId: string | null | undefined) => void;
823
- setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
824
- commentItems?: never[] | undefined;
825
- trackedChangeItems?: never[] | undefined;
826
- }) => {
827
- ok: boolean;
828
- reason: string;
829
- count?: undefined;
830
- } | {
831
- ok: boolean;
832
- count: number;
833
- reason?: undefined;
834
- };
835
- clearReviewDirectory: () => void;
836
- handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
837
- retainMissingTrackedChangeGeometry?: boolean;
838
- retainedTrackedChangeIds?: Iterable<string>;
839
- }) => void;
840
- clearEditorCommentPositions: () => void;
841
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
842
- superdoc: Object;
843
- params: Object;
844
- }) => void;
845
- syncResolvedCommentsWithDocument: () => number;
846
- setActiveFloatingCommentInstance: (instanceId?: null) => void;
847
- requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
848
- peekInstantSidebarAlignment: () => null;
849
- clearInstantSidebarAlignment: () => void;
850
- decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
851
- superdoc: Object;
852
- comment: Object;
853
- decision: string;
854
- }) => {
855
- ok: boolean;
856
- success?: boolean;
857
- reason?: string;
858
- } | Promise<{
859
- ok: boolean;
860
- success?: boolean;
861
- reason?: string;
862
- }>;
863
- v2CommentsAdapter: import('vue').ShallowRef<null, null>;
864
- setV2CommentsAdapter: (adapter: any) => void;
865
- getV2CommentsAdapter: (superdoc: any) => any;
866
- applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => {
867
- ok: boolean;
868
- geometryOnly: boolean;
869
- commentItems?: undefined;
870
- trackedItems?: undefined;
871
- reason?: undefined;
872
- detail?: undefined;
873
- } | {
874
- ok: boolean;
875
- commentItems: any;
876
- trackedItems: any;
877
- geometryOnly?: undefined;
878
- reason?: undefined;
879
- detail?: undefined;
880
- } | {
881
- ok: boolean;
882
- reason: any;
883
- geometryOnly?: undefined;
884
- commentItems?: undefined;
885
- trackedItems?: undefined;
886
- detail?: undefined;
887
- } | {
888
- ok: boolean;
889
- reason: string;
890
- detail: any;
891
- geometryOnly?: undefined;
892
- commentItems?: undefined;
893
- trackedItems?: undefined;
894
- };
895
- reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
896
- preparedInputs?: null | undefined;
897
- pruneStale?: boolean | undefined;
898
- }) => {
899
- added: null;
900
- dropped: string;
901
- } | {
902
- added: any;
903
- dropped?: undefined;
904
- };
905
- announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
906
- ok: boolean;
907
- reason: string;
908
- detail?: undefined;
909
- comment?: undefined;
910
- } | {
911
- ok: boolean;
912
- reason: string;
913
- detail: any;
914
- comment?: undefined;
915
- } | {
916
- ok: boolean;
917
- comment: any;
918
- reason?: undefined;
919
- detail?: undefined;
920
- }>;
921
- dropCommentsFromMutationImpact: ({ superdoc, documentId, removedIds }?: {}) => {
922
- ok: boolean;
923
- removedIds: (string | null)[];
924
- };
925
- isV2EditorActive: (superdoc: any) => boolean;
926
- replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
927
- superdoc?: Object | undefined;
928
- parentCommentId?: string | null | undefined;
929
- text?: string | undefined;
930
- mentions?: {
931
- name?: string | null;
932
- email?: string | null;
933
- }[] | undefined;
934
- trackedChangeTarget?: {
935
- kind: "trackedChange";
936
- trackedChangeId: string;
937
- story?: unknown;
938
- side?: import('./helpers/tracked-change-thread-index.js').TrackedChangeSideGroup;
939
- } | undefined;
940
- }) => Promise<any>;
941
- editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
942
- resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
943
- reopenCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
944
- v2TrackedChangesAdapter: import('vue').ShallowRef<null, null>;
945
- setV2TrackedChangesAdapter: (adapter: any) => void;
946
- getV2TrackedChangesAdapter: (superdoc: any) => any;
947
- getV2TrackedChangeRowCount: (documentId?: null) => number;
948
- reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, remappedPairs, allResolved, }?: {
949
- upsertIds?: never[] | undefined;
950
- removedIds?: never[] | undefined;
951
- remappedPairs?: never[] | undefined;
952
- }) => Promise<{
953
- ok: boolean;
954
- reason: string;
955
- items?: undefined;
956
- resolvedIds?: undefined;
957
- unresolvedIds?: undefined;
958
- allResolved?: undefined;
959
- removedRows?: undefined;
960
- removedIds?: undefined;
961
- } | {
962
- ok: boolean;
963
- items: never[];
964
- resolvedIds: never[];
965
- unresolvedIds: never[];
966
- allResolved: boolean;
967
- removedRows: number;
968
- reason?: undefined;
969
- removedIds?: undefined;
970
- } | {
971
- ok: boolean;
972
- items: never[];
973
- resolvedIds: never[];
974
- unresolvedIds: (string | null)[];
975
- removedIds: (string | null)[];
976
- reason?: undefined;
977
- allResolved?: undefined;
978
- removedRows?: undefined;
979
- }>;
980
- reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale, preparedParams, preparedPresentation, previousPreparedPresentation, liveIds: suppliedLiveIds, liveAnchorKeys: suppliedLiveAnchorKeys, hydrationGeneration, }?: {
981
- pruneStale?: boolean | undefined;
982
- preparedParams?: null | undefined;
983
- preparedPresentation?: null | undefined;
984
- previousPreparedPresentation?: null | undefined;
985
- liveIds?: null | undefined;
986
- liveAnchorKeys?: null | undefined;
987
- }) => {
988
- liveIds: Set<any>;
989
- liveAnchorKeys: Set<any>;
990
- appliedCount: number;
991
- } | undefined;
992
- remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
993
- }, "resolveCommentPositionEntry" | "getCommentAliasIds" | "getCommentPositionKey" | "belongsToDocument" | "getComment" | "getTrackedChangeThread" | "getCommentPosition" | "getCommentDocumentId" | "init" | "setViewingVisibility" | "setActiveComment" | "getPendingComment" | "showAddComment" | "addComment" | "addHydratedComment" | "cancelComment" | "deleteComment" | "removePendingComment" | "removeCommentsForDocument" | "setReviewDirectoryFromV2" | "clearReviewDirectory" | "handleEditorLocationsUpdate" | "clearEditorCommentPositions" | "handleTrackedChangeUpdate" | "syncResolvedCommentsWithDocument" | "setActiveFloatingCommentInstance" | "requestInstantSidebarAlignment" | "peekInstantSidebarAlignment" | "clearInstantSidebarAlignment" | "decideTrackedChangeFromSidebar" | "setV2CommentsAdapter" | "getV2CommentsAdapter" | "applyReviewWindowFromV2" | "reconcileCommentsFromV2" | "announceV2CommentCreated" | "dropCommentsFromMutationImpact" | "isV2EditorActive" | "replyCommentV2" | "editCommentV2" | "resolveCommentV2" | "reopenCommentV2" | "setV2TrackedChangesAdapter" | "getV2TrackedChangesAdapter" | "getV2TrackedChangeRowCount" | "reconcileTrackedChangeMutationFromV2" | "reconcileTrackedChangesFromV2" | "remapTrackedChangeIdentities">>;
30
+ commentsStore: {
31
+ removeCommentsForDocument(documentId: string | null | undefined): void;
32
+ };
994
33
  documents: Ref<StoreDocument[], StoreDocument[]>;
995
34
  documentBounds: Ref<unknown[], unknown[]>;
996
35
  pages: Record<string, PageEntry[]>;
@@ -1021,970 +60,9 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1021
60
  top: number;
1022
61
  } | undefined;
1023
62
  }, "user" | "pages" | "isInternal" | "measurementUnit" | "commentsStore" | "modules" | "documents" | "users" | "documentBounds" | "documentUsers" | "activeZoom" | "zoomMode" | "viewportMetrics" | "documentScroll" | "selectionPosition" | "activeSelection" | "isReady">, Pick<{
1024
- commentsStore: import('pinia').Store<"comments", Pick<{
1025
- COMMENT_EVENTS: {
1026
- readonly RESOLVED: "resolved";
1027
- readonly NEW: "new";
1028
- readonly ADD: "add";
1029
- readonly UPDATE: "update";
1030
- readonly DELETED: "deleted";
1031
- readonly PENDING: "pending";
1032
- readonly SELECTED: "selected";
1033
- readonly COMMENTS_LIST: "comments-list";
1034
- readonly CHANGE_ACCEPTED: "change-accepted";
1035
- readonly CHANGE_REJECTED: "change-rejected";
1036
- };
1037
- hasSyncedCollaborationComments: Ref<boolean, boolean>;
1038
- editingCommentId: Ref<null, null>;
1039
- activeComment: Ref<null, null>;
1040
- activeFloatingCommentInstanceId: Ref<null, null>;
1041
- suppressInternalExternal: Ref<boolean, boolean>;
1042
- pendingComment: Ref<null, null>;
1043
- currentCommentText: Ref<string, string>;
1044
- currentCommentMentions: Ref<never[], never[]>;
1045
- commentsList: Ref<never[], never[]>;
1046
- reviewDirectoryList: import('vue').ShallowRef<never[], never[]>;
1047
- isCommentsListVisible: Ref<boolean, boolean>;
1048
- isReviewDirectoryActive: Ref<boolean, boolean>;
1049
- isReviewDirectoryLoading: Ref<boolean, boolean>;
1050
- generalCommentIds: Ref<never[], never[]>;
1051
- editorCommentIds: Ref<never[], never[]>;
1052
- commentsParentElement: Ref<null, null>;
1053
- editorCommentPositions: Ref<{}, {}>;
1054
- hasInitializedLocations: Ref<boolean, boolean>;
1055
- isCommentHighlighted: Ref<boolean, boolean>;
1056
- floatingCommentsOffset: Ref<number, number>;
1057
- committedReviewPresentations: import('vue').ShallowRef<{}, {}>;
1058
- skipSelectionUpdate: Ref<boolean, boolean>;
1059
- isFloatingCommentsReady: Ref<boolean, boolean>;
1060
- instantSidebarAlignmentTargetY: Ref<null, null>;
1061
- instantSidebarAlignmentThreadId: Ref<null, null>;
1062
- instantSidebarAlignmentInstanceId: Ref<null, null>;
1063
- getConfig: import('vue').ComputedRef<{
1064
- name: string;
1065
- readOnly: boolean;
1066
- allowResolve: boolean;
1067
- showResolved: boolean;
1068
- }>;
1069
- documentsWithConverations: import('vue').ComputedRef<any>;
1070
- getGroupedComments: import('vue').ComputedRef<{
1071
- parentComments: any[];
1072
- resolvedComments: any[];
1073
- }>;
1074
- getGroupedReviewDirectory: import('vue').ComputedRef<{
1075
- parentComments: any[];
1076
- resolvedComments: any[];
1077
- }>;
1078
- hasOpenTrackedChanges: import('vue').ComputedRef<boolean>;
1079
- getFloatingComments: import('vue').ComputedRef<any[]>;
1080
- getFloatingCommentInstances: import('vue').ComputedRef<{
1081
- id: string;
1082
- threadId: string | null;
1083
- comment: any;
1084
- positionKey: string | null;
1085
- positionEntry: {
1086
- pageIndex?: number | null;
1087
- rects?: readonly ({
1088
- pageIndex?: number | null;
1089
- left?: number;
1090
- top?: number;
1091
- right?: number;
1092
- bottom?: number;
1093
- } | null | undefined)[] | null;
1094
- bounds?: Partial<{
1095
- left: number;
1096
- top: number;
1097
- right: number;
1098
- bottom: number;
1099
- width: number;
1100
- height: number;
1101
- }> | null;
1102
- } | null;
1103
- pageIndex: number | null;
1104
- isPrimary: boolean;
1105
- }[]>;
1106
- getCommentAliasIds: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined) => string[];
1107
- getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
1108
- getCommentPositionKey: (commentOrId: import('./helpers/comment-identity.js').CommentIdentityRow | string | null | undefined) => unknown;
1109
- getCommentPosition: (commentOrId: Object | string) => Object | null;
1110
- resolveCommentPositionEntry: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined, preferredId?: unknown) => {
1111
- key: string;
1112
- entry: import('./helpers/comment-identity.js').CommentPositionEntry;
1113
- } | {
1114
- key: null;
1115
- entry: null;
1116
- };
1117
- getCommentDocumentId: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment) => string | null;
1118
- belongsToDocument: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment, activeDocumentId: string | null | undefined, options?: import('./helpers/comment-document-scope.js').BelongsToDocumentOptions) => boolean;
1119
- viewingVisibility: {
1120
- documentMode: string;
1121
- commentsVisible: boolean;
1122
- trackChangesVisible: boolean;
1123
- };
1124
- isViewingMode: import('vue').ComputedRef<boolean>;
1125
- shouldRenderReviewInViewing: import('vue').ComputedRef<boolean>;
1126
- init: (config?: Object) => void;
1127
- setViewingVisibility: ({ documentMode, commentsVisible, trackChangesVisible }?: {}) => void;
1128
- getComment: (id: unknown) => import('./helpers/comment-identity.js').CommentIdentityRow | null;
1129
- setActiveComment: (superdoc: Object | undefined | null, id: string | undefined | null) => void;
1130
- getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
1131
- selection?: Object | undefined;
1132
- documentId?: string | null | undefined;
1133
- parentCommentId?: string | null | undefined;
1134
- }) => ReturnType<any>;
1135
- showAddComment: (superdoc: any, targetClientY?: null) => any;
1136
- addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
1137
- superdoc: any;
1138
- comment: any;
1139
- skipEditorUpdate?: boolean | undefined;
1140
- broadcastChanges?: boolean | undefined;
1141
- }) => {
1142
- ok: boolean;
1143
- reason?: string;
1144
- detail?: string;
1145
- code?: string;
1146
- } | Promise<{
1147
- ok: boolean;
1148
- reason?: string;
1149
- detail?: string;
1150
- code?: string;
1151
- }>;
1152
- addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
1153
- superdoc: any;
1154
- comment: any;
1155
- skipEditorUpdate?: boolean | undefined;
1156
- broadcastChanges?: boolean | undefined;
1157
- }) => {
1158
- ok: boolean;
1159
- reason?: string;
1160
- detail?: string;
1161
- code?: string;
1162
- } | Promise<{
1163
- ok: boolean;
1164
- reason?: string;
1165
- detail?: string;
1166
- code?: string;
1167
- }>;
1168
- cancelComment: (superdoc: any) => void;
1169
- deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
1170
- commentId: any;
1171
- superdoc: any;
1172
- }) => Promise<any>;
1173
- removePendingComment: (superdoc: any) => void;
1174
- removeCommentsForDocument: (documentId: string | null | undefined) => void;
1175
- setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
1176
- commentItems?: never[] | undefined;
1177
- trackedChangeItems?: never[] | undefined;
1178
- }) => {
1179
- ok: boolean;
1180
- reason: string;
1181
- count?: undefined;
1182
- } | {
1183
- ok: boolean;
1184
- count: number;
1185
- reason?: undefined;
1186
- };
1187
- clearReviewDirectory: () => void;
1188
- handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
1189
- retainMissingTrackedChangeGeometry?: boolean;
1190
- retainedTrackedChangeIds?: Iterable<string>;
1191
- }) => void;
1192
- clearEditorCommentPositions: () => void;
1193
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
1194
- superdoc: Object;
1195
- params: Object;
1196
- }) => void;
1197
- syncResolvedCommentsWithDocument: () => number;
1198
- setActiveFloatingCommentInstance: (instanceId?: null) => void;
1199
- requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
1200
- peekInstantSidebarAlignment: () => null;
1201
- clearInstantSidebarAlignment: () => void;
1202
- decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
1203
- superdoc: Object;
1204
- comment: Object;
1205
- decision: string;
1206
- }) => {
1207
- ok: boolean;
1208
- success?: boolean;
1209
- reason?: string;
1210
- } | Promise<{
1211
- ok: boolean;
1212
- success?: boolean;
1213
- reason?: string;
1214
- }>;
1215
- v2CommentsAdapter: import('vue').ShallowRef<null, null>;
1216
- setV2CommentsAdapter: (adapter: any) => void;
1217
- getV2CommentsAdapter: (superdoc: any) => any;
1218
- applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => {
1219
- ok: boolean;
1220
- geometryOnly: boolean;
1221
- commentItems?: undefined;
1222
- trackedItems?: undefined;
1223
- reason?: undefined;
1224
- detail?: undefined;
1225
- } | {
1226
- ok: boolean;
1227
- commentItems: any;
1228
- trackedItems: any;
1229
- geometryOnly?: undefined;
1230
- reason?: undefined;
1231
- detail?: undefined;
1232
- } | {
1233
- ok: boolean;
1234
- reason: any;
1235
- geometryOnly?: undefined;
1236
- commentItems?: undefined;
1237
- trackedItems?: undefined;
1238
- detail?: undefined;
1239
- } | {
1240
- ok: boolean;
1241
- reason: string;
1242
- detail: any;
1243
- geometryOnly?: undefined;
1244
- commentItems?: undefined;
1245
- trackedItems?: undefined;
1246
- };
1247
- reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
1248
- preparedInputs?: null | undefined;
1249
- pruneStale?: boolean | undefined;
1250
- }) => {
1251
- added: null;
1252
- dropped: string;
1253
- } | {
1254
- added: any;
1255
- dropped?: undefined;
1256
- };
1257
- announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
1258
- ok: boolean;
1259
- reason: string;
1260
- detail?: undefined;
1261
- comment?: undefined;
1262
- } | {
1263
- ok: boolean;
1264
- reason: string;
1265
- detail: any;
1266
- comment?: undefined;
1267
- } | {
1268
- ok: boolean;
1269
- comment: any;
1270
- reason?: undefined;
1271
- detail?: undefined;
1272
- }>;
1273
- dropCommentsFromMutationImpact: ({ superdoc, documentId, removedIds }?: {}) => {
1274
- ok: boolean;
1275
- removedIds: (string | null)[];
1276
- };
1277
- isV2EditorActive: (superdoc: any) => boolean;
1278
- replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
1279
- superdoc?: Object | undefined;
1280
- parentCommentId?: string | null | undefined;
1281
- text?: string | undefined;
1282
- mentions?: {
1283
- name?: string | null;
1284
- email?: string | null;
1285
- }[] | undefined;
1286
- trackedChangeTarget?: {
1287
- kind: "trackedChange";
1288
- trackedChangeId: string;
1289
- story?: unknown;
1290
- side?: import('./helpers/tracked-change-thread-index.js').TrackedChangeSideGroup;
1291
- } | undefined;
1292
- }) => Promise<any>;
1293
- editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
1294
- resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
1295
- reopenCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
1296
- v2TrackedChangesAdapter: import('vue').ShallowRef<null, null>;
1297
- setV2TrackedChangesAdapter: (adapter: any) => void;
1298
- getV2TrackedChangesAdapter: (superdoc: any) => any;
1299
- getV2TrackedChangeRowCount: (documentId?: null) => number;
1300
- reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, remappedPairs, allResolved, }?: {
1301
- upsertIds?: never[] | undefined;
1302
- removedIds?: never[] | undefined;
1303
- remappedPairs?: never[] | undefined;
1304
- }) => Promise<{
1305
- ok: boolean;
1306
- reason: string;
1307
- items?: undefined;
1308
- resolvedIds?: undefined;
1309
- unresolvedIds?: undefined;
1310
- allResolved?: undefined;
1311
- removedRows?: undefined;
1312
- removedIds?: undefined;
1313
- } | {
1314
- ok: boolean;
1315
- items: never[];
1316
- resolvedIds: never[];
1317
- unresolvedIds: never[];
1318
- allResolved: boolean;
1319
- removedRows: number;
1320
- reason?: undefined;
1321
- removedIds?: undefined;
1322
- } | {
1323
- ok: boolean;
1324
- items: never[];
1325
- resolvedIds: never[];
1326
- unresolvedIds: (string | null)[];
1327
- removedIds: (string | null)[];
1328
- reason?: undefined;
1329
- allResolved?: undefined;
1330
- removedRows?: undefined;
1331
- }>;
1332
- reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale, preparedParams, preparedPresentation, previousPreparedPresentation, liveIds: suppliedLiveIds, liveAnchorKeys: suppliedLiveAnchorKeys, hydrationGeneration, }?: {
1333
- pruneStale?: boolean | undefined;
1334
- preparedParams?: null | undefined;
1335
- preparedPresentation?: null | undefined;
1336
- previousPreparedPresentation?: null | undefined;
1337
- liveIds?: null | undefined;
1338
- liveAnchorKeys?: null | undefined;
1339
- }) => {
1340
- liveIds: Set<any>;
1341
- liveAnchorKeys: Set<any>;
1342
- appliedCount: number;
1343
- } | undefined;
1344
- remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
1345
- }, "COMMENT_EVENTS" | "hasSyncedCollaborationComments" | "editingCommentId" | "activeComment" | "activeFloatingCommentInstanceId" | "suppressInternalExternal" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "editorCommentPositions" | "hasInitializedLocations" | "isCommentHighlighted" | "floatingCommentsOffset" | "committedReviewPresentations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2CommentsAdapter" | "v2TrackedChangesAdapter">, Pick<{
1346
- COMMENT_EVENTS: {
1347
- readonly RESOLVED: "resolved";
1348
- readonly NEW: "new";
1349
- readonly ADD: "add";
1350
- readonly UPDATE: "update";
1351
- readonly DELETED: "deleted";
1352
- readonly PENDING: "pending";
1353
- readonly SELECTED: "selected";
1354
- readonly COMMENTS_LIST: "comments-list";
1355
- readonly CHANGE_ACCEPTED: "change-accepted";
1356
- readonly CHANGE_REJECTED: "change-rejected";
1357
- };
1358
- hasSyncedCollaborationComments: Ref<boolean, boolean>;
1359
- editingCommentId: Ref<null, null>;
1360
- activeComment: Ref<null, null>;
1361
- activeFloatingCommentInstanceId: Ref<null, null>;
1362
- suppressInternalExternal: Ref<boolean, boolean>;
1363
- pendingComment: Ref<null, null>;
1364
- currentCommentText: Ref<string, string>;
1365
- currentCommentMentions: Ref<never[], never[]>;
1366
- commentsList: Ref<never[], never[]>;
1367
- reviewDirectoryList: import('vue').ShallowRef<never[], never[]>;
1368
- isCommentsListVisible: Ref<boolean, boolean>;
1369
- isReviewDirectoryActive: Ref<boolean, boolean>;
1370
- isReviewDirectoryLoading: Ref<boolean, boolean>;
1371
- generalCommentIds: Ref<never[], never[]>;
1372
- editorCommentIds: Ref<never[], never[]>;
1373
- commentsParentElement: Ref<null, null>;
1374
- editorCommentPositions: Ref<{}, {}>;
1375
- hasInitializedLocations: Ref<boolean, boolean>;
1376
- isCommentHighlighted: Ref<boolean, boolean>;
1377
- floatingCommentsOffset: Ref<number, number>;
1378
- committedReviewPresentations: import('vue').ShallowRef<{}, {}>;
1379
- skipSelectionUpdate: Ref<boolean, boolean>;
1380
- isFloatingCommentsReady: Ref<boolean, boolean>;
1381
- instantSidebarAlignmentTargetY: Ref<null, null>;
1382
- instantSidebarAlignmentThreadId: Ref<null, null>;
1383
- instantSidebarAlignmentInstanceId: Ref<null, null>;
1384
- getConfig: import('vue').ComputedRef<{
1385
- name: string;
1386
- readOnly: boolean;
1387
- allowResolve: boolean;
1388
- showResolved: boolean;
1389
- }>;
1390
- documentsWithConverations: import('vue').ComputedRef<any>;
1391
- getGroupedComments: import('vue').ComputedRef<{
1392
- parentComments: any[];
1393
- resolvedComments: any[];
1394
- }>;
1395
- getGroupedReviewDirectory: import('vue').ComputedRef<{
1396
- parentComments: any[];
1397
- resolvedComments: any[];
1398
- }>;
1399
- hasOpenTrackedChanges: import('vue').ComputedRef<boolean>;
1400
- getFloatingComments: import('vue').ComputedRef<any[]>;
1401
- getFloatingCommentInstances: import('vue').ComputedRef<{
1402
- id: string;
1403
- threadId: string | null;
1404
- comment: any;
1405
- positionKey: string | null;
1406
- positionEntry: {
1407
- pageIndex?: number | null;
1408
- rects?: readonly ({
1409
- pageIndex?: number | null;
1410
- left?: number;
1411
- top?: number;
1412
- right?: number;
1413
- bottom?: number;
1414
- } | null | undefined)[] | null;
1415
- bounds?: Partial<{
1416
- left: number;
1417
- top: number;
1418
- right: number;
1419
- bottom: number;
1420
- width: number;
1421
- height: number;
1422
- }> | null;
1423
- } | null;
1424
- pageIndex: number | null;
1425
- isPrimary: boolean;
1426
- }[]>;
1427
- getCommentAliasIds: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined) => string[];
1428
- getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
1429
- getCommentPositionKey: (commentOrId: import('./helpers/comment-identity.js').CommentIdentityRow | string | null | undefined) => unknown;
1430
- getCommentPosition: (commentOrId: Object | string) => Object | null;
1431
- resolveCommentPositionEntry: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined, preferredId?: unknown) => {
1432
- key: string;
1433
- entry: import('./helpers/comment-identity.js').CommentPositionEntry;
1434
- } | {
1435
- key: null;
1436
- entry: null;
1437
- };
1438
- getCommentDocumentId: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment) => string | null;
1439
- belongsToDocument: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment, activeDocumentId: string | null | undefined, options?: import('./helpers/comment-document-scope.js').BelongsToDocumentOptions) => boolean;
1440
- viewingVisibility: {
1441
- documentMode: string;
1442
- commentsVisible: boolean;
1443
- trackChangesVisible: boolean;
1444
- };
1445
- isViewingMode: import('vue').ComputedRef<boolean>;
1446
- shouldRenderReviewInViewing: import('vue').ComputedRef<boolean>;
1447
- init: (config?: Object) => void;
1448
- setViewingVisibility: ({ documentMode, commentsVisible, trackChangesVisible }?: {}) => void;
1449
- getComment: (id: unknown) => import('./helpers/comment-identity.js').CommentIdentityRow | null;
1450
- setActiveComment: (superdoc: Object | undefined | null, id: string | undefined | null) => void;
1451
- getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
1452
- selection?: Object | undefined;
1453
- documentId?: string | null | undefined;
1454
- parentCommentId?: string | null | undefined;
1455
- }) => ReturnType<any>;
1456
- showAddComment: (superdoc: any, targetClientY?: null) => any;
1457
- addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
1458
- superdoc: any;
1459
- comment: any;
1460
- skipEditorUpdate?: boolean | undefined;
1461
- broadcastChanges?: boolean | undefined;
1462
- }) => {
1463
- ok: boolean;
1464
- reason?: string;
1465
- detail?: string;
1466
- code?: string;
1467
- } | Promise<{
1468
- ok: boolean;
1469
- reason?: string;
1470
- detail?: string;
1471
- code?: string;
1472
- }>;
1473
- addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
1474
- superdoc: any;
1475
- comment: any;
1476
- skipEditorUpdate?: boolean | undefined;
1477
- broadcastChanges?: boolean | undefined;
1478
- }) => {
1479
- ok: boolean;
1480
- reason?: string;
1481
- detail?: string;
1482
- code?: string;
1483
- } | Promise<{
1484
- ok: boolean;
1485
- reason?: string;
1486
- detail?: string;
1487
- code?: string;
1488
- }>;
1489
- cancelComment: (superdoc: any) => void;
1490
- deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
1491
- commentId: any;
1492
- superdoc: any;
1493
- }) => Promise<any>;
1494
- removePendingComment: (superdoc: any) => void;
1495
- removeCommentsForDocument: (documentId: string | null | undefined) => void;
1496
- setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
1497
- commentItems?: never[] | undefined;
1498
- trackedChangeItems?: never[] | undefined;
1499
- }) => {
1500
- ok: boolean;
1501
- reason: string;
1502
- count?: undefined;
1503
- } | {
1504
- ok: boolean;
1505
- count: number;
1506
- reason?: undefined;
1507
- };
1508
- clearReviewDirectory: () => void;
1509
- handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
1510
- retainMissingTrackedChangeGeometry?: boolean;
1511
- retainedTrackedChangeIds?: Iterable<string>;
1512
- }) => void;
1513
- clearEditorCommentPositions: () => void;
1514
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
1515
- superdoc: Object;
1516
- params: Object;
1517
- }) => void;
1518
- syncResolvedCommentsWithDocument: () => number;
1519
- setActiveFloatingCommentInstance: (instanceId?: null) => void;
1520
- requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
1521
- peekInstantSidebarAlignment: () => null;
1522
- clearInstantSidebarAlignment: () => void;
1523
- decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
1524
- superdoc: Object;
1525
- comment: Object;
1526
- decision: string;
1527
- }) => {
1528
- ok: boolean;
1529
- success?: boolean;
1530
- reason?: string;
1531
- } | Promise<{
1532
- ok: boolean;
1533
- success?: boolean;
1534
- reason?: string;
1535
- }>;
1536
- v2CommentsAdapter: import('vue').ShallowRef<null, null>;
1537
- setV2CommentsAdapter: (adapter: any) => void;
1538
- getV2CommentsAdapter: (superdoc: any) => any;
1539
- applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => {
1540
- ok: boolean;
1541
- geometryOnly: boolean;
1542
- commentItems?: undefined;
1543
- trackedItems?: undefined;
1544
- reason?: undefined;
1545
- detail?: undefined;
1546
- } | {
1547
- ok: boolean;
1548
- commentItems: any;
1549
- trackedItems: any;
1550
- geometryOnly?: undefined;
1551
- reason?: undefined;
1552
- detail?: undefined;
1553
- } | {
1554
- ok: boolean;
1555
- reason: any;
1556
- geometryOnly?: undefined;
1557
- commentItems?: undefined;
1558
- trackedItems?: undefined;
1559
- detail?: undefined;
1560
- } | {
1561
- ok: boolean;
1562
- reason: string;
1563
- detail: any;
1564
- geometryOnly?: undefined;
1565
- commentItems?: undefined;
1566
- trackedItems?: undefined;
1567
- };
1568
- reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
1569
- preparedInputs?: null | undefined;
1570
- pruneStale?: boolean | undefined;
1571
- }) => {
1572
- added: null;
1573
- dropped: string;
1574
- } | {
1575
- added: any;
1576
- dropped?: undefined;
1577
- };
1578
- announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
1579
- ok: boolean;
1580
- reason: string;
1581
- detail?: undefined;
1582
- comment?: undefined;
1583
- } | {
1584
- ok: boolean;
1585
- reason: string;
1586
- detail: any;
1587
- comment?: undefined;
1588
- } | {
1589
- ok: boolean;
1590
- comment: any;
1591
- reason?: undefined;
1592
- detail?: undefined;
1593
- }>;
1594
- dropCommentsFromMutationImpact: ({ superdoc, documentId, removedIds }?: {}) => {
1595
- ok: boolean;
1596
- removedIds: (string | null)[];
1597
- };
1598
- isV2EditorActive: (superdoc: any) => boolean;
1599
- replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
1600
- superdoc?: Object | undefined;
1601
- parentCommentId?: string | null | undefined;
1602
- text?: string | undefined;
1603
- mentions?: {
1604
- name?: string | null;
1605
- email?: string | null;
1606
- }[] | undefined;
1607
- trackedChangeTarget?: {
1608
- kind: "trackedChange";
1609
- trackedChangeId: string;
1610
- story?: unknown;
1611
- side?: import('./helpers/tracked-change-thread-index.js').TrackedChangeSideGroup;
1612
- } | undefined;
1613
- }) => Promise<any>;
1614
- editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
1615
- resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
1616
- reopenCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
1617
- v2TrackedChangesAdapter: import('vue').ShallowRef<null, null>;
1618
- setV2TrackedChangesAdapter: (adapter: any) => void;
1619
- getV2TrackedChangesAdapter: (superdoc: any) => any;
1620
- getV2TrackedChangeRowCount: (documentId?: null) => number;
1621
- reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, remappedPairs, allResolved, }?: {
1622
- upsertIds?: never[] | undefined;
1623
- removedIds?: never[] | undefined;
1624
- remappedPairs?: never[] | undefined;
1625
- }) => Promise<{
1626
- ok: boolean;
1627
- reason: string;
1628
- items?: undefined;
1629
- resolvedIds?: undefined;
1630
- unresolvedIds?: undefined;
1631
- allResolved?: undefined;
1632
- removedRows?: undefined;
1633
- removedIds?: undefined;
1634
- } | {
1635
- ok: boolean;
1636
- items: never[];
1637
- resolvedIds: never[];
1638
- unresolvedIds: never[];
1639
- allResolved: boolean;
1640
- removedRows: number;
1641
- reason?: undefined;
1642
- removedIds?: undefined;
1643
- } | {
1644
- ok: boolean;
1645
- items: never[];
1646
- resolvedIds: never[];
1647
- unresolvedIds: (string | null)[];
1648
- removedIds: (string | null)[];
1649
- reason?: undefined;
1650
- allResolved?: undefined;
1651
- removedRows?: undefined;
1652
- }>;
1653
- reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale, preparedParams, preparedPresentation, previousPreparedPresentation, liveIds: suppliedLiveIds, liveAnchorKeys: suppliedLiveAnchorKeys, hydrationGeneration, }?: {
1654
- pruneStale?: boolean | undefined;
1655
- preparedParams?: null | undefined;
1656
- preparedPresentation?: null | undefined;
1657
- previousPreparedPresentation?: null | undefined;
1658
- liveIds?: null | undefined;
1659
- liveAnchorKeys?: null | undefined;
1660
- }) => {
1661
- liveIds: Set<any>;
1662
- liveAnchorKeys: Set<any>;
1663
- appliedCount: number;
1664
- } | undefined;
1665
- remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
1666
- }, "getConfig" | "documentsWithConverations" | "getGroupedComments" | "getGroupedReviewDirectory" | "hasOpenTrackedChanges" | "getFloatingComments" | "getFloatingCommentInstances" | "isViewingMode" | "shouldRenderReviewInViewing">, Pick<{
1667
- COMMENT_EVENTS: {
1668
- readonly RESOLVED: "resolved";
1669
- readonly NEW: "new";
1670
- readonly ADD: "add";
1671
- readonly UPDATE: "update";
1672
- readonly DELETED: "deleted";
1673
- readonly PENDING: "pending";
1674
- readonly SELECTED: "selected";
1675
- readonly COMMENTS_LIST: "comments-list";
1676
- readonly CHANGE_ACCEPTED: "change-accepted";
1677
- readonly CHANGE_REJECTED: "change-rejected";
1678
- };
1679
- hasSyncedCollaborationComments: Ref<boolean, boolean>;
1680
- editingCommentId: Ref<null, null>;
1681
- activeComment: Ref<null, null>;
1682
- activeFloatingCommentInstanceId: Ref<null, null>;
1683
- suppressInternalExternal: Ref<boolean, boolean>;
1684
- pendingComment: Ref<null, null>;
1685
- currentCommentText: Ref<string, string>;
1686
- currentCommentMentions: Ref<never[], never[]>;
1687
- commentsList: Ref<never[], never[]>;
1688
- reviewDirectoryList: import('vue').ShallowRef<never[], never[]>;
1689
- isCommentsListVisible: Ref<boolean, boolean>;
1690
- isReviewDirectoryActive: Ref<boolean, boolean>;
1691
- isReviewDirectoryLoading: Ref<boolean, boolean>;
1692
- generalCommentIds: Ref<never[], never[]>;
1693
- editorCommentIds: Ref<never[], never[]>;
1694
- commentsParentElement: Ref<null, null>;
1695
- editorCommentPositions: Ref<{}, {}>;
1696
- hasInitializedLocations: Ref<boolean, boolean>;
1697
- isCommentHighlighted: Ref<boolean, boolean>;
1698
- floatingCommentsOffset: Ref<number, number>;
1699
- committedReviewPresentations: import('vue').ShallowRef<{}, {}>;
1700
- skipSelectionUpdate: Ref<boolean, boolean>;
1701
- isFloatingCommentsReady: Ref<boolean, boolean>;
1702
- instantSidebarAlignmentTargetY: Ref<null, null>;
1703
- instantSidebarAlignmentThreadId: Ref<null, null>;
1704
- instantSidebarAlignmentInstanceId: Ref<null, null>;
1705
- getConfig: import('vue').ComputedRef<{
1706
- name: string;
1707
- readOnly: boolean;
1708
- allowResolve: boolean;
1709
- showResolved: boolean;
1710
- }>;
1711
- documentsWithConverations: import('vue').ComputedRef<any>;
1712
- getGroupedComments: import('vue').ComputedRef<{
1713
- parentComments: any[];
1714
- resolvedComments: any[];
1715
- }>;
1716
- getGroupedReviewDirectory: import('vue').ComputedRef<{
1717
- parentComments: any[];
1718
- resolvedComments: any[];
1719
- }>;
1720
- hasOpenTrackedChanges: import('vue').ComputedRef<boolean>;
1721
- getFloatingComments: import('vue').ComputedRef<any[]>;
1722
- getFloatingCommentInstances: import('vue').ComputedRef<{
1723
- id: string;
1724
- threadId: string | null;
1725
- comment: any;
1726
- positionKey: string | null;
1727
- positionEntry: {
1728
- pageIndex?: number | null;
1729
- rects?: readonly ({
1730
- pageIndex?: number | null;
1731
- left?: number;
1732
- top?: number;
1733
- right?: number;
1734
- bottom?: number;
1735
- } | null | undefined)[] | null;
1736
- bounds?: Partial<{
1737
- left: number;
1738
- top: number;
1739
- right: number;
1740
- bottom: number;
1741
- width: number;
1742
- height: number;
1743
- }> | null;
1744
- } | null;
1745
- pageIndex: number | null;
1746
- isPrimary: boolean;
1747
- }[]>;
1748
- getCommentAliasIds: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined) => string[];
1749
- getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
1750
- getCommentPositionKey: (commentOrId: import('./helpers/comment-identity.js').CommentIdentityRow | string | null | undefined) => unknown;
1751
- getCommentPosition: (commentOrId: Object | string) => Object | null;
1752
- resolveCommentPositionEntry: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined, preferredId?: unknown) => {
1753
- key: string;
1754
- entry: import('./helpers/comment-identity.js').CommentPositionEntry;
1755
- } | {
1756
- key: null;
1757
- entry: null;
1758
- };
1759
- getCommentDocumentId: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment) => string | null;
1760
- belongsToDocument: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment, activeDocumentId: string | null | undefined, options?: import('./helpers/comment-document-scope.js').BelongsToDocumentOptions) => boolean;
1761
- viewingVisibility: {
1762
- documentMode: string;
1763
- commentsVisible: boolean;
1764
- trackChangesVisible: boolean;
1765
- };
1766
- isViewingMode: import('vue').ComputedRef<boolean>;
1767
- shouldRenderReviewInViewing: import('vue').ComputedRef<boolean>;
1768
- init: (config?: Object) => void;
1769
- setViewingVisibility: ({ documentMode, commentsVisible, trackChangesVisible }?: {}) => void;
1770
- getComment: (id: unknown) => import('./helpers/comment-identity.js').CommentIdentityRow | null;
1771
- setActiveComment: (superdoc: Object | undefined | null, id: string | undefined | null) => void;
1772
- getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
1773
- selection?: Object | undefined;
1774
- documentId?: string | null | undefined;
1775
- parentCommentId?: string | null | undefined;
1776
- }) => ReturnType<any>;
1777
- showAddComment: (superdoc: any, targetClientY?: null) => any;
1778
- addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
1779
- superdoc: any;
1780
- comment: any;
1781
- skipEditorUpdate?: boolean | undefined;
1782
- broadcastChanges?: boolean | undefined;
1783
- }) => {
1784
- ok: boolean;
1785
- reason?: string;
1786
- detail?: string;
1787
- code?: string;
1788
- } | Promise<{
1789
- ok: boolean;
1790
- reason?: string;
1791
- detail?: string;
1792
- code?: string;
1793
- }>;
1794
- addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
1795
- superdoc: any;
1796
- comment: any;
1797
- skipEditorUpdate?: boolean | undefined;
1798
- broadcastChanges?: boolean | undefined;
1799
- }) => {
1800
- ok: boolean;
1801
- reason?: string;
1802
- detail?: string;
1803
- code?: string;
1804
- } | Promise<{
1805
- ok: boolean;
1806
- reason?: string;
1807
- detail?: string;
1808
- code?: string;
1809
- }>;
1810
- cancelComment: (superdoc: any) => void;
1811
- deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
1812
- commentId: any;
1813
- superdoc: any;
1814
- }) => Promise<any>;
1815
- removePendingComment: (superdoc: any) => void;
1816
- removeCommentsForDocument: (documentId: string | null | undefined) => void;
1817
- setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
1818
- commentItems?: never[] | undefined;
1819
- trackedChangeItems?: never[] | undefined;
1820
- }) => {
1821
- ok: boolean;
1822
- reason: string;
1823
- count?: undefined;
1824
- } | {
1825
- ok: boolean;
1826
- count: number;
1827
- reason?: undefined;
1828
- };
1829
- clearReviewDirectory: () => void;
1830
- handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
1831
- retainMissingTrackedChangeGeometry?: boolean;
1832
- retainedTrackedChangeIds?: Iterable<string>;
1833
- }) => void;
1834
- clearEditorCommentPositions: () => void;
1835
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
1836
- superdoc: Object;
1837
- params: Object;
1838
- }) => void;
1839
- syncResolvedCommentsWithDocument: () => number;
1840
- setActiveFloatingCommentInstance: (instanceId?: null) => void;
1841
- requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
1842
- peekInstantSidebarAlignment: () => null;
1843
- clearInstantSidebarAlignment: () => void;
1844
- decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
1845
- superdoc: Object;
1846
- comment: Object;
1847
- decision: string;
1848
- }) => {
1849
- ok: boolean;
1850
- success?: boolean;
1851
- reason?: string;
1852
- } | Promise<{
1853
- ok: boolean;
1854
- success?: boolean;
1855
- reason?: string;
1856
- }>;
1857
- v2CommentsAdapter: import('vue').ShallowRef<null, null>;
1858
- setV2CommentsAdapter: (adapter: any) => void;
1859
- getV2CommentsAdapter: (superdoc: any) => any;
1860
- applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => {
1861
- ok: boolean;
1862
- geometryOnly: boolean;
1863
- commentItems?: undefined;
1864
- trackedItems?: undefined;
1865
- reason?: undefined;
1866
- detail?: undefined;
1867
- } | {
1868
- ok: boolean;
1869
- commentItems: any;
1870
- trackedItems: any;
1871
- geometryOnly?: undefined;
1872
- reason?: undefined;
1873
- detail?: undefined;
1874
- } | {
1875
- ok: boolean;
1876
- reason: any;
1877
- geometryOnly?: undefined;
1878
- commentItems?: undefined;
1879
- trackedItems?: undefined;
1880
- detail?: undefined;
1881
- } | {
1882
- ok: boolean;
1883
- reason: string;
1884
- detail: any;
1885
- geometryOnly?: undefined;
1886
- commentItems?: undefined;
1887
- trackedItems?: undefined;
1888
- };
1889
- reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
1890
- preparedInputs?: null | undefined;
1891
- pruneStale?: boolean | undefined;
1892
- }) => {
1893
- added: null;
1894
- dropped: string;
1895
- } | {
1896
- added: any;
1897
- dropped?: undefined;
1898
- };
1899
- announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
1900
- ok: boolean;
1901
- reason: string;
1902
- detail?: undefined;
1903
- comment?: undefined;
1904
- } | {
1905
- ok: boolean;
1906
- reason: string;
1907
- detail: any;
1908
- comment?: undefined;
1909
- } | {
1910
- ok: boolean;
1911
- comment: any;
1912
- reason?: undefined;
1913
- detail?: undefined;
1914
- }>;
1915
- dropCommentsFromMutationImpact: ({ superdoc, documentId, removedIds }?: {}) => {
1916
- ok: boolean;
1917
- removedIds: (string | null)[];
1918
- };
1919
- isV2EditorActive: (superdoc: any) => boolean;
1920
- replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
1921
- superdoc?: Object | undefined;
1922
- parentCommentId?: string | null | undefined;
1923
- text?: string | undefined;
1924
- mentions?: {
1925
- name?: string | null;
1926
- email?: string | null;
1927
- }[] | undefined;
1928
- trackedChangeTarget?: {
1929
- kind: "trackedChange";
1930
- trackedChangeId: string;
1931
- story?: unknown;
1932
- side?: import('./helpers/tracked-change-thread-index.js').TrackedChangeSideGroup;
1933
- } | undefined;
1934
- }) => Promise<any>;
1935
- editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
1936
- resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
1937
- reopenCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
1938
- v2TrackedChangesAdapter: import('vue').ShallowRef<null, null>;
1939
- setV2TrackedChangesAdapter: (adapter: any) => void;
1940
- getV2TrackedChangesAdapter: (superdoc: any) => any;
1941
- getV2TrackedChangeRowCount: (documentId?: null) => number;
1942
- reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, remappedPairs, allResolved, }?: {
1943
- upsertIds?: never[] | undefined;
1944
- removedIds?: never[] | undefined;
1945
- remappedPairs?: never[] | undefined;
1946
- }) => Promise<{
1947
- ok: boolean;
1948
- reason: string;
1949
- items?: undefined;
1950
- resolvedIds?: undefined;
1951
- unresolvedIds?: undefined;
1952
- allResolved?: undefined;
1953
- removedRows?: undefined;
1954
- removedIds?: undefined;
1955
- } | {
1956
- ok: boolean;
1957
- items: never[];
1958
- resolvedIds: never[];
1959
- unresolvedIds: never[];
1960
- allResolved: boolean;
1961
- removedRows: number;
1962
- reason?: undefined;
1963
- removedIds?: undefined;
1964
- } | {
1965
- ok: boolean;
1966
- items: never[];
1967
- resolvedIds: never[];
1968
- unresolvedIds: (string | null)[];
1969
- removedIds: (string | null)[];
1970
- reason?: undefined;
1971
- allResolved?: undefined;
1972
- removedRows?: undefined;
1973
- }>;
1974
- reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale, preparedParams, preparedPresentation, previousPreparedPresentation, liveIds: suppliedLiveIds, liveAnchorKeys: suppliedLiveAnchorKeys, hydrationGeneration, }?: {
1975
- pruneStale?: boolean | undefined;
1976
- preparedParams?: null | undefined;
1977
- preparedPresentation?: null | undefined;
1978
- previousPreparedPresentation?: null | undefined;
1979
- liveIds?: null | undefined;
1980
- liveAnchorKeys?: null | undefined;
1981
- }) => {
1982
- liveIds: Set<any>;
1983
- liveAnchorKeys: Set<any>;
1984
- appliedCount: number;
1985
- } | undefined;
1986
- remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
1987
- }, "resolveCommentPositionEntry" | "getCommentAliasIds" | "getCommentPositionKey" | "belongsToDocument" | "getComment" | "getTrackedChangeThread" | "getCommentPosition" | "getCommentDocumentId" | "init" | "setViewingVisibility" | "setActiveComment" | "getPendingComment" | "showAddComment" | "addComment" | "addHydratedComment" | "cancelComment" | "deleteComment" | "removePendingComment" | "removeCommentsForDocument" | "setReviewDirectoryFromV2" | "clearReviewDirectory" | "handleEditorLocationsUpdate" | "clearEditorCommentPositions" | "handleTrackedChangeUpdate" | "syncResolvedCommentsWithDocument" | "setActiveFloatingCommentInstance" | "requestInstantSidebarAlignment" | "peekInstantSidebarAlignment" | "clearInstantSidebarAlignment" | "decideTrackedChangeFromSidebar" | "setV2CommentsAdapter" | "getV2CommentsAdapter" | "applyReviewWindowFromV2" | "reconcileCommentsFromV2" | "announceV2CommentCreated" | "dropCommentsFromMutationImpact" | "isV2EditorActive" | "replyCommentV2" | "editCommentV2" | "resolveCommentV2" | "reopenCommentV2" | "setV2TrackedChangesAdapter" | "getV2TrackedChangesAdapter" | "getV2TrackedChangeRowCount" | "reconcileTrackedChangeMutationFromV2" | "reconcileTrackedChangesFromV2" | "remapTrackedChangeIdentities">>;
63
+ commentsStore: {
64
+ removeCommentsForDocument(documentId: string | null | undefined): void;
65
+ };
1988
66
  documents: Ref<StoreDocument[], StoreDocument[]>;
1989
67
  documentBounds: Ref<unknown[], unknown[]>;
1990
68
  pages: Record<string, PageEntry[]>;
@@ -2015,970 +93,9 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
2015
93
  top: number;
2016
94
  } | undefined;
2017
95
  }, "areDocumentsReady">, Pick<{
2018
- commentsStore: import('pinia').Store<"comments", Pick<{
2019
- COMMENT_EVENTS: {
2020
- readonly RESOLVED: "resolved";
2021
- readonly NEW: "new";
2022
- readonly ADD: "add";
2023
- readonly UPDATE: "update";
2024
- readonly DELETED: "deleted";
2025
- readonly PENDING: "pending";
2026
- readonly SELECTED: "selected";
2027
- readonly COMMENTS_LIST: "comments-list";
2028
- readonly CHANGE_ACCEPTED: "change-accepted";
2029
- readonly CHANGE_REJECTED: "change-rejected";
2030
- };
2031
- hasSyncedCollaborationComments: Ref<boolean, boolean>;
2032
- editingCommentId: Ref<null, null>;
2033
- activeComment: Ref<null, null>;
2034
- activeFloatingCommentInstanceId: Ref<null, null>;
2035
- suppressInternalExternal: Ref<boolean, boolean>;
2036
- pendingComment: Ref<null, null>;
2037
- currentCommentText: Ref<string, string>;
2038
- currentCommentMentions: Ref<never[], never[]>;
2039
- commentsList: Ref<never[], never[]>;
2040
- reviewDirectoryList: import('vue').ShallowRef<never[], never[]>;
2041
- isCommentsListVisible: Ref<boolean, boolean>;
2042
- isReviewDirectoryActive: Ref<boolean, boolean>;
2043
- isReviewDirectoryLoading: Ref<boolean, boolean>;
2044
- generalCommentIds: Ref<never[], never[]>;
2045
- editorCommentIds: Ref<never[], never[]>;
2046
- commentsParentElement: Ref<null, null>;
2047
- editorCommentPositions: Ref<{}, {}>;
2048
- hasInitializedLocations: Ref<boolean, boolean>;
2049
- isCommentHighlighted: Ref<boolean, boolean>;
2050
- floatingCommentsOffset: Ref<number, number>;
2051
- committedReviewPresentations: import('vue').ShallowRef<{}, {}>;
2052
- skipSelectionUpdate: Ref<boolean, boolean>;
2053
- isFloatingCommentsReady: Ref<boolean, boolean>;
2054
- instantSidebarAlignmentTargetY: Ref<null, null>;
2055
- instantSidebarAlignmentThreadId: Ref<null, null>;
2056
- instantSidebarAlignmentInstanceId: Ref<null, null>;
2057
- getConfig: import('vue').ComputedRef<{
2058
- name: string;
2059
- readOnly: boolean;
2060
- allowResolve: boolean;
2061
- showResolved: boolean;
2062
- }>;
2063
- documentsWithConverations: import('vue').ComputedRef<any>;
2064
- getGroupedComments: import('vue').ComputedRef<{
2065
- parentComments: any[];
2066
- resolvedComments: any[];
2067
- }>;
2068
- getGroupedReviewDirectory: import('vue').ComputedRef<{
2069
- parentComments: any[];
2070
- resolvedComments: any[];
2071
- }>;
2072
- hasOpenTrackedChanges: import('vue').ComputedRef<boolean>;
2073
- getFloatingComments: import('vue').ComputedRef<any[]>;
2074
- getFloatingCommentInstances: import('vue').ComputedRef<{
2075
- id: string;
2076
- threadId: string | null;
2077
- comment: any;
2078
- positionKey: string | null;
2079
- positionEntry: {
2080
- pageIndex?: number | null;
2081
- rects?: readonly ({
2082
- pageIndex?: number | null;
2083
- left?: number;
2084
- top?: number;
2085
- right?: number;
2086
- bottom?: number;
2087
- } | null | undefined)[] | null;
2088
- bounds?: Partial<{
2089
- left: number;
2090
- top: number;
2091
- right: number;
2092
- bottom: number;
2093
- width: number;
2094
- height: number;
2095
- }> | null;
2096
- } | null;
2097
- pageIndex: number | null;
2098
- isPrimary: boolean;
2099
- }[]>;
2100
- getCommentAliasIds: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined) => string[];
2101
- getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
2102
- getCommentPositionKey: (commentOrId: import('./helpers/comment-identity.js').CommentIdentityRow | string | null | undefined) => unknown;
2103
- getCommentPosition: (commentOrId: Object | string) => Object | null;
2104
- resolveCommentPositionEntry: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined, preferredId?: unknown) => {
2105
- key: string;
2106
- entry: import('./helpers/comment-identity.js').CommentPositionEntry;
2107
- } | {
2108
- key: null;
2109
- entry: null;
2110
- };
2111
- getCommentDocumentId: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment) => string | null;
2112
- belongsToDocument: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment, activeDocumentId: string | null | undefined, options?: import('./helpers/comment-document-scope.js').BelongsToDocumentOptions) => boolean;
2113
- viewingVisibility: {
2114
- documentMode: string;
2115
- commentsVisible: boolean;
2116
- trackChangesVisible: boolean;
2117
- };
2118
- isViewingMode: import('vue').ComputedRef<boolean>;
2119
- shouldRenderReviewInViewing: import('vue').ComputedRef<boolean>;
2120
- init: (config?: Object) => void;
2121
- setViewingVisibility: ({ documentMode, commentsVisible, trackChangesVisible }?: {}) => void;
2122
- getComment: (id: unknown) => import('./helpers/comment-identity.js').CommentIdentityRow | null;
2123
- setActiveComment: (superdoc: Object | undefined | null, id: string | undefined | null) => void;
2124
- getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
2125
- selection?: Object | undefined;
2126
- documentId?: string | null | undefined;
2127
- parentCommentId?: string | null | undefined;
2128
- }) => ReturnType<any>;
2129
- showAddComment: (superdoc: any, targetClientY?: null) => any;
2130
- addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
2131
- superdoc: any;
2132
- comment: any;
2133
- skipEditorUpdate?: boolean | undefined;
2134
- broadcastChanges?: boolean | undefined;
2135
- }) => {
2136
- ok: boolean;
2137
- reason?: string;
2138
- detail?: string;
2139
- code?: string;
2140
- } | Promise<{
2141
- ok: boolean;
2142
- reason?: string;
2143
- detail?: string;
2144
- code?: string;
2145
- }>;
2146
- addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
2147
- superdoc: any;
2148
- comment: any;
2149
- skipEditorUpdate?: boolean | undefined;
2150
- broadcastChanges?: boolean | undefined;
2151
- }) => {
2152
- ok: boolean;
2153
- reason?: string;
2154
- detail?: string;
2155
- code?: string;
2156
- } | Promise<{
2157
- ok: boolean;
2158
- reason?: string;
2159
- detail?: string;
2160
- code?: string;
2161
- }>;
2162
- cancelComment: (superdoc: any) => void;
2163
- deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
2164
- commentId: any;
2165
- superdoc: any;
2166
- }) => Promise<any>;
2167
- removePendingComment: (superdoc: any) => void;
2168
- removeCommentsForDocument: (documentId: string | null | undefined) => void;
2169
- setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
2170
- commentItems?: never[] | undefined;
2171
- trackedChangeItems?: never[] | undefined;
2172
- }) => {
2173
- ok: boolean;
2174
- reason: string;
2175
- count?: undefined;
2176
- } | {
2177
- ok: boolean;
2178
- count: number;
2179
- reason?: undefined;
2180
- };
2181
- clearReviewDirectory: () => void;
2182
- handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
2183
- retainMissingTrackedChangeGeometry?: boolean;
2184
- retainedTrackedChangeIds?: Iterable<string>;
2185
- }) => void;
2186
- clearEditorCommentPositions: () => void;
2187
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
2188
- superdoc: Object;
2189
- params: Object;
2190
- }) => void;
2191
- syncResolvedCommentsWithDocument: () => number;
2192
- setActiveFloatingCommentInstance: (instanceId?: null) => void;
2193
- requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
2194
- peekInstantSidebarAlignment: () => null;
2195
- clearInstantSidebarAlignment: () => void;
2196
- decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
2197
- superdoc: Object;
2198
- comment: Object;
2199
- decision: string;
2200
- }) => {
2201
- ok: boolean;
2202
- success?: boolean;
2203
- reason?: string;
2204
- } | Promise<{
2205
- ok: boolean;
2206
- success?: boolean;
2207
- reason?: string;
2208
- }>;
2209
- v2CommentsAdapter: import('vue').ShallowRef<null, null>;
2210
- setV2CommentsAdapter: (adapter: any) => void;
2211
- getV2CommentsAdapter: (superdoc: any) => any;
2212
- applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => {
2213
- ok: boolean;
2214
- geometryOnly: boolean;
2215
- commentItems?: undefined;
2216
- trackedItems?: undefined;
2217
- reason?: undefined;
2218
- detail?: undefined;
2219
- } | {
2220
- ok: boolean;
2221
- commentItems: any;
2222
- trackedItems: any;
2223
- geometryOnly?: undefined;
2224
- reason?: undefined;
2225
- detail?: undefined;
2226
- } | {
2227
- ok: boolean;
2228
- reason: any;
2229
- geometryOnly?: undefined;
2230
- commentItems?: undefined;
2231
- trackedItems?: undefined;
2232
- detail?: undefined;
2233
- } | {
2234
- ok: boolean;
2235
- reason: string;
2236
- detail: any;
2237
- geometryOnly?: undefined;
2238
- commentItems?: undefined;
2239
- trackedItems?: undefined;
2240
- };
2241
- reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
2242
- preparedInputs?: null | undefined;
2243
- pruneStale?: boolean | undefined;
2244
- }) => {
2245
- added: null;
2246
- dropped: string;
2247
- } | {
2248
- added: any;
2249
- dropped?: undefined;
2250
- };
2251
- announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
2252
- ok: boolean;
2253
- reason: string;
2254
- detail?: undefined;
2255
- comment?: undefined;
2256
- } | {
2257
- ok: boolean;
2258
- reason: string;
2259
- detail: any;
2260
- comment?: undefined;
2261
- } | {
2262
- ok: boolean;
2263
- comment: any;
2264
- reason?: undefined;
2265
- detail?: undefined;
2266
- }>;
2267
- dropCommentsFromMutationImpact: ({ superdoc, documentId, removedIds }?: {}) => {
2268
- ok: boolean;
2269
- removedIds: (string | null)[];
2270
- };
2271
- isV2EditorActive: (superdoc: any) => boolean;
2272
- replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
2273
- superdoc?: Object | undefined;
2274
- parentCommentId?: string | null | undefined;
2275
- text?: string | undefined;
2276
- mentions?: {
2277
- name?: string | null;
2278
- email?: string | null;
2279
- }[] | undefined;
2280
- trackedChangeTarget?: {
2281
- kind: "trackedChange";
2282
- trackedChangeId: string;
2283
- story?: unknown;
2284
- side?: import('./helpers/tracked-change-thread-index.js').TrackedChangeSideGroup;
2285
- } | undefined;
2286
- }) => Promise<any>;
2287
- editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
2288
- resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
2289
- reopenCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
2290
- v2TrackedChangesAdapter: import('vue').ShallowRef<null, null>;
2291
- setV2TrackedChangesAdapter: (adapter: any) => void;
2292
- getV2TrackedChangesAdapter: (superdoc: any) => any;
2293
- getV2TrackedChangeRowCount: (documentId?: null) => number;
2294
- reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, remappedPairs, allResolved, }?: {
2295
- upsertIds?: never[] | undefined;
2296
- removedIds?: never[] | undefined;
2297
- remappedPairs?: never[] | undefined;
2298
- }) => Promise<{
2299
- ok: boolean;
2300
- reason: string;
2301
- items?: undefined;
2302
- resolvedIds?: undefined;
2303
- unresolvedIds?: undefined;
2304
- allResolved?: undefined;
2305
- removedRows?: undefined;
2306
- removedIds?: undefined;
2307
- } | {
2308
- ok: boolean;
2309
- items: never[];
2310
- resolvedIds: never[];
2311
- unresolvedIds: never[];
2312
- allResolved: boolean;
2313
- removedRows: number;
2314
- reason?: undefined;
2315
- removedIds?: undefined;
2316
- } | {
2317
- ok: boolean;
2318
- items: never[];
2319
- resolvedIds: never[];
2320
- unresolvedIds: (string | null)[];
2321
- removedIds: (string | null)[];
2322
- reason?: undefined;
2323
- allResolved?: undefined;
2324
- removedRows?: undefined;
2325
- }>;
2326
- reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale, preparedParams, preparedPresentation, previousPreparedPresentation, liveIds: suppliedLiveIds, liveAnchorKeys: suppliedLiveAnchorKeys, hydrationGeneration, }?: {
2327
- pruneStale?: boolean | undefined;
2328
- preparedParams?: null | undefined;
2329
- preparedPresentation?: null | undefined;
2330
- previousPreparedPresentation?: null | undefined;
2331
- liveIds?: null | undefined;
2332
- liveAnchorKeys?: null | undefined;
2333
- }) => {
2334
- liveIds: Set<any>;
2335
- liveAnchorKeys: Set<any>;
2336
- appliedCount: number;
2337
- } | undefined;
2338
- remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
2339
- }, "COMMENT_EVENTS" | "hasSyncedCollaborationComments" | "editingCommentId" | "activeComment" | "activeFloatingCommentInstanceId" | "suppressInternalExternal" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "editorCommentPositions" | "hasInitializedLocations" | "isCommentHighlighted" | "floatingCommentsOffset" | "committedReviewPresentations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2CommentsAdapter" | "v2TrackedChangesAdapter">, Pick<{
2340
- COMMENT_EVENTS: {
2341
- readonly RESOLVED: "resolved";
2342
- readonly NEW: "new";
2343
- readonly ADD: "add";
2344
- readonly UPDATE: "update";
2345
- readonly DELETED: "deleted";
2346
- readonly PENDING: "pending";
2347
- readonly SELECTED: "selected";
2348
- readonly COMMENTS_LIST: "comments-list";
2349
- readonly CHANGE_ACCEPTED: "change-accepted";
2350
- readonly CHANGE_REJECTED: "change-rejected";
2351
- };
2352
- hasSyncedCollaborationComments: Ref<boolean, boolean>;
2353
- editingCommentId: Ref<null, null>;
2354
- activeComment: Ref<null, null>;
2355
- activeFloatingCommentInstanceId: Ref<null, null>;
2356
- suppressInternalExternal: Ref<boolean, boolean>;
2357
- pendingComment: Ref<null, null>;
2358
- currentCommentText: Ref<string, string>;
2359
- currentCommentMentions: Ref<never[], never[]>;
2360
- commentsList: Ref<never[], never[]>;
2361
- reviewDirectoryList: import('vue').ShallowRef<never[], never[]>;
2362
- isCommentsListVisible: Ref<boolean, boolean>;
2363
- isReviewDirectoryActive: Ref<boolean, boolean>;
2364
- isReviewDirectoryLoading: Ref<boolean, boolean>;
2365
- generalCommentIds: Ref<never[], never[]>;
2366
- editorCommentIds: Ref<never[], never[]>;
2367
- commentsParentElement: Ref<null, null>;
2368
- editorCommentPositions: Ref<{}, {}>;
2369
- hasInitializedLocations: Ref<boolean, boolean>;
2370
- isCommentHighlighted: Ref<boolean, boolean>;
2371
- floatingCommentsOffset: Ref<number, number>;
2372
- committedReviewPresentations: import('vue').ShallowRef<{}, {}>;
2373
- skipSelectionUpdate: Ref<boolean, boolean>;
2374
- isFloatingCommentsReady: Ref<boolean, boolean>;
2375
- instantSidebarAlignmentTargetY: Ref<null, null>;
2376
- instantSidebarAlignmentThreadId: Ref<null, null>;
2377
- instantSidebarAlignmentInstanceId: Ref<null, null>;
2378
- getConfig: import('vue').ComputedRef<{
2379
- name: string;
2380
- readOnly: boolean;
2381
- allowResolve: boolean;
2382
- showResolved: boolean;
2383
- }>;
2384
- documentsWithConverations: import('vue').ComputedRef<any>;
2385
- getGroupedComments: import('vue').ComputedRef<{
2386
- parentComments: any[];
2387
- resolvedComments: any[];
2388
- }>;
2389
- getGroupedReviewDirectory: import('vue').ComputedRef<{
2390
- parentComments: any[];
2391
- resolvedComments: any[];
2392
- }>;
2393
- hasOpenTrackedChanges: import('vue').ComputedRef<boolean>;
2394
- getFloatingComments: import('vue').ComputedRef<any[]>;
2395
- getFloatingCommentInstances: import('vue').ComputedRef<{
2396
- id: string;
2397
- threadId: string | null;
2398
- comment: any;
2399
- positionKey: string | null;
2400
- positionEntry: {
2401
- pageIndex?: number | null;
2402
- rects?: readonly ({
2403
- pageIndex?: number | null;
2404
- left?: number;
2405
- top?: number;
2406
- right?: number;
2407
- bottom?: number;
2408
- } | null | undefined)[] | null;
2409
- bounds?: Partial<{
2410
- left: number;
2411
- top: number;
2412
- right: number;
2413
- bottom: number;
2414
- width: number;
2415
- height: number;
2416
- }> | null;
2417
- } | null;
2418
- pageIndex: number | null;
2419
- isPrimary: boolean;
2420
- }[]>;
2421
- getCommentAliasIds: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined) => string[];
2422
- getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
2423
- getCommentPositionKey: (commentOrId: import('./helpers/comment-identity.js').CommentIdentityRow | string | null | undefined) => unknown;
2424
- getCommentPosition: (commentOrId: Object | string) => Object | null;
2425
- resolveCommentPositionEntry: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined, preferredId?: unknown) => {
2426
- key: string;
2427
- entry: import('./helpers/comment-identity.js').CommentPositionEntry;
2428
- } | {
2429
- key: null;
2430
- entry: null;
2431
- };
2432
- getCommentDocumentId: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment) => string | null;
2433
- belongsToDocument: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment, activeDocumentId: string | null | undefined, options?: import('./helpers/comment-document-scope.js').BelongsToDocumentOptions) => boolean;
2434
- viewingVisibility: {
2435
- documentMode: string;
2436
- commentsVisible: boolean;
2437
- trackChangesVisible: boolean;
2438
- };
2439
- isViewingMode: import('vue').ComputedRef<boolean>;
2440
- shouldRenderReviewInViewing: import('vue').ComputedRef<boolean>;
2441
- init: (config?: Object) => void;
2442
- setViewingVisibility: ({ documentMode, commentsVisible, trackChangesVisible }?: {}) => void;
2443
- getComment: (id: unknown) => import('./helpers/comment-identity.js').CommentIdentityRow | null;
2444
- setActiveComment: (superdoc: Object | undefined | null, id: string | undefined | null) => void;
2445
- getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
2446
- selection?: Object | undefined;
2447
- documentId?: string | null | undefined;
2448
- parentCommentId?: string | null | undefined;
2449
- }) => ReturnType<any>;
2450
- showAddComment: (superdoc: any, targetClientY?: null) => any;
2451
- addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
2452
- superdoc: any;
2453
- comment: any;
2454
- skipEditorUpdate?: boolean | undefined;
2455
- broadcastChanges?: boolean | undefined;
2456
- }) => {
2457
- ok: boolean;
2458
- reason?: string;
2459
- detail?: string;
2460
- code?: string;
2461
- } | Promise<{
2462
- ok: boolean;
2463
- reason?: string;
2464
- detail?: string;
2465
- code?: string;
2466
- }>;
2467
- addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
2468
- superdoc: any;
2469
- comment: any;
2470
- skipEditorUpdate?: boolean | undefined;
2471
- broadcastChanges?: boolean | undefined;
2472
- }) => {
2473
- ok: boolean;
2474
- reason?: string;
2475
- detail?: string;
2476
- code?: string;
2477
- } | Promise<{
2478
- ok: boolean;
2479
- reason?: string;
2480
- detail?: string;
2481
- code?: string;
2482
- }>;
2483
- cancelComment: (superdoc: any) => void;
2484
- deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
2485
- commentId: any;
2486
- superdoc: any;
2487
- }) => Promise<any>;
2488
- removePendingComment: (superdoc: any) => void;
2489
- removeCommentsForDocument: (documentId: string | null | undefined) => void;
2490
- setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
2491
- commentItems?: never[] | undefined;
2492
- trackedChangeItems?: never[] | undefined;
2493
- }) => {
2494
- ok: boolean;
2495
- reason: string;
2496
- count?: undefined;
2497
- } | {
2498
- ok: boolean;
2499
- count: number;
2500
- reason?: undefined;
2501
- };
2502
- clearReviewDirectory: () => void;
2503
- handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
2504
- retainMissingTrackedChangeGeometry?: boolean;
2505
- retainedTrackedChangeIds?: Iterable<string>;
2506
- }) => void;
2507
- clearEditorCommentPositions: () => void;
2508
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
2509
- superdoc: Object;
2510
- params: Object;
2511
- }) => void;
2512
- syncResolvedCommentsWithDocument: () => number;
2513
- setActiveFloatingCommentInstance: (instanceId?: null) => void;
2514
- requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
2515
- peekInstantSidebarAlignment: () => null;
2516
- clearInstantSidebarAlignment: () => void;
2517
- decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
2518
- superdoc: Object;
2519
- comment: Object;
2520
- decision: string;
2521
- }) => {
2522
- ok: boolean;
2523
- success?: boolean;
2524
- reason?: string;
2525
- } | Promise<{
2526
- ok: boolean;
2527
- success?: boolean;
2528
- reason?: string;
2529
- }>;
2530
- v2CommentsAdapter: import('vue').ShallowRef<null, null>;
2531
- setV2CommentsAdapter: (adapter: any) => void;
2532
- getV2CommentsAdapter: (superdoc: any) => any;
2533
- applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => {
2534
- ok: boolean;
2535
- geometryOnly: boolean;
2536
- commentItems?: undefined;
2537
- trackedItems?: undefined;
2538
- reason?: undefined;
2539
- detail?: undefined;
2540
- } | {
2541
- ok: boolean;
2542
- commentItems: any;
2543
- trackedItems: any;
2544
- geometryOnly?: undefined;
2545
- reason?: undefined;
2546
- detail?: undefined;
2547
- } | {
2548
- ok: boolean;
2549
- reason: any;
2550
- geometryOnly?: undefined;
2551
- commentItems?: undefined;
2552
- trackedItems?: undefined;
2553
- detail?: undefined;
2554
- } | {
2555
- ok: boolean;
2556
- reason: string;
2557
- detail: any;
2558
- geometryOnly?: undefined;
2559
- commentItems?: undefined;
2560
- trackedItems?: undefined;
2561
- };
2562
- reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
2563
- preparedInputs?: null | undefined;
2564
- pruneStale?: boolean | undefined;
2565
- }) => {
2566
- added: null;
2567
- dropped: string;
2568
- } | {
2569
- added: any;
2570
- dropped?: undefined;
2571
- };
2572
- announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
2573
- ok: boolean;
2574
- reason: string;
2575
- detail?: undefined;
2576
- comment?: undefined;
2577
- } | {
2578
- ok: boolean;
2579
- reason: string;
2580
- detail: any;
2581
- comment?: undefined;
2582
- } | {
2583
- ok: boolean;
2584
- comment: any;
2585
- reason?: undefined;
2586
- detail?: undefined;
2587
- }>;
2588
- dropCommentsFromMutationImpact: ({ superdoc, documentId, removedIds }?: {}) => {
2589
- ok: boolean;
2590
- removedIds: (string | null)[];
2591
- };
2592
- isV2EditorActive: (superdoc: any) => boolean;
2593
- replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
2594
- superdoc?: Object | undefined;
2595
- parentCommentId?: string | null | undefined;
2596
- text?: string | undefined;
2597
- mentions?: {
2598
- name?: string | null;
2599
- email?: string | null;
2600
- }[] | undefined;
2601
- trackedChangeTarget?: {
2602
- kind: "trackedChange";
2603
- trackedChangeId: string;
2604
- story?: unknown;
2605
- side?: import('./helpers/tracked-change-thread-index.js').TrackedChangeSideGroup;
2606
- } | undefined;
2607
- }) => Promise<any>;
2608
- editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
2609
- resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
2610
- reopenCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
2611
- v2TrackedChangesAdapter: import('vue').ShallowRef<null, null>;
2612
- setV2TrackedChangesAdapter: (adapter: any) => void;
2613
- getV2TrackedChangesAdapter: (superdoc: any) => any;
2614
- getV2TrackedChangeRowCount: (documentId?: null) => number;
2615
- reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, remappedPairs, allResolved, }?: {
2616
- upsertIds?: never[] | undefined;
2617
- removedIds?: never[] | undefined;
2618
- remappedPairs?: never[] | undefined;
2619
- }) => Promise<{
2620
- ok: boolean;
2621
- reason: string;
2622
- items?: undefined;
2623
- resolvedIds?: undefined;
2624
- unresolvedIds?: undefined;
2625
- allResolved?: undefined;
2626
- removedRows?: undefined;
2627
- removedIds?: undefined;
2628
- } | {
2629
- ok: boolean;
2630
- items: never[];
2631
- resolvedIds: never[];
2632
- unresolvedIds: never[];
2633
- allResolved: boolean;
2634
- removedRows: number;
2635
- reason?: undefined;
2636
- removedIds?: undefined;
2637
- } | {
2638
- ok: boolean;
2639
- items: never[];
2640
- resolvedIds: never[];
2641
- unresolvedIds: (string | null)[];
2642
- removedIds: (string | null)[];
2643
- reason?: undefined;
2644
- allResolved?: undefined;
2645
- removedRows?: undefined;
2646
- }>;
2647
- reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale, preparedParams, preparedPresentation, previousPreparedPresentation, liveIds: suppliedLiveIds, liveAnchorKeys: suppliedLiveAnchorKeys, hydrationGeneration, }?: {
2648
- pruneStale?: boolean | undefined;
2649
- preparedParams?: null | undefined;
2650
- preparedPresentation?: null | undefined;
2651
- previousPreparedPresentation?: null | undefined;
2652
- liveIds?: null | undefined;
2653
- liveAnchorKeys?: null | undefined;
2654
- }) => {
2655
- liveIds: Set<any>;
2656
- liveAnchorKeys: Set<any>;
2657
- appliedCount: number;
2658
- } | undefined;
2659
- remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
2660
- }, "getConfig" | "documentsWithConverations" | "getGroupedComments" | "getGroupedReviewDirectory" | "hasOpenTrackedChanges" | "getFloatingComments" | "getFloatingCommentInstances" | "isViewingMode" | "shouldRenderReviewInViewing">, Pick<{
2661
- COMMENT_EVENTS: {
2662
- readonly RESOLVED: "resolved";
2663
- readonly NEW: "new";
2664
- readonly ADD: "add";
2665
- readonly UPDATE: "update";
2666
- readonly DELETED: "deleted";
2667
- readonly PENDING: "pending";
2668
- readonly SELECTED: "selected";
2669
- readonly COMMENTS_LIST: "comments-list";
2670
- readonly CHANGE_ACCEPTED: "change-accepted";
2671
- readonly CHANGE_REJECTED: "change-rejected";
2672
- };
2673
- hasSyncedCollaborationComments: Ref<boolean, boolean>;
2674
- editingCommentId: Ref<null, null>;
2675
- activeComment: Ref<null, null>;
2676
- activeFloatingCommentInstanceId: Ref<null, null>;
2677
- suppressInternalExternal: Ref<boolean, boolean>;
2678
- pendingComment: Ref<null, null>;
2679
- currentCommentText: Ref<string, string>;
2680
- currentCommentMentions: Ref<never[], never[]>;
2681
- commentsList: Ref<never[], never[]>;
2682
- reviewDirectoryList: import('vue').ShallowRef<never[], never[]>;
2683
- isCommentsListVisible: Ref<boolean, boolean>;
2684
- isReviewDirectoryActive: Ref<boolean, boolean>;
2685
- isReviewDirectoryLoading: Ref<boolean, boolean>;
2686
- generalCommentIds: Ref<never[], never[]>;
2687
- editorCommentIds: Ref<never[], never[]>;
2688
- commentsParentElement: Ref<null, null>;
2689
- editorCommentPositions: Ref<{}, {}>;
2690
- hasInitializedLocations: Ref<boolean, boolean>;
2691
- isCommentHighlighted: Ref<boolean, boolean>;
2692
- floatingCommentsOffset: Ref<number, number>;
2693
- committedReviewPresentations: import('vue').ShallowRef<{}, {}>;
2694
- skipSelectionUpdate: Ref<boolean, boolean>;
2695
- isFloatingCommentsReady: Ref<boolean, boolean>;
2696
- instantSidebarAlignmentTargetY: Ref<null, null>;
2697
- instantSidebarAlignmentThreadId: Ref<null, null>;
2698
- instantSidebarAlignmentInstanceId: Ref<null, null>;
2699
- getConfig: import('vue').ComputedRef<{
2700
- name: string;
2701
- readOnly: boolean;
2702
- allowResolve: boolean;
2703
- showResolved: boolean;
2704
- }>;
2705
- documentsWithConverations: import('vue').ComputedRef<any>;
2706
- getGroupedComments: import('vue').ComputedRef<{
2707
- parentComments: any[];
2708
- resolvedComments: any[];
2709
- }>;
2710
- getGroupedReviewDirectory: import('vue').ComputedRef<{
2711
- parentComments: any[];
2712
- resolvedComments: any[];
2713
- }>;
2714
- hasOpenTrackedChanges: import('vue').ComputedRef<boolean>;
2715
- getFloatingComments: import('vue').ComputedRef<any[]>;
2716
- getFloatingCommentInstances: import('vue').ComputedRef<{
2717
- id: string;
2718
- threadId: string | null;
2719
- comment: any;
2720
- positionKey: string | null;
2721
- positionEntry: {
2722
- pageIndex?: number | null;
2723
- rects?: readonly ({
2724
- pageIndex?: number | null;
2725
- left?: number;
2726
- top?: number;
2727
- right?: number;
2728
- bottom?: number;
2729
- } | null | undefined)[] | null;
2730
- bounds?: Partial<{
2731
- left: number;
2732
- top: number;
2733
- right: number;
2734
- bottom: number;
2735
- width: number;
2736
- height: number;
2737
- }> | null;
2738
- } | null;
2739
- pageIndex: number | null;
2740
- isPrimary: boolean;
2741
- }[]>;
2742
- getCommentAliasIds: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined) => string[];
2743
- getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
2744
- getCommentPositionKey: (commentOrId: import('./helpers/comment-identity.js').CommentIdentityRow | string | null | undefined) => unknown;
2745
- getCommentPosition: (commentOrId: Object | string) => Object | null;
2746
- resolveCommentPositionEntry: (commentOrId: string | number | import('./helpers/comment-identity.js').CommentIdentityRow | null | undefined, preferredId?: unknown) => {
2747
- key: string;
2748
- entry: import('./helpers/comment-identity.js').CommentPositionEntry;
2749
- } | {
2750
- key: null;
2751
- entry: null;
2752
- };
2753
- getCommentDocumentId: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment) => string | null;
2754
- belongsToDocument: (comment: import('./helpers/comment-document-scope.js').DocumentScopedComment, activeDocumentId: string | null | undefined, options?: import('./helpers/comment-document-scope.js').BelongsToDocumentOptions) => boolean;
2755
- viewingVisibility: {
2756
- documentMode: string;
2757
- commentsVisible: boolean;
2758
- trackChangesVisible: boolean;
2759
- };
2760
- isViewingMode: import('vue').ComputedRef<boolean>;
2761
- shouldRenderReviewInViewing: import('vue').ComputedRef<boolean>;
2762
- init: (config?: Object) => void;
2763
- setViewingVisibility: ({ documentMode, commentsVisible, trackChangesVisible }?: {}) => void;
2764
- getComment: (id: unknown) => import('./helpers/comment-identity.js').CommentIdentityRow | null;
2765
- setActiveComment: (superdoc: Object | undefined | null, id: string | undefined | null) => void;
2766
- getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
2767
- selection?: Object | undefined;
2768
- documentId?: string | null | undefined;
2769
- parentCommentId?: string | null | undefined;
2770
- }) => ReturnType<any>;
2771
- showAddComment: (superdoc: any, targetClientY?: null) => any;
2772
- addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
2773
- superdoc: any;
2774
- comment: any;
2775
- skipEditorUpdate?: boolean | undefined;
2776
- broadcastChanges?: boolean | undefined;
2777
- }) => {
2778
- ok: boolean;
2779
- reason?: string;
2780
- detail?: string;
2781
- code?: string;
2782
- } | Promise<{
2783
- ok: boolean;
2784
- reason?: string;
2785
- detail?: string;
2786
- code?: string;
2787
- }>;
2788
- addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
2789
- superdoc: any;
2790
- comment: any;
2791
- skipEditorUpdate?: boolean | undefined;
2792
- broadcastChanges?: boolean | undefined;
2793
- }) => {
2794
- ok: boolean;
2795
- reason?: string;
2796
- detail?: string;
2797
- code?: string;
2798
- } | Promise<{
2799
- ok: boolean;
2800
- reason?: string;
2801
- detail?: string;
2802
- code?: string;
2803
- }>;
2804
- cancelComment: (superdoc: any) => void;
2805
- deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
2806
- commentId: any;
2807
- superdoc: any;
2808
- }) => Promise<any>;
2809
- removePendingComment: (superdoc: any) => void;
2810
- removeCommentsForDocument: (documentId: string | null | undefined) => void;
2811
- setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
2812
- commentItems?: never[] | undefined;
2813
- trackedChangeItems?: never[] | undefined;
2814
- }) => {
2815
- ok: boolean;
2816
- reason: string;
2817
- count?: undefined;
2818
- } | {
2819
- ok: boolean;
2820
- count: number;
2821
- reason?: undefined;
2822
- };
2823
- clearReviewDirectory: () => void;
2824
- handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
2825
- retainMissingTrackedChangeGeometry?: boolean;
2826
- retainedTrackedChangeIds?: Iterable<string>;
2827
- }) => void;
2828
- clearEditorCommentPositions: () => void;
2829
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
2830
- superdoc: Object;
2831
- params: Object;
2832
- }) => void;
2833
- syncResolvedCommentsWithDocument: () => number;
2834
- setActiveFloatingCommentInstance: (instanceId?: null) => void;
2835
- requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
2836
- peekInstantSidebarAlignment: () => null;
2837
- clearInstantSidebarAlignment: () => void;
2838
- decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
2839
- superdoc: Object;
2840
- comment: Object;
2841
- decision: string;
2842
- }) => {
2843
- ok: boolean;
2844
- success?: boolean;
2845
- reason?: string;
2846
- } | Promise<{
2847
- ok: boolean;
2848
- success?: boolean;
2849
- reason?: string;
2850
- }>;
2851
- v2CommentsAdapter: import('vue').ShallowRef<null, null>;
2852
- setV2CommentsAdapter: (adapter: any) => void;
2853
- getV2CommentsAdapter: (superdoc: any) => any;
2854
- applyReviewWindowFromV2: ({ superdoc, commentsAdapter, trackedChangesAdapter, documentId, commentItems, trackedChangeItems, preparedReview, requestedCommentIds, requestedTrackedChangeIds, unresolvedCommentIds, trackedList, sourceCoverageRevision, evaluatedRevision, patch, }?: {}) => {
2855
- ok: boolean;
2856
- geometryOnly: boolean;
2857
- commentItems?: undefined;
2858
- trackedItems?: undefined;
2859
- reason?: undefined;
2860
- detail?: undefined;
2861
- } | {
2862
- ok: boolean;
2863
- commentItems: any;
2864
- trackedItems: any;
2865
- geometryOnly?: undefined;
2866
- reason?: undefined;
2867
- detail?: undefined;
2868
- } | {
2869
- ok: boolean;
2870
- reason: any;
2871
- geometryOnly?: undefined;
2872
- commentItems?: undefined;
2873
- trackedItems?: undefined;
2874
- detail?: undefined;
2875
- } | {
2876
- ok: boolean;
2877
- reason: string;
2878
- detail: any;
2879
- geometryOnly?: undefined;
2880
- commentItems?: undefined;
2881
- trackedItems?: undefined;
2882
- };
2883
- reconcileCommentsFromV2: ({ superdoc, adapter, documentId, items, preparedInputs, pruneStale, hydrationGeneration, }?: {
2884
- preparedInputs?: null | undefined;
2885
- pruneStale?: boolean | undefined;
2886
- }) => {
2887
- added: null;
2888
- dropped: string;
2889
- } | {
2890
- added: any;
2891
- dropped?: undefined;
2892
- };
2893
- announceV2CommentCreated: ({ superdoc, commentId }?: {}) => Promise<{
2894
- ok: boolean;
2895
- reason: string;
2896
- detail?: undefined;
2897
- comment?: undefined;
2898
- } | {
2899
- ok: boolean;
2900
- reason: string;
2901
- detail: any;
2902
- comment?: undefined;
2903
- } | {
2904
- ok: boolean;
2905
- comment: any;
2906
- reason?: undefined;
2907
- detail?: undefined;
2908
- }>;
2909
- dropCommentsFromMutationImpact: ({ superdoc, documentId, removedIds }?: {}) => {
2910
- ok: boolean;
2911
- removedIds: (string | null)[];
2912
- };
2913
- isV2EditorActive: (superdoc: any) => boolean;
2914
- replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
2915
- superdoc?: Object | undefined;
2916
- parentCommentId?: string | null | undefined;
2917
- text?: string | undefined;
2918
- mentions?: {
2919
- name?: string | null;
2920
- email?: string | null;
2921
- }[] | undefined;
2922
- trackedChangeTarget?: {
2923
- kind: "trackedChange";
2924
- trackedChangeId: string;
2925
- story?: unknown;
2926
- side?: import('./helpers/tracked-change-thread-index.js').TrackedChangeSideGroup;
2927
- } | undefined;
2928
- }) => Promise<any>;
2929
- editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
2930
- resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
2931
- reopenCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
2932
- v2TrackedChangesAdapter: import('vue').ShallowRef<null, null>;
2933
- setV2TrackedChangesAdapter: (adapter: any) => void;
2934
- getV2TrackedChangesAdapter: (superdoc: any) => any;
2935
- getV2TrackedChangeRowCount: (documentId?: null) => number;
2936
- reconcileTrackedChangeMutationFromV2: ({ superdoc, adapter, documentId, upsertIds, removedIds, remappedPairs, allResolved, }?: {
2937
- upsertIds?: never[] | undefined;
2938
- removedIds?: never[] | undefined;
2939
- remappedPairs?: never[] | undefined;
2940
- }) => Promise<{
2941
- ok: boolean;
2942
- reason: string;
2943
- items?: undefined;
2944
- resolvedIds?: undefined;
2945
- unresolvedIds?: undefined;
2946
- allResolved?: undefined;
2947
- removedRows?: undefined;
2948
- removedIds?: undefined;
2949
- } | {
2950
- ok: boolean;
2951
- items: never[];
2952
- resolvedIds: never[];
2953
- unresolvedIds: never[];
2954
- allResolved: boolean;
2955
- removedRows: number;
2956
- reason?: undefined;
2957
- removedIds?: undefined;
2958
- } | {
2959
- ok: boolean;
2960
- items: never[];
2961
- resolvedIds: never[];
2962
- unresolvedIds: (string | null)[];
2963
- removedIds: (string | null)[];
2964
- reason?: undefined;
2965
- allResolved?: undefined;
2966
- removedRows?: undefined;
2967
- }>;
2968
- reconcileTrackedChangesFromV2: ({ superdoc, adapter, documentId, items, pruneStale, preparedParams, preparedPresentation, previousPreparedPresentation, liveIds: suppliedLiveIds, liveAnchorKeys: suppliedLiveAnchorKeys, hydrationGeneration, }?: {
2969
- pruneStale?: boolean | undefined;
2970
- preparedParams?: null | undefined;
2971
- preparedPresentation?: null | undefined;
2972
- previousPreparedPresentation?: null | undefined;
2973
- liveIds?: null | undefined;
2974
- liveAnchorKeys?: null | undefined;
2975
- }) => {
2976
- liveIds: Set<any>;
2977
- liveAnchorKeys: Set<any>;
2978
- appliedCount: number;
2979
- } | undefined;
2980
- remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
2981
- }, "resolveCommentPositionEntry" | "getCommentAliasIds" | "getCommentPositionKey" | "belongsToDocument" | "getComment" | "getTrackedChangeThread" | "getCommentPosition" | "getCommentDocumentId" | "init" | "setViewingVisibility" | "setActiveComment" | "getPendingComment" | "showAddComment" | "addComment" | "addHydratedComment" | "cancelComment" | "deleteComment" | "removePendingComment" | "removeCommentsForDocument" | "setReviewDirectoryFromV2" | "clearReviewDirectory" | "handleEditorLocationsUpdate" | "clearEditorCommentPositions" | "handleTrackedChangeUpdate" | "syncResolvedCommentsWithDocument" | "setActiveFloatingCommentInstance" | "requestInstantSidebarAlignment" | "peekInstantSidebarAlignment" | "clearInstantSidebarAlignment" | "decideTrackedChangeFromSidebar" | "setV2CommentsAdapter" | "getV2CommentsAdapter" | "applyReviewWindowFromV2" | "reconcileCommentsFromV2" | "announceV2CommentCreated" | "dropCommentsFromMutationImpact" | "isV2EditorActive" | "replyCommentV2" | "editCommentV2" | "resolveCommentV2" | "reopenCommentV2" | "setV2TrackedChangesAdapter" | "getV2TrackedChangesAdapter" | "getV2TrackedChangeRowCount" | "reconcileTrackedChangeMutationFromV2" | "reconcileTrackedChangesFromV2" | "remapTrackedChangeIdentities">>;
96
+ commentsStore: {
97
+ removeCommentsForDocument(documentId: string | null | undefined): void;
98
+ };
2982
99
  documents: Ref<StoreDocument[], StoreDocument[]>;
2983
100
  documentBounds: Ref<unknown[], unknown[]>;
2984
101
  pages: Record<string, PageEntry[]>;