@beyondwork/docx-react-component 1.0.1 → 1.0.2

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 (172) hide show
  1. package/README.md +44 -104
  2. package/package.json +76 -46
  3. package/src/README.md +85 -0
  4. package/src/api/README.md +22 -0
  5. package/src/api/public-types.ts +525 -0
  6. package/src/compare/diff-engine.ts +530 -0
  7. package/src/compare/export-redlines.ts +162 -0
  8. package/src/compare/snapshot.ts +37 -0
  9. package/src/component-inventory.md +99 -0
  10. package/src/core/README.md +10 -0
  11. package/src/core/commands/README.md +3 -0
  12. package/src/core/commands/formatting-commands.ts +161 -0
  13. package/src/core/commands/image-commands.ts +144 -0
  14. package/src/core/commands/index.ts +1013 -0
  15. package/src/core/commands/list-commands.ts +370 -0
  16. package/src/core/commands/review-commands.ts +108 -0
  17. package/src/core/commands/text-commands.ts +119 -0
  18. package/src/core/schema/README.md +3 -0
  19. package/src/core/schema/text-schema.ts +512 -0
  20. package/src/core/selection/README.md +3 -0
  21. package/src/core/selection/mapping.ts +238 -0
  22. package/src/core/selection/review-anchors.ts +94 -0
  23. package/src/core/state/README.md +3 -0
  24. package/src/core/state/editor-state.ts +580 -0
  25. package/src/core/state/text-transaction.ts +276 -0
  26. package/src/formats/xlsx/io/parse-shared-strings.ts +41 -0
  27. package/src/formats/xlsx/io/parse-sheet.ts +289 -0
  28. package/src/formats/xlsx/io/parse-styles.ts +57 -0
  29. package/src/formats/xlsx/io/parse-workbook.ts +75 -0
  30. package/src/formats/xlsx/io/xlsx-session.ts +306 -0
  31. package/src/formats/xlsx/model/cell.ts +189 -0
  32. package/src/formats/xlsx/model/sheet.ts +244 -0
  33. package/src/formats/xlsx/model/styles.ts +118 -0
  34. package/src/formats/xlsx/model/workbook.ts +449 -0
  35. package/src/index.ts +45 -0
  36. package/src/io/README.md +10 -0
  37. package/src/io/docx-session.ts +1763 -0
  38. package/src/io/export/README.md +3 -0
  39. package/src/io/export/export-session.ts +165 -0
  40. package/src/io/export/minimal-docx.ts +115 -0
  41. package/src/io/export/reattach-preserved-parts.ts +54 -0
  42. package/src/io/export/serialize-comments.ts +876 -0
  43. package/src/io/export/serialize-footnotes.ts +217 -0
  44. package/src/io/export/serialize-headers-footers.ts +200 -0
  45. package/src/io/export/serialize-main-document.ts +982 -0
  46. package/src/io/export/serialize-numbering.ts +97 -0
  47. package/src/io/export/serialize-revisions.ts +389 -0
  48. package/src/io/export/serialize-runtime-revisions.ts +265 -0
  49. package/src/io/export/serialize-tables.ts +147 -0
  50. package/src/io/export/split-review-boundaries.ts +194 -0
  51. package/src/io/normalize/README.md +3 -0
  52. package/src/io/normalize/normalize-text.ts +437 -0
  53. package/src/io/ooxml/README.md +3 -0
  54. package/src/io/ooxml/parse-comments.ts +779 -0
  55. package/src/io/ooxml/parse-complex-content.ts +287 -0
  56. package/src/io/ooxml/parse-fields.ts +438 -0
  57. package/src/io/ooxml/parse-footnotes.ts +403 -0
  58. package/src/io/ooxml/parse-headers-footers.ts +483 -0
  59. package/src/io/ooxml/parse-inline-media.ts +431 -0
  60. package/src/io/ooxml/parse-main-document.ts +1846 -0
  61. package/src/io/ooxml/parse-numbering.ts +425 -0
  62. package/src/io/ooxml/parse-revisions.ts +658 -0
  63. package/src/io/ooxml/parse-shapes.ts +271 -0
  64. package/src/io/ooxml/parse-tables.ts +568 -0
  65. package/src/io/ooxml/parse-theme.ts +314 -0
  66. package/src/io/ooxml/part-manifest.ts +136 -0
  67. package/src/io/ooxml/revision-boundaries.ts +351 -0
  68. package/src/io/opc/README.md +3 -0
  69. package/src/io/opc/corrupt-package.ts +166 -0
  70. package/src/io/opc/docx-package.ts +74 -0
  71. package/src/io/opc/package-reader.ts +320 -0
  72. package/src/io/opc/package-writer.ts +273 -0
  73. package/src/legal/bookmarks.ts +196 -0
  74. package/src/legal/cross-references.ts +356 -0
  75. package/src/legal/defined-terms.ts +203 -0
  76. package/src/model/README.md +3 -0
  77. package/src/model/canonical-document.ts +1911 -0
  78. package/src/model/cds-1.0.0.ts +196 -0
  79. package/src/model/snapshot.ts +393 -0
  80. package/src/preservation/README.md +3 -0
  81. package/src/preservation/markup-compatibility.ts +48 -0
  82. package/src/preservation/opaque-fragment-store.ts +89 -0
  83. package/src/preservation/opaque-region.ts +233 -0
  84. package/src/preservation/package-preservation.ts +120 -0
  85. package/src/preservation/preserved-part-manifest.ts +56 -0
  86. package/src/preservation/relationship-retention.ts +57 -0
  87. package/src/preservation/store.ts +185 -0
  88. package/src/review/README.md +16 -0
  89. package/src/review/store/README.md +3 -0
  90. package/src/review/store/comment-anchors.ts +70 -0
  91. package/src/review/store/comment-remapping.ts +154 -0
  92. package/src/review/store/comment-store.ts +331 -0
  93. package/src/review/store/comment-thread.ts +109 -0
  94. package/src/review/store/revision-actions.ts +394 -0
  95. package/src/review/store/revision-store.ts +303 -0
  96. package/src/review/store/revision-types.ts +168 -0
  97. package/src/review/store/runtime-comment-store.ts +43 -0
  98. package/src/runtime/README.md +3 -0
  99. package/src/runtime/ai-action-policy.ts +764 -0
  100. package/src/runtime/document-runtime.ts +967 -0
  101. package/src/runtime/read-only-diagnostics-runtime.ts +232 -0
  102. package/src/runtime/review-runtime.ts +44 -0
  103. package/src/runtime/revision-runtime.ts +107 -0
  104. package/src/runtime/session-capabilities.ts +138 -0
  105. package/src/runtime/surface-projection.ts +570 -0
  106. package/src/runtime/table-commands.ts +87 -0
  107. package/src/runtime/table-schema.ts +140 -0
  108. package/src/runtime/virtualized-rendering.ts +258 -0
  109. package/src/ui/README.md +30 -0
  110. package/src/ui/WordReviewEditor.tsx +1504 -0
  111. package/src/ui/comments/README.md +3 -0
  112. package/src/ui/compatibility/README.md +3 -0
  113. package/src/ui/editor-surface/README.md +3 -0
  114. package/src/ui/headless/comment-decoration-model.ts +124 -0
  115. package/src/ui/headless/revision-decoration-model.ts +128 -0
  116. package/src/ui/headless/selection-helpers.ts +34 -0
  117. package/src/ui/headless/use-editor-keyboard.ts +98 -0
  118. package/src/ui/review/README.md +3 -0
  119. package/src/ui/shared/revision-filters.ts +31 -0
  120. package/src/ui/status/README.md +3 -0
  121. package/src/ui/theme/README.md +3 -0
  122. package/src/ui/toolbar/README.md +3 -0
  123. package/src/ui-tailwind/chrome/tw-alert-banner.tsx +48 -0
  124. package/src/ui-tailwind/chrome/tw-selection-toolbar.tsx +44 -0
  125. package/src/ui-tailwind/chrome/tw-unsaved-modal.tsx +58 -0
  126. package/src/ui-tailwind/chrome/use-before-unload.ts +20 -0
  127. package/src/ui-tailwind/editor-surface/pm-command-bridge.ts +139 -0
  128. package/src/ui-tailwind/editor-surface/pm-decorations.ts +98 -0
  129. package/src/ui-tailwind/editor-surface/pm-position-map.ts +123 -0
  130. package/src/ui-tailwind/editor-surface/pm-schema.ts +452 -0
  131. package/src/ui-tailwind/editor-surface/pm-state-from-snapshot.ts +327 -0
  132. package/src/ui-tailwind/editor-surface/search-plugin.ts +157 -0
  133. package/src/ui-tailwind/editor-surface/tw-caret.tsx +12 -0
  134. package/src/ui-tailwind/editor-surface/tw-editor-surface.tsx +150 -0
  135. package/src/ui-tailwind/editor-surface/tw-inline-token.tsx +118 -0
  136. package/src/ui-tailwind/editor-surface/tw-opaque-block.tsx +52 -0
  137. package/src/ui-tailwind/editor-surface/tw-paragraph-block.tsx +151 -0
  138. package/src/ui-tailwind/editor-surface/tw-prosemirror-surface.tsx +215 -0
  139. package/src/ui-tailwind/editor-surface/tw-segment-view.tsx +111 -0
  140. package/src/ui-tailwind/editor-surface/tw-table-node-view.tsx +122 -0
  141. package/src/ui-tailwind/index.ts +61 -0
  142. package/src/ui-tailwind/review/tw-comment-sidebar.tsx +276 -0
  143. package/src/ui-tailwind/review/tw-health-panel.tsx +120 -0
  144. package/src/ui-tailwind/review/tw-review-rail.tsx +120 -0
  145. package/src/ui-tailwind/review/tw-revision-sidebar.tsx +164 -0
  146. package/src/ui-tailwind/status/tw-status-bar.tsx +58 -0
  147. package/src/ui-tailwind/theme/editor-theme.css +190 -0
  148. package/src/ui-tailwind/toolbar/tw-toolbar-icon-button.tsx +48 -0
  149. package/src/ui-tailwind/toolbar/tw-toolbar.tsx +231 -0
  150. package/src/ui-tailwind/tw-review-workspace.tsx +140 -0
  151. package/src/validation/README.md +3 -0
  152. package/src/validation/compatibility-engine.ts +317 -0
  153. package/src/validation/compatibility-report.ts +160 -0
  154. package/src/validation/diagnostics.ts +203 -0
  155. package/src/validation/import-diagnostics.ts +128 -0
  156. package/src/validation/low-priority-word-surfaces.ts +373 -0
  157. package/dist/chunk-32W6IVQE.js +0 -7725
  158. package/dist/chunk-32W6IVQE.js.map +0 -1
  159. package/dist/index.cjs +0 -23722
  160. package/dist/index.cjs.map +0 -1
  161. package/dist/index.d.cts +0 -7
  162. package/dist/index.d.ts +0 -7
  163. package/dist/index.js +0 -16011
  164. package/dist/index.js.map +0 -1
  165. package/dist/public-types-DqCURAz8.d.cts +0 -1152
  166. package/dist/public-types-DqCURAz8.d.ts +0 -1152
  167. package/dist/tailwind.cjs +0 -8295
  168. package/dist/tailwind.cjs.map +0 -1
  169. package/dist/tailwind.d.cts +0 -323
  170. package/dist/tailwind.d.ts +0 -323
  171. package/dist/tailwind.js +0 -553
  172. package/dist/tailwind.js.map +0 -1
