oasis-editor 0.0.11 → 0.0.13

package/dist/core/commands/builtinCommands.d.ts

@@ -1,2 +1,2 @@
-export declare const OASIS_BUILTIN_COMMANDS: readonly ["selectAll", "insertFootnote", "pastePlainText", "bold", "italic", "underline", "strike", "superscript", "subscript", "link", "unlink", "alignLeft", "alignCenter", "alignRight", "alignJustify", "orderedList", "bulletList", "find", "replace", "toggleTrackChanges", "acceptRevisions", "rejectRevisions", "toggleShowMargins", "toggleShowParagraphMarks", "togglePreciseFonts", "undo", "redo", "pageBreak", "lineBreak", "splitBlock", "setFontFamily", "setFontSize", "increaseFontSize", "decreaseFontSize", "changeTextCase", "clearFormatting", "setColor", "setHighlight", "setTextShading", "setStyleId", "setUnderlineStyle", "documentStyles", "print", "copy", "exportDocx", "exportPdf", "importDocument", "insertImage", "editImageAlt", "outdent", "indent", "togglePageBreakBefore", "toggleKeepWithNext", "setSpacingAfter", "setSpacingBefore", "setIndentLeft", "setIndentRight", "setIndentFirstLine", "setIndentHanging", "setParagraphShading", "applyParagraphBorders", "setLineHeight", "setListFormat", "setListStartAt", "toggleOrientation", "sectionBreakNextPage", "sectionBreakContinuous", "setPageMargins", "tableContext", "tableMerge", "tableSplit", "tableInsertColumnBefore", "tableInsertColumnAfter", "tableDeleteColumn", "tableInsertRowBefore", "tableInsertRowAfter", "tableDeleteRow", "tableCellShading", "tableCellBorders", "tableCellNoBorders", "tableWidth100", "tableAlignLeft", "tableAlignCenter", "tableAlignRight", "tableSetCellWidth", "insertTable"];
+export declare const OASIS_BUILTIN_COMMANDS: readonly ["selectAll", "insertFootnote", "pastePlainText", "bold", "italic", "underline", "strike", "superscript", "subscript", "link", "unlink", "alignLeft", "alignCenter", "alignRight", "alignJustify", "orderedList", "bulletList", "find", "replace", "toggleTrackChanges", "acceptRevisions", "rejectRevisions", "toggleShowMargins", "toggleShowParagraphMarks", "togglePreciseFonts", "undo", "redo", "pageBreak", "lineBreak", "splitBlock", "setFontFamily", "setFontSize", "increaseFontSize", "decreaseFontSize", "changeTextCase", "clearFormatting", "setColor", "setHighlight", "setTextShading", "setStyleId", "setUnderlineStyle", "documentStyles", "print", "copy", "exportDocx", "exportPdf", "importDocument", "insertImage", "editImageAlt", "insertImageCaption", "outdent", "indent", "togglePageBreakBefore", "toggleKeepWithNext", "setSpacingAfter", "setSpacingBefore", "setIndentLeft", "setIndentRight", "setIndentFirstLine", "setIndentHanging", "setParagraphShading", "applyParagraphBorders", "setLineHeight", "setListFormat", "setListStartAt", "toggleOrientation", "sectionBreakNextPage", "sectionBreakContinuous", "setPageMargins", "tableContext", "tableMerge", "tableSplit", "tableInsertColumnBefore", "tableInsertColumnAfter", "tableDeleteColumn", "tableInsertRowBefore", "tableInsertRowAfter", "tableDeleteRow", "tableCellShading", "tableCellBorders", "tableCellNoBorders", "tableWidth100", "tableAlignLeft", "tableAlignCenter", "tableAlignRight", "tableSetCellWidth", "insertTable"];
 export type OasisBuiltinCommand = (typeof OASIS_BUILTIN_COMMANDS)[number];

package/dist/core/commands/image.d.ts

