superdoc 2.28.0-next.9 → 2.29.0-next.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/dist/chunks/{FindReplaceSurface-8V8AjgR4.cjs → FindReplaceSurface-BRs3JrCq.cjs} +1 -1
  2. package/dist/chunks/{FindReplaceSurface-RUiTFDt3.es.js → FindReplaceSurface-Dm043CZP.es.js} +1 -1
  3. package/dist/chunks/{PasswordPromptSurface-B5DHV6qr.cjs → PasswordPromptSurface-BpqP4pUa.cjs} +1 -1
  4. package/dist/chunks/{PasswordPromptSurface-BDpxqdzp.es.js → PasswordPromptSurface-DGjmN7A-.es.js} +1 -1
  5. package/dist/chunks/{PdfViewer-DjdsIh6n.es.js → PdfViewer-D4lVeOJu.es.js} +4 -3
  6. package/dist/chunks/{PdfViewer-omriDChK.cjs → PdfViewer-boENOZdF.cjs} +4 -3
  7. package/dist/chunks/{_plugin-vue_export-helper-BUdjGKyl.cjs → _plugin-vue_export-helper-6MBoygIY.cjs} +9 -0
  8. package/dist/chunks/{_plugin-vue_export-helper-7ZiLY07t.es.js → _plugin-vue_export-helper-CsJQtMvr.es.js} +4 -1
  9. package/dist/chunks/{create-super-doc-ui-B4c55pFy.cjs → create-super-doc-ui-0OA8hCNb.cjs} +390 -44
  10. package/dist/chunks/{create-super-doc-ui-C4Ka5Ph3.es.js → create-super-doc-ui-Duf65d0b.es.js} +357 -41
  11. package/dist/chunks/is-finite-number-BEXgTRgc.cjs +11 -0
  12. package/dist/chunks/is-finite-number-BpL4F38c.es.js +6 -0
  13. package/dist/collaboration-upgrade-engine.cjs +1 -1
  14. package/dist/collaboration-upgrade-engine.es.js +1 -1
  15. package/dist/document-api/src/capabilities/html-markdown-support.d.ts +3 -3
  16. package/dist/document-api/src/contract/operation-definitions.d.ts +2 -2
  17. package/dist/document-api/src/index.d.ts +1 -1
  18. package/dist/document-api/src/lists/lists.d.ts +79 -79
  19. package/dist/document-api/src/lists/lists.types.d.ts +1 -0
  20. package/dist/document-api/src/sections/sections.types.d.ts +5 -1
  21. package/dist/document-api/src/types/clipboard.d.ts +5 -1
  22. package/dist/document-api/src/types/receipt.d.ts +2 -1
  23. package/dist/document-api/src/write/write.d.ts +10 -9
  24. package/dist/layout-engine/contracts/src/index.d.ts +5 -1
  25. package/dist/layout-engine/contracts/src/run-helpers.d.ts +1 -0
  26. package/dist/layout-engine/layout-bridge/src/index.d.ts +1 -0
  27. package/dist/layout-engine/layout-bridge/src/place-inline-drawings.d.ts +9 -0
  28. package/dist/layout-engine/layout-engine/src/layout-drawing.d.ts +2 -1
  29. package/dist/layout-engine/layout-engine/src/paginator.d.ts +1 -0
  30. package/dist/layout-engine/painters/dom/src/page-content.d.ts +1 -1
  31. package/dist/layout-engine/painters/dom/src/persistent-page-surface.d.ts +2 -0
  32. package/dist/layout-engine/style-engine/src/ooxml/index.d.ts +1 -1
  33. package/dist/public/ui-react.cjs +1 -1
  34. package/dist/public/ui-react.es.js +1 -1
  35. package/dist/public/ui-vue.cjs +1 -1
  36. package/dist/public/ui-vue.es.js +1 -1
  37. package/dist/public/ui.cjs +3 -2
  38. package/dist/public/ui.es.js +3 -2
  39. package/dist/shared/font-system/src/resolver.d.ts +3 -3
  40. package/dist/style.css +1 -1
  41. package/dist/style.layered.css +1 -1
  42. package/dist/superdoc/src/SuperDoc.vue.d.ts +5 -3
  43. package/dist/superdoc/src/components/CommentsLayer/CommentDialog.vue.d.ts +1670 -24
  44. package/dist/superdoc/src/components/CommentsLayer/CommentHeader.vue.d.ts +2 -2
  45. package/dist/superdoc/src/components/CommentsLayer/CommentInput.vue.d.ts +2 -2
  46. package/dist/superdoc/src/components/CommentsLayer/FloatingComments.vue.d.ts +24 -0
  47. package/dist/superdoc/src/components/CommentsLayer/PdfCommentsLayer.vue.d.ts +4 -0
  48. package/dist/superdoc/src/components/general/Avatar.vue.d.ts +7 -0
  49. package/dist/superdoc/src/components/surfaces/SurfaceDialog.vue.d.ts +27 -9
  50. package/dist/superdoc/src/components/surfaces/SurfaceExternalMount.vue.d.ts +53 -16
  51. package/dist/superdoc/src/composables/use-high-contrast-mode.d.ts +8 -4
  52. package/dist/superdoc/src/composables/use-link-popover.d.ts +3 -3
  53. package/dist/superdoc/src/composables/use-superdoc-instance.d.ts +10 -0
  54. package/dist/superdoc/src/core/SuperDoc.d.ts +2 -6
  55. package/dist/superdoc/src/core/collaboration/helpers.d.ts +0 -5
  56. package/dist/superdoc/src/core/collaboration/permissions.d.ts +1 -0
  57. package/dist/superdoc/src/core/collaboration/resolve-v2-collaboration-target.d.ts +2 -1
  58. package/dist/superdoc/src/core/create-app.d.ts +2 -6
  59. package/dist/superdoc/src/core/editor-runtime/types.d.ts +2 -0
  60. package/dist/superdoc/src/core/editor-runtime/v2/v2-editor-runtime-adapter.d.ts +2 -0
  61. package/dist/superdoc/src/core/types/index.d.ts +10 -4
  62. package/dist/superdoc/src/core/v2-integration/internal-vue-runtime.d.ts +1 -0
  63. package/dist/superdoc/src/core/v2-integration/v2-integration.d.ts +104 -84
  64. package/dist/superdoc/src/helpers/is-finite-number.d.ts +1 -0
  65. package/dist/superdoc/src/helpers/v2-review-mutation-impact.d.ts +2 -0
  66. package/dist/superdoc/src/internal/diagnostics/diagnostic-dedupe.d.ts +2 -2
  67. package/dist/superdoc/src/internal/diagnostics/translate-diagnostic.d.ts +5 -0
  68. package/dist/superdoc/src/internal/toolbar/built-in/AIWriter.vue.d.ts +2 -2
  69. package/dist/superdoc/src/internal/toolbar/built-in/LinkInput.vue.d.ts +181 -36
  70. package/dist/superdoc/src/internal/toolbar/built-in/LinkedStyle.vue.d.ts +39 -10
  71. package/dist/superdoc/src/internal/toolbar/built-in/PageNumberMenu.vue.d.ts +133 -22
  72. package/dist/superdoc/src/internal/toolbar/built-in/SdTooltip.vue.d.ts +62 -23
  73. package/dist/superdoc/src/internal/toolbar/built-in/ToolbarButton.vue.d.ts +101 -16
  74. package/dist/superdoc/src/internal/toolbar/built-in/ToolbarButtonIcon.vue.d.ts +31 -10
  75. package/dist/superdoc/src/internal/toolbar/built-in/ToolbarComboBox.vue.d.ts +82 -11
  76. package/dist/superdoc/src/internal/toolbar/built-in/ToolbarDropdown.vue.d.ts +122 -33
  77. package/dist/superdoc/src/internal/toolbar/built-in/constants.d.ts +0 -48
  78. package/dist/superdoc/src/internal/toolbar/built-in/use-toolbar-item.d.ts +0 -1
  79. package/dist/superdoc/src/internal/toolbar/built-in-toolbar.d.ts +4 -1
  80. package/dist/superdoc/src/internal/toolbar/compatibility-catalog.d.ts +16 -0
  81. package/dist/superdoc/src/public/ui/types.d.ts +39 -1
  82. package/dist/superdoc/src/public/ui.d.cts +12 -0
  83. package/dist/superdoc/src/public/ui.d.ts +1 -1
  84. package/dist/superdoc/src/stores/comments-store.d.ts +158 -125
  85. package/dist/superdoc/src/stores/superdoc-store.d.ts +475 -376
  86. package/dist/superdoc.cjs +561 -1843
  87. package/dist/superdoc.es.js +766 -13144
  88. package/dist-cdn/style.layered.css +1 -1
  89. package/dist-cdn/superdoc.min.css +1 -1
  90. package/dist-cdn/superdoc.min.js +42 -42
  91. package/package.json +4 -3
  92. package/dist/superdoc/src/core/collaboration/collaboration.d.ts +0 -18
  93. package/dist/superdoc/src/helpers/group-changes.d.ts +0 -1
  94. package/dist/superdoc/src/internal/toolbar/built-in/OverflowMenu.vue.d.ts +0 -104
@@ -107,17 +107,6 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
107
107
  getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
108
108
  getCommentPositionKey: (commentOrId: Object | string | null | undefined) => string | null;
109
109
  getCommentPosition: (commentOrId: Object | string) => Object | null;
110
- getCommentAnchoredText: (commentOrId: Object | string, options?: {
111
- separator?: string | undefined;
112
- trim?: boolean | undefined;
113
- }) => string | null;
114
- getCommentAnchorData: (commentOrId: Object | string, options?: {
115
- separator?: string | undefined;
116
- trim?: boolean | undefined;
117
- }) => {
118
- position: Object;
119
- anchoredText: string | null;
120
- } | null;
121
110
  resolveCommentPositionEntry: (commentOrId: any, preferredId: any) => {
122
111
  key: string | null;
123
112
  entry: any;
@@ -141,30 +130,49 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
141
130
  };
