@stll/folio-core 0.4.0 → 0.6.0

package/dist/prosemirror/utils/tabCalculator.js

@@ -5,6 +5,8 @@ const DEFAULT_TAB_INTERVAL_TWIPS = 720;
 const TWIPS_PER_INCH = 1440;
 /** Pixels per inch (96 dpi standard for CSS) */
 const PIXELS_PER_INCH = 96;
+/** Ignore sub-twip round trips when the cursor already occupies a tab stop. */
+const TAB_POSITION_EPSILON_TWIPS = .01;
 /**
 * Convert twips to pixels
 * @param twips - Value in twips (1/1440 inch)
@@ -44,7 +46,7 @@ function computeTabStops(context) {
 			leader: "none"
 		});
 	}
-	let pos = maxExplicit > 0 ? Math.max(maxExplicit, leftIndent) : leftIndent;
+	let pos = Math.floor(Math.max(maxExplicit, leftIndent) / defaultTabInterval) * defaultTabInterval;
 	const limitPos = leftIndent + 14400;
 	while (pos < limitPos) {
 		pos += defaultTabInterval;
@@ -84,7 +86,7 @@ function computeTabStops(context) {
 function calculateTabWidth(currentXPx, context, following = {}) {
 	const { defaultTabInterval = 720 } = context;
 	const currentXTwips = pixelsToTwips(currentXPx);
-	const nextStop = computeTabStops(context).find((stop) => stop.pos > currentXTwips);
+	const nextStop = computeTabStops(context).find((stop) => stop.pos > currentXTwips + TAB_POSITION_EPSILON_TWIPS);
 	if (!nextStop) {
 		const defaultTabPx = twipsToPixels(defaultTabInterval);
 		let tabWidth = defaultTabPx - currentXPx % defaultTabPx;

package/dist/redline.d.ts

@@ -0,0 +1,20 @@
+import { FolioAIEditApplyResult } from "./ai-edits/types.js";
+
+//#region src/redline.d.ts
+/** Options for {@link generateRedlineDocx}. */
+type GenerateRedlineDocxOptions = {
+  /** Author recorded on the generated tracked changes. (default: `"folio compare"`) */author?: string;
+};
+/** Result of {@link generateRedlineDocx}. */
+type GenerateRedlineDocxResult = FolioAIEditApplyResult & {
+  /** The redline `.docx`: the base document with base → revised tracked changes. */buffer: ArrayBuffer;
+};
+/**
+ * Compare `base` and `revised` and return the base document with every
+ * difference recorded as a tracked change. See the module doc comment for
+ * semantics and limitations; `skipped` reports any block the generator could
+ * not redline (e.g. additions with no anchor in an empty base document).
+ */
+declare const generateRedlineDocx: (base: ArrayBuffer, revised: ArrayBuffer, options?: GenerateRedlineDocxOptions) => Promise<GenerateRedlineDocxResult>;
+//#endregion
+export { GenerateRedlineDocxOptions, GenerateRedlineDocxResult, generateRedlineDocx };

package/dist/redline.js

