superdoc 2.28.0-next.6 → 2.28.0-next.7

package/dist/superdoc.cjs

@@ -1,7 +1,7 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_rolldown_runtime = require("./chunks/rolldown-runtime-74VwNCz7.cjs");
 const require_blank_docx = require("./chunks/blank-docx-BuFAbRjs.cjs");
-const require_create_super_doc_ui = require("./chunks/create-super-doc-ui-D1eOhAjv.cjs");
+const require_create_super_doc_ui = require("./chunks/create-super-doc-ui-B4c55pFy.cjs");
 const require_eventemitter3 = require("./chunks/eventemitter3-C_TAnXOl.cjs");
 const require_uuid = require("./chunks/uuid-BhG0ngwk.cjs");
 const require__plugin_vue_export_helper = require("./chunks/_plugin-vue_export-helper-BUdjGKyl.cjs");
@@ -260,7 +260,7 @@ var v_click_outside_default = {
 var DEFAULT_ENDPOINT = "https://ingest.superdoc.dev/v1/collect";
 function getSuperdocVersion() {
 	try {
-		return "2.28.0-next.6";
+		return "2.28.0-next.7";
 	} catch {
 		return "unknown";
 	}
@@ -7756,6 +7756,7 @@ var useCommentsStore = defineStore("comments", () => {
 	const instantSidebarAlignmentInstanceId = require__plugin_vue_export_helper.ref(null);
 	const pendingComment = require__plugin_vue_export_helper.ref(null);
 	const pendingV2CommentTarget = require__plugin_vue_export_helper.shallowRef(null);
+	let pendingCommentRequest = 0;
 	const isViewingMode = require__plugin_vue_export_helper.computed(() => viewingVisibility.documentMode === "viewing");
 	const shouldRenderReviewInViewing = require__plugin_vue_export_helper.computed(() => {
 		if (!isViewingMode.value) return true;
@@ -7763,6 +7764,7 @@ var useCommentsStore = defineStore("comments", () => {
 	});
 	const v2CommentsAdapter = require__plugin_vue_export_helper.shallowRef(null);
 	const setV2CommentsAdapter = (adapter) => {
+		if (v2CommentsAdapter.value !== (adapter ?? null)) pendingCommentRequest += 1;
 		v2CommentsAdapter.value = adapter ?? null;
 	};
 	const getV2CommentsAdapter = (superdoc) => {
@@ -8621,26 +8623,41 @@ var useCommentsStore = defineStore("comments", () => {
 		}
 		if (typeof currentSelection !== "function") return null;
 		try {
-			return currentSelection();
+			const snapshot = currentSelection();
+			return typeof snapshot?.then === "function" ? Promise.resolve(snapshot).catch(() => null) : snapshot;
 		} catch {
 			return null;
 		}
 	};
 	const showAddComment = (superdoc, targetClientY = null) => {
+		const request = ++pendingCommentRequest;
+		const editor = superdoc?.activeEditor;
 		const v2Adapter = getV2CommentsAdapter(superdoc);
-		const pendingSelection = getPendingSelectionSnapshot(superdoc, superdocStore.activeSelection);
-		const event = {
-			type: COMMENT_EVENTS.PENDING,
-			pendingSelection
+		const ownsRequest = () => pendingCommentRequest === request;
+		const emitPending = (snapshot) => {
+			if (!ownsRequest()) return;
+			superdoc.emit("comments-update", {
+				type: COMMENT_EVENTS.PENDING,
+				pendingSelection: superdoc?.activeEditor === editor ? snapshot : null
+			});
 		};
-		superdoc.emit("comments-update", event);
 		if (v2Adapter) {
 			const cap = v2Adapter.getCapabilityState?.();
 			if (cap && cap.canWrite === false) return {
 				ok: false,
 				reason: cap.reason
 			};
-			return Promise.resolve(v2Adapter.captureCurrentSelection?.()).then((capture) => {
+			return Promise.resolve(v2Adapter.captureCurrentSelection?.({ beforeReady: (snapshot) => {
+				if (superdoc?.activeEditor === editor && getV2CommentsAdapter(superdoc) === v2Adapter) emitPending(snapshot);
+			} })).then((capture) => {
+				if (!ownsRequest()) return {
+					ok: false,
+					reason: "pending-comment-superseded"
+				};
+				if (superdoc?.activeEditor !== editor || getV2CommentsAdapter(superdoc) !== v2Adapter) return {
+					ok: false,
+					reason: "document-replaced"
+				};
 				if (!capture?.ok) return {
 					ok: false,
 					reason: capture?.reason ?? "editing-range-required",
@@ -8669,25 +8686,52 @@ var useCommentsStore = defineStore("comments", () => {
 				detail: err?.message ?? String(err)
 			}));
 		}
-		const selection = { ...superdocStore.activeSelection };
-		selection.selectionBounds = { ...selection.selectionBounds };
-		if (superdocStore.selectionPosition?.source && superdocStore.selectionPosition.source !== "pdf") superdocStore.selectionPosition.source = null;
-		pendingComment.value = getPendingComment({
-			selection,
-			documentId: selection.documentId,
-			parentCommentId: null
-		});
-		if (!superdoc.config.isInternal) pendingComment.value.isInternal = false;
-		if (superdoc.activeEditor?.commands) superdoc.activeEditor.commands.insertComment({
-			...pendingComment.value.getValues(),
-			commentId: "pending",
-			skipEmit: true
-		});
-		if (pendingComment.value.selection.source === "document-editor" && superdocStore.selectionPosition) superdocStore.selectionPosition.source = DOCUMENT_EDITOR_SELECTION_SOURCE;
-		requestInstantSidebarAlignment(targetClientY, "pending");
-		setActiveFloatingCommentInstance(null);
-		activeComment.value = pendingComment.value.commentId;
-		return { ok: true };
+		const pendingSelection = getPendingSelectionSnapshot(superdoc, superdocStore.activeSelection);
+		const asyncSnapshot = typeof pendingSelection?.then === "function";
+		if (!asyncSnapshot) emitPending(pendingSelection);
+		const showLegacyPending = (selection) => {
+			selection.selectionBounds = { ...selection.selectionBounds };
+			if (superdocStore.selectionPosition?.source && superdocStore.selectionPosition.source !== "pdf") superdocStore.selectionPosition.source = null;
+			pendingComment.value = getPendingComment({
+				selection,
+				documentId: selection.documentId,
+				parentCommentId: null
+			});
+			if (!superdoc.config.isInternal) pendingComment.value.isInternal = false;
+			if (superdoc.activeEditor?.commands) superdoc.activeEditor.commands.insertComment({
+				...pendingComment.value.getValues(),
+				commentId: "pending",
+				skipEmit: true
+			});
+			if (pendingComment.value.selection.source === "document-editor" && superdocStore.selectionPosition) superdocStore.selectionPosition.source = DOCUMENT_EDITOR_SELECTION_SOURCE;
+			requestInstantSidebarAlignment(targetClientY, "pending");
+			setActiveFloatingCommentInstance(null);
+			activeComment.value = pendingComment.value.commentId;
+			return { ok: true };
+		};
+		if (asyncSnapshot) {
+			const selection = { ...superdocStore.activeSelection };
+			selection.selectionBounds = { ...selection.selectionBounds };
+			return pendingSelection.then((snapshot) => {
+				if (!ownsRequest()) return {
+					ok: false,
+					reason: "pending-comment-superseded"
+				};
+				emitPending(snapshot);
+				if (!ownsRequest()) return {
+					ok: false,
+					reason: "pending-comment-superseded"
+				};
+				return superdoc?.activeEditor === editor ? showLegacyPending(selection) : {
+					ok: false,
+					reason: "document-replaced"
+				};
+			});
+		}
+		return ownsRequest() ? showLegacyPending({ ...superdocStore.activeSelection }) : {
+			ok: false,
+			reason: "pending-comment-superseded"
+		};
 	};
 	/**
 	* Get the numeric position value for sorting a comment by document order.
@@ -8842,7 +8886,7 @@ var useCommentsStore = defineStore("comments", () => {
 	*
 	* @returns {void}
 	*/
-	const removePendingComment = (superdoc) => {
+	const resetPendingCommentState = (superdoc, clearViewingSelection = true) => {
 		const hadPending = !!pendingComment.value;
 		currentCommentText.value = "";
 		currentCommentMentions.value = [];
@@ -8851,13 +8895,17 @@ var useCommentsStore = defineStore("comments", () => {
 		superdocStore.selectionPosition = null;
 		if (hadPending) clearActiveCommentSelection();
 		if (isV2EditorActive(superdoc)) {
-			if (hadPending && isViewingMode.value) try {
+			if (hadPending && clearViewingSelection && isViewingMode.value) try {
 				superdoc?.activeEditor?.host?.getHandles?.()?.selection?.clear?.();
 			} catch {}
 			return;
 		}
 		superdoc?.activeEditor?.commands?.removeComment({ commentId: "pending" });
 	};
+	const removePendingComment = (superdoc) => {
+		pendingCommentRequest += 1;
+		resetPendingCommentState(superdoc);
+	};
 	const getV2CreatedComment = ({ outcome, reconciled, documentId }) => {
 		const createdId = normalizeCommentId(outcome?.createdCommentId);
 		if (!createdId) return reconciled?.added ?? null;
@@ -8875,6 +8923,7 @@ var useCommentsStore = defineStore("comments", () => {
 		const v2Adapter = !skipEditorUpdate && !isHydration ? getV2CommentsAdapter(superdoc) : null;
 		if (v2Adapter && !comment.trackedChange) {
 			const submittedPendingComment = pendingComment.value;
+			const submittedPendingRequest = pendingCommentRequest;
 			const text = normalizeV2CommentDraftText(submittedPendingComment ? currentCommentText.value : comment.commentText);
 			const mentions = pendingComment.value ? currentCommentMentions.value : comment.mentions ?? [];
 			const target = pendingComment.value ? pendingV2CommentTarget.value : null;
@@ -8923,9 +8972,11 @@ var useCommentsStore = defineStore("comments", () => {
 					documentId: v2Adapter.documentId
 				});
 				const hadPendingComment = submittedPendingComment != null && pendingComment.value?.commentId === submittedPendingComment.commentId;
-				if (hadPendingComment) removePendingComment(superdoc);
+				const ownsSubmittedRequest = pendingCommentRequest === submittedPendingRequest;
+				if (hadPendingComment) if (ownsSubmittedRequest) removePendingComment(superdoc);
+				else resetPendingCommentState(superdoc, false);
 				const createdId = created?.commentId ?? null;
-				if (hadPendingComment && createdId) {
+				if (hadPendingComment && ownsSubmittedRequest && createdId) {
 					setActiveComment(superdoc, createdId);
 					setActiveFloatingCommentInstance(createdId);
 				}
@@ -13521,6 +13572,7 @@ var _sfc_main$33 = {
 			};
 		};
 		const CLICK_OUTSIDE_IGNORED_SELECTORS = [
+			".superdoc__tools [data-id=\"is-tool\"]",
 			".comments-dropdown__option-label",
 			".comments-dropdown__menu",
 			".comments-dropdown__option",
@@ -14643,7 +14695,7 @@ var _sfc_main$33 = {
 		};
 	}
 };
-var CommentDialog_default = /*#__PURE__*/ require__plugin_vue_export_helper._plugin_vue_export_helper_default(_sfc_main$33, [["__scopeId", "data-v-05d27982"]]);
+var CommentDialog_default = /*#__PURE__*/ require__plugin_vue_export_helper._plugin_vue_export_helper_default(_sfc_main$33, [["__scopeId", "data-v-f8b79c74"]]);
 //#endregion
 //#region src/components/CommentsLayer/commentsList/ReviewDirectoryListItem.vue
 var _hoisted_1$25 = [
@@ -15368,6 +15420,80 @@ var composeAuthorColorResolver = (config) => {
 	};
 };
 //#endregion
+//#region ../document-api/src/errors.ts
+/**
+* Structured validation error thrown by document-api execute* functions.
+*
+* Consumers should prefer checking `error.code` over `instanceof` for resilience
+* across package boundaries and bundling scenarios.
+*/
+var DocumentApiValidationError = class DocumentApiValidationError extends Error {
+	constructor(code, message, details) {
+		super(message);
+		this.name = "DocumentApiValidationError";
+		this.code = code;
+		this.details = details;
+		Object.setPrototypeOf(this, DocumentApiValidationError.prototype);
+	}
+};
+//#endregion
+//#region ../document-api/src/export/export.types.ts
+/** Canonical tracked-change export modes accepted by every public export surface. */
+var SD_EXPORT_MODES = [
+	"review-preserving",
+	"final",
+	"original"
+];
+/** Default mode for modeful DOCX export. */
+var DEFAULT_SD_EXPORT_MODE = "review-preserving";
+var SD_COMMENT_EXPORT_POLICIES = [
+	"preserve",
+	"resolve",
+	"remove"
+];
+var SD_CONTENT_CONTROL_EXPORT_POLICIES = ["preserve", "flatten"];
+//#endregion
+//#region ../document-api/src/export/export.ts
+/**
+* Export namespace: engine-agnostic public API and adapter contract.
+*
+* Validates the requested mode at the public boundary so an invalid mode fails
+* closed with `INVALID_INPUT` before any document work happens, then delegates
+* byte production and degradation reporting to the engine adapter.
+*/
+function resolveMode$1(input) {
+	if (input != null && !require_create_super_doc_ui.isRecord(input)) throw new DocumentApiValidationError("INVALID_INPUT", "export.toDocx input must be an object.");
+	const raw = input?.mode;
+	if (raw === void 0) return DEFAULT_SD_EXPORT_MODE;
+	if (typeof raw !== "string" || !SD_EXPORT_MODES.includes(raw)) throw new DocumentApiValidationError("INVALID_INPUT", `export.toDocx mode must be one of: ${SD_EXPORT_MODES.join(", ")}.`, {
+		mode: raw,
+		allowedModes: [...SD_EXPORT_MODES]
+	});
+	return raw;
+}
+function resolveDocxExportPolicies(input = {}) {
+	if (!require_create_super_doc_ui.isRecord(input)) throw new DocumentApiValidationError("INVALID_INPUT", "DOCX export input must be an object.");
+	const mode = resolveMode$1(input);
+	const policies = input.policies;
+	if (policies !== void 0 && !require_create_super_doc_ui.isRecord(policies)) throw new DocumentApiValidationError("INVALID_INPUT", "DOCX export policies must be an object.");
+	const allowed = {
+		trackedChanges: SD_EXPORT_MODES,
+		comments: SD_COMMENT_EXPORT_POLICIES,
+		contentControls: SD_CONTENT_CONTROL_EXPORT_POLICIES
+	};
+	for (const [key, value] of Object.entries(policies ?? {})) if (!Object.prototype.hasOwnProperty.call(allowed, key) || value !== void 0 && !allowed[key].includes(value)) throw new DocumentApiValidationError("INVALID_INPUT", `Unsupported DOCX export policy: ${key}.`, {
+		policy: key,
+		value
+	});
+	const requested = policies;
+	if (input.mode !== void 0 && requested?.trackedChanges !== void 0 && mode !== requested.trackedChanges) throw new DocumentApiValidationError("INVALID_INPUT", "mode conflicts with policies.trackedChanges.");
+	return {
+		trackedChanges: requested?.trackedChanges ?? mode,
+		comments: requested?.comments ?? "preserve",
+		contentControls: requested?.contentControls ?? "preserve"
+	};
+}
+//#endregion
 //#region ../document-api/src/permission-ranges/permission-ranges.ts
 function editorKey(editor) {
 	return editor.id?.trim() ? editor.id : editor.email?.trim() || void 0;
@@ -20127,6 +20253,28 @@ function useLinkPopover({ getSurfaceManager, getActiveEditor, getUi, getActivati
 	};
 }
 //#endregion
+//#region src/core/helpers/resolve-docx-export.ts
+function resolveV2DocxExportOptions(options = {}) {
+	const policies = resolveDocxExportPolicies({ policies: options.policies });
+	if (options.isFinalDoc !== void 0) {
+		if (typeof options.isFinalDoc !== "boolean") throw new DocumentApiValidationError("INVALID_INPUT", "isFinalDoc must be a boolean.");
+		const legacy = options.isFinalDoc ? "final" : "review-preserving";
+		if (options.policies?.trackedChanges !== void 0 && policies.trackedChanges !== legacy) throw new DocumentApiValidationError("INVALID_INPUT", "isFinalDoc conflicts with policies.trackedChanges.");
+		policies.trackedChanges = legacy;
+	}
+	if (options.commentsType !== void 0) {
+		if (options.commentsType !== "external" && options.commentsType !== "clean") throw new DocumentApiValidationError("INVALID_INPUT", "commentsType must be external or clean.");
+		const legacy = options.commentsType === "clean" ? "remove" : "preserve";
+		if (options.policies?.comments !== void 0 && policies.comments !== legacy) throw new DocumentApiValidationError("INVALID_INPUT", "commentsType conflicts with policies.comments.");
+		policies.comments = legacy;
+	}
+	return {
+		mode: policies.trackedChanges,
+		commentExportMode: policies.comments === "remove" ? "strip" : policies.comments,
+		contentControlExportMode: policies.contentControls
+	};
+}
+//#endregion
 //#region src/core/editor-runtime/v2/v2-editor-runtime-adapter.ts
 var DEFAULT_V2_LEGACY_PROJECTION = Object.freeze({
 	editorVersion: 2,
@@ -20766,7 +20914,7 @@ function createV2EditorRuntimeAdapter(options) {
 			save: () => host.save(),
 			exportDocx: (options) => host.save({
 				format: "docx",
-				commentExportMode: options?.commentsType === "clean" ? "strip" : "preserve"
+				...resolveV2DocxExportOptions(options)
 			}),
 			async setZoom(percent) {
 				const result = host.setZoom(percent);
@@ -22167,6 +22315,10 @@ var SuperDoc_default = /*#__PURE__*/ require__plugin_vue_export_helper._plugin_v
 			return layers.value.getBoundingClientRect().top + top * zoom;
 		};
 		const handleCommentToolClick = async () => {
+			if (isV2Mode.value) {
+				cancelScheduledV2DomSelectionSync();
+				if (applyCurrentV2DomSelection()?.ok === false) return;
+			}
 			if ((await showAddComment(proxy.$superdoc, getPendingCommentTargetClientY()))?.ok === false) return;
 			if (!isV2Mode.value) return;
 			const pendingPosition = buildV2PendingPositionEntry();
@@ -22439,10 +22591,9 @@ var SuperDoc_default = /*#__PURE__*/ require__plugin_vue_export_helper._plugin_v
 				return host.save(saveOptions);
 			});
 			const exportV2Docx = async (options = {}) => {
-				const commentExportMode = options?.commentsType === "clean" ? "strip" : "preserve";
 				const bytes = await saveV2Bytes({
 					format: "docx",
-					commentExportMode
+					...resolveV2DocxExportOptions(options)
 				});
 				return new Blob([bytes], { type: DOCX });
 			};
@@ -22717,6 +22868,9 @@ var SuperDoc_default = /*#__PURE__*/ require__plugin_vue_export_helper._plugin_v
 					subscribe: (listener) => v2ReviewWindowController.subscribe?.(listener) ?? (() => void 0)
 				},
 				extensions: createV2ExtensionsFacet(host),
+				get visuals() {
+					return typeof host?.getHostVisuals === "function" ? host.getHostVisuals() : null;
+				},
 				fonts: fonts ?? host?.getFontRuntime?.() ?? null,
 				/**
 				* The v2 active-editor facade explicitly does NOT carry v1 commands /
@@ -22882,7 +23036,7 @@ var SuperDoc_default = /*#__PURE__*/ require__plugin_vue_export_helper._plugin_v
 			const result = handles?.selection?.applyDomSelection?.(selection);
 			if (!result?.ok || result.mode !== "range") {
 				clearV2SelectionToolbarState();
-				return;
+				return { ok: false };
 			}
 			v2DomMirroredRange.value = true;
 			v2HasRangeSelection.value = true;
@@ -24589,7 +24743,7 @@ var SuperDoc_default = /*#__PURE__*/ require__plugin_vue_export_helper._plugin_v
 			], 46, _hoisted_1$17);
 		};
 	}
-}, [["__scopeId", "data-v-2fc1721f"]]);
+}, [["__scopeId", "data-v-0f22e103"]]);
 //#endregion
 //#region src/core/create-app.js
 var PINIA_DEVTOOLS_SETUP_EVENT = "devtools-plugin:setup";
@@ -46318,7 +46472,7 @@ var SuperDoc = class extends require_eventemitter3.import_eventemitter3.default
 		}
 		this.userColorMap = /* @__PURE__ */ new Map();
 		this.colorIndex = 0;
-		this.version = "2.28.0-next.6";
+		this.version = "2.28.0-next.7";
 		this.#log("🦋 [superdoc] Using SuperDoc version:", this.version);
 		this.superdocId = config.superdocId || require_uuid.v4();
 		this.colors = this.config.colors ?? [];
@@ -48272,12 +48426,13 @@ var SuperDoc = class extends require_eventemitter3.import_eventemitter3.default
 	* Export the superdoc to a file
 	* @param params - Export configuration
 	*/
-	async export({ exportType = ["docx"], commentsType = "external", exportedName, additionalFiles = [], additionalFileNames = [], isFinalDoc = false, triggerDownload = true, fieldsHighlightColor = null } = {}) {
+	async export({ exportType = ["docx"], commentsType, exportedName, additionalFiles = [], additionalFileNames = [], isFinalDoc, policies, triggerDownload = true, fieldsHighlightColor = null } = {}) {
 		if (!Array.isArray(exportType) || exportType.length !== 1 || exportType[0] !== "docx") throw new TypeError("SuperDoc.export() only supports exportType: [\"docx\"].");
 		const baseFileName = exportedName ? cleanName(exportedName) : cleanName(this.config.title);
 		const docxFiles = await this.exportEditorsToDOCX({
 			commentsType,
 			isFinalDoc,
+			policies,
 			fieldsHighlightColor
 		});
 		const blobsToZip = [...additionalFiles];
@@ -48363,7 +48518,12 @@ var SuperDoc = class extends require_eventemitter3.import_eventemitter3.default
 	* Export editors to DOCX format.
 	* @param [options]
 	*/
-	async exportEditorsToDOCX({ commentsType, isFinalDoc, fieldsHighlightColor } = {}) {
+	async exportEditorsToDOCX({ commentsType, isFinalDoc, policies, fieldsHighlightColor } = {}) {
+		if (policies !== void 0) resolveV2DocxExportOptions({
+			policies,
+			commentsType,
+			isFinalDoc
+		});
 		const uiStoreHydrated = this.config?.modules?.comments !== false;
 		let legacyComments;
 		let legacyCommentsComputed = false;
@@ -48383,7 +48543,13 @@ var SuperDoc = class extends require_eventemitter3.import_eventemitter3.default
 		};
 		this.on("exception", rememberBridgedExportError);
 		try {
-			const docxPromises = this.#requireSuperdocStore("exportEditorsToDOCX").documents.map(async (doc) => {
+			const documents = this.#requireSuperdocStore("exportEditorsToDOCX").documents;
+			if (policies !== void 0 && documents.some((doc) => {
+				if (doc.type !== "application/vnd.openxmlformats-officedocument.wordprocessingml.document") return false;
+				const editor = doc.getEditor?.();
+				return editor?.editorVersion !== 2 || typeof editor.exportDocx !== "function";
+			})) throw new Error("Independent DOCX export policies require a mounted V2 exporter for every document.");
+			const docxPromises = documents.map(async (doc) => {
 				if (!doc || doc.type !== "application/vnd.openxmlformats-officedocument.wordprocessingml.document") return null;
 				const editor = typeof doc.getEditor === "function" ? doc.getEditor() : null;
 				const fallbackDocx = () => {
@@ -48400,6 +48566,7 @@ var SuperDoc = class extends require_eventemitter3.import_eventemitter3.default
 					const exported = await editor.exportDocx(isV2Editor ? {
 						isFinalDoc,
 						commentsType,
+						policies,
 						fieldsHighlightColor
 					} : {
 						isFinalDoc,
@@ -48728,7 +48895,11 @@ function defineSuperDocExtension(extension) {
 	return extension;
 }
 //#endregion
-exports.BlankDOCX = require_blank_docx.blank_default;
+//#region src/public/index.ts
+/** URL to the blank DOCX template. */
+var BlankDOCX = require_blank_docx.blank_default;
+//#endregion
+exports.BlankDOCX = BlankDOCX;
 exports.DOCX = DOCX;
 exports.DocumentLoadError = DocumentLoadError;
 exports.HTML = HTML;