@harbour-enterprises/superdoc 0.11.37 → 0.11.39

package/dist/superdoc.es.js

@@ -1,5 +1,5 @@
-import { Y as md, g as yd, c as bd, n as jo, F as Wo, H as wd, x as Sd, D as Dd, M as vd, a as Fd } from "./chunks/super-editor.es-CjnJi9EI.es.js";
-import { O as Ib, X as Cb, R as fb } from "./chunks/super-editor.es-CjnJi9EI.es.js";
+import { Y as md, g as yd, c as bd, n as jo, F as Wo, H as wd, x as Sd, D as Dd, M as vd, a as Fd } from "./chunks/super-editor.es-CfOoZR7Y.es.js";
+import { O as Ib, X as Cb, R as fb } from "./chunks/super-editor.es-CfOoZR7Y.es.js";
 import { Y as Vl, r as W, Z as ui, p as Ge, _ as Vn, a as ae, $ as zn, a0 as ua, D as dt, i as ht, q as ji, l as wt, y as Fe, a1 as kd, N as Zt, u as qt, a2 as xd, a3 as Rd, a4 as Xo, g as Ji, K as Us, O as jr, j as Ii, k as Di, h as da, U as Nd, s as Md, A as Wr, F as jt, R as GA, m as Ct, E as mi, I as ms, C as re, V as Ld, S as Gd, W as Td, J as qi, P as Es, G as ar, Q as Ud, H as Hd, T as Pd, b as ye, o as fe, t as yi, x as bi, z as zl, f as We, B as ri, e as Ze, v as hi, w as Qi, n as Xs, a5 as Zl, d as gn, c as $l, X as Od, a6 as Jd } from "./chunks/vue-DKS68Dra.es.js";
 import { B as qn } from "./chunks/jszip-OpmRHhd4.es.js";
 import { B as Yd } from "./chunks/blank-docx-BRvkcuiv.es.js";