142
131
  hasOverlapId: (id: any) => any;
143
132
  getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
144
- selection: Object;
145
- documentId: string;
146
- parentCommentId: string;
147
- }) => Object;
133
+ selection?: Object | undefined;
134
+ documentId?: string | null | undefined;
135
+ parentCommentId?: string | null | undefined;
136
+ }) => ReturnType<any>;
148
137
  showAddComment: (superdoc: any, targetClientY?: null) => any;
149
138
  addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
150
139
  superdoc: any;
151
140
  comment: any;
152
141
  skipEditorUpdate?: boolean | undefined;
153
142
  broadcastChanges?: boolean | undefined;
154
- }) => void;
143
+ }) => {
144
+ ok: boolean;
145
+ reason?: string;
146
+ detail?: string;
147
+ code?: string;
148
+ } | Promise<{
149
+ ok: boolean;
150
+ reason?: string;
151
+ detail?: string;
152
+ code?: string;
153
+ }>;
155
154
  addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
156
155
  superdoc: any;
157
156
  comment: any;
158
157
  skipEditorUpdate?: boolean | undefined;
159
158
  broadcastChanges?: boolean | undefined;
160
- }) => void;
159
+ }) => {
160
+ ok: boolean;
161
+ reason?: string;
162
+ detail?: string;
163
+ code?: string;
164
+ } | Promise<{
165
+ ok: boolean;
166
+ reason?: string;
167
+ detail?: string;
168
+ code?: string;
169
+ }>;
161
170
  cancelComment: (superdoc: any) => void;
162
171
  deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
163
172
  commentId: any;
164
173
  superdoc: any;
165
174
  }) => Promise<any>;
166
175
  removePendingComment: (superdoc: any) => void;
167
- cancelImportedTrackedChangeBootstrap: (documentId: string | null | undefined) => number;
168
176
  removeCommentsForDocument: (documentId: string | null | undefined) => void;
169
177
  setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
170
178
  commentItems?: never[] | undefined;
@@ -179,42 +187,33 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
179
187
  reason?: undefined;
180
188
  };
181
189
  clearReviewDirectory: () => void;
182
- processLoadedDocxComments: ({ superdoc, editor, comments, documentId, replacedFile }: {
183
- comments: any[];
184
- documentId: string;
185
- replacedFile?: boolean | undefined;
186
- }) => void;
187
- translateCommentsForExport: () => any[];
188
190
  handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
189
191
  retainMissingTrackedChangeGeometry?: boolean;
190
192
  retainedTrackedChangeIds?: Iterable<string>;
191
193
  }) => void;
192
194
  clearEditorCommentPositions: () => void;
193
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState, trackedChangeIdentityIndex, }: {
195
+ handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
194
196
  superdoc: Object;
195
197
  params: Object;
196
198
  }) => void;
197
- refreshTrackedChangeCommentsByIds: ({ superdoc, editor, changeIds, broadcastChanges }: {
198
- superdoc: any;
199
- editor: any;
200
- changeIds: any;
201
- broadcastChanges?: boolean | undefined;
202
- }) => void;
203
- syncResolvedCommentsWithDocument: ({ editor }?: {}) => number;
204
- syncTrackedChangePositionsWithDocument: ({ documentId, editor }?: {}) => number;
199
+ syncResolvedCommentsWithDocument: () => number;
205
200
  setActiveFloatingCommentInstance: (instanceId?: null) => void;
206
201
  requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
207
202
  peekInstantSidebarAlignment: () => null;
208
203
  clearInstantSidebarAlignment: () => void;
209
- syncTrackedChangeComments: ({ superdoc, editor, broadcastChanges }: {
210
- superdoc: any;
211
- editor: any;
212
- broadcastChanges?: boolean | undefined;
213
- }) => void;
214
204
  decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
215
205
  superdoc: Object;
216
- editor: Object;
217
- }) => void;
206
+ comment: Object;
207
+ decision: string;
208
+ }) => {
209
+ ok: boolean;
210
+ success?: boolean;
211
+ reason?: string;
212
+ } | Promise<{
213
+ ok: boolean;
214
+ success?: boolean;
215
+ reason?: string;
216
+ }>;
218
217
  v2CommentsAdapter: import('vue').ShallowRef<null, null>;
219
218
  setV2CommentsAdapter: (adapter: any) => void;
220
219
  getV2CommentsAdapter: (superdoc: any) => any;
@@ -245,7 +244,19 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
245
244
  };
246
245
  isV2EditorActive: (superdoc: any) => boolean;
247
246
  replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
248
- mentions?: never[] | undefined;
247
+ superdoc?: Object | undefined;
248
+ parentCommentId?: string | null | undefined;
249
+ text?: string | undefined;
250
+ mentions?: {
251
+ name?: string | null;
252
+ email?: string | null;
253
+ }[] | undefined;
254
+ trackedChangeTarget?: {
255
+ kind: "trackedChange";
256
+ trackedChangeId: string;
257
+ story?: unknown;
258
+ side?: "source" | "destination";
259
+ } | undefined;
249
260
  }) => Promise<any>;
250
261
  editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
251
262
  resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -295,7 +306,7 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
295
306
  liveAnchorKeys?: null | undefined;
296
307
  }) => any;
297
308
  remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
298
- }, "suppressInternalExternal" | "activeComment" | "activeFloatingCommentInstanceId" | "floatingCommentsOffset" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "isDebugging" | "editingCommentId" | "editorCommentPositions" | "isCommentHighlighted" | "v2CommentsAdapter" | "COMMENT_EVENTS" | "hasInitializedComments" | "hasSyncedCollaborationComments" | "commentDialogs" | "overlappingComments" | "overlappedIds" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "hasInitializedLocations" | "committedReviewPresentations" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2TrackedChangesAdapter">, Pick<{
309
+ }, "COMMENT_EVENTS" | "isDebugging" | "hasInitializedComments" | "hasSyncedCollaborationComments" | "editingCommentId" | "activeComment" | "activeFloatingCommentInstanceId" | "commentDialogs" | "overlappingComments" | "overlappedIds" | "suppressInternalExternal" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "editorCommentPositions" | "hasInitializedLocations" | "isCommentHighlighted" | "floatingCommentsOffset" | "committedReviewPresentations" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2CommentsAdapter" | "v2TrackedChangesAdapter">, Pick<{
299
310
  COMMENT_EVENTS: {
300
311
  readonly RESOLVED: "resolved";
301
312
  readonly NEW: "new";
@@ -375,17 +386,6 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
375
386
  getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
376
387
  getCommentPositionKey: (commentOrId: Object | string | null | undefined) => string | null;
377
388
  getCommentPosition: (commentOrId: Object | string) => Object | null;
378
- getCommentAnchoredText: (commentOrId: Object | string, options?: {
379
- separator?: string | undefined;
380
- trim?: boolean | undefined;
381
- }) => string | null;
382
- getCommentAnchorData: (commentOrId: Object | string, options?: {
383
- separator?: string | undefined;
384
- trim?: boolean | undefined;
385
- }) => {
386
- position: Object;
387
- anchoredText: string | null;
388
- } | null;
389
389
  resolveCommentPositionEntry: (commentOrId: any, preferredId: any) => {
390
390
  key: string | null;
391
391
  entry: any;
@@ -409,30 +409,49 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
409
409
  };
410
410
  hasOverlapId: (id: any) => any;
411
411
  getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
412
- selection: Object;
413
- documentId: string;
414
- parentCommentId: string;
415
- }) => Object;
412
+ selection?: Object | undefined;
413
+ documentId?: string | null | undefined;
414
+ parentCommentId?: string | null | undefined;
415
+ }) => ReturnType<any>;
416
416
  showAddComment: (superdoc: any, targetClientY?: null) => any;
417
417
  addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
418
418
  superdoc: any;
419
419
  comment: any;
420
420
  skipEditorUpdate?: boolean | undefined;
421
421
  broadcastChanges?: boolean | undefined;
422
- }) => void;
422
+ }) => {
423
+ ok: boolean;
424
+ reason?: string;
425
+ detail?: string;
426
+ code?: string;
427
+ } | Promise<{
428
+ ok: boolean;
429
+ reason?: string;
430
+ detail?: string;
431
+ code?: string;
432
+ }>;
423
433
  addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
424
434
  superdoc: any;
425
435
  comment: any;
426
436
  skipEditorUpdate?: boolean | undefined;
427
437
  broadcastChanges?: boolean | undefined;
428
- }) => void;
438
+ }) => {
439
+ ok: boolean;
440
+ reason?: string;
441
+ detail?: string;
442
+ code?: string;
443
+ } | Promise<{
444
+ ok: boolean;
445
+ reason?: string;
446
+ detail?: string;
447
+ code?: string;
448
+ }>;
429
449
  cancelComment: (superdoc: any) => void;
430
450
  deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
431
451
  commentId: any;
432
452
  superdoc: any;
433
453
  }) => Promise<any>;
434
454
  removePendingComment: (superdoc: any) => void;
435
- cancelImportedTrackedChangeBootstrap: (documentId: string | null | undefined) => number;
436
455
  removeCommentsForDocument: (documentId: string | null | undefined) => void;
437
456
  setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
438
457
  commentItems?: never[] | undefined;
@@ -447,42 +466,33 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
447
466
  reason?: undefined;
448
467
  };
449
468
  clearReviewDirectory: () => void;
450
- processLoadedDocxComments: ({ superdoc, editor, comments, documentId, replacedFile }: {
451
- comments: any[];
452
- documentId: string;
453
- replacedFile?: boolean | undefined;
454
- }) => void;
455
- translateCommentsForExport: () => any[];
456
469
  handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
457
470
  retainMissingTrackedChangeGeometry?: boolean;
458
471
  retainedTrackedChangeIds?: Iterable<string>;
459
472
  }) => void;
460
473
  clearEditorCommentPositions: () => void;
461
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState, trackedChangeIdentityIndex, }: {
474
+ handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
462
475
  superdoc: Object;
463
476
  params: Object;
464
477
  }) => void;
