docx-diff-editor 1.0.35 → 1.0.38

package/README.md

@@ -132,6 +132,18 @@ interface DocxDiffEditorRef {
 
   // Check if ready
   isReady(): boolean;
+
+  // Get current page count
+  getPages(): number;
+
+  // 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>;
 }
 ```
 
@@ -148,6 +160,39 @@ interface ComparisonResult {
 }
 ```
 
+### DocumentInfo
+
+```tsx
+interface DocumentInfo {
+  // Metadata
+  documentGuid: string | null;
+  isModified: boolean;
+  version: number | null;
+  // Statistics
+  words: number;
+  characters: number;
+  paragraphs: number;
+  pages: number;
+}
+```
+
+### 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:
@@ -175,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,50 @@ 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
+ */
+interface DocumentInfo {
+    /** Document unique identifier */
+    documentGuid: string | null;
+    /** Whether the document has unsaved changes */
+    isModified: boolean;
+    /** Document version number */
+    version: number | null;
+    /** Word count */
+    words: number;
+    /** Character count */
+    characters: number;
+    /** Paragraph count */
+    paragraphs: number;
+    /** Page count */
+    pages: number;
+}
 /**
  * Props for DocxDiffEditor component
  */
@@ -164,6 +208,14 @@ interface DocxDiffEditorRef {
     acceptAllChanges(): Promise<ProseMirrorJSON>;
     /** Check if editor is ready */
     isReady(): boolean;
+    /** Get the current page count from the presentation editor */
+    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>;
 }
 
 /**
@@ -311,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 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,50 @@ 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
+ */
+interface DocumentInfo {
+    /** Document unique identifier */
+    documentGuid: string | null;
+    /** Whether the document has unsaved changes */
+    isModified: boolean;
+    /** Document version number */
+    version: number | null;
+    /** Word count */
+    words: number;
+    /** Character count */
+    characters: number;
+    /** Paragraph count */
+    paragraphs: number;
+    /** Page count */
+    pages: number;
+}
 /**
  * Props for DocxDiffEditor component
  */
@@ -164,6 +208,14 @@ interface DocxDiffEditorRef {
     acceptAllChanges(): Promise<ProseMirrorJSON>;
     /** Check if editor is ready */
     isReady(): boolean;
+    /** Get the current page count from the presentation editor */
+    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>;
 }
 
 /**
@@ -311,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 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

@@ -1177,6 +1177,182 @@ var DocxDiffEditor = react.forwardRef(
          */
         isReady() {
           return readyRef.current;
+        },
+        /**
+         * Get the current page count from the presentation editor.
+         * Returns 0 if editor is not ready or pages are unavailable.
+         */
+        getPages() {
+          if (!readyRef.current || !superdocRef.current) {
+            return 0;
+          }
+          try {
+            const sd = superdocRef.current;
+            const doc = sd.superdocStore?.documents?.[0];
+            if (!doc) {
+              return 0;
+            }
+            const presentationEditor = doc.getPresentationEditor?.();
+            const pages = presentationEditor?.getPages?.();
+            return pages?.length ?? 0;
+          } catch (err) {
+            console.warn("[DocxDiffEditor] Failed to get page count:", err);
+            return 0;
+          }
+        },
+        /**
+         * Get combined document metadata and statistics.
+         * Returns null if editor is not ready.
+         */
+        getDocumentInfo() {
+          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?.();
+            const metadata = editor?.getMetadata?.() ?? {};
+            const stats = editor?.commands?.getDocumentStats?.() ?? {};
+            const presentationEditor = doc.getPresentationEditor?.();
+            const pages = presentationEditor?.getPages?.();
+            const pageCount = pages?.length ?? 0;
+            return {
+              // Metadata
+              documentGuid: metadata.documentGuid ?? null,
+              isModified: metadata.isModified ?? false,
+              version: metadata.version ?? null,
+              // Stats
+              words: stats.words ?? 0,
+              characters: stats.characters ?? 0,
+              paragraphs: stats.paragraphs ?? 0,
+              // Pages
+              pages: pageCount
+            };
+          } catch (err) {
+            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 coreProps = editor.getInternalXmlFile?.("docProps/core.xml", "json");
+            if (!coreProps?.elements) {
+              return null;
+            }
+            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 coreProps.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.
+         * 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 coreProps = editor.getInternalXmlFile?.("docProps/core.xml", "json");
+            if (!coreProps?.elements) {
+              return false;
+            }
+            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);
+              let found = false;
+              for (const el of coreProps.elements) {
+                if (el.name === xmlName) {
+                  el.elements = [{ type: "text", text: textValue }];
+                  found = true;
+                  break;
+                }
+              }
+              if (!found) {
+                coreProps.elements.push({
+                  type: "element",
+                  name: xmlName,
+                  elements: [{ type: "text", text: textValue }]
+                });
+              }
+            }
+            editor.updateInternalXmlFile?.("docProps/core.xml", { elements: [coreProps] });
+            return true;
+          } catch (err) {
+            console.warn("[DocxDiffEditor] Failed to set properties:", err);
+            return false;
+          }
         }
       }),
       [