@@ -32651,9 +32651,14 @@ const yy = ["innerHTML"], by = { class: "superdoc__document document" }, wy = {
 class hb extends eg {
   /** @type {Array<string>} */
   static allowedTypes = [on, Ia, TA];
-  /** @type {number} */
+  /** @type {string} */
   version;
+  /** @type {User[]} */
   users;
+  /** @type {import('yjs').Doc | undefined} */
+  ydoc;
+  /** @type {import('@hocuspocus/provider').HocuspocusProvider | undefined} */
+  provider;
   /** @type {Config} */
   config = {
     superdocId: null,
@@ -32673,7 +32678,6 @@ class hb extends eg {
     conversations: [],
     pagination: !1,
     // Optional: Whether to show pagination in SuperEditors
-    isCollaborative: !1,
     isInternal: !1,
     // toolbar config
     toolbar: null,
@@ -32713,8 +32717,12 @@ class hb extends eg {
     this.config = {
       ...this.config,
       ...t
-    }, this.config.colors = NI(this.config.colors), this.userColorMap = /* @__PURE__ */ new Map(), this.colorIndex = 0, this.version = "0.11.37", console.debug("🦋 [superdoc] Using SuperDoc version:", this.version), this.superdocId = t.superdocId || ig(), this.colors = this.config.colors, this.#t(), await this.#r(this.config.modules), this.#i(), this.#s(), this.user = this.config.user, this.users = this.config.users || [], this.socket = null, this.isDev = this.config.isDev || !1, this.activeEditor = null, this.comments = [], this.app.mount(this.config.selector), this.readyEditors = 0, this.isLocked = this.config.isLocked || !1, this.lockedBy = this.config.lockedBy || null, this.#a(this);
+    }, this.config.colors = NI(this.config.colors), this.userColorMap = /* @__PURE__ */ new Map(), this.colorIndex = 0, this.version = "0.11.39", console.debug("🦋 [superdoc] Using SuperDoc version:", this.version), this.superdocId = t.superdocId || ig(), this.colors = this.config.colors, this.#t(), await this.#r(this.config.modules), this.#i(), this.#s(), this.user = this.config.user, this.users = this.config.users || [], this.socket = null, this.isDev = this.config.isDev || !1, this.activeEditor = null, this.comments = [], this.app.mount(this.config.selector), this.readyEditors = 0, this.isLocked = this.config.isLocked || !1, this.lockedBy = this.config.lockedBy || null, this.#a();
   }
+  /**
+   * Get the number of editors that are required for this superdoc
+   * @returns {number} The number of required editors
+   */
   get requiredNumberOfEditors() {
     return this.superdocStore.documents.filter((t) => t.type === on).length;
   }
@@ -32744,7 +32752,7 @@ class hb extends eg {
   }
   #i() {
     const { app: t, pinia: i, superdocStore: r, commentsStore: A } = Fy();
-    this.app = t, this.pinia = i, this.app.config.globalProperties.$config = this.config, this.app.config.globalProperties.$documentMode = this.config.documentMode, this.app.config.globalProperties.$superdoc = this, this.superdocStore = r, this.commentsStore = A, this.version = this.config.version, this.superdocStore.init(this.config), this.commentsStore.init(this.config.modules.comments);
+    this.app = t, this.pinia = i, this.app.config.globalProperties.$config = this.config, this.app.config.globalProperties.$documentMode = this.config.documentMode, this.app.config.globalProperties.$superdoc = this, this.superdocStore = r, this.commentsStore = A, this.superdocStore.init(this.config), this.commentsStore.init(this.config.modules.comments);
   }
   #s() {
     this.on("editorBeforeCreate", this.config.onEditorBeforeCreate), this.on("editorCreate", this.config.onEditorCreate), this.on("editorDestroy", this.config.onEditorDestroy), this.on("ready", this.config.onReady), this.on("comments-update", this.config.onCommentsUpdate), this.on("awareness-update", this.config.onAwarenessUpdate), this.on("locked", this.config.onLocked), this.on("pdf-document-ready", this.config.onPdfDocumentReady), this.on("sidebar-toggle", this.config.onSidebarToggle), this.on("collaboration-ready", this.config.onCollaborationReady), this.on("editor-update", this.config.onEditorUpdate), this.on("content-error", this.onContentError), this.on("exception", this.config.onException);
@@ -32761,7 +32769,6 @@ class hb extends eg {
   }
   /**
    * Add a user to the shared users list
-   * 
    * @param {Object} user The user to add
    * @returns {void}
    */
@@ -32770,7 +32777,6 @@ class hb extends eg {
   }
   /**
    * Remove a user from the shared users list
-   * 
    * @param {String} email The email of the user to remove
    * @returns {void}
    */
@@ -32789,31 +32795,68 @@ class hb extends eg {
       superdocVersion: this.version
     });
   }
+  /**
+   * Triggered when there is an error in the content
+   * @param {Object} param0
+   * @param {Error} param0.error The error that occurred
+   * @param {Editor} param0.editor The editor that caused the error
+   */
   onContentError({ error: t, editor: i }) {
     const { documentId: r } = i.options, A = this.superdocStore.documents.find((c) => c.id === r);
     this.config.onContentError({ error: t, editor: i, documentId: A.id, file: A.data });
   }
+  /**
+   * Triggered when the PDF document is ready
+   * @returns {void}
+   */
   broadcastPdfDocumentReady() {
     this.emit("pdf-document-ready");
   }
+  /**
+   * Triggered when the superdoc is ready
+   * @returns {void}
+   */
   broadcastReady() {
     this.readyEditors === this.requiredNumberOfEditors && this.emit("ready", { superdoc: this });
   }
+  /**
+   * Triggered before an editor is created
+   * @param {Editor} editor The editor that is about to be created
+   * @returns {void}
+   */
   broadcastEditorBeforeCreate(t) {
     this.emit("editorBeforeCreate", { editor: t });
   }
+  /**
+   * Triggered when an editor is created
+   * @param {Editor} editor The editor that was created
+   * @returns {void}
+   */
   broadcastEditorCreate(t) {
     this.readyEditors++, this.broadcastReady(), this.emit("editorCreate", { editor: t });
   }
+  /**
+   * Triggered when an editor is destroyed
+   * @returns {void}
+   */
   broadcastEditorDestroy() {
     this.emit("editorDestroy");
   }