465
- refreshTrackedChangeCommentsByIds: ({ superdoc, editor, changeIds, broadcastChanges }: {
466
- superdoc: any;
467
- editor: any;
468
- changeIds: any;
469
- broadcastChanges?: boolean | undefined;
470
- }) => void;
471
- syncResolvedCommentsWithDocument: ({ editor }?: {}) => number;
472
- syncTrackedChangePositionsWithDocument: ({ documentId, editor }?: {}) => number;
478
+ syncResolvedCommentsWithDocument: () => number;
473
479
  setActiveFloatingCommentInstance: (instanceId?: null) => void;
474
480
  requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
475
481
  peekInstantSidebarAlignment: () => null;
476
482
  clearInstantSidebarAlignment: () => void;
477
- syncTrackedChangeComments: ({ superdoc, editor, broadcastChanges }: {
478
- superdoc: any;
479
- editor: any;
480
- broadcastChanges?: boolean | undefined;
481
- }) => void;
482
483
  decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
483
484
  superdoc: Object;
484
- editor: Object;
485
- }) => void;
485
+ comment: Object;
486
+ decision: string;
487
+ }) => {
488
+ ok: boolean;
489
+ success?: boolean;
490
+ reason?: string;
491
+ } | Promise<{
492
+ ok: boolean;
493
+ success?: boolean;
494
+ reason?: string;
495
+ }>;
486
496
  v2CommentsAdapter: import('vue').ShallowRef<null, null>;
487
497
  setV2CommentsAdapter: (adapter: any) => void;
488
498
  getV2CommentsAdapter: (superdoc: any) => any;
@@ -513,7 +523,19 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
513
523
  };
514
524
  isV2EditorActive: (superdoc: any) => boolean;
515
525
  replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
516
- mentions?: never[] | undefined;
526
+ superdoc?: Object | undefined;
527
+ parentCommentId?: string | null | undefined;
528
+ text?: string | undefined;
529
+ mentions?: {
530
+ name?: string | null;
531
+ email?: string | null;
532
+ }[] | undefined;
533
+ trackedChangeTarget?: {
534
+ kind: "trackedChange";
535
+ trackedChangeId: string;
536
+ story?: unknown;
537
+ side?: "source" | "destination";
538
+ } | undefined;
517
539
  }) => Promise<any>;
518
540
  editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
519
541
  resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -643,17 +665,6 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
643
665
  getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
644
666
  getCommentPositionKey: (commentOrId: Object | string | null | undefined) => string | null;
645
667
  getCommentPosition: (commentOrId: Object | string) => Object | null;
646
- getCommentAnchoredText: (commentOrId: Object | string, options?: {
647
- separator?: string | undefined;
648
- trim?: boolean | undefined;
649
- }) => string | null;
650
- getCommentAnchorData: (commentOrId: Object | string, options?: {
651
- separator?: string | undefined;
652
- trim?: boolean | undefined;
653
- }) => {
654
- position: Object;
655
- anchoredText: string | null;
656
- } | null;
657
668
  resolveCommentPositionEntry: (commentOrId: any, preferredId: any) => {
658
669
  key: string | null;
659
670
  entry: any;
@@ -677,30 +688,49 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
677
688
  };
678
689
  hasOverlapId: (id: any) => any;
679
690
  getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
680
- selection: Object;
681
- documentId: string;
682
- parentCommentId: string;
683
- }) => Object;
691
+ selection?: Object | undefined;
692
+ documentId?: string | null | undefined;
693
+ parentCommentId?: string | null | undefined;
694
+ }) => ReturnType<any>;
684
695
  showAddComment: (superdoc: any, targetClientY?: null) => any;
685
696
  addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
686
697
  superdoc: any;
687
698
  comment: any;
688
699
  skipEditorUpdate?: boolean | undefined;
689
700
  broadcastChanges?: boolean | undefined;
690
- }) => void;
701
+ }) => {
702
+ ok: boolean;
703
+ reason?: string;
704
+ detail?: string;
705
+ code?: string;
706
+ } | Promise<{
707
+ ok: boolean;
708
+ reason?: string;
709
+ detail?: string;
710
+ code?: string;
711
+ }>;
691
712
  addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
692
713
  superdoc: any;
693
714
  comment: any;
694
715
  skipEditorUpdate?: boolean | undefined;
695
716
  broadcastChanges?: boolean | undefined;
696
- }) => void;
717
+ }) => {
718
+ ok: boolean;
719
+ reason?: string;
720
+ detail?: string;
721
+ code?: string;
722
+ } | Promise<{
723
+ ok: boolean;
724
+ reason?: string;
725
+ detail?: string;
726
+ code?: string;
727
+ }>;
697
728
  cancelComment: (superdoc: any) => void;
698
729
  deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
699
730
  commentId: any;
700
731
  superdoc: any;
701
732
  }) => Promise<any>;
702
733
  removePendingComment: (superdoc: any) => void;
703
- cancelImportedTrackedChangeBootstrap: (documentId: string | null | undefined) => number;
704
734
  removeCommentsForDocument: (documentId: string | null | undefined) => void;
705
735
  setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
706
736
  commentItems?: never[] | undefined;
@@ -715,42 +745,33 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
715
745
  reason?: undefined;
716
746
  };
717
747
  clearReviewDirectory: () => void;
718
- processLoadedDocxComments: ({ superdoc, editor, comments, documentId, replacedFile }: {
719
- comments: any[];
720
- documentId: string;
721
- replacedFile?: boolean | undefined;
722
- }) => void;
723
- translateCommentsForExport: () => any[];
724
748
  handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
725
749
  retainMissingTrackedChangeGeometry?: boolean;
726
750
  retainedTrackedChangeIds?: Iterable<string>;
727
751
  }) => void;
728
752
  clearEditorCommentPositions: () => void;
729
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState, trackedChangeIdentityIndex, }: {
753
+ handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
730
754
  superdoc: Object;
731
755
  params: Object;
732
756
  }) => void;
733
- refreshTrackedChangeCommentsByIds: ({ superdoc, editor, changeIds, broadcastChanges }: {
734
- superdoc: any;
735
- editor: any;
736
- changeIds: any;
737
- broadcastChanges?: boolean | undefined;
738
- }) => void;
739
- syncResolvedCommentsWithDocument: ({ editor }?: {}) => number;
740
- syncTrackedChangePositionsWithDocument: ({ documentId, editor }?: {}) => number;
757
+ syncResolvedCommentsWithDocument: () => number;
741
758
  setActiveFloatingCommentInstance: (instanceId?: null) => void;
742
759
  requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
743
760
  peekInstantSidebarAlignment: () => null;
744
761
  clearInstantSidebarAlignment: () => void;
745
- syncTrackedChangeComments: ({ superdoc, editor, broadcastChanges }: {
746
- superdoc: any;
747
- editor: any;
748
- broadcastChanges?: boolean | undefined;
749
- }) => void;
750
762
  decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
751
763
  superdoc: Object;
752
- editor: Object;
753
- }) => void;
764
+ comment: Object;
765
+ decision: string;
766
+ }) => {
767
+ ok: boolean;
768
+ success?: boolean;
769
+ reason?: string;
770
+ } | Promise<{
771
+ ok: boolean;
772
+ success?: boolean;
773
+ reason?: string;
774
+ }>;
754
775
  v2CommentsAdapter: import('vue').ShallowRef<null, null>;
755
776
  setV2CommentsAdapter: (adapter: any) => void;
756
777
  getV2CommentsAdapter: (superdoc: any) => any;
@@ -781,7 +802,19 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
781
802
  };
782
803
  isV2EditorActive: (superdoc: any) => boolean;
783
804
  replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
784
- mentions?: never[] | undefined;
805
+ superdoc?: Object | undefined;
806
+ parentCommentId?: string | null | undefined;
807
+ text?: string | undefined;
808
+ mentions?: {
809
+ name?: string | null;
810
+ email?: string | null;
811
+ }[] | undefined;
812
+ trackedChangeTarget?: {
813
+ kind: "trackedChange";
814
+ trackedChangeId: string;
815
+ story?: unknown;
816
+ side?: "source" | "destination";
817
+ } | undefined;
785
818
  }) => Promise<any>;
786
819
  editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
787
820
  resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -831,7 +864,7 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
831
864
  liveAnchorKeys?: null | undefined;
832
865
  }) => any;
833
866
  remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
834
- }, "getCommentAliasIds" | "getTrackedChangeThread" | "getCommentPositionKey" | "getCommentPosition" | "getCommentAnchoredText" | "getCommentAnchorData" | "resolveCommentPositionEntry" | "getCommentDocumentId" | "belongsToDocument" | "init" | "setViewingVisibility" | "getComment" | "setActiveComment" | "getCommentLocation" | "hasOverlapId" | "getPendingComment" | "showAddComment" | "addComment" | "addHydratedComment" | "cancelComment" | "deleteComment" | "removePendingComment" | "cancelImportedTrackedChangeBootstrap" | "removeCommentsForDocument" | "setReviewDirectoryFromV2" | "clearReviewDirectory" | "processLoadedDocxComments" | "translateCommentsForExport" | "handleEditorLocationsUpdate" | "clearEditorCommentPositions" | "handleTrackedChangeUpdate" | "refreshTrackedChangeCommentsByIds" | "syncResolvedCommentsWithDocument" | "syncTrackedChangePositionsWithDocument" | "setActiveFloatingCommentInstance" | "requestInstantSidebarAlignment" | "peekInstantSidebarAlignment" | "clearInstantSidebarAlignment" | "syncTrackedChangeComments" | "decideTrackedChangeFromSidebar" | "setV2CommentsAdapter" | "getV2CommentsAdapter" | "applyReviewWindowFromV2" | "reconcileCommentsFromV2" | "announceV2CommentCreated" | "dropCommentsFromMutationImpact" | "isV2EditorActive" | "replyCommentV2" | "editCommentV2" | "resolveCommentV2" | "reopenCommentV2" | "setV2TrackedChangesAdapter" | "getV2TrackedChangesAdapter" | "getV2TrackedChangeRowCount" | "reconcileTrackedChangeMutationFromV2" | "reconcileTrackedChangesFromV2" | "remapTrackedChangeIdentities">>;
867
+ }, "getCommentAliasIds" | "getTrackedChangeThread" | "getCommentPositionKey" | "getCommentPosition" | "resolveCommentPositionEntry" | "getCommentDocumentId" | "belongsToDocument" | "init" | "setViewingVisibility" | "getComment" | "setActiveComment" | "getCommentLocation" | "hasOverlapId" | "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">>;
835
868
  documents: Ref<StoreDocument[], StoreDocument[]>;
