docx-diff-editor 1.0.37 → 1.0.39

package/README.md

@@ -138,6 +138,12 @@ interface DocxDiffEditorRef {
 
   // Get document metadata and statistics
   getDocumentInfo(): DocumentInfo | null;
+
+  // Get document core properties
+  getProperties(): Promise<DocumentProperties | null>;
+
+  // Set document core properties (partial update)
+  setProperties(properties: Partial<DocumentProperties>): Promise<boolean>;
 }
 ```
 
@@ -170,6 +176,23 @@ interface DocumentInfo {
 }
 ```
 
+### DocumentProperties
+
+```tsx
+interface DocumentProperties {
+  title?: string;
+  author?: string;
+  subject?: string;
+  description?: string;
+  keywords?: string;
+  category?: string;
+  lastModifiedBy?: string;
+  revision?: string;
+  created?: Date;
+  modified?: Date;
+}
+```
+
 ## Getting LLM Context
 
 Extract enriched changes with semantic context for AI/LLM processing:
@@ -197,6 +220,30 @@ await fetch('/api/summarize', {
 // }
 ```
 
+## Document Properties
+
+Read and update document metadata (stored in `docProps/core.xml`):
+
+```tsx
+// Get current properties
+const props = await editorRef.current?.getProperties();
+if (props) {
+  console.log(`Title: ${props.title}`);
+  console.log(`Author: ${props.author}`);
+  console.log(`Created: ${props.created?.toLocaleDateString()}`);
+  console.log(`Modified: ${props.modified?.toLocaleDateString()}`);
+}
+
+// Update properties (partial update - only specified fields are changed)
+await editorRef.current?.setProperties({
+  title: 'Quarterly Report Q4 2026',
+  author: 'Jane Smith',
+  subject: 'Financial Summary',
+  keywords: 'report, quarterly, finance, 2026',
+  modified: new Date(),
+});
+```
+
 ## Customization
 
 ### CSS Variables

package/dist/index.d.mts

@@ -109,6 +109,31 @@ interface TrackChangeAuthor {
     name: string;
     email: string;
 }
+/**
+ * Document core properties (stored in docProps/core.xml)
+ */
+interface DocumentProperties {
+    /** Document title (dc:title) */
+    title?: string;
+    /** Original author (dc:creator) */
+    author?: string;
+    /** Subject/topic (dc:subject) */
+    subject?: string;
+    /** Comments/description (dc:description) */
+    description?: string;
+    /** Keywords/tags (cp:keywords) */
+    keywords?: string;
+    /** Category (cp:category) */
+    category?: string;
+    /** Last modified by (cp:lastModifiedBy) */
+    lastModifiedBy?: string;
+    /** Revision number (cp:revision) */
+    revision?: string;
+    /** Creation date (dcterms:created) */
+    created?: Date;
+    /** Last modified date (dcterms:modified) */
+    modified?: Date;
+}
 /**
  * Combined document metadata and statistics
  */
@@ -187,6 +212,10 @@ interface DocxDiffEditorRef {
     getPages(): number;
     /** Get combined document metadata and statistics */
     getDocumentInfo(): DocumentInfo | null;
+    /** Get document core properties (from docProps/core.xml) */
+    getProperties(): Promise<DocumentProperties | null>;
+    /** Set document core properties (partial update) */
+    setProperties(properties: Partial<DocumentProperties>): Promise<boolean>;
 }
 
 /**
@@ -334,4 +363,4 @@ declare function getBlankTemplateBlob(): Blob;
  */
 declare function isValidDocxFile(file: File): boolean;
 
-export { CSS_PREFIX, type ChangeLocation, type ComparisonResult, DEFAULT_AUTHOR, DEFAULT_SUPERDOC_USER, type DiffResult, type DiffSegment, type DocumentInfo, type DocxContent, DocxDiffEditor, type DocxDiffEditorProps, type DocxDiffEditorRef, type EnrichedChange, type FormatChange, type FormatDetails, type ProseMirrorJSON, type ProseMirrorMark, type ProseMirrorNode, type TrackChangeAuthor, createTrackDeleteMark, createTrackFormatMark, createTrackInsertMark, DocxDiffEditor as default, detectContentType, diffDocuments, extractEnrichedChanges, getBlankTemplateBlob, getBlankTemplateFile, isProseMirrorJSON, isValidDocxFile, mergeDocuments, parseDocxFile };
+export { CSS_PREFIX, type ChangeLocation, type ComparisonResult, DEFAULT_AUTHOR, DEFAULT_SUPERDOC_USER, type DiffResult, type DiffSegment, type DocumentInfo, type DocumentProperties, type DocxContent, DocxDiffEditor, type DocxDiffEditorProps, type DocxDiffEditorRef, type EnrichedChange, type FormatChange, type FormatDetails, type ProseMirrorJSON, type ProseMirrorMark, type ProseMirrorNode, type TrackChangeAuthor, createTrackDeleteMark, createTrackFormatMark, createTrackInsertMark, DocxDiffEditor as default, detectContentType, diffDocuments, extractEnrichedChanges, getBlankTemplateBlob, getBlankTemplateFile, isProseMirrorJSON, isValidDocxFile, mergeDocuments, parseDocxFile };

package/dist/index.d.ts

@@ -109,6 +109,31 @@ interface TrackChangeAuthor {
     name: string;
     email: string;
 }
+/**
+ * Document core properties (stored in docProps/core.xml)
+ */
+interface DocumentProperties {
+    /** Document title (dc:title) */
+    title?: string;
+    /** Original author (dc:creator) */
+    author?: string;
+    /** Subject/topic (dc:subject) */
+    subject?: string;
+    /** Comments/description (dc:description) */
+    description?: string;
+    /** Keywords/tags (cp:keywords) */
+    keywords?: string;
+    /** Category (cp:category) */
+    category?: string;
+    /** Last modified by (cp:lastModifiedBy) */
+    lastModifiedBy?: string;
+    /** Revision number (cp:revision) */
+    revision?: string;
+    /** Creation date (dcterms:created) */
+    created?: Date;
+    /** Last modified date (dcterms:modified) */
+    modified?: Date;
+}
 /**
  * Combined document metadata and statistics
  */
@@ -187,6 +212,10 @@ interface DocxDiffEditorRef {
     getPages(): number;
     /** Get combined document metadata and statistics */
     getDocumentInfo(): DocumentInfo | null;
+    /** Get document core properties (from docProps/core.xml) */
+    getProperties(): Promise<DocumentProperties | null>;
+    /** Set document core properties (partial update) */
+    setProperties(properties: Partial<DocumentProperties>): Promise<boolean>;
 }
 
 /**
@@ -334,4 +363,4 @@ declare function getBlankTemplateBlob(): Blob;
  */
 declare function isValidDocxFile(file: File): boolean;
 
-export { CSS_PREFIX, type ChangeLocation, type ComparisonResult, DEFAULT_AUTHOR, DEFAULT_SUPERDOC_USER, type DiffResult, type DiffSegment, type DocumentInfo, type DocxContent, DocxDiffEditor, type DocxDiffEditorProps, type DocxDiffEditorRef, type EnrichedChange, type FormatChange, type FormatDetails, type ProseMirrorJSON, type ProseMirrorMark, type ProseMirrorNode, type TrackChangeAuthor, createTrackDeleteMark, createTrackFormatMark, createTrackInsertMark, DocxDiffEditor as default, detectContentType, diffDocuments, extractEnrichedChanges, getBlankTemplateBlob, getBlankTemplateFile, isProseMirrorJSON, isValidDocxFile, mergeDocuments, parseDocxFile };
+export { CSS_PREFIX, type ChangeLocation, type ComparisonResult, DEFAULT_AUTHOR, DEFAULT_SUPERDOC_USER, type DiffResult, type DiffSegment, type DocumentInfo, type DocumentProperties, type DocxContent, DocxDiffEditor, type DocxDiffEditorProps, type DocxDiffEditorRef, type EnrichedChange, type FormatChange, type FormatDetails, type ProseMirrorJSON, type ProseMirrorMark, type ProseMirrorNode, type TrackChangeAuthor, createTrackDeleteMark, createTrackFormatMark, createTrackInsertMark, DocxDiffEditor as default, detectContentType, diffDocuments, extractEnrichedChanges, getBlankTemplateBlob, getBlankTemplateFile, isProseMirrorJSON, isValidDocxFile, mergeDocuments, parseDocxFile };

package/dist/index.js

@@ -1236,6 +1236,132 @@ var DocxDiffEditor = react.forwardRef(
             console.warn("[DocxDiffEditor] Failed to get document info:", err);
             return null;
           }
+        },
+        /**
+         * Get document core properties from docProps/core.xml.
+         * Returns null if editor is not ready or properties unavailable.
+         */
+        async getProperties() {
+          if (!readyRef.current || !superdocRef.current) {
+            return null;
+          }
+          try {
+            const sd = superdocRef.current;
+            const doc = sd.superdocStore?.documents?.[0];
+            if (!doc) {
+              return null;
+            }
+            const editor = doc.getEditor?.();
+            if (!editor) {
+              return null;
+            }
+            const coreXml = editor.converter?.convertedXml?.["docProps/core.xml"];
+            if (!coreXml?.elements?.[0]?.elements) {
+              return null;
+            }
+            const elements = coreXml.elements[0].elements;
+            const xmlToKey = {
+              "dc:title": "title",
+              "dc:creator": "author",
+              "dc:subject": "subject",
+              "dc:description": "description",
+              "cp:keywords": "keywords",
+              "cp:category": "category",
+              "cp:lastModifiedBy": "lastModifiedBy",
+              "cp:revision": "revision",
+              "dcterms:created": "created",
+              "dcterms:modified": "modified"
+            };
+            const props = {};
+            for (const el of elements) {
+              const key = xmlToKey[el.name];
+              if (key) {
+                const textValue = el.elements?.[0]?.text;
+                if (textValue !== void 0 && textValue !== null) {
+                  if (key === "created" || key === "modified") {
+                    props[key] = new Date(textValue);
+                  } else {
+                    props[key] = textValue;
+                  }
+                }
+              }
+            }
+            return props;
+          } catch (err) {
+            console.warn("[DocxDiffEditor] Failed to get properties:", err);
+            return null;
+          }
+        },
+        /**
+         * Set document core properties (partial update).
+         * Only provided properties will be updated; others are preserved.
+         * Preserves XML namespaces and structure for valid DOCX output.
+         * Returns true on success, false on failure.
+         */
+        async setProperties(properties) {
+          if (!readyRef.current || !superdocRef.current) {
+            return false;
+          }
+          try {
+            const sd = superdocRef.current;
+            const doc = sd.superdocStore?.documents?.[0];
+            if (!doc) {
+              return false;
+            }
+            const editor = doc.getEditor?.();
+            if (!editor) {
+              return false;
+            }
+            const coreXml = editor.converter?.convertedXml?.["docProps/core.xml"];
+            if (!coreXml?.elements?.[0]?.elements) {
+              console.warn("[DocxDiffEditor] docProps/core.xml not found or invalid structure");
+              return false;
+            }
+            const coreProperties = coreXml.elements[0];
+            const elements = coreProperties.elements;
+            const keyToXml = {
+              title: "dc:title",
+              author: "dc:creator",
+              subject: "dc:subject",
+              description: "dc:description",
+              keywords: "cp:keywords",
+              category: "cp:category",
+              lastModifiedBy: "cp:lastModifiedBy",
+              revision: "cp:revision",
+              created: "dcterms:created",
+              modified: "dcterms:modified"
+            };
+            for (const [key, value] of Object.entries(properties)) {
+              if (value === void 0) continue;
+              const xmlName = keyToXml[key];
+              if (!xmlName) continue;
+              const textValue = value instanceof Date ? value.toISOString() : String(value);
+              const existingProp = elements.find((el) => el.name === xmlName);
+              if (existingProp) {
+                if (!existingProp.elements) {
+                  existingProp.elements = [];
+                }
+                if (existingProp.elements[0]) {
+                  existingProp.elements[0].text = textValue;
+                } else {
+                  existingProp.elements.push({ type: "text", text: textValue });
+                }
+              } else {
+                elements.push({
+                  type: "element",
+                  name: xmlName,
+                  elements: [{ type: "text", text: textValue }]
+                });
+              }
+            }
+            if (editor.converter) {
+              editor.converter.documentModified = true;
+            }
+            return true;
+          } catch (err) {
+            console.warn("[DocxDiffEditor] Failed to set properties:", err);
+            return false;
+          }
         }
       }),
       [