@@ -0,0 +1,127 @@
+import { FolioDocxReviewer } from "./ai-edits/headless.js";
+import { alignFolioBlocks } from "./version-comparison.js";
+//#region src/redline.ts
+/**
+* Redline generator: compare two `.docx` buffers and produce a THIRD `.docx`
+* whose differences are recorded as real Word tracked changes (`w:ins` /
+* `w:del`), ready for review in Word or the folio editor — the
+* document-producing counterpart to {@link compareDocxVersions}'s structured
+* diff.
+*
+* The pipeline is a composition of existing machinery, not a new engine:
+* the base buffer is opened in a headless {@link FolioDocxReviewer}, the two
+* snapshots are aligned with {@link alignFolioBlocks} (the same three-pass
+* alignment the comparer uses), each alignment event maps onto a
+* tracked-changes {@link FolioAIEditOperation}, and the reviewer's shared
+* apply path records them as redlines. Word-level minimality comes free:
+* the apply engine word-diffs a `replaceBlock` and only marks the divergent
+* tokens.
+*
+* ## Semantics and limitations
+*
+* - **As-accepted inputs.** Pending tracked changes in either input count as
+*   applied before comparison (mirroring {@link compareDocxVersions}): the
+*   base's own pending redlines are accepted in the output, so the tracked
+*   changes it carries are exactly base → revised. This is intentionally
+*   lossy about the inputs' own revision history and authorship.
+* - **Text redlines only.** Format-only changes and relocated blocks are
+*   redlined as plain edits (a move becomes a delete + insert, like Word
+*   compare with move detection off); block-level formatting is carried via
+*   the revised block's `styleId` on inserted blocks.
+* - **Anchoring.** Insertions anchor `before` the next surviving base block
+*   so consecutive additions keep their order; additions past the last base
+*   block anchor `after` it. A base document with no content blocks offers
+*   no anchor at all — such additions surface in `skipped` rather than
+*   silently vanishing.
+*/
+/**
+* For each event index, the base block id the next `revisedOnly` event
+* should anchor before: the base side of the nearest later `pair` or
+* `baseOnly` event, or `null` when only additions remain until the end of
+* the document. One backward pass, so a long run of trailing additions
+* (huge revised document vs. a small base) stays linear instead of
+* re-scanning the tail per added block.
+*/
+const nextBaseBlockIdByIndex = (events) => {
+	const nextIds = Array.from({ length: events.length });
+	let nextId = null;
+	for (let i = events.length - 1; i >= 0; i--) {
+		nextIds[i] = nextId;
+		const event = events[i];
+		if (event?.type === "pair") nextId = event.baseBlock.id;
+		else if (event?.type === "baseOnly") nextId = event.block.id;
+	}
+	return nextIds;
+};
+/**
+* Compare `base` and `revised` and return the base document with every
+* difference recorded as a tracked change. See the module doc comment for
+* semantics and limitations; `skipped` reports any block the generator could
+* not redline (e.g. additions with no anchor in an empty base document).
+*/
+const generateRedlineDocx = async (base, revised, options = {}) => {
+	const [baseReviewer, revisedReviewer] = await Promise.all([FolioDocxReviewer.fromBuffer(base, { author: options.author ?? "folio compare" }), FolioDocxReviewer.fromBuffer(revised)]);
+	baseReviewer.acceptAll();
+	const baseSnapshot = baseReviewer.snapshot();
+	const revisedBlocks = revisedReviewer.snapshot().blocks;
+	const events = alignFolioBlocks(baseSnapshot.blocks, revisedBlocks);
+	const anchorIds = nextBaseBlockIdByIndex(events);
+	const operations = [];
+	let operationSeq = 0;
+	const nextOperationId = () => `redline-${++operationSeq}`;
+	/** Additions past the last base block, inserted after it in reverse so the final order matches the revised document. */
+	const trailingAdditions = [];
+	const lastBaseBlockId = baseSnapshot.blocks.at(-1)?.id ?? null;
+	events.forEach((event, eventIndex) => {
+		if (event.type === "pair") {
+			if (event.baseBlock.text !== event.revisedBlock.text) operations.push({
+				id: nextOperationId(),
+				type: "replaceBlock",
+				blockId: event.baseBlock.id,
+				text: event.revisedBlock.text
+			});
+			return;
+		}
+		if (event.type === "baseOnly") {
+			operations.push({
+				id: nextOperationId(),
+				type: "deleteBlock",
+				blockId: event.block.id
+			});
+			return;
+		}
+		const anchorId = anchorIds[eventIndex] ?? null;
+		if (anchorId === null) {
+			trailingAdditions.push({
+				text: event.block.text,
+				...event.block.styleId !== void 0 && { styleId: event.block.styleId }
+			});
+			return;
+		}
+		operations.push({
+			id: nextOperationId(),
+			type: "insertBeforeBlock",
+			blockId: anchorId,
+			text: event.block.text,
+			...event.block.styleId !== void 0 && { styleId: event.block.styleId }
+		});
+	});
+	for (const addition of trailingAdditions.toReversed()) operations.push({
+		id: nextOperationId(),
+		type: "insertAfterBlock",
+		blockId: lastBaseBlockId ?? "redline-unanchored",
+		text: addition.text,
+		...addition.styleId !== void 0 && { styleId: addition.styleId }
+	});
+	const { applied, skipped } = baseReviewer.applyOperations(operations, {
+		mode: "tracked-changes",
+		snapshot: baseSnapshot
+	});
+	return {
+		buffer: await baseReviewer.toBuffer(),
+		applied,
+		skipped
+	};
+};
+//#endregion
+export { generateRedlineDocx };