836
869
  documentBounds: Ref<unknown[], unknown[]>;
837
870
  pages: Record<string, PageEntry[]>;
@@ -861,7 +894,7 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
861
894
  getPageBounds: (documentId: string, page: number) => {
862
895
  top: number;
863
896
  } | undefined;
864
- }, "user" | "pages" | "isInternal" | "users" | "measurementUnit" | "isReady" | "activeZoom" | "zoomMode" | "viewportMetrics" | "documents" | "commentsStore" | "documentBounds" | "documentUsers" | "documentScroll" | "selectionPosition" | "activeSelection" | "modules">, Pick<{
897
+ }, "user" | "pages" | "isInternal" | "measurementUnit" | "commentsStore" | "documents" | "documentBounds" | "documentUsers" | "users" | "activeZoom" | "zoomMode" | "viewportMetrics" | "documentScroll" | "selectionPosition" | "activeSelection" | "isReady" | "modules">, Pick<{
865
898
  commentsStore: import('pinia').Store<"comments", Pick<{
866
899
  COMMENT_EVENTS: {
867
900
  readonly RESOLVED: "resolved";
@@ -942,17 +975,6 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
942
975
  getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
943
976
  getCommentPositionKey: (commentOrId: Object | string | null | undefined) => string | null;
944
977
  getCommentPosition: (commentOrId: Object | string) => Object | null;
945
- getCommentAnchoredText: (commentOrId: Object | string, options?: {
946
- separator?: string | undefined;
947
- trim?: boolean | undefined;
948
- }) => string | null;
949
- getCommentAnchorData: (commentOrId: Object | string, options?: {
950
- separator?: string | undefined;
951
- trim?: boolean | undefined;
952
- }) => {
953
- position: Object;
954
- anchoredText: string | null;
955
- } | null;
956
978
  resolveCommentPositionEntry: (commentOrId: any, preferredId: any) => {
957
979
  key: string | null;
958
980
  entry: any;
@@ -976,30 +998,49 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
976
998
  };
977
999
  hasOverlapId: (id: any) => any;
978
1000
  getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
979
- selection: Object;
980
- documentId: string;
981
- parentCommentId: string;
982
- }) => Object;
1001
+ selection?: Object | undefined;
1002
+ documentId?: string | null | undefined;
1003
+ parentCommentId?: string | null | undefined;
1004
+ }) => ReturnType<any>;
983
1005
  showAddComment: (superdoc: any, targetClientY?: null) => any;
984
1006
  addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
985
1007
  superdoc: any;
986
1008
  comment: any;
987
1009
  skipEditorUpdate?: boolean | undefined;
988
1010
  broadcastChanges?: boolean | undefined;
989
- }) => void;
1011
+ }) => {
1012
+ ok: boolean;
1013
+ reason?: string;
1014
+ detail?: string;
1015
+ code?: string;
1016
+ } | Promise<{
1017
+ ok: boolean;
1018
+ reason?: string;
1019
+ detail?: string;
1020
+ code?: string;
1021
+ }>;
990
1022
  addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
991
1023
  superdoc: any;
992
1024
  comment: any;
993
1025
  skipEditorUpdate?: boolean | undefined;
994
1026
  broadcastChanges?: boolean | undefined;
995
- }) => void;
1027
+ }) => {
1028
+ ok: boolean;
1029
+ reason?: string;
1030
+ detail?: string;
1031
+ code?: string;
1032
+ } | Promise<{
1033
+ ok: boolean;
1034
+ reason?: string;
1035
+ detail?: string;
1036
+ code?: string;
1037
+ }>;
996
1038
  cancelComment: (superdoc: any) => void;
997
1039
  deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
998
1040
  commentId: any;
999
1041
  superdoc: any;
1000
1042
  }) => Promise<any>;
1001
1043
  removePendingComment: (superdoc: any) => void;
1002
- cancelImportedTrackedChangeBootstrap: (documentId: string | null | undefined) => number;
1003
1044
  removeCommentsForDocument: (documentId: string | null | undefined) => void;
1004
1045
  setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
1005
1046
  commentItems?: never[] | undefined;
@@ -1014,42 +1055,33 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1014
1055
  reason?: undefined;
1015
1056
  };
1016
1057
  clearReviewDirectory: () => void;
1017
- processLoadedDocxComments: ({ superdoc, editor, comments, documentId, replacedFile }: {
1018
- comments: any[];
1019
- documentId: string;
1020
- replacedFile?: boolean | undefined;
1021
- }) => void;
1022
- translateCommentsForExport: () => any[];
1023
1058
  handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
1024
1059
  retainMissingTrackedChangeGeometry?: boolean;
1025
1060
  retainedTrackedChangeIds?: Iterable<string>;
1026
1061
  }) => void;
1027
1062
  clearEditorCommentPositions: () => void;
1028
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState, trackedChangeIdentityIndex, }: {
1063
+ handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
1029
1064
  superdoc: Object;
1030
1065
  params: Object;
1031
1066
  }) => void;
1032
- refreshTrackedChangeCommentsByIds: ({ superdoc, editor, changeIds, broadcastChanges }: {
1033
- superdoc: any;
1034
- editor: any;
1035
- changeIds: any;
1036
- broadcastChanges?: boolean | undefined;
1037
- }) => void;
1038
- syncResolvedCommentsWithDocument: ({ editor }?: {}) => number;
1039
- syncTrackedChangePositionsWithDocument: ({ documentId, editor }?: {}) => number;
1067
+ syncResolvedCommentsWithDocument: () => number;
1040
1068
  setActiveFloatingCommentInstance: (instanceId?: null) => void;
1041
1069
  requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
1042
1070
  peekInstantSidebarAlignment: () => null;
1043
1071
  clearInstantSidebarAlignment: () => void;
1044
- syncTrackedChangeComments: ({ superdoc, editor, broadcastChanges }: {
1045
- superdoc: any;
1046
- editor: any;
1047
- broadcastChanges?: boolean | undefined;
1048
- }) => void;
1049
1072
  decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
1050
1073
  superdoc: Object;
1051
- editor: Object;
1052
- }) => void;
1074
+ comment: Object;
1075
+ decision: string;
1076
+ }) => {
1077
+ ok: boolean;
1078
+ success?: boolean;
1079
+ reason?: string;
1080
+ } | Promise<{
1081
+ ok: boolean;
1082
+ success?: boolean;
1083
+ reason?: string;
1084
+ }>;
1053
1085
  v2CommentsAdapter: import('vue').ShallowRef<null, null>;
1054
1086
  setV2CommentsAdapter: (adapter: any) => void;
1055
1087
  getV2CommentsAdapter: (superdoc: any) => any;
@@ -1080,7 +1112,19 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1080
1112
  };
1081
1113
  isV2EditorActive: (superdoc: any) => boolean;
1082
1114
  replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
1083
- mentions?: never[] | undefined;
1115
+ superdoc?: Object | undefined;
1116
+ parentCommentId?: string | null | undefined;
1117
+ text?: string | undefined;
1118
+ mentions?: {
1119
+ name?: string | null;
1120
+ email?: string | null;
1121
+ }[] | undefined;
1122
+ trackedChangeTarget?: {
1123
+ kind: "trackedChange";
1124
+ trackedChangeId: string;
1125
+ story?: unknown;
1126
+ side?: "source" | "destination";
1127
+ } | undefined;
1084
1128
  }) => Promise<any>;
1085
1129
  editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
1086
1130
  resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -1130,7 +1174,7 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1130
1174
  liveAnchorKeys?: null | undefined;
1131
1175
  }) => any;
1132
1176
  remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
1133
- }, "suppressInternalExternal" | "activeComment" | "activeFloatingCommentInstanceId" | "floatingCommentsOffset" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "isDebugging" | "editingCommentId" | "editorCommentPositions" | "isCommentHighlighted" | "v2CommentsAdapter" | "COMMENT_EVENTS" | "hasInitializedComments" | "hasSyncedCollaborationComments" | "commentDialogs" | "overlappingComments" | "overlappedIds" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "hasInitializedLocations" | "committedReviewPresentations" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2TrackedChangesAdapter">, Pick<{
1177
+ }, "COMMENT_EVENTS" | "isDebugging" | "hasInitializedComments" | "hasSyncedCollaborationComments" | "editingCommentId" | "activeComment" | "activeFloatingCommentInstanceId" | "commentDialogs" | "overlappingComments" | "overlappedIds" | "suppressInternalExternal" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "editorCommentPositions" | "hasInitializedLocations" | "isCommentHighlighted" | "floatingCommentsOffset" | "committedReviewPresentations" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2CommentsAdapter" | "v2TrackedChangesAdapter">, Pick<{
1134
1178
  COMMENT_EVENTS: {
1135
1179
  readonly RESOLVED: "resolved";
1136
1180
  readonly NEW: "new";
@@ -1210,17 +1254,6 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1210
1254
  getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
1211
1255
  getCommentPositionKey: (commentOrId: Object | string | null | undefined) => string | null;
1212
1256
  getCommentPosition: (commentOrId: Object | string) => Object | null;
1213
- getCommentAnchoredText: (commentOrId: Object | string, options?: {
1214
- separator?: string | undefined;
1215
- trim?: boolean | undefined;
1216
- }) => string | null;
1217
- getCommentAnchorData: (commentOrId: Object | string, options?: {
1218
- separator?: string | undefined;
1219
- trim?: boolean | undefined;
1220
- }) => {
1221
- position: Object;
1222
- anchoredText: string | null;
1223
- } | null;
1224
1257
  resolveCommentPositionEntry: (commentOrId: any, preferredId: any) => {
1225
1258
  key: string | null;
1226
1259
  entry: any;
@@ -1244,30 +1277,49 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1244
1277
  };
1245
1278
  hasOverlapId: (id: any) => any;
1246
1279
  getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
1247
- selection: Object;
1248
- documentId: string;
1249
- parentCommentId: string;
1250
- }) => Object;
1280
+ selection?: Object | undefined;
1281
+ documentId?: string | null | undefined;
1282
+ parentCommentId?: string | null | undefined;
1283
+ }) => ReturnType<any>;
1251
1284
  showAddComment: (superdoc: any, targetClientY?: null) => any;
