HAR-8546 Telemetry Service Updated

packages/super-editor/src/core/Editor.js

@@ -79,8 +79,12 @@ export class Editor extends EventEmitter {
     onDocumentLocked: () => null,
     onFirstRender: () => null,
     onCollaborationReady: () => null,
+    onException: () => null,
     // async (file) => url;
     handleImageUpload: null,
+
+    // telemetry
+    telemetry: null,
   };
 
   constructor(options) {
@@ -99,7 +103,7 @@ export class Editor extends EventEmitter {
     };
 
     let initMode = modes[this.options.mode] ?? modes.default;
-
+    
     initMode();
   }
 
@@ -113,6 +117,7 @@ export class Editor extends EventEmitter {
     this.on('beforeCreate', this.options.onBeforeCreate);
     this.emit('beforeCreate', { editor: this });
     this.on('contentError', this.options.onContentError);
+    this.on('exception', this.options.onException);
 
     this.#createView();
     this.initDefaultStyles();
@@ -438,6 +443,9 @@ export class Editor extends EventEmitter {
         docx: this.options.content,
         media: this.options.mediaFiles,
         debug: true,
+        telemetry: this.options.telemetry,
+        fileSource: this.options.fileSource,
+        documentId: this.options.documentId,
       });
     }
   }
@@ -495,9 +503,9 @@ export class Editor extends EventEmitter {
 
     try {
       const { mode, fragment, isHeadless, content, loadFromSchema } = this.options;
-
+      
       if (mode === 'docx') {
-        doc = createDocument(this.converter, this.schema);
+        doc = createDocument(this.converter, this.schema, this);
 
         if (fragment && isHeadless) {
           doc = yXmlFragmentToProseMirrorRootNode(fragment, this.schema);
@@ -838,6 +846,11 @@ export class Editor extends EventEmitter {
       fonts: this.options.fonts,
       isHeadless: this.options.isHeadless,
     });
+
+    this.telemetry?.trackUsage('document_export', {
+      documentType: 'docx',
+      timestamp: new Date().toISOString()
+    });
 
     return result;
   }

packages/super-editor/src/core/helpers/ErrorWithDetails.js

@@ -0,0 +1,21 @@
+/**
+ * Custom error class which allows to pass additional details
+ * @param {string} name - Error name
+ * @param {string} message - Error message
+ * @param {object} details - additional details from the calling context
+ */
+
+function ErrorWithDetails(name, message, details) {
+  this.name = name;
+  this.message = message || '';
+  this.details = details;
+
+  const error = new Error(this.message);
+  this.stack = error.stack;
+  error.name = this.name;
+}
+ErrorWithDetails.prototype = Object.create(Error.prototype);
+
+export {
+  ErrorWithDetails,
+}

packages/super-editor/src/core/helpers/createDocument.js

@@ -2,10 +2,11 @@
  * Creates the document to pass to EditorState.
  * @param converter SuperConverter instance.
  * @param schema Schema.
+ * @param editor Editor
  * @returns Document.
  */
-export function createDocument(converter, schema) {
-  const documentData = converter.getSchema();
+export function createDocument(converter, schema, editor) {
+  const documentData = converter.getSchema(editor);
 
   if (documentData) {
     return schema.nodeFromJSON(documentData);

packages/super-editor/src/core/super-converter/SuperConverter.js

@@ -95,6 +95,14 @@ class SuperConverter {
     this.tagsNotInSchema = ['w:body'];
     this.savedTagsToRestore = [];
 
+    // Initialize telemetry
+    this.telemetry = params?.telemetry || null;
+    this.documentInternalId = null;
+
+    // Uploaded file
+    this.fileSource = params?.fileSource || null;
+    this.documentId = params?.documentId || null;
+
     // Parse the initial XML, if provided
     if (this.docx.length || this.xml) this.parseFromXml();
   }
@@ -155,6 +163,15 @@ class SuperConverter {
       return { fontSizePt, kern, typeface, panose };
     }
   }
+
+  getDocumentInternalId() {
+    const settings = this.convertedXml['word/settings.xml'];
+    if (!settings) return '';
+    // New versions of Word will have w15:docId
+    // It's possible to have w14:docId as well but Word(2013 and later) will convert it automatically when document opened
+    const w15DocId = settings.elements[0].elements.find((el) => el.name === 'w15:docId');
+    this.documentInternalId = w15DocId?.attributes['w15:val'];
+  }
 
   getThemeInfo(themeName) {
     themeName = themeName.toLowerCase();
@@ -174,8 +191,10 @@ class SuperConverter {
     return { typeface, panose };
   }
 
-  getSchema() {
-    const result = createDocumentJson({...this.convertedXml, media: this.media }, this );
+  getSchema(editor) {
+    this.getDocumentInternalId();
+    const result = createDocumentJson({...this.convertedXml, media: this.media }, this, editor);
+
     if (result) {
       this.savedTagsToRestore.push({ ...result.savedTagsToRestore });
       this.pageStyles = result.pageStyles;