@@ -0,0 +1,1763 @@
1
+ import type {
2
+ CompatibilityReport as PublicCompatibilityReport,
3
+ EditorError,
4
+ EditorWarning as PublicEditorWarning,
5
+ EditorAnchorProjection as PublicEditorAnchorProjection,
6
+ ExportDocxOptions,
7
+ ExportResult,
8
+ PersistedEditorSnapshot,
9
+ } from "../api/public-types.ts";
10
+ import type {
11
+ CanonicalDocumentEnvelope,
12
+ CompatibilityFeatureEntry as InternalCompatibilityFeatureEntry,
13
+ CompatibilityReport as InternalCompatibilityReport,
14
+ CommentThreadRecord,
15
+ EditorError as InternalEditorError,
16
+ RevisionRecord as RuntimeRevisionRecord,
17
+ EditorWarning as InternalEditorWarning,
18
+ } from "../core/state/editor-state.ts";
19
+ import { createCanonicalDocumentId } from "../core/state/editor-state.ts";
20
+ import {
21
+ createDetachedAnchor,
22
+ type EditorAnchorProjection as InternalEditorAnchorProjection,
23
+ } from "../core/selection/mapping.ts";
24
+ import { DOCX_MIME_TYPE } from "./opc/docx-package.ts";
25
+ import { readOpcPackage, type OpcPackage } from "./opc/package-reader.ts";
26
+ import { parseMainDocumentXml } from "./ooxml/parse-main-document.ts";
27
+ import { normalizeParsedTextDocument } from "./normalize/normalize-text.ts";
28
+ import {
29
+ normalizePartPath,
30
+ resolveRelationshipTarget,
31
+ type OpcRelationship,
32
+ } from "./ooxml/part-manifest.ts";
33
+ import {
34
+ classifyCorruptPackageError,
35
+ createBrokenRelationshipIssue,
36
+ createMissingPartIssue,
37
+ } from "./opc/corrupt-package.ts";
38
+ import { createExportSession } from "./export/export-session.ts";
39
+ import { serializeMainDocument } from "./export/serialize-main-document.ts";
40
+ import { parseRevisionsFromDocumentXml, type ParsedRevisionsResult } from "./ooxml/parse-revisions.ts";
41
+ import { parseCommentsFromOoxml } from "./ooxml/parse-comments.ts";
42
+ import { parseNumberingXml } from "./ooxml/parse-numbering.ts";
43
+ import {
44
+ createCommentExportIdMap,
45
+ serializeCommentAnchorsIntoDocumentXml,
46
+ serializeMergedCommentsXml,
47
+ } from "./export/serialize-comments.ts";
48
+ import { splitDocumentAtReviewBoundaries } from "./export/split-review-boundaries.ts";
49
+ import { serializeRuntimeRevisionsIntoDocumentXml } from "./export/serialize-runtime-revisions.ts";
50
+ import { createCommentStoreFromRuntimeComments } from "../review/store/runtime-comment-store.ts";
51
+ import type { CommentThread } from "../review/store/comment-store.ts";
52
+ import type { RevisionRecord as ReviewRevisionRecord } from "../review/store/revision-types.ts";
53
+ import { getRevisionActionability } from "../review/store/revision-types.ts";
54
+ import { buildCompatibilityReport } from "../validation/compatibility-engine.ts";
55
+ import {
56
+ createPackageImportDiagnostics,
57
+ createValidationImportDiagnostics,
58
+ type ImportDiagnosticsResult,
59
+ } from "../validation/import-diagnostics.ts";
60
+ import type {
61
+ FootnoteCollection,
62
+ HeaderDocument,
63
+ FooterDocument,
64
+ MediaCatalog,
65
+ NumberingCatalog,
66
+ OpaqueFragmentRecord,
67
+ PreservedPackagePart,
68
+ SubPartsCatalog,
69
+ } from "../model/canonical-document.ts";
70
+ import { createCanonicalDocumentSignature } from "../model/canonical-document.ts";
71
+ import type {
72
+ CommentImportDiagnostic,
73
+ ImportedCommentDefinition,
74
+ ParsedCommentsResult,
75
+ } from "./ooxml/parse-comments.ts";
76
+ import { createReadOnlyDiagnosticsRuntime } from "../runtime/read-only-diagnostics-runtime.ts";
77
+ import {
78
+ WORD_NUMBERING_CONTENT_TYPE,
79
+ serializeNumberingXml,
80
+ } from "./export/serialize-numbering.ts";
81
+ import {
82
+ parseHeaderFooterReferences,
83
+ parseHeaderXml,
84
+ parseFooterXml,
85
+ } from "./ooxml/parse-headers-footers.ts";
86
+ import { parseFootnotesXml, parseEndnotesXml } from "./ooxml/parse-footnotes.ts";
87
+ import { parseThemeXml } from "./ooxml/parse-theme.ts";
88
+ import {
89
+ serializeHeaderXml,
90
+ serializeFooterXml,
91
+ WORD_HEADER_CONTENT_TYPE,
92
+ WORD_FOOTER_CONTENT_TYPE,
93
+ } from "./export/serialize-headers-footers.ts";
94
+ import {
95
+ serializeFootnotesXml,
96
+ serializeEndnotesXml,
97
+ WORD_FOOTNOTES_CONTENT_TYPE,
98
+ WORD_ENDNOTES_CONTENT_TYPE,
99
+ } from "./export/serialize-footnotes.ts";
100
+
101
+ const MAIN_DOCUMENT_PATH = "/word/document.xml";
102
+ const NUMBERING_PART_PATH = "/word/numbering.xml";
103
+ const COMMENTS_PART_PATH = "/word/comments.xml";
104
+ const COMMENTS_EXTENDED_PART_PATH = "/word/commentsExtended.xml";
105
+ const COMMENTS_IDS_PART_PATH = "/word/commentsIds.xml";
106
+ const PEOPLE_PART_PATH = "/word/people.xml";
107
+ const MAIN_DOCUMENT_CONTENT_TYPE =
108
+ "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml";
109
+ const NUMBERING_RELATIONSHIP_TYPE =
110
+ "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering";
111
+ const COMMENTS_CONTENT_TYPE =
112
+ "application/vnd.openxmlformats-officedocument.wordprocessingml.comments+xml";
113
+ const COMMENTS_EXTENDED_CONTENT_TYPE =
114
+ "application/vnd.openxmlformats-officedocument.wordprocessingml.commentsExtended+xml";
115
+ const COMMENTS_IDS_CONTENT_TYPE =
116
+ "application/vnd.openxmlformats-officedocument.wordprocessingml.commentsIds+xml";
117
+ const PEOPLE_CONTENT_TYPE =
118
+ "application/vnd.openxmlformats-officedocument.wordprocessingml.people+xml";
119
+ const COMMENTS_RELATIONSHIP_TYPE =
120
+ "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments";
121
+ const COMMENTS_EXTENDED_RELATIONSHIP_TYPE =
122
+ "http://schemas.microsoft.com/office/2011/relationships/commentsExtended";
123
+ const COMMENTS_IDS_RELATIONSHIP_TYPE =
124
+ "http://schemas.microsoft.com/office/2016/09/relationships/commentsIds";
125
+ const PEOPLE_RELATIONSHIP_TYPE =
126
+ "http://schemas.microsoft.com/office/2011/relationships/people";
127
+ const HEADER_RELATIONSHIP_TYPE =
128
+ "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header";
129
+ const FOOTER_RELATIONSHIP_TYPE =
130
+ "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer";
131
+ const FOOTNOTES_RELATIONSHIP_TYPE =
132
+ "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes";
133
+ const ENDNOTES_RELATIONSHIP_TYPE =
134
+ "http://schemas.openxmlformats.org/officeDocument/2006/relationships/endnotes";
135
+ const FOOTNOTES_PART_PATH = "/word/footnotes.xml";
136
+ const ENDNOTES_PART_PATH = "/word/endnotes.xml";
137
+
138
+ interface LoadDocxEditorSessionOptions {
139
+ documentId: string;
140
+ sourceLabel?: string;
141
+ bytes: Uint8Array | ArrayBuffer;
142
+ editorBuild: string;
143
+ }
144
+
145
+ export interface LoadedDocxEditorSession {
146
+ initialSnapshot: PersistedEditorSnapshot;
147
+ fatalError?: EditorError;
148
+ readOnly: boolean;
149
+ exportDocx: (
150
+ snapshot: PersistedEditorSnapshot,
151
+ options?: ExportDocxOptions,
152
+ ) => Promise<ExportResult>;
153
+ }
154
+
155
+ interface ImportedDocxState {
156
+ sourceBytes: Uint8Array;
157
+ sourcePackage: OpcPackage;
158
+ sourceDocumentRelationships: readonly OpcRelationship[];
159
+ sourceDocumentAttributes: Record<string, string>;
160
+ sourceNumberingPartPath?: string;
161
+ sourceNumberingRelationshipId?: string;
162
+ sourceCommentsPartPath?: string;
163
+ sourceCommentsRelationshipId?: string;
164
+ sourceCommentsRootTag?: string;
165
+ sourceCommentsExtendedPartPath?: string;
166
+ sourceCommentsExtendedRelationshipId?: string;
167
+ sourceCommentsExtendedRootTag?: string;
168
+ sourceCommentsIdsPartPath?: string;
169
+ sourceCommentsIdsRelationshipId?: string;
170
+ sourceCommentsIdsRootTag?: string;
171
+ sourcePeoplePartPath?: string;
172
+ sourcePeopleRelationshipId?: string;
173
+ sourcePeopleRootTag?: string;
174
+ sourcePeopleAuthors: readonly string[];
175
+ preservedCommentDefinitions: readonly ImportedCommentDefinition[];
176
+ blockingCommentDiagnostics: readonly CommentImportDiagnostic[];
177
+ initialCanonicalSignature: string;
178
+ sourceSubPartPaths: {
179
+ headers: Array<{ partPath: string; relationshipId: string }>;
180
+ footers: Array<{ partPath: string; relationshipId: string }>;
181
+ footnotesPartPath?: string;
182
+ footnotesRelationshipId?: string;
183
+ endnotesPartPath?: string;
184
+ endnotesRelationshipId?: string;
185
+ themePartPath?: string;
186
+ themeRelationshipId?: string;
187
+ };
188
+ }
189
+
190
+ interface NormalizedImportedCommentsResult extends ParsedCommentsResult {
191
+ preservedDefinitions: readonly ImportedCommentDefinition[];
192
+ }
193
+
194
+ const BLOCKING_COMMENT_DIAGNOSTIC_CODES = new Set<CommentImportDiagnostic["code"]>([
195
+ "missing_comment_definition",
196
+ "missing_anchor_reference",
197
+ "multi_paragraph_anchor_preserve_only",
198
+ "opaque_anchor_preserve_only",
199
+ "preserve_only_revision_overlap",
200
+ ]);
201
+
202
+ export function loadDocxEditorSession(
203
+ options: LoadDocxEditorSessionOptions,
204
+ ): LoadedDocxEditorSession {
205
+ const sourceBytes = toUint8Array(options.bytes);
206
+ let sourcePackage: OpcPackage;
207
+
208
+ try {
209
+ sourcePackage = readOpcPackage(sourceBytes);
210
+ } catch (error) {
211
+ return createDiagnosticsSession(
212
+ options,
213
+ createPackageImportDiagnostics({
214
+ issue: classifyCorruptPackageError(error),
215
+ }),
216
+ );
217
+ }
218
+
219
+ const brokenRelationshipIssues = collectBrokenInternalRelationshipIssues(sourcePackage);
220
+ if (brokenRelationshipIssues.length > 0) {
221
+ return createDiagnosticsSession(
222
+ options,
223
+ createPackageImportDiagnostics({
224
+ issue: {
225
+ ...brokenRelationshipIssues[0],
226
+ message: summarizeBrokenRelationshipIssues(brokenRelationshipIssues),
227
+ details: {
228
+ issueCount: brokenRelationshipIssues.length,
229
+ targets: brokenRelationshipIssues.map((issue) => issue.targetPartPath).filter(Boolean),
230
+ },
231
+ },
232
+ }),
233
+ );
234
+ }
235
+
236
+ const documentPart = sourcePackage.parts.get(MAIN_DOCUMENT_PATH);
237
+ if (!documentPart) {
238
+ return createDiagnosticsSession(
239
+ options,
240
+ createPackageImportDiagnostics({
241
+ issue: createMissingPartIssue(MAIN_DOCUMENT_PATH),
242
+ }),
243
+ );
244
+ }
245
+
246
+ try {
247
+ const sourceDocumentXml = decodeUtf8(documentPart.bytes);
248
+ const importedRevisions = parseRevisionsFromDocumentXml(sourceDocumentXml);
249
+ const numberingPartPath = resolveDocumentRelatedPartPath(
250
+ sourcePackage,
251
+ documentPart.relationships,
252
+ NUMBERING_RELATIONSHIP_TYPE,
253
+ NUMBERING_PART_PATH,
254
+ );
255
+ const parsedNumbering = numberingPartPath
256
+ ? parseNumberingXml(
257
+ decodeUtf8(sourcePackage.parts.get(numberingPartPath)?.bytes ?? new Uint8Array()),
258
+ )
259
+ : createEmptyNumberingCatalog();
260
+ const mediaParts = collectInlineMediaParts(sourcePackage);
261
+ const parsedDocument = parseMainDocumentXml(
262
+ sourceDocumentXml,
263
+ documentPart.relationships,
264
+ mediaParts,
265
+ MAIN_DOCUMENT_PATH,
266
+ );
267
+ const normalizedDocument = normalizeParsedTextDocument(
268
+ parsedDocument,
269
+ MAIN_DOCUMENT_PATH,
270
+ );
271
+ const commentsPartPath = resolveCommentsPartPath(sourcePackage, documentPart.relationships);
272
+ const commentsExtendedPartPath = resolveDocumentRelatedPartPath(
273
+ sourcePackage,
274
+ documentPart.relationships,
275
+ COMMENTS_EXTENDED_RELATIONSHIP_TYPE,
276
+ COMMENTS_EXTENDED_PART_PATH,
277
+ );
278
+ const commentsIdsPartPath = resolveDocumentRelatedPartPath(
279
+ sourcePackage,
280
+ documentPart.relationships,
281
+ COMMENTS_IDS_RELATIONSHIP_TYPE,
282
+ COMMENTS_IDS_PART_PATH,
283
+ );
284
+ const peoplePartPath = resolveDocumentRelatedPartPath(
285
+ sourcePackage,
286
+ documentPart.relationships,
287
+ PEOPLE_RELATIONSHIP_TYPE,
288
+ PEOPLE_PART_PATH,
289
+ );
290
+ const parsedComments = commentsPartPath
291
+ ? parseCommentsFromOoxml(
292
+ sourceDocumentXml,
293
+ {
294
+ commentsXml: decodeUtf8(sourcePackage.parts.get(commentsPartPath)?.bytes ?? new Uint8Array()),
295
+ commentsExtendedXml: decodeUtf8(
296
+ sourcePackage.parts.get(commentsExtendedPartPath ?? "")?.bytes ?? new Uint8Array(),
297
+ ),
298
+ commentsIdsXml: decodeUtf8(
299
+ sourcePackage.parts.get(commentsIdsPartPath ?? "")?.bytes ?? new Uint8Array(),
300
+ ),
301
+ peopleXml: decodeUtf8(
302
+ sourcePackage.parts.get(peoplePartPath ?? "")?.bytes ?? new Uint8Array(),
303
+ ),
304
+ },
305
+ )
306
+ : {
307
+ threads: [] as CommentThread[],
308
+ diagnostics: [] as CommentImportDiagnostic[],
309
+ definitions: [] as ImportedCommentDefinition[],
310
+ sourceRootTag: undefined,
311
+ sourceExtendedRootTag: undefined,
312
+ sourceIdsRootTag: undefined,
313
+ sourcePeopleRootTag: undefined,
314
+ peopleAuthors: [] as string[],
315
+ };
316
+ const normalizedRevisions = normalizeImportedRevisionRecords(
317
+ importedRevisions,
318
+ normalizedDocument.content,
319
+ normalizedDocument.preservation.opaqueFragments,
320
+ );
321
+ const normalizedComments = normalizeImportedCommentThreads(
322
+ parsedComments,
323
+ normalizedDocument.preservation.opaqueFragments,
324
+ normalizedRevisions.revisions,
325
+ );
326
+ // ---- Parse sub-parts: headers, footers, footnotes, endnotes, theme ----
327
+ const headerFooterRefs = parseHeaderFooterReferences(sourceDocumentXml);
328
+ const parsedHeaders: HeaderDocument[] = [];
329
+ const parsedFooters: FooterDocument[] = [];
330
+ const sourceHeaderPaths: Array<{ partPath: string; relationshipId: string }> = [];
331
+ const sourceFooterPaths: Array<{ partPath: string; relationshipId: string }> = [];
332
+ const seenSubPartRelIds = new Set<string>();
333
+
334
+ for (const ref of headerFooterRefs) {
335
+ if (seenSubPartRelIds.has(ref.relationshipId)) {
336
+ continue;
337
+ }
338
+ seenSubPartRelIds.add(ref.relationshipId);
339
+
340
+ const relationship = documentPart.relationships.find(
341
+ (r) => r.id === ref.relationshipId && r.targetMode === "internal",
342
+ );
343
+ if (!relationship) {
344
+ continue;
345
+ }
346
+
347
+ const partPath = resolveRelationshipTarget(MAIN_DOCUMENT_PATH, relationship);
348
+ const partBytes = sourcePackage.parts.get(partPath)?.bytes;
349
+ if (!partBytes) {
350
+ continue;
351
+ }
352
+
353
+ const xml = decodeUtf8(partBytes);
354
+ if (ref.kind === "header") {
355
+ const parsed = parseHeaderXml(xml);
356
+ parsedHeaders.push({
357
+ variant: ref.variant,
358
+ partPath,
359
+ relationshipId: ref.relationshipId,
360
+ blocks: parsed.blocks,
361
+ });
362
+ sourceHeaderPaths.push({ partPath, relationshipId: ref.relationshipId });
363
+ } else {
364
+ const parsed = parseFooterXml(xml);
365
+ parsedFooters.push({
366
+ variant: ref.variant,
367
+ partPath,
368
+ relationshipId: ref.relationshipId,
369
+ blocks: parsed.blocks,
370
+ });
371
+ sourceFooterPaths.push({ partPath, relationshipId: ref.relationshipId });
372
+ }
373
+ }
374
+
375
+ const footnotesPartPath = resolveDocumentRelatedPartPath(
376
+ sourcePackage,
377
+ documentPart.relationships,
378
+ FOOTNOTES_RELATIONSHIP_TYPE,
379
+ FOOTNOTES_PART_PATH,
380
+ );
381
+ const footnotesRelationshipId = documentPart.relationships.find(
382
+ (r) => r.type === FOOTNOTES_RELATIONSHIP_TYPE && r.targetMode === "internal",
383
+ )?.id;
384
+ const endnotesPartPath = resolveDocumentRelatedPartPath(
385
+ sourcePackage,
386
+ documentPart.relationships,
387
+ ENDNOTES_RELATIONSHIP_TYPE,
388
+ ENDNOTES_PART_PATH,
389
+ );
390
+ const endnotesRelationshipId = documentPart.relationships.find(
391
+ (r) => r.type === ENDNOTES_RELATIONSHIP_TYPE && r.targetMode === "internal",
392
+ )?.id;
393
+
394
+ let footnoteCollection: FootnoteCollection | undefined;
395
+ if (footnotesPartPath) {
396
+ footnoteCollection = parseFootnotesXml(
397
+ decodeUtf8(sourcePackage.parts.get(footnotesPartPath)?.bytes ?? new Uint8Array()),
398
+ );
399
+ }
400
+ if (endnotesPartPath) {
401
+ footnoteCollection = parseEndnotesXml(
402
+ decodeUtf8(sourcePackage.parts.get(endnotesPartPath)?.bytes ?? new Uint8Array()),
403
+ footnoteCollection,
404
+ );
405
+ }
406
+
407
+ const themeRelationship = documentPart.relationships.find(
408
+ (r) => r.type === "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme" &&
409
+ r.targetMode === "internal",
410
+ );
411
+ const themePartPath = themeRelationship
412
+ ? resolveRelationshipTarget(MAIN_DOCUMENT_PATH, themeRelationship)
413
+ : undefined;
414
+ const parsedTheme =
415
+ themePartPath && sourcePackage.parts.has(themePartPath)
416
+ ? parseThemeXml(
417
+ decodeUtf8(sourcePackage.parts.get(themePartPath)?.bytes ?? new Uint8Array()),
418
+ )
419
+ : undefined;
420
+
421
+ const subParts: SubPartsCatalog | undefined =
422
+ parsedHeaders.length > 0 ||
423
+ parsedFooters.length > 0 ||
424
+ footnoteCollection !== undefined ||
425
+ parsedTheme !== undefined
426
+ ? {
427
+ headers: parsedHeaders,
428
+ footers: parsedFooters,
429
+ ...(footnoteCollection !== undefined ? { footnoteCollection } : {}),
430
+ ...(parsedTheme !== undefined ? { theme: parsedTheme } : {}),
431
+ }
432
+ : undefined;
433
+
434
+ const timestamp = new Date().toISOString();
435
+ const document = createImportedCanonicalDocument({
436
+ documentId: options.documentId,
437
+ timestamp,
438
+ numbering: parsedNumbering,
439
+ media: normalizedDocument.media,
440
+ content: normalizedDocument.content,
441
+ subParts,
442
+ preservation: {
443
+ ...normalizedDocument.preservation,
444
+ packageParts: {
445
+ ...normalizedDocument.preservation.packageParts,
446
+ ...collectPreservedPackageParts(sourcePackage, [
447
+ numberingPartPath,
448
+ commentsPartPath,
449
+ commentsExtendedPartPath,
450
+ commentsIdsPartPath,
451
+ peoplePartPath,
452
+ ]),
453
+ },
454
+ },
455
+ diagnostics: {
456
+ warnings: [
457
+ ...normalizedDocument.diagnostics.warnings,
458
+ ...normalizedRevisions.diagnostics.map((diagnostic, index) => ({
459
+ diagnosticId: `diagnostic:revision-import-${index + 1}`,
460
+ warningId: `warning:revision-import-${diagnostic.revisionId}`,
461
+ source: "review" as const,
462
+ message: diagnostic.message,
463
+ })),
464
+ ...normalizedComments.diagnostics.map((diagnostic, index) => ({
465
+ diagnosticId: `diagnostic:comment-import-${index + 1}`,
466
+ warningId: `warning:comment-import-${diagnostic.commentId}`,
467
+ source: "review" as const,
468
+ message: diagnostic.message,
469
+ })),
470
+ ],
471
+ errors: [],
472
+ },
473
+ review: {
474
+ comments: toRuntimeCommentRecords(normalizedComments.threads),
475
+ revisions: toRuntimeRevisionRecords(normalizedRevisions.revisions),
476
+ },
477
+ });
478
+ const compatibility = buildCompatibilityReport({
479
+ document,
480
+ generatedAt: timestamp,
481
+ });
482
+ const snapshot = createImportedSnapshot({
483
+ documentId: options.documentId,
484
+ editorBuild: options.editorBuild,
485
+ timestamp,
486
+ document,
487
+ compatibility: toPublicCompatibilityReport(compatibility),
488
+ });
489
+ const importedState: ImportedDocxState = {
490
+ sourceBytes: new Uint8Array(sourceBytes),
491
+ sourcePackage,
492
+ sourceDocumentRelationships: documentPart.relationships,
493
+ sourceDocumentAttributes: extractDocumentRootAttributes(sourceDocumentXml),
494
+ sourceNumberingPartPath: numberingPartPath,
495
+ sourceNumberingRelationshipId: documentPart.relationships.find(
496
+ (relationship) =>
497
+ relationship.type === NUMBERING_RELATIONSHIP_TYPE &&
498
+ relationship.targetMode === "internal",
499
+ )?.id,
500
+ sourceCommentsPartPath: commentsPartPath,
501
+ sourceCommentsRelationshipId: documentPart.relationships.find(
502
+ (relationship) =>
503
+ relationship.type === COMMENTS_RELATIONSHIP_TYPE &&
504
+ relationship.targetMode === "internal",
505
+ )?.id,
506
+ sourceCommentsRootTag: normalizedComments.sourceRootTag,
507
+ sourceCommentsExtendedPartPath: commentsExtendedPartPath,
508
+ sourceCommentsExtendedRelationshipId: documentPart.relationships.find(
509
+ (relationship) =>
510
+ relationship.type === COMMENTS_EXTENDED_RELATIONSHIP_TYPE &&
511
+ relationship.targetMode === "internal",
512
+ )?.id,
513
+ sourceCommentsExtendedRootTag: normalizedComments.sourceExtendedRootTag,
514
+ sourceCommentsIdsPartPath: commentsIdsPartPath,
515
+ sourceCommentsIdsRelationshipId: documentPart.relationships.find(
516
+ (relationship) =>
517
+ relationship.type === COMMENTS_IDS_RELATIONSHIP_TYPE &&
518
+ relationship.targetMode === "internal",
519
+ )?.id,
520
+ sourceCommentsIdsRootTag: normalizedComments.sourceIdsRootTag,
521
+ sourcePeoplePartPath: peoplePartPath,
522
+ sourcePeopleRelationshipId: documentPart.relationships.find(
523
+ (relationship) =>
524
+ relationship.type === PEOPLE_RELATIONSHIP_TYPE &&
525
+ relationship.targetMode === "internal",
526
+ )?.id,
527
+ sourcePeopleRootTag: normalizedComments.sourcePeopleRootTag,
528
+ sourcePeopleAuthors: normalizedComments.peopleAuthors,
529
+ preservedCommentDefinitions: normalizedComments.preservedDefinitions,
530
+ blockingCommentDiagnostics: normalizedComments.diagnostics.filter((diagnostic) =>
531
+ BLOCKING_COMMENT_DIAGNOSTIC_CODES.has(diagnostic.code),
532
+ ),
533
+ initialCanonicalSignature: serializeCanonicalDocumentForExport(document),
534
+ sourceSubPartPaths: {
535
+ headers: sourceHeaderPaths,
536
+ footers: sourceFooterPaths,
537
+ footnotesPartPath,
538
+ footnotesRelationshipId,
539
+ endnotesPartPath,
540
+ endnotesRelationshipId,
541
+ themePartPath,
542
+ themeRelationshipId: themeRelationship?.id,
543
+ },
544
+ };
545
+
546
+ return {
547
+ initialSnapshot: snapshot,
548
+ readOnly: false,
549
+ exportDocx: async (nextSnapshot, exportOptions) =>
550
+ exportDocxEditorSession(importedState, nextSnapshot, exportOptions),
551
+ };
552
+ } catch (error) {
553
+ return createDiagnosticsSession(
554
+ options,
555
+ createImportDiagnosticsFromError(error),
556
+ );
557
+ }
558
+ }
559
+
560
+ function exportDocxEditorSession(
561
+ state: ImportedDocxState,
562
+ snapshot: PersistedEditorSnapshot,
563
+ options?: ExportDocxOptions,
564
+ ): ExportResult {
565
+ if (snapshot.compatibility.blockExport) {
566
+ throw new Error("DOCX export is blocked by the current compatibility report.");
567
+ }
568
+
569
+ const currentDocument = snapshot.canonicalDocument as CanonicalDocumentEnvelope;
570
+ if (
571
+ serializeCanonicalDocumentForExport(currentDocument) ===
572
+ state.initialCanonicalSignature &&
573
+ canReuseSourceBytesForCurrentDocument(state, currentDocument)
574
+ ) {
575
+ return {
576
+ bytes: new Uint8Array(state.sourceBytes),
577
+ mimeType: DOCX_MIME_TYPE,
578
+ fileName: options?.fileName ?? `${snapshot.documentId}.docx`,
579
+ };
580
+ }
581
+ if (state.blockingCommentDiagnostics.length > 0) {
582
+ throw new Error(
583
+ `DOCX export is blocked because ${state.blockingCommentDiagnostics.length} preserve-only comment anchors cannot be safely remapped after runtime edits.`,
584
+ );
585
+ }
586
+ const currentRevisions = toReviewRevisionRecords(currentDocument.review.revisions);
587
+ const actionableRevisions = currentRevisions.filter(
588
+ (revision) => getRevisionActionability(revision) === "actionable",
589
+ );
590
+ const commentThreads = Object.values(
591
+ createCommentStoreFromRuntimeComments(currentDocument.review.comments).threads,
592
+ );
593
+ const preservedCommentIds = new Set(
594
+ state.preservedCommentDefinitions.map((definition) => definition.commentId),
595
+ );
596
+ const ownedCommentThreads = commentThreads.filter(
597
+ (thread) => !preservedCommentIds.has(thread.commentId),
598
+ );
599
+ const serialized = serializeMainDocument(
600
+ splitDocumentAtReviewBoundaries(
601
+ currentDocument.content as never,
602
+ ownedCommentThreads,
603
+ actionableRevisions,
604
+ ) as never,
605
+ currentDocument.preservation as never,
606
+ state.sourceDocumentRelationships,
607
+ {
608
+ documentAttributes: state.sourceDocumentAttributes,
609
+ media: currentDocument.media as MediaCatalog,
610
+ },
611
+ );
612
+ const revisionDocument = serializeRuntimeRevisionsIntoDocumentXml(
613
+ serialized.documentXml,
614
+ actionableRevisions,
615
+ serialized.paragraphBoundaries,
616
+ );
617
+ if (revisionDocument.skippedRevisionIds.length > 0) {
618
+ throw new Error(
619
+ `DOCX export is blocked because ${revisionDocument.skippedRevisionIds.length} active revisions overlap unsupported serialization boundaries.`,
620
+ );
621
+ }
622
+
623
+ const strippedDocumentXml = stripCommentMarkup(
624
+ revisionDocument.documentXml,
625
+ ownedCommentThreads.map((thread) => thread.commentId),
626
+ );
627
+ const exportCommentIds = createCommentExportIdMap(
628
+ ownedCommentThreads,
629
+ state.preservedCommentDefinitions,
630
+ );
631
+ const serializedComments = serializeMergedCommentsXml(ownedCommentThreads, {
632
+ exportCommentIds,
633
+ preservedDefinitions: state.preservedCommentDefinitions,
634
+ sourceRootTag: state.sourceCommentsRootTag,
635
+ sourceExtendedRootTag: state.sourceCommentsExtendedRootTag,
636
+ sourceIdsRootTag: state.sourceCommentsIdsRootTag,
637
+ sourcePeopleRootTag: state.sourcePeopleRootTag,
638
+ peopleAuthors: state.sourcePeopleAuthors,
639
+ });
640
+ const annotatedDocument = serializeCommentAnchorsIntoDocumentXml(
641
+ strippedDocumentXml,
642
+ ownedCommentThreads,
643
+ undefined,
644
+ {
645
+ exportCommentIds,
646
+ },
647
+ );
648
+ const blockingSkippedCommentIds = annotatedDocument.skippedCommentIds.filter((commentId) => {
649
+ const thread = ownedCommentThreads.find((candidate) => candidate.commentId === commentId);
650
+ return !thread || thread.anchor.kind !== "detached";
651
+ });
652
+ if (blockingSkippedCommentIds.length > 0) {
653
+ throw new Error(
654
+ `DOCX export is blocked because ${blockingSkippedCommentIds.length} comments no longer map to serializable ranges.`,
655
+ );
656
+ }
657
+ const commentsPartPath =
658
+ state.sourceCommentsPartPath ?? COMMENTS_PART_PATH;
659
+ const commentsExtendedPartPath =
660
+ state.sourceCommentsExtendedPartPath ?? COMMENTS_EXTENDED_PART_PATH;
661
+ const commentsIdsPartPath =
662
+ state.sourceCommentsIdsPartPath ?? COMMENTS_IDS_PART_PATH;
663
+ const peoplePartPath =
664
+ state.sourcePeoplePartPath ?? PEOPLE_PART_PATH;
665
+ const numberingPartPath =
666
+ state.sourceNumberingPartPath ?? NUMBERING_PART_PATH;
667
+ const serializedNumberingXml = hasNumberingEntries(currentDocument.numbering as NumberingCatalog)
668
+ ? serializeNumberingXml(currentDocument.numbering as NumberingCatalog)
669
+ : undefined;
670
+ const nextRelationships = withDocumentRelatedParts(
671
+ serialized.relationships,
672
+ [
673
+ {
674
+ relationshipType: NUMBERING_RELATIONSHIP_TYPE,
675
+ partPath: numberingPartPath,
676
+ existingRelationshipId: state.sourceNumberingRelationshipId,
677
+ include:
678
+ Boolean(serializedNumberingXml) ||
679
+ Boolean(state.sourceNumberingPartPath),
680
+ },
681
+ {
682
+ relationshipType: COMMENTS_RELATIONSHIP_TYPE,
683
+ partPath: commentsPartPath,
684
+ existingRelationshipId: state.sourceCommentsRelationshipId,
685
+ include:
686
+ serializedComments.serializedCommentIds.length > 0 ||
687
+ Boolean(state.sourceCommentsPartPath),
688
+ },
689
+ {
690
+ relationshipType: COMMENTS_EXTENDED_RELATIONSHIP_TYPE,
691
+ partPath: commentsExtendedPartPath,
692
+ existingRelationshipId: state.sourceCommentsExtendedRelationshipId,
693
+ include:
694
+ Boolean(serializedComments.commentsExtendedXml) ||
695
+ Boolean(state.sourceCommentsExtendedPartPath),
696
+ },
697
+ {
698
+ relationshipType: COMMENTS_IDS_RELATIONSHIP_TYPE,
699
+ partPath: commentsIdsPartPath,
700
+ existingRelationshipId: state.sourceCommentsIdsRelationshipId,
701
+ include:
702
+ Boolean(serializedComments.commentsIdsXml) ||
703
+ Boolean(state.sourceCommentsIdsPartPath),
704
+ },
705
+ {
706
+ relationshipType: PEOPLE_RELATIONSHIP_TYPE,
707
+ partPath: peoplePartPath,
708
+ existingRelationshipId: state.sourcePeopleRelationshipId,
709
+ include:
710
+ Boolean(serializedComments.peopleXml) ||
711
+ Boolean(state.sourcePeoplePartPath),
712
+ },
713
+ ],
714
+ );
715
+
716
+ const exportedSubParts = currentDocument.subParts as SubPartsCatalog | undefined;
717
+ const subPartOwnedPaths: string[] = [];
718
+ if (exportedSubParts) {
719
+ for (const header of exportedSubParts.headers) {
720
+ subPartOwnedPaths.push(header.partPath);
721
+ }
722
+ for (const footer of exportedSubParts.footers) {
723
+ subPartOwnedPaths.push(footer.partPath);
724
+ }
725
+ if (exportedSubParts.footnoteCollection) {
726
+ if (state.sourceSubPartPaths.footnotesPartPath) {
727
+ subPartOwnedPaths.push(state.sourceSubPartPaths.footnotesPartPath);
728
+ }
729
+ if (state.sourceSubPartPaths.endnotesPartPath) {
730
+ subPartOwnedPaths.push(state.sourceSubPartPaths.endnotesPartPath);
731
+ }
732
+ }
733
+ if (exportedSubParts.theme && state.sourceSubPartPaths.themePartPath) {
734
+ subPartOwnedPaths.push(state.sourceSubPartPaths.themePartPath);
735
+ }
736
+ }
737
+
738
+ const exportSession = createExportSession(state.sourcePackage, [
739
+ MAIN_DOCUMENT_PATH,
740
+ numberingPartPath,
741
+ commentsPartPath,
742
+ commentsExtendedPartPath,
743
+ commentsIdsPartPath,
744
+ peoplePartPath,
745
+ ...subPartOwnedPaths,
746
+ ]);
747
+
748
+ exportSession.replaceOwnedPart({
749
+ path: MAIN_DOCUMENT_PATH,
750
+ bytes: new TextEncoder().encode(annotatedDocument.documentXml),
751
+ contentType: MAIN_DOCUMENT_CONTENT_TYPE,
752
+ relationships: nextRelationships,
753
+ });
754
+
755
+ if (serializedNumberingXml || state.sourceNumberingPartPath) {
756
+ exportSession.replaceOwnedPart({
757
+ path: numberingPartPath,
758
+ bytes: new TextEncoder().encode(
759
+ serializedNumberingXml ??
760
+ `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n<w:numbering xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"></w:numbering>`,
761
+ ),
762
+ contentType:
763
+ state.sourcePackage.parts.get(numberingPartPath)?.contentType ??
764
+ WORD_NUMBERING_CONTENT_TYPE,
765
+ });
766
+ }
767
+
768
+ if (serializedComments.serializedCommentIds.length > 0 || state.sourceCommentsPartPath) {
769
+ exportSession.replaceOwnedPart({
770
+ path: commentsPartPath,
771
+ bytes: new TextEncoder().encode(serializedComments.commentsXml),
772
+ contentType:
773
+ state.sourcePackage.parts.get(commentsPartPath)?.contentType ?? COMMENTS_CONTENT_TYPE,
774
+ });
775
+ }
776
+
777
+ if (serializedComments.commentsExtendedXml || state.sourceCommentsExtendedPartPath) {
778
+ exportSession.replaceOwnedPart({
779
+ path: commentsExtendedPartPath,
780
+ bytes: new TextEncoder().encode(
781
+ serializedComments.commentsExtendedXml ?? `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n<w15:commentsEx xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml"></w15:commentsEx>`,
782
+ ),
783
+ contentType:
784
+ state.sourcePackage.parts.get(commentsExtendedPartPath)?.contentType ??
785
+ COMMENTS_EXTENDED_CONTENT_TYPE,
786
+ });
787
+ }
788
+
789
+ if (serializedComments.commentsIdsXml || state.sourceCommentsIdsPartPath) {
790
+ exportSession.replaceOwnedPart({
791
+ path: commentsIdsPartPath,
792
+ bytes: new TextEncoder().encode(
793
+ serializedComments.commentsIdsXml ?? `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n<w16cid:commentsIds xmlns:w16cid="http://schemas.microsoft.com/office/word/2016/wordml/cid"></w16cid:commentsIds>`,
794
+ ),
795
+ contentType:
796
+ state.sourcePackage.parts.get(commentsIdsPartPath)?.contentType ??
797
+ COMMENTS_IDS_CONTENT_TYPE,
798
+ });
799
+ }
800
+
801
+ if (serializedComments.peopleXml || state.sourcePeoplePartPath) {
802
+ exportSession.replaceOwnedPart({
803
+ path: peoplePartPath,
804
+ bytes: new TextEncoder().encode(
805
+ serializedComments.peopleXml ?? `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n<w15:people xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml"></w15:people>`,
806
+ ),
807
+ contentType:
808
+ state.sourcePackage.parts.get(peoplePartPath)?.contentType ??
809
+ PEOPLE_CONTENT_TYPE,
810
+ });
811
+ }
812
+
813
+ if (exportedSubParts) {
814
+ for (const header of exportedSubParts.headers) {
815
+ exportSession.replaceOwnedPart({
816
+ path: header.partPath,
817
+ bytes: new TextEncoder().encode(serializeHeaderXml(header)),
818
+ contentType:
819
+ state.sourcePackage.parts.get(header.partPath)?.contentType ?? WORD_HEADER_CONTENT_TYPE,
820
+ });
821
+ }
822
+ for (const footer of exportedSubParts.footers) {
823
+ exportSession.replaceOwnedPart({
824
+ path: footer.partPath,
825
+ bytes: new TextEncoder().encode(serializeFooterXml(footer)),
826
+ contentType:
827
+ state.sourcePackage.parts.get(footer.partPath)?.contentType ?? WORD_FOOTER_CONTENT_TYPE,
828
+ });
829
+ }
830
+ if (exportedSubParts.footnoteCollection) {
831
+ if (state.sourceSubPartPaths.footnotesPartPath) {
832
+ exportSession.replaceOwnedPart({
833
+ path: state.sourceSubPartPaths.footnotesPartPath,
834
+ bytes: new TextEncoder().encode(serializeFootnotesXml(exportedSubParts.footnoteCollection)),
835
+ contentType:
836
+ state.sourcePackage.parts.get(state.sourceSubPartPaths.footnotesPartPath)?.contentType ??
837
+ WORD_FOOTNOTES_CONTENT_TYPE,
838
+ });
839
+ }
840
+ if (state.sourceSubPartPaths.endnotesPartPath) {
841
+ exportSession.replaceOwnedPart({
842
+ path: state.sourceSubPartPaths.endnotesPartPath,
843
+ bytes: new TextEncoder().encode(serializeEndnotesXml(exportedSubParts.footnoteCollection)),
844
+ contentType:
845
+ state.sourcePackage.parts.get(state.sourceSubPartPaths.endnotesPartPath)?.contentType ??
846
+ WORD_ENDNOTES_CONTENT_TYPE,
847
+ });
848
+ }
849
+ }
850
+ if (exportedSubParts.theme && state.sourceSubPartPaths.themePartPath) {
851
+ const sourceThemePart = state.sourcePackage.parts.get(state.sourceSubPartPaths.themePartPath);
852
+ if (sourceThemePart) {
853
+ exportSession.replaceOwnedPart({
854
+ path: state.sourceSubPartPaths.themePartPath,
855
+ bytes: sourceThemePart.bytes,
856
+ contentType: sourceThemePart.contentType,
857
+ relationships: sourceThemePart.relationships,
858
+ compression: sourceThemePart.compression,
859
+ });
860
+ }
861
+ }
862
+ }
863
+
864
+ return {
865
+ bytes: exportSession.serialize(),
866
+ mimeType: DOCX_MIME_TYPE,
867
+ fileName: options?.fileName ?? `${snapshot.documentId}.docx`,
868
+ };
869
+ }
870
+
871
+ function createImportedCanonicalDocument(input: {
872
+ documentId: string;
873
+ timestamp: string;
874
+ numbering: CanonicalDocumentEnvelope["numbering"];
875
+ media: CanonicalDocumentEnvelope["media"];
876
+ content: CanonicalDocumentEnvelope["content"];
877
+ subParts?: SubPartsCatalog;
878
+ preservation: CanonicalDocumentEnvelope["preservation"];
879
+ diagnostics: CanonicalDocumentEnvelope["diagnostics"];
880
+ review: CanonicalDocumentEnvelope["review"];
881
+ }): CanonicalDocumentEnvelope {
882
+ return {
883
+ schemaVersion: "cds/1.0.0",
884
+ docId: createCanonicalDocumentId(input.documentId),
885
+ createdAt: input.timestamp,
886
+ updatedAt: input.timestamp,
887
+ metadata: {
888
+ customProperties: {},
889
+ },
890
+ styles: {
891
+ paragraphs: {},
892
+ characters: {},
893
+ tables: {},
894
+ },
895
+ numbering: input.numbering,
896
+ media: input.media,
897
+ content: input.content,
898
+ review: input.review,
899
+ preservation: input.preservation,
900
+ diagnostics: input.diagnostics,
901
+ ...(input.subParts !== undefined ? { subParts: input.subParts } : {}),
902
+ };
903
+ }
904
+
905
+ function createImportedSnapshot(input: {
906
+ documentId: string;
907
+ editorBuild: string;
908
+ timestamp: string;
909
+ document: CanonicalDocumentEnvelope;
910
+ compatibility: PersistedEditorSnapshot["compatibility"];
911
+ }): PersistedEditorSnapshot {
912
+ return {
913
+ snapshotVersion: "persisted-editor-snapshot/1",
914
+ schemaVersion: input.document.schemaVersion,
915
+ documentId: input.documentId,
916
+ docId: input.document.docId,
917
+ createdAt: input.document.createdAt,
918
+ updatedAt: input.document.updatedAt,
919
+ savedAt: input.timestamp,
920
+ editorBuild: input.editorBuild,
921
+ canonicalDocument: input.document,
922
+ compatibility: input.compatibility,
923
+ warningLog: input.compatibility.warnings,
924
+ };
925
+ }
926
+
927
+ function toPublicAnchorProjection(
928
+ anchor: InternalEditorAnchorProjection,
929
+ ): PublicEditorAnchorProjection {
930
+ switch (anchor.kind) {
931
+ case "range":
932
+ return {
933
+ kind: "range",
934
+ from: anchor.range.from,
935
+ to: anchor.range.to,
936
+ assoc: anchor.assoc,
937
+ };
938
+ case "node":
939
+ return {
940
+ kind: "node",
941
+ at: anchor.at,
942
+ assoc: anchor.assoc,
943
+ };
944
+ case "detached":
945
+ return {
946
+ kind: "detached",
947
+ lastKnownRange: anchor.lastKnownRange,
948
+ reason: anchor.reason,
949
+ };
950
+ }
951
+ }
952
+
953
+ function toPublicCompatibilityFeatureEntry(entry: InternalCompatibilityFeatureEntry) {
954
+ return {
955
+ ...entry,
956
+ affectedAnchor: entry.affectedAnchor
957
+ ? toPublicAnchorProjection(entry.affectedAnchor)
958
+ : undefined,
959
+ };
960
+ }
961
+
962
+ function toPublicWarning(warning: InternalEditorWarning): PublicEditorWarning {
963
+ return {
964
+ ...warning,
965
+ affectedAnchor: warning.affectedAnchor
966
+ ? toPublicAnchorProjection(warning.affectedAnchor)
967
+ : undefined,
968
+ };
969
+ }
970
+
971
+ function toPublicError(error: InternalEditorError): EditorError {
972
+ return { ...error };
973
+ }
974
+
975
+ function toPublicCompatibilityReport(
976
+ report: InternalCompatibilityReport,
977
+ ): PublicCompatibilityReport {
978
+ return {
979
+ reportVersion: report.reportVersion,
980
+ generatedAt: report.generatedAt,
981
+ blockExport: report.blockExport,
982
+ featureEntries: report.featureEntries.map((entry) =>
983
+ toPublicCompatibilityFeatureEntry(entry),
984
+ ),
985
+ warnings: report.warnings.map((warning) => toPublicWarning(warning)),
986
+ errors: report.errors.map((error) => toPublicError(error)),
987
+ };
988
+ }
989
+
990
+ function createDiagnosticsSession(
991
+ options: LoadDocxEditorSessionOptions,
992
+ diagnostics: ImportDiagnosticsResult,
993
+ ): LoadedDocxEditorSession {
994
+ const timestamp = new Date().toISOString();
995
+ const runtime = createReadOnlyDiagnosticsRuntime({
996
+ documentId: options.documentId,
997
+ sourceLabel: options.sourceLabel,
998
+ editorBuild: options.editorBuild,
999
+ generatedAt: timestamp,
1000
+ diagnostics,
1001
+ });
1002
+ const initialSnapshot = runtime.getPersistedSnapshot();
1003
+
1004
+ return {
1005
+ initialSnapshot,
1006
+ fatalError: diagnostics.fatalError,
1007
+ readOnly: true,
1008
+ exportDocx: async (_snapshot, exportOptions) => runtime.exportDocx(exportOptions),
1009
+ };
1010
+ }
1011
+
1012
+ function createImportDiagnosticsFromError(error: unknown): ImportDiagnosticsResult {
1013
+ if (isPackageImportError(error)) {
1014
+ return createPackageImportDiagnostics({
1015
+ issue: classifyCorruptPackageError(error),
1016
+ });
1017
+ }
1018
+
1019
+ return createValidationImportDiagnostics({
1020
+ message:
1021
+ error instanceof Error
1022
+ ? error.message
1023
+ : "DOCX import failed during validation.",
1024
+ });
1025
+ }
1026
+
1027
+ function normalizeImportedRevisionRecords(
1028
+ parsed: ParsedRevisionsResult,
1029
+ content: CanonicalDocumentEnvelope["content"],
1030
+ opaqueFragments: Record<string, OpaqueFragmentRecord>,
1031
+ ): ParsedRevisionsResult {
1032
+ const opaqueRanges = Object.values(opaqueFragments).map((fragment) => fragment.lastKnownRange);
1033
+ const paragraphRanges = collectCanonicalParagraphRanges(content);
1034
+ if (opaqueRanges.length === 0) {
1035
+ return {
1036
+ ...parsed,
1037
+ revisions: parsed.revisions.map((revision) => {
1038
+ if (revision.anchor.kind !== "range" || revision.metadata.preserveOnlyReason) {
1039
+ return revision;
1040
+ }
1041
+
1042
+ const preserveOnlyReason = getStructuralPreserveOnlyReason(
1043
+ revision,
1044
+ paragraphRanges,
1045
+ );
1046
+ if (!preserveOnlyReason) {
1047
+ return revision;
1048
+ }
1049
+
1050
+ return {
1051
+ ...revision,
1052
+ metadata: {
1053
+ ...revision.metadata,
1054
+ preserveOnlyReason,
1055
+ },
1056
+ };
1057
+ }),
1058
+ };
1059
+ }
1060
+
1061
+ return {
1062
+ ...parsed,
1063
+ revisions: parsed.revisions.map((revision) => {
1064
+ if (revision.anchor.kind !== "range" || revision.metadata.preserveOnlyReason) {
1065
+ return revision;
1066
+ }
1067
+
1068
+ const preserveOnlyReason =
1069
+ getStructuralPreserveOnlyReason(revision, paragraphRanges) ??
1070
+ (opaqueRanges.some((range) => rangesIntersect(range, revision.anchor.range))
1071
+ ? "Imported revision overlaps preserve-only OOXML and remains preserve-only."
1072
+ : undefined);
1073
+
1074
+ if (!preserveOnlyReason) {
1075
+ return revision;
1076
+ }
1077
+
1078
+ return {
1079
+ ...revision,
1080
+ metadata: {
1081
+ ...revision.metadata,
1082
+ preserveOnlyReason,
1083
+ },
1084
+ };
1085
+ }),
1086
+ };
1087
+ }
1088
+
1089
+ function normalizeImportedCommentThreads(
1090
+ parsed: ParsedCommentsResult,
1091
+ opaqueFragments: Record<string, OpaqueFragmentRecord>,
1092
+ revisions: readonly ReviewRevisionRecord[],
1093
+ ): NormalizedImportedCommentsResult {
1094
+ const opaqueRanges = Object.values(opaqueFragments).map((fragment) => fragment.lastKnownRange);
1095
+ const preserveOnlyRevisionRanges = revisions
1096
+ .filter(
1097
+ (revision) =>
1098
+ revision.anchor.kind === "range" &&
1099
+ typeof revision.metadata.preserveOnlyReason === "string" &&
1100
+ revision.metadata.preserveOnlyReason.length > 0,
1101
+ )
1102
+ .map((revision) => revision.anchor.range);
1103
+ const preserveOnlyCommentIds = new Set(parsed.diagnostics.map((diagnostic) => diagnostic.commentId));
1104
+ const additionalDiagnostics: CommentImportDiagnostic[] = [];
1105
+ const normalizedThreads = parsed.threads.map((thread) => {
1106
+ if (thread.anchor.kind !== "range") {
1107
+ preserveOnlyCommentIds.add(thread.commentId);
1108
+ return thread;
1109
+ }
1110
+
1111
+ const opaqueOverlap = opaqueRanges.some((range) => rangesIntersect(range, thread.anchor.range));
1112
+ if (opaqueOverlap) {
1113
+ preserveOnlyCommentIds.add(thread.commentId);
1114
+ additionalDiagnostics.push({
1115
+ commentId: thread.commentId,
1116
+ code: "opaque_anchor_preserve_only",
1117
+ message:
1118
+ "Comment anchor intersects preserve-only OOXML and remains preserve-only on export.",
1119
+ featureClass: "preserve-only",
1120
+ });
1121
+ return {
1122
+ ...thread,
1123
+ anchor: createDetachedAnchor(thread.anchor.range, "importAmbiguity"),
1124
+ status: "detached",
1125
+ };
1126
+ }
1127
+
1128
+ const preserveOnlyRevisionOverlap = preserveOnlyRevisionRanges.some((range) =>
1129
+ rangesIntersect(range, thread.anchor.range),
1130
+ );
1131
+ if (preserveOnlyRevisionOverlap) {
1132
+ preserveOnlyCommentIds.add(thread.commentId);
1133
+ additionalDiagnostics.push({
1134
+ commentId: thread.commentId,
1135
+ code: "preserve_only_revision_overlap",
1136
+ message:
1137
+ "Comment anchor overlaps preserve-only review markup and remains preserve-only on export.",
1138
+ featureClass: "preserve-only",
1139
+ });
1140
+ return {
1141
+ ...thread,
1142
+ anchor: createDetachedAnchor(thread.anchor.range, "importAmbiguity"),
1143
+ status: "detached",
1144
+ };
1145
+ }
1146
+
1147
+ return thread;
1148
+ });
1149
+
1150
+ return {
1151
+ ...parsed,
1152
+ threads: normalizedThreads,
1153
+ diagnostics: [...parsed.diagnostics, ...additionalDiagnostics],
1154
+ definitions: parsed.definitions,
1155
+ preservedDefinitions: parsed.definitions.filter((definition) =>
1156
+ preserveOnlyCommentIds.has(
1157
+ resolveDefinitionRootCommentId(definition, parsed.definitions),
1158
+ ),
1159
+ ),
1160
+ };
1161
+ }
1162
+
1163
+ function resolveDefinitionRootCommentId(
1164
+ definition: ImportedCommentDefinition,
1165
+ definitions: readonly ImportedCommentDefinition[],
1166
+ ): string {
1167
+ if (!definition.parentParaId) {
1168
+ return definition.commentId;
1169
+ }
1170
+
1171
+ const definitionsByParaId = new Map(
1172
+ definitions
1173
+ .filter((candidate) => typeof candidate.paraId === "string")
1174
+ .map((candidate) => [candidate.paraId!, candidate]),
1175
+ );
1176
+ const visited = new Set<string>();
1177
+ let current: ImportedCommentDefinition | undefined = definition;
1178
+
1179
+ while (current?.parentParaId) {
1180
+ if (visited.has(current.parentParaId)) {
1181
+ break;
1182
+ }
1183
+ visited.add(current.parentParaId);
1184
+ const parent = definitionsByParaId.get(current.parentParaId);
1185
+ if (!parent) {
1186
+ break;
1187
+ }
1188
+ current = parent;
1189
+ }
1190
+
1191
+ return current?.commentId ?? definition.commentId;
1192
+ }
1193
+
1194
+ function getStructuralPreserveOnlyReason(
1195
+ revision: ReviewRevisionRecord,
1196
+ paragraphRanges: ReadonlyArray<{ start: number; end: number }>,
1197
+ ): string | undefined {
1198
+ const form = revision.metadata.importedRevisionForm;
1199
+ if (!form || revision.anchor.kind !== "range") {
1200
+ return undefined;
1201
+ }
1202
+
1203
+ if (
1204
+ (form === "run-insertion" || form === "run-deletion") &&
1205
+ revision.anchor.range.from === revision.anchor.range.to
1206
+ ) {
1207
+ return "Imported zero-width run revision remains preserve-only.";
1208
+ }
1209
+
1210
+ if (form === "paragraph-insertion" || form === "paragraph-deletion") {
1211
+ const paragraphBoundary = paragraphRanges.find(
1212
+ (boundary) =>
1213
+ boundary.end === revision.anchor.range.from ||
1214
+ (revision.anchor.range.from >= boundary.start &&
1215
+ revision.anchor.range.from <= boundary.end),
1216
+ );
1217
+ return paragraphBoundary
1218
+ ? undefined
1219
+ : "Imported revision spans paragraph-level structure and remains preserve-only.";
1220
+ }
1221
+
1222
+ const paragraphBoundary = paragraphRanges.find(
1223
+ (boundary) =>
1224
+ revision.anchor.range.from >= boundary.start &&
1225
+ revision.anchor.range.to <= boundary.end,
1226
+ );
1227
+ return paragraphBoundary
1228
+ ? undefined
1229
+ : "Imported revision spans structural boundaries and remains preserve-only.";
1230
+ }
1231
+
1232
+ function collectCanonicalParagraphRanges(
1233
+ content: CanonicalDocumentEnvelope["content"],
1234
+ ): Array<{ start: number; end: number }> {
1235
+ const ranges: Array<{ start: number; end: number }> = [];
1236
+ let cursor = 0;
1237
+ let previousWasParagraph = false;
1238
+
1239
+ for (const block of content.children) {
1240
+ if (block.type === "paragraph") {
1241
+ if (previousWasParagraph) {
1242
+ cursor += 1;
1243
+ }
1244
+ const start = cursor;
1245
+ cursor += measureCanonicalParagraph(block);
1246
+ ranges.push({ start, end: cursor });
1247
+ previousWasParagraph = true;
1248
+ continue;
1249
+ }
1250
+
1251
+ cursor += 1;
1252
+ previousWasParagraph = false;
1253
+ }
1254
+
1255
+ return ranges;
1256
+ }
1257
+
1258
+ function measureCanonicalParagraph(paragraph: CanonicalDocumentEnvelope["content"]["children"][number] & { type: "paragraph" }): number {
1259
+ return paragraph.children.reduce((size, child) => {
1260
+ switch (child.type) {
1261
+ case "text":
1262
+ return size + child.text.length;
1263
+ case "tab":
1264
+ case "hard_break":
1265
+ case "image":
1266
+ case "opaque_inline":
1267
+ return size + 1;
1268
+ case "hyperlink":
1269
+ return (
1270
+ size +
1271
+ child.children.reduce((childSize, entry) => {
1272
+ switch (entry.type) {
1273
+ case "text":
1274
+ return childSize + entry.text.length;
1275
+ case "tab":
1276
+ case "hard_break":
1277
+ return childSize + 1;
1278
+ }
1279
+ }, 0)
1280
+ );
1281
+ }
1282
+ }, 0);
1283
+ }
1284
+
1285
+ function rangesIntersect(
1286
+ left: { from: number; to: number },
1287
+ right: { from: number; to: number },
1288
+ ): boolean {
1289
+ return left.from < right.to && right.from < left.to;
1290
+ }
1291
+
1292
+ function resolveCommentsPartPath(
1293
+ sourcePackage: OpcPackage,
1294
+ relationships: readonly OpcRelationship[],
1295
+ ): string | undefined {
1296
+ return resolveDocumentRelatedPartPath(
1297
+ sourcePackage,
1298
+ relationships,
1299
+ COMMENTS_RELATIONSHIP_TYPE,
1300
+ COMMENTS_PART_PATH,
1301
+ );
1302
+ }
1303
+
1304
+ function resolveDocumentRelatedPartPath(
1305
+ sourcePackage: OpcPackage,
1306
+ relationships: readonly OpcRelationship[],
1307
+ relationshipType: string,
1308
+ fallbackPartPath: string,
1309
+ ): string | undefined {
1310
+ const relationship = relationships.find(
1311
+ (candidate) =>
1312
+ candidate.type === relationshipType &&
1313
+ candidate.targetMode === "internal",
1314
+ );
1315
+ if (!relationship) {
1316
+ return sourcePackage.parts.has(fallbackPartPath) ? fallbackPartPath : undefined;
1317
+ }
1318
+
1319
+ const targetPath = resolveRelationshipTarget(MAIN_DOCUMENT_PATH, relationship);
1320
+ return sourcePackage.parts.has(targetPath) ? targetPath : undefined;
1321
+ }
1322
+
1323
+ function toRuntimeCommentRecords(
1324
+ threads: readonly CommentThread[],
1325
+ ): Record<string, CommentThreadRecord> {
1326
+ return Object.fromEntries(
1327
+ threads.map((thread) => {
1328
+ return [
1329
+ thread.commentId,
1330
+ {
1331
+ commentId: thread.commentId,
1332
+ body: thread.entries.map((entry) => entry.body).join("\n"),
1333
+ anchor: thread.anchor,
1334
+ createdBy: thread.createdBy,
1335
+ authorId: thread.createdBy,
1336
+ createdAt: thread.createdAt,
1337
+ entries: thread.entries.map((entry) => ({
1338
+ entryId: entry.entryId,
1339
+ authorId: entry.authorId,
1340
+ body: entry.body,
1341
+ createdAt: entry.createdAt,
1342
+ metadata: entry.metadata
1343
+ ? {
1344
+ ooxmlCommentId: entry.metadata.ooxmlCommentId,
1345
+ paraId: entry.metadata.paraId,
1346
+ parentParaId: entry.metadata.parentParaId,
1347
+ durableId: entry.metadata.durableId,
1348
+ initials: entry.metadata.initials,
1349
+ }
1350
+ : undefined,
1351
+ })),
1352
+ status: thread.status,
1353
+ resolution: thread.resolution
1354
+ ? {
1355
+ resolvedAt: thread.resolution.resolvedAt,
1356
+ resolvedBy: thread.resolution.resolvedBy,
1357
+ }
1358
+ : undefined,
1359
+ resolvedAt: thread.resolution?.resolvedAt,
1360
+ warningIds: [...thread.warningIds],
1361
+ isResolved: thread.status === "resolved",
1362
+ metadata: thread.metadata
1363
+ ? {
1364
+ source: thread.metadata.source,
1365
+ rootOoxmlCommentId: thread.metadata.rootOoxmlCommentId,
1366
+ rootParaId: thread.metadata.rootParaId,
1367
+ }
1368
+ : undefined,
1369
+ } satisfies CommentThreadRecord,
1370
+ ];
1371
+ }),
1372
+ );
1373
+ }
1374
+
1375
+ function toRuntimeRevisionRecords(
1376
+ revisions: readonly ReviewRevisionRecord[],
1377
+ ): Record<string, RuntimeRevisionRecord> {
1378
+ return Object.fromEntries(
1379
+ revisions.map((revision) => [
1380
+ revision.revisionId,
1381
+ {
1382
+ changeId: revision.revisionId,
1383
+ kind: revision.kind,
1384
+ anchor: revision.anchor,
1385
+ authorId: revision.authorId,
1386
+ createdAt: revision.createdAt,
1387
+ warningIds: [...revision.warningIds],
1388
+ metadata: {
1389
+ source: revision.metadata.source,
1390
+ preserveOnlyReason: revision.metadata.preserveOnlyReason,
1391
+ importedRevisionForm: revision.metadata.importedRevisionForm,
1392
+ originalRevisionType: revision.metadata.originalRevisionType,
1393
+ ooxmlRevisionId: revision.metadata.ooxmlRevisionId,
1394
+ },
1395
+ status: revision.status === "active" ? "open" : revision.status,
1396
+ } satisfies RuntimeRevisionRecord,
1397
+ ]),
1398
+ );
1399
+ }
1400
+
1401
+ function toReviewRevisionRecords(
1402
+ revisions: CanonicalDocumentEnvelope["review"]["revisions"],
1403
+ ): ReviewRevisionRecord[] {
1404
+ return Object.values(revisions).map((revision) => ({
1405
+ revisionId: revision.changeId,
1406
+ kind: revision.kind,
1407
+ anchor: revision.anchor,
1408
+ authorId: revision.authorId ?? "unknown",
1409
+ createdAt: revision.createdAt,
1410
+ warningIds: [...(revision.warningIds ?? [])],
1411
+ metadata: {
1412
+ source: revision.metadata?.source ?? "runtime",
1413
+ preserveOnlyReason: revision.metadata?.preserveOnlyReason,
1414
+ importedRevisionForm: revision.metadata?.importedRevisionForm,
1415
+ originalRevisionType: revision.metadata?.originalRevisionType,
1416
+ ooxmlRevisionId: revision.metadata?.ooxmlRevisionId,
1417
+ },
1418
+ status: revision.status === "open" ? "active" : revision.status,
1419
+ }));
1420
+ }
1421
+
1422
+ export function stripCommentMarkup(
1423
+ documentXml: string,
1424
+ ownedCommentIds: readonly string[],
1425
+ ): string {
1426
+ if (ownedCommentIds.length === 0) {
1427
+ return documentXml;
1428
+ }
1429
+
1430
+ let output = documentXml;
1431
+ for (const commentId of ownedCommentIds) {
1432
+ const escapedCommentId = escapeRegExp(commentId);
1433
+ const attributePattern = `(?:w:id|id)=["']${escapedCommentId}["']`;
1434
+ output = output
1435
+ .replace(
1436
+ new RegExp(`<w:commentRangeStart\\b[^>]*${attributePattern}[^>]*/>`, "gu"),
1437
+ "",
1438
+ )
1439
+ .replace(
1440
+ new RegExp(`<w:commentRangeEnd\\b[^>]*${attributePattern}[^>]*/>`, "gu"),
1441
+ "",
1442
+ )
1443
+ .replace(
1444
+ new RegExp(
1445
+ `<w:r\\b[^>]*>(?:(?!<w:t\\b|</w:r>)[\\s\\S])*?<w:commentReference\\b[^>]*${attributePattern}[^>]*/>(?:(?!<w:t\\b|</w:r>)[\\s\\S])*?</w:r>`,
1446
+ "gu",
1447
+ ),
1448
+ "",
1449
+ );
1450
+ }
1451
+
1452
+ return output;
1453
+ }
1454
+
1455
+ function escapeRegExp(value: string): string {
1456
+ return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
1457
+ }
1458
+
1459
+ function withDocumentRelatedParts(
1460
+ relationships: readonly OpcRelationship[],
1461
+ relatedParts: ReadonlyArray<{
1462
+ relationshipType: string;
1463
+ partPath: string;
1464
+ existingRelationshipId?: string;
1465
+ include: boolean;
1466
+ }>,
1467
+ ): OpcRelationship[] {
1468
+ const filteredTypes = new Set(relatedParts.map((part) => part.relationshipType));
1469
+ const nextRelationships = relationships
1470
+ .filter((relationship) => !filteredTypes.has(relationship.type))
1471
+ .map(cloneRelationship);
1472
+
1473
+ for (const part of relatedParts) {
1474
+ if (!part.include) {
1475
+ continue;
1476
+ }
1477
+
1478
+ nextRelationships.push({
1479
+ id: part.existingRelationshipId ?? createCommentsRelationshipId(nextRelationships),
1480
+ type: part.relationshipType,
1481
+ target: toDocumentRelativeTarget(part.partPath),
1482
+ targetMode: "internal",
1483
+ });
1484
+ }
1485
+
1486
+ return nextRelationships;
1487
+ }
1488
+
1489
+ function collectPreservedPackageParts(
1490
+ sourcePackage: OpcPackage,
1491
+ ownedPartPaths: ReadonlyArray<string | undefined>,
1492
+ ): Record<string, PreservedPackagePart> {
1493
+ const normalizedOwnedPaths = new Set(
1494
+ ownedPartPaths
1495
+ .filter((value): value is string => typeof value === "string")
1496
+ .map((path) => normalizePartPath(path)),
1497
+ );
1498
+ return Object.fromEntries(
1499
+ [...sourcePackage.parts.values()]
1500
+ .filter((part) =>
1501
+ shouldPreservePackagePart(part.path, part.surfaceKind, normalizedOwnedPaths),
1502
+ )
1503
+ .map((part) => [
1504
+ part.path,
1505
+ {
1506
+ packagePartName: part.path,
1507
+ contentType: part.contentType ?? "application/octet-stream",
1508
+ relationshipIds: findRelationshipIdsTargetingPart(sourcePackage, part.path),
1509
+ } satisfies PreservedPackagePart,
1510
+ ]),
1511
+ );
1512
+ }
1513
+
1514
+ function collectInlineMediaParts(
1515
+ sourcePackage: OpcPackage,
1516
+ ): ReadonlyMap<string, { path: string; contentType: string }> {
1517
+ return new Map(
1518
+ [...sourcePackage.parts.values()]
1519
+ .filter(
1520
+ (part) =>
1521
+ part.path.startsWith("/word/media/") && typeof part.contentType === "string",
1522
+ )
1523
+ .map((part) => [
1524
+ part.path,
1525
+ {
1526
+ path: part.path,
1527
+ contentType: part.contentType ?? "application/octet-stream",
1528
+ },
1529
+ ]),
1530
+ );
1531
+ }
1532
+
1533
+ function createEmptyNumberingCatalog(): NumberingCatalog {
1534
+ return {
1535
+ abstractDefinitions: {},
1536
+ instances: {},
1537
+ };
1538
+ }
1539
+
1540
+ function hasNumberingEntries(catalog: NumberingCatalog): boolean {
1541
+ return (
1542
+ Object.keys(catalog.abstractDefinitions ?? {}).length > 0 ||
1543
+ Object.keys(catalog.instances ?? {}).length > 0
1544
+ );
1545
+ }
1546
+
1547
+ function collectBrokenInternalRelationshipIssues(
1548
+ sourcePackage: OpcPackage,
1549
+ ): ReturnType<typeof createBrokenRelationshipIssue>[] {
1550
+ const brokenTargets = new Map<string, ReturnType<typeof createBrokenRelationshipIssue>>();
1551
+
1552
+ for (const relationship of sourcePackage.manifest.packageRelationships) {
1553
+ if (relationship.targetMode !== "internal") {
1554
+ continue;
1555
+ }
1556
+
1557
+ const target = resolveRelationshipTarget(null, relationship);
1558
+ if (!sourcePackage.parts.has(target)) {
1559
+ brokenTargets.set(
1560
+ `package:${relationship.id}:${target}`,
1561
+ createBrokenRelationshipIssue({
1562
+ relationshipSourcePath: null,
1563
+ relationshipId: relationship.id,
1564
+ targetPartPath: target,
1565
+ }),
1566
+ );
1567
+ }
1568
+ }
1569
+
1570
+ for (const part of sourcePackage.parts.values()) {
1571
+ for (const relationship of part.relationships) {
1572
+ if (relationship.targetMode !== "internal") {
1573
+ continue;
1574
+ }
1575
+
1576
+ const target = resolveRelationshipTarget(part.path, relationship);
1577
+ if (!sourcePackage.parts.has(target)) {
1578
+ brokenTargets.set(
1579
+ `${part.path}:${relationship.id}:${target}`,
1580
+ createBrokenRelationshipIssue({
1581
+ relationshipSourcePath: part.path,
1582
+ relationshipId: relationship.id,
1583
+ targetPartPath: target,
1584
+ }),
1585
+ );
1586
+ }
1587
+ }
1588
+ }
1589
+
1590
+ return [...brokenTargets.values()].sort((left, right) =>
1591
+ `${left.relationshipSourcePath ?? ""}:${left.relationshipId}:${left.targetPartPath}`.localeCompare(
1592
+ `${right.relationshipSourcePath ?? ""}:${right.relationshipId}:${right.targetPartPath}`,
1593
+ ),
1594
+ );
1595
+ }
1596
+
1597
+ function summarizeBrokenRelationshipIssues(
1598
+ issues: readonly ReturnType<typeof createBrokenRelationshipIssue>[],
1599
+ ): string {
1600
+ return `DOCX package has unresolved internal relationships: ${issues
1601
+ .map((issue) => issue.targetPartPath ?? issue.message)
1602
+ .slice(0, 3)
1603
+ .join(", ")}${issues.length > 3 ? ", ..." : ""}.`;
1604
+ }
1605
+
1606
+ function shouldPreservePackagePart(
1607
+ partPath: string,
1608
+ surfaceKind: OpcPackage["parts"] extends Map<string, infer T>
1609
+ ? T extends { surfaceKind: infer U }
1610
+ ? U
1611
+ : never
1612
+ : never,
1613
+ ownedPartPaths: ReadonlySet<string>,
1614
+ ): boolean {
1615
+ if (surfaceKind !== "content") {
1616
+ return false;
1617
+ }
1618
+
1619
+ if (
1620
+ partPath === MAIN_DOCUMENT_PATH ||
1621
+ ownedPartPaths.has(partPath) ||
1622
+ partPath.startsWith("/word/media/") ||
1623
+ CORE_NON_PRESERVED_PART_PATHS.has(partPath)
1624
+ ) {
1625
+ return false;
1626
+ }
1627
+
1628
+ return true;
1629
+ }
1630
+
1631
+ function findRelationshipIdsTargetingPart(
1632
+ sourcePackage: OpcPackage,
1633
+ targetPartPath: string,
1634
+ ): string[] {
1635
+ const ids = new Set<string>();
1636
+
1637
+ for (const relationship of sourcePackage.manifest.packageRelationships) {
1638
+ if (
1639
+ relationship.targetMode === "internal" &&
1640
+ resolveRelationshipTarget(null, relationship) === targetPartPath
1641
+ ) {
1642
+ ids.add(relationship.id);
1643
+ }
1644
+ }
1645
+
1646
+ for (const part of sourcePackage.parts.values()) {
1647
+ for (const relationship of part.relationships) {
1648
+ if (
1649
+ relationship.targetMode === "internal" &&
1650
+ resolveRelationshipTarget(part.path, relationship) === targetPartPath
1651
+ ) {
1652
+ ids.add(relationship.id);
1653
+ }
1654
+ }
1655
+ }
1656
+
1657
+ return [...ids].sort();
1658
+ }
1659
+
1660
+ function extractDocumentRootAttributes(documentXml: string): Record<string, string> {
1661
+ const match = documentXml.match(
1662
+ /<(?:[A-Za-z_][A-Za-z0-9:._-]*:)?document\b([^>]*)>/u,
1663
+ );
1664
+ if (!match) {
1665
+ return {};
1666
+ }
1667
+
1668
+ const attributes: Record<string, string> = {};
1669
+ const pattern = /([A-Za-z_][A-Za-z0-9:._-]*)\s*=\s*("([^"]*)"|'([^']*)')/gu;
1670
+ for (const attributeMatch of (match[1] ?? "").matchAll(pattern)) {
1671
+ const name = attributeMatch[1];
1672
+ const value = attributeMatch[3] ?? attributeMatch[4] ?? "";
1673
+ if (!name) {
1674
+ continue;
1675
+ }
1676
+ attributes[name] = value;
1677
+ }
1678
+
1679
+ return attributes;
1680
+ }
1681
+
1682
+ function isPackageImportError(error: unknown): boolean {
1683
+ if (!(error instanceof Error)) {
1684
+ return false;
1685
+ }
1686
+
1687
+ const normalized = error.message.toLowerCase();
1688
+ return (
1689
+ normalized.includes("zip") ||
1690
+ normalized.includes("opc package") ||
1691
+ normalized.includes("compression") ||
1692
+ normalized.includes("relationship") ||
1693
+ normalized.includes("/[content_types].xml") ||
1694
+ normalized.includes("/word/document.xml") ||
1695
+ normalized.includes("xml")
1696
+ );
1697
+ }
1698
+
1699
+ const CORE_NON_PRESERVED_PART_PATHS = new Set([
1700
+ "/docProps/app.xml",
1701
+ "/docProps/core.xml",
1702
+ "/docProps/custom.xml",
1703
+ "/word/fontTable.xml",
1704
+ "/word/numbering.xml",
1705
+ "/word/settings.xml",
1706
+ "/word/styles.xml",
1707
+ "/word/stylesWithEffects.xml",
1708
+ "/word/webSettings.xml",
1709
+ ]);
1710
+
1711
+ function createCommentsRelationshipId(
1712
+ relationships: readonly OpcRelationship[],
1713
+ ): string {
1714
+ let nextIndex = 1;
1715
+ while (relationships.some((relationship) => relationship.id === `rIdComments${nextIndex}`)) {
1716
+ nextIndex += 1;
1717
+ }
1718
+
1719
+ return `rIdComments${nextIndex}`;
1720
+ }
1721
+
1722
+ function toDocumentRelativeTarget(partPath: string): string {
1723
+ const normalized = normalizePartPath(partPath);
1724
+ return normalized.startsWith("/word/") ? normalized.slice("/word/".length) : normalized.slice(1);
1725
+ }
1726
+
1727
+ function cloneRelationship(relationship: OpcRelationship): OpcRelationship {
1728
+ return { ...relationship };
1729
+ }
1730
+
1731
+ function decodeUtf8(bytes: Uint8Array | undefined): string {
1732
+ if (!bytes) {
1733
+ return "";
1734
+ }
1735
+
1736
+ return Buffer.from(bytes.buffer, bytes.byteOffset, bytes.byteLength).toString("utf8");
1737
+ }
1738
+
1739
+ function toUint8Array(bytes: Uint8Array | ArrayBuffer): Uint8Array {
1740
+ return bytes instanceof Uint8Array ? bytes : new Uint8Array(bytes);
1741
+ }
1742
+
1743
+ function serializeCanonicalDocumentForExport(document: CanonicalDocumentEnvelope): string {
1744
+ return createCanonicalDocumentSignature(document);
1745
+ }
1746
+
1747
+ function canReuseSourceBytesForCurrentDocument(
1748
+ state: ImportedDocxState,
1749
+ document: CanonicalDocumentEnvelope,
1750
+ ): boolean {
1751
+ const commentThreads = Object.values(document.review.comments);
1752
+ const hasLiveComments = commentThreads.some((thread) => thread.anchor.kind !== "detached");
1753
+ if (!hasLiveComments) {
1754
+ return true;
1755
+ }
1756
+
1757
+ return Boolean(
1758
+ state.sourceCommentsPartPath &&
1759
+ state.sourceCommentsExtendedPartPath &&
1760
+ state.sourceCommentsIdsPartPath &&
1761
+ state.sourcePeoplePartPath,
1762
+ );
1763
+ }