1252
1285
  addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
1253
1286
  superdoc: any;
1254
1287
  comment: any;
1255
1288
  skipEditorUpdate?: boolean | undefined;
1256
1289
  broadcastChanges?: boolean | undefined;
1257
- }) => void;
1290
+ }) => {
1291
+ ok: boolean;
1292
+ reason?: string;
1293
+ detail?: string;
1294
+ code?: string;
1295
+ } | Promise<{
1296
+ ok: boolean;
1297
+ reason?: string;
1298
+ detail?: string;
1299
+ code?: string;
1300
+ }>;
1258
1301
  addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
1259
1302
  superdoc: any;
1260
1303
  comment: any;
1261
1304
  skipEditorUpdate?: boolean | undefined;
1262
1305
  broadcastChanges?: boolean | undefined;
1263
- }) => void;
1306
+ }) => {
1307
+ ok: boolean;
1308
+ reason?: string;
1309
+ detail?: string;
1310
+ code?: string;
1311
+ } | Promise<{
1312
+ ok: boolean;
1313
+ reason?: string;
1314
+ detail?: string;
1315
+ code?: string;
1316
+ }>;
1264
1317
  cancelComment: (superdoc: any) => void;
1265
1318
  deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
1266
1319
  commentId: any;
1267
1320
  superdoc: any;
1268
1321
  }) => Promise<any>;
1269
1322
  removePendingComment: (superdoc: any) => void;
1270
- cancelImportedTrackedChangeBootstrap: (documentId: string | null | undefined) => number;
1271
1323
  removeCommentsForDocument: (documentId: string | null | undefined) => void;
1272
1324
  setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
1273
1325
  commentItems?: never[] | undefined;
@@ -1282,42 +1334,33 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1282
1334
  reason?: undefined;
1283
1335
  };
1284
1336
  clearReviewDirectory: () => void;
1285
- processLoadedDocxComments: ({ superdoc, editor, comments, documentId, replacedFile }: {
1286
- comments: any[];
1287
- documentId: string;
1288
- replacedFile?: boolean | undefined;
1289
- }) => void;
1290
- translateCommentsForExport: () => any[];
1291
1337
  handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
1292
1338
  retainMissingTrackedChangeGeometry?: boolean;
1293
1339
  retainedTrackedChangeIds?: Iterable<string>;
1294
1340
  }) => void;
1295
1341
  clearEditorCommentPositions: () => void;
1296
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState, trackedChangeIdentityIndex, }: {
1342
+ handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
1297
1343
  superdoc: Object;
1298
1344
  params: Object;
1299
1345
  }) => void;
1300
- refreshTrackedChangeCommentsByIds: ({ superdoc, editor, changeIds, broadcastChanges }: {
1301
- superdoc: any;
1302
- editor: any;
1303
- changeIds: any;
1304
- broadcastChanges?: boolean | undefined;
1305
- }) => void;
1306
- syncResolvedCommentsWithDocument: ({ editor }?: {}) => number;
1307
- syncTrackedChangePositionsWithDocument: ({ documentId, editor }?: {}) => number;
1346
+ syncResolvedCommentsWithDocument: () => number;
1308
1347
  setActiveFloatingCommentInstance: (instanceId?: null) => void;
1309
1348
  requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
1310
1349
  peekInstantSidebarAlignment: () => null;
1311
1350
  clearInstantSidebarAlignment: () => void;
1312
- syncTrackedChangeComments: ({ superdoc, editor, broadcastChanges }: {
1313
- superdoc: any;
1314
- editor: any;
1315
- broadcastChanges?: boolean | undefined;
1316
- }) => void;
1317
1351
  decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
1318
1352
  superdoc: Object;
1319
- editor: Object;
1320
- }) => void;
1353
+ comment: Object;
1354
+ decision: string;
1355
+ }) => {
1356
+ ok: boolean;
1357
+ success?: boolean;
1358
+ reason?: string;
1359
+ } | Promise<{
1360
+ ok: boolean;
1361
+ success?: boolean;
1362
+ reason?: string;
1363
+ }>;
1321
1364
  v2CommentsAdapter: import('vue').ShallowRef<null, null>;
1322
1365
  setV2CommentsAdapter: (adapter: any) => void;
1323
1366
  getV2CommentsAdapter: (superdoc: any) => any;
@@ -1348,7 +1391,19 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1348
1391
  };
1349
1392
  isV2EditorActive: (superdoc: any) => boolean;
1350
1393
  replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
1351
- mentions?: never[] | undefined;
1394
+ superdoc?: Object | undefined;
1395
+ parentCommentId?: string | null | undefined;
1396
+ text?: string | undefined;
1397
+ mentions?: {
1398
+ name?: string | null;
1399
+ email?: string | null;
1400
+ }[] | undefined;
1401
+ trackedChangeTarget?: {
1402
+ kind: "trackedChange";
1403
+ trackedChangeId: string;
1404
+ story?: unknown;
1405
+ side?: "source" | "destination";
1406
+ } | undefined;
1352
1407
  }) => Promise<any>;
1353
1408
  editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
1354
1409
  resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -1478,17 +1533,6 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1478
1533
  getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
1479
1534
  getCommentPositionKey: (commentOrId: Object | string | null | undefined) => string | null;
1480
1535
  getCommentPosition: (commentOrId: Object | string) => Object | null;
1481
- getCommentAnchoredText: (commentOrId: Object | string, options?: {
1482
- separator?: string | undefined;
1483
- trim?: boolean | undefined;
1484
- }) => string | null;
1485
- getCommentAnchorData: (commentOrId: Object | string, options?: {
1486
- separator?: string | undefined;
1487
- trim?: boolean | undefined;
1488
- }) => {
1489
- position: Object;
1490
- anchoredText: string | null;
1491
- } | null;
1492
1536
  resolveCommentPositionEntry: (commentOrId: any, preferredId: any) => {
1493
1537
  key: string | null;
1494
1538
  entry: any;
@@ -1512,30 +1556,49 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1512
1556
  };
1513
1557
  hasOverlapId: (id: any) => any;
1514
1558
  getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
1515
- selection: Object;
1516
- documentId: string;
1517
- parentCommentId: string;
1518
- }) => Object;
1559
+ selection?: Object | undefined;
1560
+ documentId?: string | null | undefined;
1561
+ parentCommentId?: string | null | undefined;
1562
+ }) => ReturnType<any>;
1519
1563
  showAddComment: (superdoc: any, targetClientY?: null) => any;
1520
1564
  addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
1521
1565
  superdoc: any;
1522
1566
  comment: any;
1523
1567
  skipEditorUpdate?: boolean | undefined;
1524
1568
  broadcastChanges?: boolean | undefined;
1525
- }) => void;
1569
+ }) => {
1570
+ ok: boolean;
1571
+ reason?: string;
1572
+ detail?: string;
1573
+ code?: string;
1574
+ } | Promise<{
1575
+ ok: boolean;
1576
+ reason?: string;
1577
+ detail?: string;
1578
+ code?: string;
1579
+ }>;
1526
1580
  addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
1527
1581
  superdoc: any;
1528
1582
  comment: any;
1529
1583
  skipEditorUpdate?: boolean | undefined;
1530
1584
  broadcastChanges?: boolean | undefined;
1531
- }) => void;
1585
+ }) => {
1586
+ ok: boolean;
1587
+ reason?: string;
1588
+ detail?: string;
1589
+ code?: string;
1590
+ } | Promise<{
1591
+ ok: boolean;
1592
+ reason?: string;
1593
+ detail?: string;
1594
+ code?: string;
1595
+ }>;
1532
1596
  cancelComment: (superdoc: any) => void;
1533
1597
  deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
1534
1598
  commentId: any;
1535
1599
  superdoc: any;
1536
1600
  }) => Promise<any>;
1537
1601
  removePendingComment: (superdoc: any) => void;
1538
- cancelImportedTrackedChangeBootstrap: (documentId: string | null | undefined) => number;
1539
1602
  removeCommentsForDocument: (documentId: string | null | undefined) => void;
1540
1603
  setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
1541
1604
  commentItems?: never[] | undefined;
@@ -1550,42 +1613,33 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1550
1613
  reason?: undefined;
1551
1614
  };
1552
1615
  clearReviewDirectory: () => void;
1553
- processLoadedDocxComments: ({ superdoc, editor, comments, documentId, replacedFile }: {
1554
- comments: any[];
1555
- documentId: string;
1556
- replacedFile?: boolean | undefined;
1557
- }) => void;
1558
- translateCommentsForExport: () => any[];
1559
1616
  handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
1560
1617
  retainMissingTrackedChangeGeometry?: boolean;
1561
1618
  retainedTrackedChangeIds?: Iterable<string>;
1562
1619
  }) => void;
1563
1620
  clearEditorCommentPositions: () => void;
1564
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState, trackedChangeIdentityIndex, }: {
1621
+ handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
1565
1622
  superdoc: Object;
1566
1623
  params: Object;
1567
1624
  }) => void;