package/dist/server.d.ts

@@ -1,8 +1,12 @@
-import { FolioAIBlock, FolioAIBlockAnchor, FolioAIBlockKind, FolioAIBlockPreviewRun, FolioAIComment, FolioAIEditApplyMode, FolioAIEditApplyResult, FolioAIEditOperation, FolioAIEditSnapshot } from "./ai-edits/types.js";
+import { FolioAIBlock, FolioAIBlockAnchor, FolioAIBlockKind, FolioAIBlockPreviewRun, FolioAIComment, FolioAIEditApplyMode, FolioAIEditApplyResult, FolioAIEditOperation, FolioAIEditPrecondition, FolioAIEditSnapshot, FolioAIInlineFormatting, FolioAITextRangeHandle } from "./ai-edits/types.js";
+import { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FolioDocumentOperation, FolioDocumentOperationAffectedTarget, FolioDocumentOperationBatch, FolioDocumentOperationCapabilities, FolioDocumentOperationIssue, FolioDocumentOperationMode, FolioDocumentOperationPrecondition, FolioDocumentOperationReceipt, FolioDocumentOperationRecovery, FolioDocumentOperationResult, FolioDocumentOperationStatus, FolioDocumentOperationType, FolioDocumentOperationUndoFailureReason, FolioDocumentOperationUndoHandle, FolioDocumentOperationUndoResult, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, assertSupportedFolioDocumentOperationVersion, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, isFolioDocumentOperationModeSupported, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch } from "./document-operations.js";
 import { FolioReviewChange, FolioReviewChangeKind } from "./ai-edits/read.js";
-import { ApplyFolioAIEditsToBufferOptions, ApplyFolioAIEditsToBufferResult, FolioApplyOperationsOptions, FolioDocxReviewer, FolioDocxReviewerOptions, FolioReviewChangeFilter, FolioReviewComment, FolioReviewCommentFilter, FolioReviewCommentReply, FolioReviewReplyInput, applyFolioAIEditsToBuffer } from "./ai-edits/headless.js";
+import { ApplyFolioAIEditsToBufferOptions, ApplyFolioAIEditsToBufferResult, FolioApplyDocumentOperationsOptions, FolioApplyOperationsOptions, FolioDocumentStory, FolioDocumentStoryHandle, FolioDocxReviewer, FolioDocxReviewerOptions, FolioReviewChangeFilter, FolioReviewComment, FolioReviewCommentFilter, FolioReviewCommentReply, FolioReviewReplyInput, applyFolioAIEditsToBuffer } from "./ai-edits/headless.js";
+import { createFolioAITextRangeHandle } from "./ai-edits/snapshot.js";
 import { DeriveBlockIdInput, FolioBlockId, deriveBlockId, getFolioParaIdFromBlockId, isFolioBlockId, isSequentialFolioBlockId } from "./types/block-id.js";
 import { CreateEmptyDocumentOptions, createEmptyDocument } from "./utils/createDocument.js";
 import { createDocx } from "./docx/rezip.js";
 import { CreateCommentReplyInput, replyToComment } from "./docx/replyToComment.js";
