@ansonlai/docx-redline-js 0.9.0 → 0.11.0

package/engine/table-mode.js

@@ -36,9 +36,10 @@ function noChanges(serializer, xmlDoc) {
  * @param {DOMParser} parser - Parser instance
  * @param {string} author - Author name
  * @param {boolean} [generateRedlines=true] - Track change toggle
+ * @param {{ plainTextContent?: boolean }} [extra] - plainTextContent keeps cell text literal
  * @returns {{ oxml: string, hasChanges: boolean }}
  */
-export function applyTableReconciliation(xmlDoc, modifiedText, serializer, parser, author, generateRedlines = true) {
+export function applyTableReconciliation(xmlDoc, modifiedText, serializer, parser, author, generateRedlines = true, extra = {}) {
     const tableNodes = getElementsByTagNSOrTag(xmlDoc, NS_W, 'tbl');
     const newTableData = parseTable(modifiedText);
     const hasNewContent = newTableData.rows.length > 0 || newTableData.headers.length > 0;
@@ -58,7 +59,8 @@ export function applyTableReconciliation(xmlDoc, modifiedText, serializer, parse
     const options = {
         generateRedlines,
         author,
-        revisionIdAllocator: getRevisionIdAllocatorForDocument(xmlDoc)
+        revisionIdAllocator: getRevisionIdAllocatorForDocument(xmlDoc),
+        plainTextContent: extra.plainTextContent === true
     };
     const reconciledOxml = serializeVirtualGridToOoxml(oldGrid, operations, options);
     const wrappedOxml = `<root xmlns:w="${NS_W}">${reconciledOxml}</root>`;
@@ -92,9 +94,10 @@ export function applyTableReconciliation(xmlDoc, modifiedText, serializer, parse
  * @param {DOMParser} parser - Parser instance
  * @param {string} author - Author name
  * @param {boolean} generateRedlines - Track change toggle
+ * @param {{ plainTextContent?: boolean }} [extra] - plainTextContent keeps cell text literal
  * @returns {{ oxml: string, hasChanges: boolean }}
  */
-export function applyTextToTableTransformation(xmlDoc, modifiedText, serializer, parser, author, generateRedlines) {
+export function applyTextToTableTransformation(xmlDoc, modifiedText, serializer, parser, author, generateRedlines, extra = {}) {
     const revisionIdAllocator = getRevisionIdAllocatorForDocument(xmlDoc);
     const tableData = parseTable(modifiedText);
     if (!tableData || (tableData.rows.length === 0 && tableData.headers.length === 0)) {
@@ -102,7 +105,7 @@ export function applyTextToTableTransformation(xmlDoc, modifiedText, serializer,
         return noChanges(serializer, xmlDoc);
     }
 
-    const tableOoxml = generateTableOoxml(tableData, { generateRedlines, author, revisionIdAllocator, trackAsBlock: true });
+    const tableOoxml = generateTableOoxml(tableData, { generateRedlines, author, revisionIdAllocator, trackAsBlock: true, plainTextContent: extra.plainTextContent === true });
     const tableDoc = parseOoxmlSafe(`<root xmlns:w="${NS_W}">${tableOoxml}</root>`, 'application/xml').doc;
     if (!tableDoc) return noChanges(serializer, xmlDoc);
 

package/index.d.ts

@@ -1,6 +1,6 @@
 export type OoxmlSourceType = 'package' | 'document' | 'fragment';
 export type RedlineStatus = 'ok' | 'no-op' | 'partial' | 'error';
-export type ExistingRevisionsPolicy = 'merge-same-author' | 'slice-cross-author' | 'reject-input' | 'accept-all-first' | 'accept-all-first-keep-normalized';
+export type ExistingRevisionsPolicy = 'auto' | 'merge-same-author' | 'slice-cross-author' | 'reject-input' | 'accept-all-first' | 'accept-all-first-keep-normalized';
 export type RevisionView = 'accepted' | 'rejected';
 
 export interface RevisionTextSegment {
@@ -372,6 +372,11 @@ export function inspectDocumentParts(parts: { documentXml: string; commentsXml?:
 export function buildRevisionTokenFraming(options: { scope: string; entries?: unknown }): { framing: Uint8Array; scope: string; version: number; coveredParts: string[] };
 export function computeRevisionToken(options: { scope: string; entries?: unknown; digestFn?: (bytes: Uint8Array) => Promise<string> }): Promise<RevisionToken>;
 export function computeRevisionTokenSync(options: { scope: string; entries?: unknown; digestFn: (bytes: Uint8Array) => string }): RevisionToken;
+/** Compare two inspections by visible text, table position, list label, review segments and comments (ids, dates and run boundaries ignored). */
+export function compareDocumentInspections(expected: { paragraphs: unknown[]; comments?: unknown[] }, actual: { paragraphs: unknown[]; comments?: unknown[] }): { matches: boolean; differences: Array<{ path: string; expected: unknown; actual: unknown }> };
+export function inspectionReviewShape(inspection: { paragraphs: unknown[]; comments?: unknown[] }): { paragraphs: unknown[]; comments: string[] };
+/** Resolve `existingRevisions: 'auto'` for one target node; other policies are returned unchanged. */
+export function resolveExistingRevisionsPolicy(policy: ExistingRevisionsPolicy | null | undefined, node: unknown, author: string): ExistingRevisionsPolicy | null | undefined;
 export function computeDocumentPartsRevisionToken(parts: unknown, options?: { digestFn?: (bytes: Uint8Array) => Promise<string> }): Promise<RevisionToken>;
 export function validateRevisionToken(token: unknown): { valid: boolean; error?: { code: string; message: string } };
 export function areRevisionTokensEqual(a: string, b: string): boolean;
@@ -385,7 +390,29 @@ export function wrapInDocumentFragment(rawOoxml: string, options?: Record<string
 
 export function injectCommentsIntoOoxml(oxml: string, comments: unknown[], options?: Record<string, unknown>): unknown;
 export function injectCommentsIntoPackage(packageXml: string, comments: unknown[], options?: Record<string, unknown>): unknown;
-export function applyCommentReplyToParts(options: { commentsXml: string; commentsExtendedXml?: string | null; parentCommentId: string | number; commentId: string | number; commentContent: string; author: string; date?: string }): { status: 'ok' | 'error'; hasChanges?: boolean; commentsXml?: string; commentsExtendedXml?: string; commentsXmlMode?: 'replace'; commentsExtendedXmlMode?: 'replace'; parentCommentId?: string; paraId?: string; parentParaId?: string; error?: RedlineError };
+export function applyCommentReplyToParts(options: { commentsXml: string; commentsExtendedXml?: string | null; documentXml?: string | null; parentCommentId: string | number; commentId: string | number; commentContent: string; author: string; date?: string }): { status: 'ok' | 'error'; hasChanges?: boolean; commentsXml?: string; commentsExtendedXml?: string; commentsXmlMode?: 'replace'; commentsExtendedXmlMode?: 'replace'; parentCommentId?: string; paraId?: string; parentParaId?: string; error?: RedlineError };
+export interface CommentParts {
+  commentsXml: string | null;
+  commentsExtendedXml: string | null;
+  commentsIdsXml: string | null;
+  commentsExtensibleXml: string | null;
+}
+export type CommentPartName = 'comments' | 'commentsExtended' | 'commentsIds' | 'commentsExtensible';
+export interface MergeCommentPartsResult {
+  status: 'ok' | 'error';
+  hasChanges: boolean;
+  /** Updated parts on success; the input parts unchanged on error. Absent parts are null. */
+  parts: CommentParts;
+  changedParts: CommentPartName[];
+  /** Parts the input did not have; the host adds their relationship and content type. Part presence only: also repair a missing relationship for any changed part. */
+  addedParts: CommentPartName[];
+  error?: { code: 'PARSE_ERROR' | 'INVALID_COMMENT_PARTS' | 'DUPLICATE_COMMENT_ID' | 'UNSUPPORTED_EXISTING_COMMENT_THREAD_METADATA' | string; message: string; part?: CommentPartName; commentId?: string };
+}
+/** Merge a batch result's comment output into comment parts held as XML strings (no ZIP); reconciles commentsIds/commentsExtensible. */
+export function mergeCommentParts(
+  parts?: Partial<CommentParts>,
+  output?: { commentsXml?: string | null; commentsXmlMode?: 'merge' | 'replace'; commentsExtendedXml?: string | null; commentsExtendedXmlMode?: 'merge' | 'replace' }
+): MergeCommentPartsResult;
 export function acceptTrackedChangesInOoxml(oxml: string, options?: RevisionFilterOptions): AcceptTrackedChangesResult;
 export function rejectTrackedChangesInOoxml(oxml: string, options?: RevisionFilterOptions): RejectTrackedChangesResult;
 export function deleteCommentsByAuthorInOoxml(oxml: string, options?: RevisionFilterOptions): DeleteCommentsResult;

package/index.js

@@ -284,6 +284,8 @@ export {
 } from './pipeline/ingestion-export.js';
 export { extractCanonicalParagraphText, readCanonicalRunText, isNodeVisibleInRevisionView, extractParagraphRevisionSegments } from './core/paragraph-text.js';
 export { inspectDocumentParts } from './services/document-inspection.js';
+export { compareDocumentInspections, inspectionReviewShape } from './services/inspection-comparison.js';
+export { resolveExistingRevisionsPolicy } from './core/word-xml.js';
 export {
     buildRevisionTokenFraming,
     computeRevisionToken,
@@ -305,6 +307,7 @@ export {
     buildCommentsPartXml
 } from './services/comment-engine.js';
 export { applyCommentReplyToParts } from './services/comment-replies.js';
+export { mergeCommentParts } from './services/comment-parts-merge.js';
 export {
     acceptTrackedChangesInOoxml,
     rejectTrackedChangesInOoxml,