1568
- refreshTrackedChangeCommentsByIds: ({ superdoc, editor, changeIds, broadcastChanges }: {
1569
- superdoc: any;
1570
- editor: any;
1571
- changeIds: any;
1572
- broadcastChanges?: boolean | undefined;
1573
- }) => void;
1574
- syncResolvedCommentsWithDocument: ({ editor }?: {}) => number;
1575
- syncTrackedChangePositionsWithDocument: ({ documentId, editor }?: {}) => number;
1625
+ syncResolvedCommentsWithDocument: () => number;
1576
1626
  setActiveFloatingCommentInstance: (instanceId?: null) => void;
1577
1627
  requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
1578
1628
  peekInstantSidebarAlignment: () => null;
1579
1629
  clearInstantSidebarAlignment: () => void;
1580
- syncTrackedChangeComments: ({ superdoc, editor, broadcastChanges }: {
1581
- superdoc: any;
1582
- editor: any;
1583
- broadcastChanges?: boolean | undefined;
1584
- }) => void;
1585
1630
  decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
1586
1631
  superdoc: Object;
1587
- editor: Object;
1588
- }) => void;
1632
+ comment: Object;
1633
+ decision: string;
1634
+ }) => {
1635
+ ok: boolean;
1636
+ success?: boolean;
1637
+ reason?: string;
1638
+ } | Promise<{
1639
+ ok: boolean;
1640
+ success?: boolean;
1641
+ reason?: string;
1642
+ }>;
1589
1643
  v2CommentsAdapter: import('vue').ShallowRef<null, null>;
1590
1644
  setV2CommentsAdapter: (adapter: any) => void;
1591
1645
  getV2CommentsAdapter: (superdoc: any) => any;
@@ -1616,7 +1670,19 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1616
1670
  };
1617
1671
  isV2EditorActive: (superdoc: any) => boolean;
1618
1672
  replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
1619
- mentions?: never[] | undefined;
1673
+ superdoc?: Object | undefined;
1674
+ parentCommentId?: string | null | undefined;
1675
+ text?: string | undefined;
1676
+ mentions?: {
1677
+ name?: string | null;
1678
+ email?: string | null;
1679
+ }[] | undefined;
1680
+ trackedChangeTarget?: {
1681
+ kind: "trackedChange";
1682
+ trackedChangeId: string;
1683
+ story?: unknown;
1684
+ side?: "source" | "destination";
1685
+ } | undefined;
1620
1686
  }) => Promise<any>;
1621
1687
  editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
1622
1688
  resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -1666,7 +1732,7 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1666
1732
  liveAnchorKeys?: null | undefined;
1667
1733
  }) => any;
1668
1734
  remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
1669
- }, "getCommentAliasIds" | "getTrackedChangeThread" | "getCommentPositionKey" | "getCommentPosition" | "getCommentAnchoredText" | "getCommentAnchorData" | "resolveCommentPositionEntry" | "getCommentDocumentId" | "belongsToDocument" | "init" | "setViewingVisibility" | "getComment" | "setActiveComment" | "getCommentLocation" | "hasOverlapId" | "getPendingComment" | "showAddComment" | "addComment" | "addHydratedComment" | "cancelComment" | "deleteComment" | "removePendingComment" | "cancelImportedTrackedChangeBootstrap" | "removeCommentsForDocument" | "setReviewDirectoryFromV2" | "clearReviewDirectory" | "processLoadedDocxComments" | "translateCommentsForExport" | "handleEditorLocationsUpdate" | "clearEditorCommentPositions" | "handleTrackedChangeUpdate" | "refreshTrackedChangeCommentsByIds" | "syncResolvedCommentsWithDocument" | "syncTrackedChangePositionsWithDocument" | "setActiveFloatingCommentInstance" | "requestInstantSidebarAlignment" | "peekInstantSidebarAlignment" | "clearInstantSidebarAlignment" | "syncTrackedChangeComments" | "decideTrackedChangeFromSidebar" | "setV2CommentsAdapter" | "getV2CommentsAdapter" | "applyReviewWindowFromV2" | "reconcileCommentsFromV2" | "announceV2CommentCreated" | "dropCommentsFromMutationImpact" | "isV2EditorActive" | "replyCommentV2" | "editCommentV2" | "resolveCommentV2" | "reopenCommentV2" | "setV2TrackedChangesAdapter" | "getV2TrackedChangesAdapter" | "getV2TrackedChangeRowCount" | "reconcileTrackedChangeMutationFromV2" | "reconcileTrackedChangesFromV2" | "remapTrackedChangeIdentities">>;
1735
+ }, "getCommentAliasIds" | "getTrackedChangeThread" | "getCommentPositionKey" | "getCommentPosition" | "resolveCommentPositionEntry" | "getCommentDocumentId" | "belongsToDocument" | "init" | "setViewingVisibility" | "getComment" | "setActiveComment" | "getCommentLocation" | "hasOverlapId" | "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">>;
1670
1736
  documents: Ref<StoreDocument[], StoreDocument[]>;
1671
1737
  documentBounds: Ref<unknown[], unknown[]>;
1672
1738
  pages: Record<string, PageEntry[]>;
@@ -1777,17 +1843,6 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1777
1843
  getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
1778
1844
  getCommentPositionKey: (commentOrId: Object | string | null | undefined) => string | null;
1779
1845
  getCommentPosition: (commentOrId: Object | string) => Object | null;
1780
- getCommentAnchoredText: (commentOrId: Object | string, options?: {
1781
- separator?: string | undefined;
1782
- trim?: boolean | undefined;
1783
- }) => string | null;
1784
- getCommentAnchorData: (commentOrId: Object | string, options?: {
1785
- separator?: string | undefined;
1786
- trim?: boolean | undefined;
1787
- }) => {
1788
- position: Object;
1789
- anchoredText: string | null;
1790
- } | null;
1791
1846
  resolveCommentPositionEntry: (commentOrId: any, preferredId: any) => {
1792
1847
  key: string | null;
1793
1848
  entry: any;
@@ -1811,30 +1866,49 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1811
1866
  };
1812
1867
  hasOverlapId: (id: any) => any;
1813
1868
  getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
1814
- selection: Object;
1815
- documentId: string;
1816
- parentCommentId: string;
1817
- }) => Object;
1869
+ selection?: Object | undefined;
1870
+ documentId?: string | null | undefined;
1871
+ parentCommentId?: string | null | undefined;
1872
+ }) => ReturnType<any>;
1818
1873
  showAddComment: (superdoc: any, targetClientY?: null) => any;
1819
1874
  addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
1820
1875
  superdoc: any;
1821
1876
  comment: any;
1822
1877
  skipEditorUpdate?: boolean | undefined;
1823
1878
  broadcastChanges?: boolean | undefined;
1824
- }) => void;
1879
+ }) => {
1880
+ ok: boolean;
1881
+ reason?: string;
1882
+ detail?: string;
1883
+ code?: string;
1884
+ } | Promise<{
1885
+ ok: boolean;
1886
+ reason?: string;
1887
+ detail?: string;
1888
+ code?: string;
1889
+ }>;
1825
1890
  addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
1826
1891
  superdoc: any;
1827
1892
  comment: any;
1828
1893
  skipEditorUpdate?: boolean | undefined;
1829
1894
  broadcastChanges?: boolean | undefined;
1830
- }) => void;
1895
+ }) => {
1896
+ ok: boolean;
1897
+ reason?: string;
1898
+ detail?: string;
1899
+ code?: string;
1900
+ } | Promise<{
1901
+ ok: boolean;
1902
+ reason?: string;
1903
+ detail?: string;
1904
+ code?: string;
1905
+ }>;
1831
1906
  cancelComment: (superdoc: any) => void;
1832
1907
  deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
1833
1908
  commentId: any;
1834
1909
  superdoc: any;
1835
1910
  }) => Promise<any>;
1836
1911
  removePendingComment: (superdoc: any) => void;
1837
- cancelImportedTrackedChangeBootstrap: (documentId: string | null | undefined) => number;
1838
1912
  removeCommentsForDocument: (documentId: string | null | undefined) => void;
1839
1913
  setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
1840
1914
  commentItems?: never[] | undefined;
@@ -1849,42 +1923,33 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1849
1923
  reason?: undefined;
1850
1924
  };
1851
1925
  clearReviewDirectory: () => void;
1852
- processLoadedDocxComments: ({ superdoc, editor, comments, documentId, replacedFile }: {
1853
- comments: any[];
1854
- documentId: string;
1855
- replacedFile?: boolean | undefined;
1856
- }) => void;
1857
- translateCommentsForExport: () => any[];
1858
1926
  handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
1859
1927
  retainMissingTrackedChangeGeometry?: boolean;
1860
1928
  retainedTrackedChangeIds?: Iterable<string>;
1861
1929
  }) => void;
1862
1930
  clearEditorCommentPositions: () => void;
1863
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState, trackedChangeIdentityIndex, }: {
1931
+ handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
1864
1932
  superdoc: Object;
1865
1933
  params: Object;
1866
1934
  }) => void;
1867
- refreshTrackedChangeCommentsByIds: ({ superdoc, editor, changeIds, broadcastChanges }: {
1868
- superdoc: any;
1869
- editor: any;
1870
- changeIds: any;
1871
- broadcastChanges?: boolean | undefined;
1872
- }) => void;
1873
- syncResolvedCommentsWithDocument: ({ editor }?: {}) => number;
1874
- syncTrackedChangePositionsWithDocument: ({ documentId, editor }?: {}) => number;
1935
+ syncResolvedCommentsWithDocument: () => number;
1875
1936
  setActiveFloatingCommentInstance: (instanceId?: null) => void;
1876
1937
  requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
1877
1938
  peekInstantSidebarAlignment: () => null;
1878
1939
  clearInstantSidebarAlignment: () => void;
1879
- syncTrackedChangeComments: ({ superdoc, editor, broadcastChanges }: {
1880
- superdoc: any;
1881
- editor: any;
1882
- broadcastChanges?: boolean | undefined;
1883
- }) => void;
1884
1940
  decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
1885
1941
  superdoc: Object;