+  /**
+   * Triggered when the comments sidebar is toggled
+   * @param {boolean} isOpened 
+   */
   broadcastSidebarToggle(t) {
     this.emit("sidebar-toggle", t);
   }
   log(...t) {
     console.debug("🦋 🦸‍♀️ [superdoc]", ...t);
   }
+  /**
+   * Set the active editor
+   * @param {Editor} editor The editor to set as active
+   * @returns {void}
+   */
   setActiveEditor(t) {
     this.activeEditor = t, this.toolbar && this.toolbar.setActiveEditor(t);
   }
@@ -32847,15 +32890,36 @@ class hb extends eg {
       this.emit("ai-highlight", { type: r, data: A });
     }), this.once("editorCreate", () => this.toolbar.updateToolbarState());
   }
+  /**
+   * Add a comments list to the superdoc
+   * Requires the comments module to be enabled
+   * @param {Element} element The DOM element to render the comments list in
+   * @returns {void}
+   */
   addCommentsList(t) {
     !this.config?.modules?.comments || this.config.role === "viewer" || (console.debug("🦋 [superdoc] Adding comments list to:", t), t && (this.config.modules.comments.element = t), this.commentsList = new Em(this.config.modules?.comments, this), this.config.onCommentsListChange && this.config.onCommentsListChange({ isRendered: !0 }));
   }
+  /**
+   * Remove the comments list from the superdoc
+   * @returns {void}
+   */
   removeCommentsList() {
     this.commentsList && (this.commentsList.close(), this.commentsList = null, this.config.onCommentsListChange && this.config.onCommentsListChange({ isRendered: !1 }));
   }
+  /**
+   * Triggered when a toolbar command is executed
+   * @param {Object} param0
+   * @param {Object} param0.item The toolbar item that was clicked
+   * @param {string} param0.argument The argument passed to the command
+   */
   onToolbarCommand({ item: t, argument: i }) {
     t.command === "setDocumentMode" ? this.setDocumentMode(i) : t.command === "setZoom" && (this.superdocStore.activeZoom = i);
   }
+  /**
+   * Set the document mode.
+   * @param {DocumentMode} type
+   * @returns {void}
+   */
   setDocumentMode(t) {
     if (!t) return;
     t = t.toLowerCase(), this.config.documentMode = t;
@@ -32897,9 +32961,19 @@ class hb extends eg {
       i && i.setDocumentMode("viewing");
     }), this.toolbar && (this.toolbar.documentMode = "viewing", this.toolbar.updateToolbarState());
   }
+  /**
+   * Search for text or regex in the active editor
+   * @param {string | RegExp} text The text or regex to search for
+   * @returns {Object[]} The search results
+   */
   search(t) {
     return this.activeEditor?.commands.search(t);
   }
+  /**
+   * Go to the next search result
+   * @param {Object} match The match object
+   * @returns {void}
+   */
   goToSearchResult(t) {
     return this.activeEditor?.commands.goToSearchResult(t);
   }
@@ -32915,6 +32989,10 @@ class hb extends eg {
       });
     });
   }