@@ -20,4 +20,6 @@ export declare function setSelectedImageFixedPosition(state: EditorState, fixed:
 export declare function setImageWrapPolygon(state: EditorState, runId: string, polygon: EditorImageRunData["wrapPolygon"]): EditorState;
 export declare function getSelectedImageAlt(state: EditorState): string | null;
 export declare function setSelectedImageAlt(state: EditorState, alt: string | null): EditorState;
+export declare function getSelectedImageCaption(state: EditorState): string | null;
+export declare function setSelectedImageCaption(state: EditorState, captionText: string, label: string): EditorState;
 export declare function moveSelectedImageToPosition(state: EditorState, targetPosition: EditorPosition): EditorState;

package/dist/core/commands/publicCommandTypes.d.ts

@@ -61,6 +61,7 @@ export interface OasisCommandPayloads {
     importDocument: undefined;
     insertImage: undefined;
     editImageAlt: undefined;
+    insertImageCaption: undefined;
     outdent: undefined;
     indent: undefined;
     togglePageBreakBefore: undefined;

package/dist/core/document/imageCaptions.d.ts

@@ -0,0 +1,13 @@
+import { EditorDocument, EditorParagraphNode } from '../../../model.js';
+
+export declare const IMAGE_CAPTION_STYLE_ID = "Caption";
+export declare const IMAGE_CAPTION_FIELD_IDENTIFIER = "Figure";
+export declare const IMAGE_CAPTION_FIELD_INSTRUCTION = " SEQ Figure \\* ARABIC ";
+export declare function createImageCaptionParagraph(captionText: string, label: string, sequenceNumber: number): EditorParagraphNode;
+export declare function isImageCaptionParagraph(paragraph: EditorParagraphNode | undefined): paragraph is EditorParagraphNode;
+export declare function getImageCaptionText(paragraph: EditorParagraphNode | undefined): string;
+export declare function updateImageCaptionParagraph(paragraph: EditorParagraphNode, captionText: string, label: string): EditorParagraphNode;
+export declare function renumberImageCaptionParagraphs(paragraphs: EditorParagraphNode[]): EditorParagraphNode[];
+export declare function renumberImageCaptionsInDocument(document: EditorDocument): EditorDocument;
+export declare function getCaptionSelectionOffset(paragraph: EditorParagraphNode): number;
+export declare function cloneParagraphsWithRenumberedCaptions(paragraphs: EditorParagraphNode[]): EditorParagraphNode[];

package/dist/core/editorState.d.ts

@@ -2,6 +2,7 @@ import { EditorAsset, EditorBlockNode, EditorDocument, EditorFootnote, EditorPag
 
 export declare function resetEditorIds(): void;
 export declare function createEditorBookmarkId(): string;
+export declare function createEditorCommentId(): string;
 export declare function createEditorRun(text?: string): EditorTextRun;
 export declare function createEditorStyledRun(text?: string, styles?: EditorTextStyle, image?: EditorImageRunData, textBox?: EditorTextBoxData): EditorTextRun;
 export declare function createEditorParagraph(text?: string): EditorParagraphNode;

package/dist/core/model/index.d.ts

@@ -12,6 +12,7 @@ export type { EditorTextRun, EditorTextBoxShape, EditorTextBoxBody, EditorTextBo
 export type { EditorFootnote } from '../../types/documentFootnotes.js';
 export type { EditorEndnote } from '../../types/documentEndnotes.js';
 export type { EditorBookmark, EditorBookmarkAnchor, EditorBookmarks, } from '../../types/documentBookmarks.js';
+export type { EditorComment, EditorCommentAnchor, EditorComments, } from '../../types/documentComments.js';
 export type { EditorPageMargins, EditorPageSettings, EditorSection, EditorFootnoteSettings, EditorFootnotes, EditorEndnoteSettings, EditorEndnotes, EditorDocument, } from '../../types/document.js';
 export type { EditorPosition, EditorSelection, EditorEditingZone, } from '../../types/selection.js';
 export type { EditorCaretSlot, EditorLayoutFragmentChar, EditorLayoutFragment, EditorLayoutLine, EditorLayoutParagraph, EditorLayoutBlock, TableCellBlockPosition, EditorLayoutPage, EditorLayoutDocument, } from '../../types/layout.js';

package/dist/core/model/types/document.d.ts

@@ -3,6 +3,7 @@ import { EditorBlockNode } from '../../../nodes.js';
 import { EditorFootnote } from '../../../documentFootnotes.js';
 import { EditorEndnote } from '../../../documentEndnotes.js';
 import { EditorBookmarks } from '../../../documentBookmarks.js';
+import { EditorComments } from '../../../documentComments.js';
 import { EditorNamedStyle } from '../../../styles.js';
 
 export interface EditorPageMargins {
@@ -79,6 +80,12 @@ export interface EditorDocument {
      * hyperlinks (`#name`) and cross-references.
      */
     bookmarks?: EditorBookmarks;
+    /**
+     * Comment registry (`w:commentRangeStart`/`w:commentRangeEnd` +
+     * `word/comments.xml` bodies). Each comment owns a highlighted range and a
+     * body shown in a hover/click popup.
+     */
+    comments?: EditorComments;
     metadata?: {
         title?: string;
         [key: string]: unknown;

package/dist/core/model/types/documentComments.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Comment registry (Word's `w:commentRangeStart` / `w:commentRangeEnd` /
+ * `w:commentReference` + the `word/comments.xml` bodies).
+ *
+ * A comment is two independent things glued by a shared id:
+ *  - a *range* over the document text (start/end anchors), independent of the
+ *    run/paragraph tree — modeled exactly like {@link EditorBookmark}; and
+ *  - a *body* (author, date, text, resolved state) that lives out-of-band in
+ *    `word/comments.xml` — modeled like footnotes/endnotes.
+ *
+ * This is the import/display/export representation: faithful round-trip plus a
+ * highlighted range and a hover/click popup. Authoring (create/reply/resolve)
+ * and live-edit anchor transforms are intentionally out of scope here.
+ */
+export interface EditorCommentAnchor {
+    /** Id of the paragraph this anchor lives in (`EditorParagraphNode.id`). */
+    paragraphId: string;
+    /** Character offset into the paragraph's flattened text stream. */
+    offset: number;
+    /**
+     * Document order in which the original marker appeared. Keeps a deterministic
+     * emit order when several boundaries share one offset.
+     */
+    seq?: number;
+}
+export interface EditorComment {
+    /** Stable editor-local id (not the DOCX `w:id`). */
+    id: string;
+    /** Original DOCX `w:id`, used only as a hint for export id stability. */
+    docxIdHint?: number;
+    /** `w:comment/@w:author`. */
+    author: string;
+    /** `w:comment/@w:initials`. */
+    initials?: string;
+    /** `w:comment/@w:date` as an epoch millisecond timestamp. */
+    date?: number;
+    /** Resolved/"done" state (`w15:commentEx/@w15:done`). */
+    resolved?: boolean;
+    /** Flattened comment body text (bodies in scope are single paragraphs). */
+    text: string;
+    /** Start anchor. May be absent for a malformed import (orphan end). */
+    start?: EditorCommentAnchor;
+    /** End anchor. May be absent for a malformed import (orphan start). */
+    end?: EditorCommentAnchor;
+}
+export interface EditorComments {
+    items: Record<string, EditorComment>;
+    /** Stable creation/import order for deterministic export. */
+    order: string[];
+}

package/dist/export/docx/commentsXml.d.ts

@@ -0,0 +1,34 @@
+import { EditorComment, EditorDocument } from '../../../../core/model.js';
+
+export interface CommentBoundaryEvent {
+    kind: "start" | "end" | "reference";
+    /** Character offset into the paragraph's flattened text. */
+    offset: number;
+    /** Stable emit order for boundaries that share an offset. */
+    seq: number;
+    /** Allocated DOCX `w:id`. */
+    wId: number;
+}
+export type CommentEventsByParagraph = Map<string, CommentBoundaryEvent[]>;
+interface AssignedComment {
+    comment: EditorComment;
+    wId: number;
+    /** Allocated `w14:paraId` for the comment body paragraph. */
+    paraId: string;
+}
+export interface CommentExportPlan {
+    eventsByParagraph: CommentEventsByParagraph;
+    comments: AssignedComment[];
+}
+/**
+ * Allocate unique numeric `w:id`s (preferring each comment's imported hint),
+ * a `w14:paraId` per comment, and group start/end/reference boundary events by
+ * paragraph id. Returns `undefined` when the document has no comments.
+ */
+export declare function buildCommentExportPlan(document: EditorDocument): CommentExportPlan | undefined;
+export declare function serializeCommentRangeEvent(event: CommentBoundaryEvent): string;
+/** Build `word/comments.xml` from the assigned comments. */
+export declare function buildCommentsPartXml(plan: CommentExportPlan): string;
+/** Build `word/commentsExtended.xml` carrying the resolved/"done" state. */
+export declare function buildCommentsExtendedPartXml(plan: CommentExportPlan): string;
+export {};

package/dist/export/docx/docxTypes.d.ts

@@ -1,5 +1,6 @@
 import { EditorBlockNode, EditorImageCrop, EditorImageFillMode, EditorImageFloatingLayout, EditorParagraphListStyle, EditorWrapPolygonPoint } from '../../../../core/model.js';
 import { BookmarkEventsByParagraph } from '../../bookmarksXml.js';
+import { CommentEventsByParagraph } from '../../commentsXml.js';
 
 export interface NumberingDefinition {
     kind: EditorParagraphListStyle["kind"];
@@ -64,6 +65,12 @@ export interface DocContext {
      * paragraph ids are globally unique.
      */
     bookmarkEventsByParagraph?: BookmarkEventsByParagraph;
+    /**
+     * Per-paragraph comment boundary events (`w:commentRangeStart`/`End` +
+     * `w:commentReference`), keyed by `EditorParagraphNode.id`. Shared across all
+     * part contexts since paragraph ids are globally unique.
+     */
+    commentEventsByParagraph?: CommentEventsByParagraph;
 }
 export interface NumberingContext {
     numberingInfo: Map<string, {

package/dist/i18n/locales/en.d.ts

@@ -6,6 +6,7 @@ export declare const en: {
     "toolbar.redo": string;
     "toolbar.insert": string;
     "toolbar.image": string;
+    "toolbar.imageCaption": string;
     "toolbar.shapes": string;
     "toolbar.shape.rect": string;
     "toolbar.shape.roundRect": string;
@@ -229,6 +230,9 @@ export declare const en: {
     "dialog.imageAlt.title": string;
     "dialog.imageAlt.label": string;
     "dialog.imageAlt.placeholder": string;
+    "dialog.imageCaption.title": string;
+    "dialog.imageCaption.label": string;
+    "dialog.imageCaption.placeholder": string;
     "dialog.link.title": string;
     "dialog.link.label": string;
     "dialog.link.placeholder": string;

package/dist/i18n/locales/pt-BR.d.ts

@@ -6,6 +6,7 @@ export declare const ptBR: {
     "toolbar.redo": string;
     "toolbar.insert": string;
     "toolbar.image": string;
+    "toolbar.imageCaption": string;
     "toolbar.shapes": string;
     "toolbar.shape.rect": string;
     "toolbar.shape.roundRect": string;
@@ -229,6 +230,9 @@ export declare const ptBR: {
     "dialog.imageAlt.title": string;
     "dialog.imageAlt.label": string;
     "dialog.imageAlt.placeholder": string;
+    "dialog.imageCaption.title": string;
+    "dialog.imageCaption.label": string;
+    "dialog.imageCaption.placeholder": string;
     "dialog.link.title": string;
     "dialog.link.label": string;
     "dialog.link.placeholder": string;

package/dist/import/docx/comments.d.ts

@@ -0,0 +1,12 @@
+import { EditorCommentAnchor, EditorSection } from '../../../../core/model.js';
+
+export interface CommentRange {
+    start?: EditorCommentAnchor;
+    end?: EditorCommentAnchor;
+}
+/**
+ * Walk all stories in the imported sections, collect comment range boundaries,
+ * pair them by DOCX id and return a `docxId -> { start, end }` map. Mutates the
+ * paragraphs in place to remove the transient marker runs.
+ */
+export declare function extractCommentRangesFromSections(sections: EditorSection[]): Map<string, CommentRange>;

package/dist/import/docx/commentsXml.d.ts

@@ -0,0 +1,14 @@
+export interface ParsedCommentBody {
+    author: string;
+    initials?: string;
+    date?: number;
+    text: string;
+    resolved?: boolean;
+    /** `w14:paraId` of the comment's (first) paragraph — links to commentsEx. */
+    paraId?: string;
+}
+/**
+ * Parse `word/comments.xml` (+ optional `word/commentsExtended.xml`) into a map
+ * keyed by the DOCX `w:id` (string) of each comment.
+ */
+export declare function parseCommentsXml(commentsXml: string | null, commentsExtendedXml: string | null): Map<string, ParsedCommentBody>;

package/dist/import/docx/runs/types.d.ts

@@ -14,6 +14,15 @@ export interface ImportedBookmarkMarker {
     colFirst?: number;
     colLast?: number;
 }
+/**
+ * A `w:commentRangeStart` / `w:commentRangeEnd` marker carried through the run
+ * stream as a zero-length transient run. The import driver extracts these into
+ * the document-level comment registry once paragraph ids and offsets are known.
+ */
+export interface ImportedCommentMarker {
+    kind: "start" | "end";
+    docxId: string;
+}
 export interface ImportedRun {
     text: string;
     image?: EditorImageRunData;
@@ -39,6 +48,7 @@ export interface ImportedRun {
         customMark?: string;
     };
     bookmark?: ImportedBookmarkMarker;
+    comment?: ImportedCommentMarker;
     sym?: {
         font: string;
         char: string;

package/dist/import/docx/runs.d.ts

@@ -4,7 +4,7 @@ import { EditorImageRunData, EditorTextBoxData } from '../../../../core/model.js
 import { AssetRegistry } from '../../assetRegistry.js';
 import { DocxImportTheme } from '../../theme.js';
 import { NumberingMaps } from '../../numbering.js';
-import { ImportedBookmarkMarker, ImportedRun, ParseNestedBlocks } from '../../runs/types.js';
+import { ImportedBookmarkMarker, ImportedCommentMarker, ImportedRun, ParseNestedBlocks } from '../../runs/types.js';
 
 export type { ImportedRun } from '../../runs/types.js';
 export type { ParseNestedBlocks } from '../../runs/types.js';
@@ -17,6 +17,10 @@ export declare function parseRunElement(runElement: XmlElement, zip: JSZip, rels
         offset: number;
         marker: ImportedBookmarkMarker;
     }>;
+    innerComments?: Array<{
+        offset: number;
+        marker: ImportedCommentMarker;
+    }>;
     sym?: {
         font: string;
         char: string;