1886
- editor: Object;
1887
- }) => void;
1942
+ comment: Object;
1943
+ decision: string;
1944
+ }) => {
1945
+ ok: boolean;
1946
+ success?: boolean;
1947
+ reason?: string;
1948
+ } | Promise<{
1949
+ ok: boolean;
1950
+ success?: boolean;
1951
+ reason?: string;
1952
+ }>;
1888
1953
  v2CommentsAdapter: import('vue').ShallowRef<null, null>;
1889
1954
  setV2CommentsAdapter: (adapter: any) => void;
1890
1955
  getV2CommentsAdapter: (superdoc: any) => any;
@@ -1915,7 +1980,19 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1915
1980
  };
1916
1981
  isV2EditorActive: (superdoc: any) => boolean;
1917
1982
  replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
1918
- mentions?: never[] | undefined;
1983
+ superdoc?: Object | undefined;
1984
+ parentCommentId?: string | null | undefined;
1985
+ text?: string | undefined;
1986
+ mentions?: {
1987
+ name?: string | null;
1988
+ email?: string | null;
1989
+ }[] | undefined;
1990
+ trackedChangeTarget?: {
1991
+ kind: "trackedChange";
1992
+ trackedChangeId: string;
1993
+ story?: unknown;
1994
+ side?: "source" | "destination";
1995
+ } | undefined;
1919
1996
  }) => Promise<any>;
1920
1997
  editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
1921
1998
  resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -1965,7 +2042,7 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
1965
2042
  liveAnchorKeys?: null | undefined;
1966
2043
  }) => any;
1967
2044
  remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
1968
- }, "suppressInternalExternal" | "activeComment" | "activeFloatingCommentInstanceId" | "floatingCommentsOffset" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "isDebugging" | "editingCommentId" | "editorCommentPositions" | "isCommentHighlighted" | "v2CommentsAdapter" | "COMMENT_EVENTS" | "hasInitializedComments" | "hasSyncedCollaborationComments" | "commentDialogs" | "overlappingComments" | "overlappedIds" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "hasInitializedLocations" | "committedReviewPresentations" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2TrackedChangesAdapter">, Pick<{
2045
+ }, "COMMENT_EVENTS" | "isDebugging" | "hasInitializedComments" | "hasSyncedCollaborationComments" | "editingCommentId" | "activeComment" | "activeFloatingCommentInstanceId" | "commentDialogs" | "overlappingComments" | "overlappedIds" | "suppressInternalExternal" | "pendingComment" | "currentCommentText" | "currentCommentMentions" | "commentsList" | "reviewDirectoryList" | "isCommentsListVisible" | "isReviewDirectoryActive" | "isReviewDirectoryLoading" | "generalCommentIds" | "editorCommentIds" | "commentsParentElement" | "editorCommentPositions" | "hasInitializedLocations" | "isCommentHighlighted" | "floatingCommentsOffset" | "committedReviewPresentations" | "sortedConversations" | "visibleConversations" | "skipSelectionUpdate" | "isFloatingCommentsReady" | "instantSidebarAlignmentTargetY" | "instantSidebarAlignmentThreadId" | "instantSidebarAlignmentInstanceId" | "viewingVisibility" | "v2CommentsAdapter" | "v2TrackedChangesAdapter">, Pick<{
1969
2046
  COMMENT_EVENTS: {
1970
2047
  readonly RESOLVED: "resolved";
1971
2048
  readonly NEW: "new";
@@ -2045,17 +2122,6 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
2045
2122
  getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
2046
2123
  getCommentPositionKey: (commentOrId: Object | string | null | undefined) => string | null;
2047
2124
  getCommentPosition: (commentOrId: Object | string) => Object | null;
2048
- getCommentAnchoredText: (commentOrId: Object | string, options?: {
2049
- separator?: string | undefined;
2050
- trim?: boolean | undefined;
2051
- }) => string | null;
2052
- getCommentAnchorData: (commentOrId: Object | string, options?: {
2053
- separator?: string | undefined;
2054
- trim?: boolean | undefined;
2055
- }) => {
2056
- position: Object;
2057
- anchoredText: string | null;
2058
- } | null;
2059
2125
  resolveCommentPositionEntry: (commentOrId: any, preferredId: any) => {
2060
2126
  key: string | null;
2061
2127
  entry: any;
@@ -2079,30 +2145,49 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
2079
2145
  };
2080
2146
  hasOverlapId: (id: any) => any;
2081
2147
  getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
2082
- selection: Object;
2083
- documentId: string;
2084
- parentCommentId: string;
2085
- }) => Object;
2148
+ selection?: Object | undefined;
2149
+ documentId?: string | null | undefined;
2150
+ parentCommentId?: string | null | undefined;
2151
+ }) => ReturnType<any>;
2086
2152
  showAddComment: (superdoc: any, targetClientY?: null) => any;
2087
2153
  addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
2088
2154
  superdoc: any;
2089
2155
  comment: any;
2090
2156
  skipEditorUpdate?: boolean | undefined;
2091
2157
  broadcastChanges?: boolean | undefined;
2092
- }) => void;
2158
+ }) => {
2159
+ ok: boolean;
2160
+ reason?: string;
2161
+ detail?: string;
2162
+ code?: string;
2163
+ } | Promise<{
2164
+ ok: boolean;
2165
+ reason?: string;
2166
+ detail?: string;
2167
+ code?: string;
2168
+ }>;
2093
2169
  addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
2094
2170
  superdoc: any;
2095
2171
  comment: any;
2096
2172
  skipEditorUpdate?: boolean | undefined;
2097
2173
  broadcastChanges?: boolean | undefined;
2098
- }) => void;
2174
+ }) => {
2175
+ ok: boolean;
2176
+ reason?: string;
2177
+ detail?: string;
2178
+ code?: string;
2179
+ } | Promise<{
2180
+ ok: boolean;
2181
+ reason?: string;
2182
+ detail?: string;
2183
+ code?: string;
2184
+ }>;
2099
2185
  cancelComment: (superdoc: any) => void;
2100
2186
  deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
2101
2187
  commentId: any;
2102
2188
  superdoc: any;
2103
2189
  }) => Promise<any>;
2104
2190
  removePendingComment: (superdoc: any) => void;
2105
- cancelImportedTrackedChangeBootstrap: (documentId: string | null | undefined) => number;
2106
2191
  removeCommentsForDocument: (documentId: string | null | undefined) => void;
2107
2192
  setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
2108
2193
  commentItems?: never[] | undefined;
@@ -2117,42 +2202,33 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
2117
2202
  reason?: undefined;
2118
2203
  };
2119
2204
  clearReviewDirectory: () => void;
2120
- processLoadedDocxComments: ({ superdoc, editor, comments, documentId, replacedFile }: {
2121
- comments: any[];
2122
- documentId: string;
2123
- replacedFile?: boolean | undefined;
2124
- }) => void;
2125
- translateCommentsForExport: () => any[];
2126
2205
  handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
2127
2206
  retainMissingTrackedChangeGeometry?: boolean;
2128
2207
  retainedTrackedChangeIds?: Iterable<string>;
2129
2208
  }) => void;
2130
2209
  clearEditorCommentPositions: () => void;
2131
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState, trackedChangeIdentityIndex, }: {
2210
+ handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
2132
2211
  superdoc: Object;
2133
2212
  params: Object;
2134
2213
  }) => void;
2135
- refreshTrackedChangeCommentsByIds: ({ superdoc, editor, changeIds, broadcastChanges }: {
2136
- superdoc: any;
2137
- editor: any;
2138
- changeIds: any;
2139
- broadcastChanges?: boolean | undefined;
2140
- }) => void;
2141
- syncResolvedCommentsWithDocument: ({ editor }?: {}) => number;
2142
- syncTrackedChangePositionsWithDocument: ({ documentId, editor }?: {}) => number;
2214
+ syncResolvedCommentsWithDocument: () => number;
2143
2215
  setActiveFloatingCommentInstance: (instanceId?: null) => void;
2144
2216
  requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
2145
2217
  peekInstantSidebarAlignment: () => null;
2146
2218
  clearInstantSidebarAlignment: () => void;
2147
- syncTrackedChangeComments: ({ superdoc, editor, broadcastChanges }: {
2148
- superdoc: any;
2149
- editor: any;
2150
- broadcastChanges?: boolean | undefined;
2151
- }) => void;
2152
2219
  decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
2153
2220
  superdoc: Object;
2154
- editor: Object;
2155
- }) => void;
2221
+ comment: Object;
2222
+ decision: string;
2223
+ }) => {
2224
+ ok: boolean;
2225
+ success?: boolean;
2226
+ reason?: string;
2227
+ } | Promise<{
2228
+ ok: boolean;
2229
+ success?: boolean;
2230
+ reason?: string;
2231
+ }>;
2156
2232
  v2CommentsAdapter: import('vue').ShallowRef<null, null>;
2157
2233
  setV2CommentsAdapter: (adapter: any) => void;
2158
2234
  getV2CommentsAdapter: (superdoc: any) => any;
@@ -2183,7 +2259,19 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
2183
2259
  };
2184
2260
  isV2EditorActive: (superdoc: any) => boolean;
2185
2261
  replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
2186
- mentions?: never[] | undefined;
2262
+ superdoc?: Object | undefined;
2263
+ parentCommentId?: string | null | undefined;
2264
+ text?: string | undefined;
2265
+ mentions?: {
2266
+ name?: string | null;
2267
+ email?: string | null;
2268
+ }[] | undefined;
2269
+ trackedChangeTarget?: {
2270
+ kind: "trackedChange";
2271
+ trackedChangeId: string;
2272
+ story?: unknown;
2273
+ side?: "source" | "destination";
2274
+ } | undefined;
2187
2275
  }) => Promise<any>;
2188
2276
  editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
2189
2277
  resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -2313,17 +2401,6 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
2313
2401
  getTrackedChangeThread: (parentComment: any) => any[] | readonly never[];
2314
2402
  getCommentPositionKey: (commentOrId: Object | string | null | undefined) => string | null;