+  /**
+   * Get the HTML content of all editors
+   * @returns {Array<string>} The HTML content of all editors
+   */
   getHTML() {
     const t = [];
     return this.superdocStore.documents.forEach((i) => {
@@ -32933,6 +33011,17 @@ class hb extends eg {
 
 `), this.emit("locked", { isLocked: t, lockedBy: i });
   }
+  /**
+   * Export the superdoc to a file
+   * @param {Object} params
+   * @param {string[]} [params.exportType]
+   * @param {string} [params.commentsType]
+   * @param {string} [params.exportedName]
+   * @param {Array} [params.additionalFiles]
+   * @param {Array} [params.additionalFileNames]
+   * @param {boolean} [params.isFinalDoc]
+   * @returns {Promise<void>} The exported file
+   */
   async export({
     exportType: t = ["docx"],
     commentsType: i,
@@ -32951,6 +33040,11 @@ class hb extends eg {
       Wl(m, u, "zip");
     }
   }
+  /**
+   * Export editors to DOCX format.
+   * @param {{ commentsType?: string, isFinalDoc?: boolean }} [options]
+   * @returns {Promise<Array<Blob>>}
+   */
   async exportEditorsToDOCX({ commentsType: t, isFinalDoc: i } = {}) {
     const r = [];
     t !== "clean" && r.push(...this.commentsStore?.translateCommentsForExport());
@@ -32977,6 +33071,10 @@ class hb extends eg {
       });
     });
   }
+  /**
+   * Save the superdoc if in collaboration mode
+   * @returns {Promise<void[]>} Resolves when all documents have saved
+   */
   async save() {
     const t = [
       this.#h()
@@ -32986,10 +33084,14 @@ class hb extends eg {
     const i = await Promise.all(t);
     return console.debug("🦋 [superdoc] Save complete:", i), i;
   }
+  /**
+   * Destroy the superdoc instance
+   * @returns {void}
+   */
   destroy() {
     this.app && (this.log("[superdoc] Unmounting app"), this.config.socket?.cancelWebsocketRetry(), this.config.socket?.disconnect(), this.config.socket?.destroy(), this.ydoc?.destroy(), this.provider?.disconnect(), this.provider?.destroy(), this.config.documents.forEach((t) => {
       t.provider && (t.provider.disconnect(), t.provider.destroy()), t.ydoc?.destroy();
-    }), this.superdocStore.reset(), this.telemetry?.destroy(), this.app.unmount(), this.removeAllListeners(), delete this.app.config.globalProperties.$config, delete this.app.config.globalProperties.$superdoc);
+    }), this.superdocStore.reset(), this.app.unmount(), this.removeAllListeners(), delete this.app.config.globalProperties.$config, delete this.app.config.globalProperties.$superdoc);
   }
   /**
    * Focus the active editor or the first editor in the superdoc

package/dist/superdoc.umd.js

@@ -24155,7 +24155,7 @@ Actual: ` + p3.attribValue
         return;
       }
     }
-    static updateDocumentVersion(e = this.convertedXml, t = "0.11.37") {
+    static updateDocumentVersion(e = this.convertedXml, t = "0.11.39") {
       const n = "docProps/custom.xml";
       e[n] || (e[n] = Fu$2());
       const i3 = e["docProps/custom.xml"];
@@ -24418,7 +24418,7 @@ Actual: ` + p3.attribValue
   function Fu$2() {
     return Gf$1;
   }
-  function Bu$2(r22 = 2, e = "0.11.37") {
+  function Bu$2(r22 = 2, e = "0.11.39") {
     return {
       type: "element",
       name: "property",
@@ -37216,7 +37216,7 @@ Actual: ` + p3.attribValue
      * @returns {Object | void} Migration results
      */
     processCollaborationMigrations() {
-      if (console.debug("[checkVersionMigrations] Current editor version", "0.11.37"), !this.options.ydoc) return;
+      if (console.debug("[checkVersionMigrations] Current editor version", "0.11.39"), !this.options.ydoc) return;
       let r = this.options.ydoc.getMap("meta").get("version");
       r || (r = "initial"), console.debug("[checkVersionMigrations] Document version", r);
       const o = hl$1(r) || [], s = this.state.plugins.find((c3) => c3.key.startsWith("y-sync"));
@@ -71426,9 +71426,14 @@ ${style2}
   class SuperDoc extends EventEmitter {
     /** @type {Array<string>} */
     static allowedTypes = [DOCX, PDF, HTML];
-    /** @type {number} */
+    /** @type {string} */
     version;
+    /** @type {User[]} */
     users;
+    /** @type {import('yjs').Doc | undefined} */
+    ydoc;
+    /** @type {import('@hocuspocus/provider').HocuspocusProvider | undefined} */
+    provider;
     /** @type {Config} */
     config = {
       superdocId: null,
@@ -71448,7 +71453,6 @@ ${style2}
       conversations: [],
       pagination: false,
       // Optional: Whether to show pagination in SuperEditors
-      isCollaborative: false,
       isInternal: false,
       // toolbar config
       toolbar: null,
@@ -71493,7 +71497,7 @@ ${style2}
       this.config.colors = shuffleArray(this.config.colors);
       this.userColorMap = /* @__PURE__ */ new Map();
       this.colorIndex = 0;
-      this.version = "0.11.37";
+      this.version = "0.11.39";
       console.debug("🦋 [superdoc] Using SuperDoc version:", this.version);
       this.superdocId = config.superdocId || v4();
       this.colors = this.config.colors;
@@ -71511,8 +71515,12 @@ ${style2}
       this.readyEditors = 0;
       this.isLocked = this.config.isLocked || false;
       this.lockedBy = this.config.lockedBy || null;
-      this.#addToolbar(this);
+      this.#addToolbar();
     }
+    /**
+     * Get the number of editors that are required for this superdoc
+     * @returns {number} The number of required editors
+     */
     get requiredNumberOfEditors() {
       return this.superdocStore.documents.filter((d) => d.type === DOCX).length;
     }
@@ -71562,7 +71570,6 @@ ${style2}
       this.app.config.globalProperties.$superdoc = this;
       this.superdocStore = superdocStore;
       this.commentsStore = commentsStore;
-      this.version = this.config.version;
       this.superdocStore.init(this.config);
       this.commentsStore.init(this.config.modules.comments);
     }
@@ -71598,7 +71605,6 @@ ${style2}
     }
     /**
      * Add a user to the shared users list
-     * 
      * @param {Object} user The user to add
      * @returns {void}
      */
@@ -71608,7 +71614,6 @@ ${style2}
     }
     /**
      * Remove a user from the shared users list
-     * 
      * @param {String} email The email of the user to remove
      * @returns {void}
      */
@@ -71627,36 +71632,73 @@ ${style2}
         superdocVersion: this.version
       });
     }