-export { type ApplyFolioAIEditsToBufferOptions, type ApplyFolioAIEditsToBufferResult, type CreateCommentReplyInput, type CreateEmptyDocumentOptions, type DeriveBlockIdInput, type FolioAIBlock, type FolioAIBlockAnchor, type FolioAIBlockKind, type FolioAIBlockPreviewRun, type FolioAIComment, type FolioAIEditApplyMode, type FolioAIEditApplyResult, type FolioAIEditOperation, type FolioAIEditSnapshot, type FolioApplyOperationsOptions, type FolioBlockId, FolioDocxReviewer, type FolioDocxReviewerOptions, type FolioReviewChange, type FolioReviewChangeFilter, type FolioReviewChangeKind, type FolioReviewComment, type FolioReviewCommentFilter, type FolioReviewCommentReply, type FolioReviewReplyInput, applyFolioAIEditsToBuffer, createDocx, createEmptyDocument, deriveBlockId, getFolioParaIdFromBlockId, isFolioBlockId, isSequentialFolioBlockId, replyToComment };
+import { GenerateRedlineDocxOptions, GenerateRedlineDocxResult, generateRedlineDocx } from "./redline.js";
+import { FolioBlockDiff, FolioFormatProperty, FolioVersionDiff, FolioVersionDiffSegment, compareDocxVersions } from "./version-comparison.js";
+export { type ApplyFolioAIEditsToBufferOptions, type ApplyFolioAIEditsToBufferResult, type CreateCommentReplyInput, type CreateEmptyDocumentOptions, type DeriveBlockIdInput, FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, type FolioAIBlock, type FolioAIBlockAnchor, type FolioAIBlockKind, type FolioAIBlockPreviewRun, type FolioAIComment, type FolioAIEditApplyMode, type FolioAIEditApplyResult, type FolioAIEditOperation, type FolioAIEditPrecondition, type FolioAIEditSnapshot, type FolioAIInlineFormatting, type FolioAITextRangeHandle, type FolioApplyDocumentOperationsOptions, type FolioApplyOperationsOptions, type FolioBlockDiff, type FolioBlockId, type FolioDocumentOperation, type FolioDocumentOperationAffectedTarget, type FolioDocumentOperationBatch, type FolioDocumentOperationCapabilities, type FolioDocumentOperationIssue, type FolioDocumentOperationMode, type FolioDocumentOperationPrecondition, type FolioDocumentOperationReceipt, type FolioDocumentOperationRecovery, type FolioDocumentOperationResult, type FolioDocumentOperationStatus, type FolioDocumentOperationType, type FolioDocumentOperationUndoFailureReason, type FolioDocumentOperationUndoHandle, type FolioDocumentOperationUndoResult, type FolioDocumentStory, type FolioDocumentStoryHandle, FolioDocxReviewer, type FolioDocxReviewerOptions, type FolioFormatProperty, type FolioReviewChange, type FolioReviewChangeFilter, type FolioReviewChangeKind, type FolioReviewComment, type FolioReviewCommentFilter, type FolioReviewCommentReply, type FolioReviewReplyInput, type FolioVersionDiff, type FolioVersionDiffSegment, type GenerateRedlineDocxOptions, type GenerateRedlineDocxResult, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, applyFolioAIEditsToBuffer, assertSupportedFolioDocumentOperationVersion, compareDocxVersions, createDocx, createEmptyDocument, createFolioAITextRangeHandle, deriveBlockId, generateRedlineDocx, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioParaIdFromBlockId, isFolioBlockId, isFolioDocumentOperationModeSupported, isSequentialFolioBlockId, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch, replyToComment };

package/dist/server.js

@@ -1,6 +1,10 @@
+import { deriveBlockId, getFolioParaIdFromBlockId, isFolioBlockId, isSequentialFolioBlockId } from "./types/block-id.js";
+import { createFolioAITextRangeHandle } from "./ai-edits/snapshot.js";
+import { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, assertSupportedFolioDocumentOperationVersion, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, isFolioDocumentOperationModeSupported, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch } from "./document-operations.js";
 import { createEmptyDocument } from "./utils/createDocument.js";
 import { createDocx } from "./docx/rezip.js";