2315
2403
  getCommentPosition: (commentOrId: Object | string) => Object | null;
2316
- getCommentAnchoredText: (commentOrId: Object | string, options?: {
2317
- separator?: string | undefined;
2318
- trim?: boolean | undefined;
2319
- }) => string | null;
2320
- getCommentAnchorData: (commentOrId: Object | string, options?: {
2321
- separator?: string | undefined;
2322
- trim?: boolean | undefined;
2323
- }) => {
2324
- position: Object;
2325
- anchoredText: string | null;
2326
- } | null;
2327
2404
  resolveCommentPositionEntry: (commentOrId: any, preferredId: any) => {
2328
2405
  key: string | null;
2329
2406
  entry: any;
@@ -2347,30 +2424,49 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
2347
2424
  };
2348
2425
  hasOverlapId: (id: any) => any;
2349
2426
  getPendingComment: ({ selection, documentId, parentCommentId, ...options }: {
2350
- selection: Object;
2351
- documentId: string;
2352
- parentCommentId: string;
2353
- }) => Object;
2427
+ selection?: Object | undefined;
2428
+ documentId?: string | null | undefined;
2429
+ parentCommentId?: string | null | undefined;
2430
+ }) => ReturnType<any>;
2354
2431
  showAddComment: (superdoc: any, targetClientY?: null) => any;
2355
2432
  addComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
2356
2433
  superdoc: any;
2357
2434
  comment: any;
2358
2435
  skipEditorUpdate?: boolean | undefined;
2359
2436
  broadcastChanges?: boolean | undefined;
2360
- }) => void;
2437
+ }) => {
2438
+ ok: boolean;
2439
+ reason?: string;
2440
+ detail?: string;
2441
+ code?: string;
2442
+ } | Promise<{
2443
+ ok: boolean;
2444
+ reason?: string;
2445
+ detail?: string;
2446
+ code?: string;
2447
+ }>;
2361
2448
  addHydratedComment: ({ superdoc, comment, skipEditorUpdate, broadcastChanges }: {
2362
2449
  superdoc: any;
2363
2450
  comment: any;
2364
2451
  skipEditorUpdate?: boolean | undefined;
2365
2452
  broadcastChanges?: boolean | undefined;
2366
- }) => void;
2453
+ }) => {
2454
+ ok: boolean;
2455
+ reason?: string;
2456
+ detail?: string;
2457
+ code?: string;
2458
+ } | Promise<{
2459
+ ok: boolean;
2460
+ reason?: string;
2461
+ detail?: string;
2462
+ code?: string;
2463
+ }>;
2367
2464
  cancelComment: (superdoc: any) => void;
2368
2465
  deleteComment: ({ commentId: commentIdToDelete, superdoc }: {
2369
2466
  commentId: any;
2370
2467
  superdoc: any;
2371
2468
  }) => Promise<any>;
2372
2469
  removePendingComment: (superdoc: any) => void;
2373
- cancelImportedTrackedChangeBootstrap: (documentId: string | null | undefined) => number;
2374
2470
  removeCommentsForDocument: (documentId: string | null | undefined) => void;
2375
2471
  setReviewDirectoryFromV2: ({ superdoc, commentItems, trackedChangeItems }?: {
2376
2472
  commentItems?: never[] | undefined;
@@ -2385,42 +2481,33 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
2385
2481
  reason?: undefined;
2386
2482
  };
2387
2483
  clearReviewDirectory: () => void;
2388
- processLoadedDocxComments: ({ superdoc, editor, comments, documentId, replacedFile }: {
2389
- comments: any[];
2390
- documentId: string;
2391
- replacedFile?: boolean | undefined;
2392
- }) => void;
2393
- translateCommentsForExport: () => any[];
2394
2484
  handleEditorLocationsUpdate: (allCommentPositions: Object, options?: {
2395
2485
  retainMissingTrackedChangeGeometry?: boolean;
2396
2486
  retainedTrackedChangeIds?: Iterable<string>;
2397
2487
  }) => void;
2398
2488
  clearEditorCommentPositions: () => void;
2399
- handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, documentState, trackedChangeIdentityIndex, }: {
2489
+ handleTrackedChangeUpdate: ({ superdoc, params, broadcastChanges, trackedChangeIdentityIndex, }: {
2400
2490
  superdoc: Object;
2401
2491
  params: Object;
2402
2492
  }) => void;
2403
- refreshTrackedChangeCommentsByIds: ({ superdoc, editor, changeIds, broadcastChanges }: {
2404
- superdoc: any;
2405
- editor: any;
2406
- changeIds: any;
2407
- broadcastChanges?: boolean | undefined;
2408
- }) => void;
2409
- syncResolvedCommentsWithDocument: ({ editor }?: {}) => number;
2410
- syncTrackedChangePositionsWithDocument: ({ documentId, editor }?: {}) => number;
2493
+ syncResolvedCommentsWithDocument: () => number;
2411
2494
  setActiveFloatingCommentInstance: (instanceId?: null) => void;
2412
2495
  requestInstantSidebarAlignment: (targetY?: null, threadId?: null, instanceId?: null) => void;
2413
2496
  peekInstantSidebarAlignment: () => null;
2414
2497
  clearInstantSidebarAlignment: () => void;
2415
- syncTrackedChangeComments: ({ superdoc, editor, broadcastChanges }: {
2416
- superdoc: any;
2417
- editor: any;
2418
- broadcastChanges?: boolean | undefined;
2419
- }) => void;
2420
2498
  decideTrackedChangeFromSidebar: ({ superdoc, comment, decision }: {
2421
2499
  superdoc: Object;
2422
- editor: Object;
2423
- }) => void;
2500
+ comment: Object;
2501
+ decision: string;
2502
+ }) => {
2503
+ ok: boolean;
2504
+ success?: boolean;
2505
+ reason?: string;
2506
+ } | Promise<{
2507
+ ok: boolean;
2508
+ success?: boolean;
2509
+ reason?: string;
2510
+ }>;
2424
2511
  v2CommentsAdapter: import('vue').ShallowRef<null, null>;
2425
2512
  setV2CommentsAdapter: (adapter: any) => void;
2426
2513
  getV2CommentsAdapter: (superdoc: any) => any;
@@ -2451,7 +2538,19 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
2451
2538
  };
2452
2539
  isV2EditorActive: (superdoc: any) => boolean;
2453
2540
  replyCommentV2: ({ superdoc, parentCommentId, text, mentions, trackedChangeTarget }?: {
2454
- mentions?: never[] | undefined;
2541
+ superdoc?: Object | undefined;
2542
+ parentCommentId?: string | null | undefined;
2543
+ text?: string | undefined;
2544
+ mentions?: {
2545
+ name?: string | null;
2546
+ email?: string | null;
2547
+ }[] | undefined;
2548
+ trackedChangeTarget?: {
2549
+ kind: "trackedChange";
2550
+ trackedChangeId: string;
2551
+ story?: unknown;
2552
+ side?: "source" | "destination";
2553
+ } | undefined;
2455
2554
  }) => Promise<any>;
2456
2555
  editCommentV2: ({ superdoc, commentId, text }?: {}) => Promise<any>;
2457
2556
  resolveCommentV2: ({ superdoc, commentId }?: {}) => Promise<any>;
@@ -2501,7 +2600,7 @@ export declare const useSuperdocStore: import('pinia').StoreDefinition<"superdoc
2501
2600
  liveAnchorKeys?: null | undefined;
2502
2601
  }) => any;
2503
2602
  remapTrackedChangeIdentities: (pairs?: any[], { documentId }?: {}) => void;
2504
- }, "getCommentAliasIds" | "getTrackedChangeThread" | "getCommentPositionKey" | "getCommentPosition" | "getCommentAnchoredText" | "getCommentAnchorData" | "resolveCommentPositionEntry" | "getCommentDocumentId" | "belongsToDocument" | "init" | "setViewingVisibility" | "getComment" | "setActiveComment" | "getCommentLocation" | "hasOverlapId" | "getPendingComment" | "showAddComment" | "addComment" | "addHydratedComment" | "cancelComment" | "deleteComment" | "removePendingComment" | "cancelImportedTrackedChangeBootstrap" | "removeCommentsForDocument" | "setReviewDirectoryFromV2" | "clearReviewDirectory" | "processLoadedDocxComments" | "translateCommentsForExport" | "handleEditorLocationsUpdate" | "clearEditorCommentPositions" | "handleTrackedChangeUpdate" | "refreshTrackedChangeCommentsByIds" | "syncResolvedCommentsWithDocument" | "syncTrackedChangePositionsWithDocument" | "setActiveFloatingCommentInstance" | "requestInstantSidebarAlignment" | "peekInstantSidebarAlignment" | "clearInstantSidebarAlignment" | "syncTrackedChangeComments" | "decideTrackedChangeFromSidebar" | "setV2CommentsAdapter" | "getV2CommentsAdapter" | "applyReviewWindowFromV2" | "reconcileCommentsFromV2" | "announceV2CommentCreated" | "dropCommentsFromMutationImpact" | "isV2EditorActive" | "replyCommentV2" | "editCommentV2" | "resolveCommentV2" | "reopenCommentV2" | "setV2TrackedChangesAdapter" | "getV2TrackedChangesAdapter" | "getV2TrackedChangeRowCount" | "reconcileTrackedChangeMutationFromV2" | "reconcileTrackedChangesFromV2" | "remapTrackedChangeIdentities">>;
2603
+ }, "getCommentAliasIds" | "getTrackedChangeThread" | "getCommentPositionKey" | "getCommentPosition" | "resolveCommentPositionEntry" | "getCommentDocumentId" | "belongsToDocument" | "init" | "setViewingVisibility" | "getComment" | "setActiveComment" | "getCommentLocation" | "hasOverlapId" | "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">>;
2505
2604
  documents: Ref<StoreDocument[], StoreDocument[]>;
2506
2605
  documentBounds: Ref<unknown[], unknown[]>;
2507
2606
  pages: Record<string, PageEntry[]>;