+    /**
+     * Triggered when there is an error in the content
+     * @param {Object} param0
+     * @param {Error} param0.error The error that occurred
+     * @param {Editor} param0.editor The editor that caused the error
+     */
     onContentError({ error, editor }) {
       const { documentId } = editor.options;
       const doc2 = this.superdocStore.documents.find((d) => d.id === documentId);
       this.config.onContentError({ error, editor, documentId: doc2.id, file: doc2.data });
     }
+    /**
+     * Triggered when the PDF document is ready
+     * @returns {void}
+     */
     broadcastPdfDocumentReady() {
       this.emit("pdf-document-ready");
     }
+    /**
+     * Triggered when the superdoc is ready
+     * @returns {void}
+     */
     broadcastReady() {
       if (this.readyEditors === this.requiredNumberOfEditors) {
         this.emit("ready", { superdoc: this });
       }
     }
+    /**
+     * Triggered before an editor is created
+     * @param {Editor} editor The editor that is about to be created
+     * @returns {void}
+     */
     broadcastEditorBeforeCreate(editor) {
       this.emit("editorBeforeCreate", { editor });
     }
+    /**
+     * Triggered when an editor is created
+     * @param {Editor} editor The editor that was created
+     * @returns {void}
+     */
     broadcastEditorCreate(editor) {
       this.readyEditors++;
       this.broadcastReady();
       this.emit("editorCreate", { editor });
     }
+    /**
+     * Triggered when an editor is destroyed
+     * @returns {void}
+     */
     broadcastEditorDestroy() {
       this.emit("editorDestroy");
     }
+    /**
+     * Triggered when the comments sidebar is toggled
+     * @param {boolean} isOpened 
+     */
     broadcastSidebarToggle(isOpened) {
       this.emit("sidebar-toggle", isOpened);
     }
     log(...args) {
       console.debug("🦋 🦸‍♀️ [superdoc]", ...args);
     }
+    /**
+     * Set the active editor
+     * @param {Editor} editor The editor to set as active
+     * @returns {void}
+     */
     setActiveEditor(editor) {
       this.activeEditor = editor;
       if (this.toolbar) this.toolbar.setActiveEditor(editor);
@@ -71696,6 +71738,12 @@ ${style2}
       });
       this.once("editorCreate", () => this.toolbar.updateToolbarState());
     }
+    /**
+     * Add a comments list to the superdoc
+     * Requires the comments module to be enabled
+     * @param {Element} element The DOM element to render the comments list in
+     * @returns {void}
+     */
     addCommentsList(element) {
       if (!this.config?.modules?.comments || this.config.role === "viewer") return;
       console.debug("🦋 [superdoc] Adding comments list to:", element);
@@ -71703,6 +71751,10 @@ ${style2}
       this.commentsList = new SuperComments(this.config.modules?.comments, this);
       if (this.config.onCommentsListChange) this.config.onCommentsListChange({ isRendered: true });
     }