-import { deriveBlockId, getFolioParaIdFromBlockId, isFolioBlockId, isSequentialFolioBlockId } from "./types/block-id.js";
 import { replyToComment } from "./docx/replyToComment.js";
 import { FolioDocxReviewer, applyFolioAIEditsToBuffer } from "./ai-edits/headless.js";
-export { FolioDocxReviewer, applyFolioAIEditsToBuffer, createDocx, createEmptyDocument, deriveBlockId, getFolioParaIdFromBlockId, isFolioBlockId, isSequentialFolioBlockId, replyToComment };
+import { compareDocxVersions } from "./version-comparison.js";
+import { generateRedlineDocx } from "./redline.js";
+export { FOLIO_DOCUMENT_OPERATION_BATCH_MODES, FOLIO_DOCUMENT_OPERATION_CONTRACT_VERSION, FOLIO_DOCUMENT_OPERATION_MODES, FOLIO_DOCUMENT_OPERATION_MODES_BY_TYPE, FOLIO_DOCUMENT_OPERATION_PRECONDITIONS, FOLIO_DOCUMENT_OPERATION_STORIES, FOLIO_DOCUMENT_OPERATION_TYPES, FolioDocxReviewer, InvalidFolioDocumentOperationBatchError, UnsupportedFolioDocumentOperationVersionError, applyFolioAIEditsToBuffer, assertSupportedFolioDocumentOperationVersion, compareDocxVersions, createDocx, createEmptyDocument, createFolioAITextRangeHandle, deriveBlockId, generateRedlineDocx, getFolioDocumentOperationCapabilities, getFolioDocumentOperationIssues, getFolioDocumentOperationReceipts, getFolioParaIdFromBlockId, isFolioBlockId, isFolioDocumentOperationModeSupported, isSequentialFolioBlockId, isSupportedFolioDocumentOperationVersion, parseFolioDocumentOperationBatch, replyToComment };

package/dist/symbols.d.ts

@@ -0,0 +1,35 @@
+//#region src/symbols.d.ts
+/**
+ * Symbol catalog for the "Insert Symbol" dialog.
+ *
+ * Framework-neutral data + filtering shared by every folio adapter (React,
+ * Vue, ...), so the two never drift on which symbols they offer. Category
+ * display names are i18n keys (`dialogs.insertSymbol.categories.*`) resolved by
+ * each adapter's own translator; the `char`/`name` pairs are the raw catalog.
+ */
+type SymbolEntry = {
+  /** The character to insert. */char: string; /** English descriptive name, used for search matching. */
+  name: string;
+};
+/** i18n message keys for the symbol-category display labels. */
+type SymbolCategoryNameKey = "dialogs.insertSymbol.categories.common" | "dialogs.insertSymbol.categories.arrows" | "dialogs.insertSymbol.categories.math" | "dialogs.insertSymbol.categories.greek" | "dialogs.insertSymbol.categories.currency" | "dialogs.insertSymbol.categories.shapes";
+type SymbolCategory = {
+  /** Stable category id (also the default active tab). */name: string; /** i18n key for the category's display label. */
+  nameKey: SymbolCategoryNameKey;
+  symbols: SymbolEntry[];
+};
+/** A catalog entry tagged with the category it belongs to (search results). */
+type SymbolSearchEntry = SymbolEntry & {
+  category: string;
+};
+declare const SYMBOL_CATEGORIES: SymbolCategory[];
+/** Every catalog symbol, flattened and tagged with its category. */
+declare const ALL_SYMBOLS: SymbolSearchEntry[];
+/**
+ * Symbols whose descriptive name contains `query` (case-insensitive), or whose
+ * character is exactly `query`. An empty/whitespace query returns `[]` so
+ * callers fall back to the active category.
+ */
+declare function filterSymbols(query: string): SymbolSearchEntry[];
+//#endregion
+export { ALL_SYMBOLS, SYMBOL_CATEGORIES, SymbolCategory, SymbolCategoryNameKey, SymbolEntry, SymbolSearchEntry, filterSymbols };