@stll/folio-react 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import React$1, { CSSProperties, ComponentProps, ComponentType, ReactNode, Ref,
 import { EditorState, Plugin, Transaction } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
 import { XmlFragment } from "yjs";
-import { FolioAIBlock, FolioAIBlockAnchor, FolioAIBlockKind, FolioAIBlockPreviewRun, FolioAIComment, FolioAIEditAppliedOperation, FolioAIEditApplyMode, FolioAIEditApplyMode as FolioAIEditApplyMode$1, FolioAIEditApplyResult, FolioAIEditApplyResult as FolioAIEditApplyResult$1, FolioAIEditOperation, FolioAIEditOperation as FolioAIEditOperation$1, FolioAIEditReviewMeta, FolioAIEditSeverity, FolioAIEditSkipReason, FolioAIEditSkippedOperation, FolioAIEditSnapshot, FolioAIEditSnapshot as FolioAIEditSnapshot$1, FolioAISignatureParty, WordDiffSegment, applyFolioAIEditOperations, createFolioAIEditSnapshot, diffWordSegments, hashFolioAIBlockText, normalizeFolioAIBlockText } from "@stll/folio-core/ai-edits";
+import { FolioAIBlock, FolioAIBlockAnchor, FolioAIBlockKind, FolioAIBlockPreviewRun, FolioAIComment, FolioAIEditAppliedOperation, FolioAIEditApplyMode, FolioAIEditApplyMode as FolioAIEditApplyMode$1, FolioAIEditApplyResult, FolioAIEditApplyResult as FolioAIEditApplyResult$1, FolioAIEditOperation, FolioAIEditOperation as FolioAIEditOperation$1, FolioAIEditReviewMeta, FolioAIEditSeverity, FolioAIEditSkipReason, FolioAIEditSkippedOperation, FolioAIEditSnapshot, FolioAIEditSnapshot as FolioAIEditSnapshot$1, FolioAISignatureParty, FolioCommentAnchor, FolioReviewChange, WordDiffSegment, applyFolioAIEditOperations, createFolioAIEditSnapshot, diffWordSegments, hashFolioAIBlockText, normalizeFolioAIBlockText } from "@stll/folio-core/ai-edits";
 import { ContentControlFilter, SetContentControlContentInput, SetContentControlValueInput } from "@stll/folio-core/content-controls";
 import { FolioEditor } from "@stll/folio-core/controller/folioEditor";
 import { DocxCompatibility, DocxCompatibility as DocxCompatibility$1 } from "@stll/folio-core/docx/compatibility";
@@ -818,6 +818,28 @@ type DocxEditorRef = {
    * a fresh-from-live-doc snapshot.
    */
   scrollToBlock: (blockId: string, snapshot?: FolioAIEditSnapshot$1) => boolean;
+  /**
+   * The tracked changes (insertions and deletions) present in the live
+   * document, read from the current ProseMirror `state.doc`. Empty array
+   * before the editor view mounts.
+   */
+  getTrackedChanges: () => FolioReviewChange[];
+  /**
+   * The comment anchors present in the live document, read from the current
+   * ProseMirror `state.doc`. Empty array before the editor view mounts.
+   */
+  getCommentAnchors: () => FolioCommentAnchor[];
+  /**
+   * The plain text of the current selection, or `""` when the editor has no
+   * view or the selection is collapsed.
+   */
+  getSelectionText: () => string;
+  /**
+   * The plain text of a single rendered page (1-based), joining each of its
+   * layout fragments with a newline. Returns `null` when the page number is
+   * out of range or the layout hasn't been computed yet.
+   */
+  getPageText: (page: number) => string | null;
   /**
    * List every block-level content control in the live document, filtered by
    * tag / alias / id / sdtType. Returns the modeled SdtProperties projection

package/dist/index.js

@@ -6,11 +6,11 @@ import * as React$1 from "react";
 import React, { Component, Suspense, cloneElement, createContext, isValidElement, lazy, memo, useCallback, useEffect, useImperativeHandle, useLayoutEffect, useMemo, useRef, useState, useSyncExternalStore } from "react";
 import { AlertCircleIcon, AlertTriangleIcon, AlignCenterIcon, AlignJustifyIcon, AlignLeftIcon, AlignRightIcon, BaselineIcon, BoldIcon, CheckIcon, ChevronDownIcon, ChevronLeftIcon, ChevronRightIcon, ClipboardCopyIcon, EyeIcon, FileIcon, GlobeIcon, ImageIcon, IndentDecreaseIcon, IndentIncreaseIcon, InfoIcon, ItalicIcon, LinkIcon, ListIcon, ListOrderedIcon, MoreHorizontalIcon, PaintbrushIcon, PenLineIcon, PencilIcon, PilcrowIcon, Redo2Icon, RulerIcon, SeparatorHorizontalIcon, SquarePenIcon, StickyNoteIcon, TableIcon, TableOfContentsIcon, TypeIcon, UnderlineIcon, Undo2Icon, UnlinkIcon, XIcon } from "lucide-react";
 import { IntlProvider, useTranslations } from "use-intl";
-import { applyFolioAIEditOperations, applyFolioAIEditOperations as applyFolioAIEditOperations$1, createFolioAIEditSnapshot, createFolioAIEditSnapshot as createFolioAIEditSnapshot$1, diffWordSegments, hashFolioAIBlockText, normalizeFolioAIBlockText } from "@stll/folio-core/ai-edits";
+import { applyFolioAIEditOperations, applyFolioAIEditOperations as applyFolioAIEditOperations$1, createFolioAIEditSnapshot, createFolioAIEditSnapshot as createFolioAIEditSnapshot$1, diffWordSegments, getCommentAnchorsFromDoc, getTrackedChangesFromDoc, hashFolioAIBlockText, normalizeFolioAIBlockText } from "@stll/folio-core/ai-edits";
 import { normalizeBaseDirection } from "@stll/folio-core/docx/normalizeBaseDirection";
 import { getCachedNumberingMap } from "@stll/folio-core/docx/numberingParser";
 import { computeScrollPageInfo, updateScrollPageTotal } from "@stll/folio-core/paged-layout/scrollPageInfo";
-import { TextSelection, addColumnLeft, addColumnRight, addRowAbove, addRowBelow, applyFormatMarks, applyStyle, applyTableStyle, autoFitContents, captureFormatMarks, clearFormatting, clearTextColor, createStyleResolver, decreaseIndent, decreaseListLevel, deleteColumn, deleteRow, deleteTable, distributeColumns, extractSelectionState, getTableContext, increaseIndent, increaseListLevel, insertImageFromFile, insertPageBreakInView, insertTableInView, insertTableOfContentsInView, mergeCells, removeTabStop, removeTableBorders, schema, selectColumn, selectRow, selectTable, setAlignment, setAllTableBorders, setCellBorder, setCellFillColor, setCellMargins, setCellTextDirection, setCellVerticalAlign, setFontFamily, setFontSize, setHighlight, setIndentFirstLine, setIndentLeft, setIndentRight, setInsideTableBorders, setLineSpacing, setLtr, setOutsideTableBorders, setRowHeight, setRtl, setTableBorderColor, setTableBorderPreset, setTableBorderWidth, setTableProperties, setTextColor, splitCell, toggleBidi, toggleBold, toggleBulletList, toggleHeaderRow, toggleItalic, toggleNoWrap, toggleNumberedList, toggleStrike, toggleSubscript, toggleSuperscript, toggleUnderline } from "@stll/folio-core/prosemirror";
+import { TextSelection, addColumnLeft, addColumnRight, addRowAbove, addRowBelow, applyFormatMarks, applyStyle, applyTableStyle, autoFitContents, captureFormatMarks, clearFormatting, clearTextColor, createStyleResolver, decreaseIndent, decreaseListLevel, deleteColumn, deleteRow, deleteTable, distributeColumns, extractSelectionState, getSelectedText, getTableContext, increaseIndent, increaseListLevel, insertImageFromFile, insertPageBreakInView, insertTableInView, insertTableOfContentsInView, mergeCells, removeTabStop, removeTableBorders, schema, selectColumn, selectRow, selectTable, setAlignment, setAllTableBorders, setCellBorder, setCellFillColor, setCellMargins, setCellTextDirection, setCellVerticalAlign, setFontFamily, setFontSize, setHighlight, setIndentFirstLine, setIndentLeft, setIndentRight, setInsideTableBorders, setLineSpacing, setLtr, setOutsideTableBorders, setRowHeight, setRtl, setTableBorderColor, setTableBorderPreset, setTableBorderWidth, setTableProperties, setTextColor, splitCell, toggleBidi, toggleBold, toggleBulletList, toggleHeaderRow, toggleItalic, toggleNoWrap, toggleNumberedList, toggleStrike, toggleSubscript, toggleSuperscript, toggleUnderline } from "@stll/folio-core/prosemirror";
 import { acceptAIEditRevision, acceptChange, findAIEditRevisionRange, findChangeAtPosition, findNextChange, findParagraphBoundaryChangeAtPosition, findPreviousChange, rejectAIEditRevision, rejectChange } from "@stll/folio-core/prosemirror/commands/comments";
 import { blockSdtAttrsToSdtProperties, findBlockSdtMatch, findBlockSdtMatches, removeContentControlTr, setContentControlContentTr, setContentControlValueTr } from "@stll/folio-core/prosemirror/commands/contentControls";
 import { setContentControlContentBlocksTr } from "@stll/folio-core/prosemirror/commands/contentControlsBlockFill";
@@ -6142,6 +6142,26 @@ function resolveCommentCreationRange({ docSize, capturedRange, currentRange, sav
 	})();
 	return range ? clampCommentMarkRange(docSize, range) : null;
 }
+//#endregion
+//#region src/components/pageText.ts
+/**
+* The plain text of a single rendered page (1-based), read by joining each of
+* the page's layout fragments' `[pmStart, pmEnd)` document text with a
+* newline. Fragments with no `pmStart`/`pmEnd` (e.g. a page-shell placeholder)
+* are skipped. Returns `null` when the layout hasn't been computed yet or the
+* page number is out of range.
+*/
+const getPageTextFromLayout = (layout, doc, page) => {
+	if (!layout || !Number.isInteger(page) || page < 1) return null;
+	const layoutPage = layout.pages[page - 1];
+	if (!layoutPage) return null;
+	const fragmentTexts = [];
+	for (const fragment of layoutPage.fragments) {
+		if (typeof fragment.pmStart !== "number" || typeof fragment.pmEnd !== "number") continue;
+		fragmentTexts.push(doc.textBetween(fragment.pmStart, fragment.pmEnd, "\n"));
+	}
+	return fragmentTexts.join("\n");
+};
 /** Stable empty anchor positions Map used as the initial state. */
 const EMPTY_ANCHOR_POSITIONS = /* @__PURE__ */ new Map();
 let nextCommentId = Date.now();
@@ -11681,6 +11701,23 @@ function DocxEditor({ ref, documentBuffer, document: initialDocument, documentKe
 			});
 			return true;
 		},
+		getTrackedChanges: () => {
+			const view = pagedEditorRef.current?.getView();
+			return view ? getTrackedChangesFromDoc(view.state.doc) : [];
+		},
+		getCommentAnchors: () => {
+			const view = pagedEditorRef.current?.getView();
+			return view ? getCommentAnchorsFromDoc(view.state.doc) : [];
+		},
+		getSelectionText: () => {
+			const view = pagedEditorRef.current?.getView();
+			return view ? getSelectedText(view.state) : "";
+		},
+		getPageText: (page) => {
+			const view = pagedEditorRef.current?.getView();
+			if (!view) return null;
+			return getPageTextFromLayout(pagedEditorRef.current?.getEditor()?.getLayout() ?? null, view.state.doc, page);
+		},
 		getContentControls: (filter = {}) => {
 			const view = pagedEditorRef.current?.getView();
 			if (!view) return [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stll/folio-react",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "React editor for folio: a Word-document (.docx) editor for the browser, built on @stll/folio-core and ProseMirror.",
   "keywords": [
     "document-editor",
@@ -58,7 +58,7 @@
     "@fontsource/cousine": "^5.2.7",
     "@fontsource/noto-sans-arabic": "^5.2.7",
     "@fontsource/tinos": "^5.2.7",
-    "@stll/folio-core": "^0.1.3",
+    "@stll/folio-core": "^0.2.0",
     "better-result": "2.9.2",
     "lucide-react": "1.21.0",
     "prosemirror-history": "^1.5.0",
@@ -82,6 +82,7 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
+    "skills",
     "README.md",
     "LICENSE",
     "NOTICE.md"