+    /**
+     * Remove the comments list from the superdoc
+     * @returns {void}
+     */
     removeCommentsList() {
       if (this.commentsList) {
         this.commentsList.close();
@@ -71710,6 +71762,12 @@ ${style2}
         if (this.config.onCommentsListChange) this.config.onCommentsListChange({ isRendered: false });
       }
     }
+    /**
+     * Triggered when a toolbar command is executed
+     * @param {Object} param0
+     * @param {Object} param0.item The toolbar item that was clicked
+     * @param {string} param0.argument The argument passed to the command
+     */
     onToolbarCommand({ item, argument }) {
       if (item.command === "setDocumentMode") {
         this.setDocumentMode(argument);
@@ -71717,6 +71775,11 @@ ${style2}
         this.superdocStore.activeZoom = argument;
       }
     }
+    /**
+     * Set the document mode.
+     * @param {DocumentMode} type
+     * @returns {void}
+     */
     setDocumentMode(type) {
       if (!type) return;
       type = type.toLowerCase();
@@ -71772,9 +71835,19 @@ ${style2}
         this.toolbar.updateToolbarState();
       }
     }
+    /**
+     * Search for text or regex in the active editor
+     * @param {string | RegExp} text The text or regex to search for
+     * @returns {Object[]} The search results
+     */
     search(text) {
       return this.activeEditor?.commands.search(text);
     }
+    /**
+     * Go to the next search result
+     * @param {Object} match The match object
+     * @returns {void}
+     */
     goToSearchResult(match) {
       return this.activeEditor?.commands.goToSearchResult(match);
     }
@@ -71791,6 +71864,10 @@ ${style2}
         });
       });
     }
+    /**
+     * Get the HTML content of all editors
+     * @returns {Array<string>} The HTML content of all editors
+     */
     getHTML() {
       const editors = [];
       this.superdocStore.documents.forEach((doc2) => {
@@ -71812,6 +71889,17 @@ ${style2}
       console.debug("🦋 [superdoc] Locking superdoc:", isLocked, lockedBy, "\n\n\n");
       this.emit("locked", { isLocked, lockedBy });
     }
+    /**
+     * Export the superdoc to a file
+     * @param {Object} params
+     * @param {string[]} [params.exportType]
+     * @param {string} [params.commentsType]
+     * @param {string} [params.exportedName]
+     * @param {Array} [params.additionalFiles]
+     * @param {Array} [params.additionalFileNames]
+     * @param {boolean} [params.isFinalDoc]
+     * @returns {Promise<void>} The exported file
+     */
     async export({
       exportType = ["docx"],
       commentsType,
@@ -71837,6 +71925,11 @@ ${style2}
         createDownload(zip, baseFileName, "zip");
       }
     }
+    /**
+     * Export editors to DOCX format.
+     * @param {{ commentsType?: string, isFinalDoc?: boolean }} [options]
+     * @returns {Promise<Array<Blob>>}
+     */
     async exportEditorsToDOCX({ commentsType, isFinalDoc } = {}) {
       const comments = [];
       if (commentsType !== "clean") {
@@ -71876,6 +71969,10 @@ ${style2}
         });
       });
     }
+    /**
+     * Save the superdoc if in collaboration mode
+     * @returns {Promise<void[]>} Resolves when all documents have saved
+     */
     async save() {
       const savePromises = [
         this.#triggerCollaborationSaves()
@@ -71886,6 +71983,10 @@ ${style2}
       console.debug("🦋 [superdoc] Save complete:", result);
       return result;
     }
+    /**
+     * Destroy the superdoc instance
+     * @returns {void}
+     */
     destroy() {
       if (!this.app) {
         return;
@@ -71905,7 +72006,6 @@ ${style2}
         doc2.ydoc?.destroy();
       });
       this.superdocStore.reset();
-      this.telemetry?.destroy();
       this.app.unmount();
       this.removeAllListeners();
       delete this.app.config.globalProperties.$config;