oasis-editor 0.0.11 → 0.0.13

package/dist/plugins/internal/createEssentialsPlugin.d.ts

@@ -77,6 +77,7 @@ export interface EssentialsLinkCapability {
 }
 export interface EssentialsImageCapability {
     promptAlt: () => void;
+    promptCaption: () => void;
     isSelected: () => boolean;
 }
 export interface EssentialsBrowserCapability {

package/dist/ui/OasisEditorEditor.d.ts

@@ -2,7 +2,7 @@ import { Accessor, JSX } from '../solid-js';
 import { ToolbarHost } from '../components/Toolbar/state/createToolbarApi.js';
 import { EditorLayoutParagraph, EditorState } from '../../core/model.js';
 import { ImportProgressState } from '../../app/controllers/useEditorDocumentIO.js';
-import { CaretBox, InputBox, LayoutOptionsOverlay, RevisionBox, SelectedImageBox, SelectedTextBoxBox, SelectionBox } from '../editorUiTypes.js';
+import { CaretBox, CommentHighlightBox, InputBox, LayoutOptionsOverlay, RevisionBox, SelectedImageBox, SelectedTextBoxBox, SelectionBox } from '../editorUiTypes.js';
 import { ResizeHandleDirection } from '../resizeGeometry.js';
 
 type ImportProgress = ImportProgressState;
@@ -17,6 +17,7 @@ export interface OasisEditorEditorLayoutProps {
 }
 export interface OasisEditorEditorOverlayProps {
     selectionBoxes: Accessor<SelectionBox[]>;
+    commentHighlights: Accessor<CommentHighlightBox[]>;
     selectedImageBox: Accessor<SelectedImageBox | null>;
     selectedTextBoxBox: Accessor<SelectedTextBoxBox | null>;
     caretBox: Accessor<CaretBox>;

package/dist/ui/app/EditorDialogsLayer.d.ts

@@ -16,6 +16,7 @@ export interface EditorDialogsLayerProps {
     focusInput: () => void;
     applyLinkCommand: (href: string | null) => void;
     applyImageAltCommand: (alt: string) => void;
+    applyImageCaptionCommand: (caption: string) => void;
     applyFontDialogValues: ComponentProps<typeof FontDialog>["onApply"];
     applyParagraphDialogValues: ComponentProps<typeof ParagraphDialog>["onApply"];
     applyTablePropertiesDialogValues: ComponentProps<typeof TablePropertiesDialog>["onApply"];

package/dist/ui/app/buildEditorViewProps.d.ts

@@ -1,5 +1,5 @@
 import { Accessor, JSX } from '../../solid-js';
-import { CaretBox, InputBox, LayoutOptionsOverlay, RevisionBox, SelectedImageBox, SelectedTextBoxBox, SelectionBox } from '../../../editorUiTypes.js';
+import { CaretBox, CommentHighlightBox, InputBox, LayoutOptionsOverlay, RevisionBox, SelectedImageBox, SelectedTextBoxBox, SelectionBox } from '../../../editorUiTypes.js';
 import { OasisEditorEditorFileHandlers, OasisEditorEditorInputHandlers, OasisEditorEditorLayoutProps, OasisEditorEditorOverlayProps, OasisEditorEditorRefProps, OasisEditorEditorSurfaceHandlers } from '../../../OasisEditorEditor.js';
 import { createEditorFocusController } from '../../useEditorFocus.js';
 import { createEditorSurfaceEvents } from '../../../../app/controllers/useEditorSurfaceEvents.js';
@@ -20,6 +20,7 @@ export interface EditorViewPropsContext {
     className: string | undefined;
     style: JSX.CSSProperties | undefined;
     selectionBoxes: Accessor<SelectionBox[]>;
+    commentHighlights: Accessor<CommentHighlightBox[]>;
     selectedImageBox: Accessor<SelectedImageBox | null>;
     selectedTextBoxBox: Accessor<SelectedTextBoxBox | null>;
     layoutOptions: LayoutOptionsOverlay;

package/dist/ui/app/useEditorDialogs.d.ts

@@ -19,6 +19,14 @@ export declare function createEditorDialogs(): {
         isOpen: boolean;
         initialAlt: string;
     }>;
+    imageCaptionDialog: import('../../solid-js').Accessor<{
+        isOpen: boolean;
+        initialCaption: string;
+    }>;
+    setImageCaptionDialog: import('../../solid-js').Setter<{
+        isOpen: boolean;
+        initialCaption: string;
+    }>;
     contextMenu: import('../../solid-js').Accessor<{
         isOpen: boolean;
         x: number;

package/dist/ui/canvas/CanvasCommentGeometry.d.ts

@@ -0,0 +1,13 @@
+import { EditorState } from '../../../../core/model.js';
+import { CommentHighlightBox } from '../../../editorUiTypes.js';
+import { CanvasLayoutSnapshot } from '../../CanvasLayoutSnapshot.js';
+
+/**
+ * Project each document comment's start/end anchors into highlight rectangles
+ * over the commented text, reusing the canvas layout snapshot's per-line slot
+ * positions (the same machinery `computeCanvasSelectionGeometry` uses for the
+ * live selection). Multi-line and cross-paragraph comments yield one box per
+ * covered line; every box carries its `commentId` so the overlay can group them
+ * and resolve the popup body on hover.
+ */
+export declare function computeCommentHighlights(snapshot: CanvasLayoutSnapshot, state: EditorState): CommentHighlightBox[];

package/dist/ui/components/CommentHighlightOverlay.d.ts

@@ -0,0 +1,16 @@
+import { Accessor } from '../../solid-js';
+import { EditorComment } from '../../../../core/model.js';
+import { CommentHighlightBox } from '../../../editorUiTypes.js';
+
+export interface CommentHighlightOverlayProps {
+    boxes: Accessor<CommentHighlightBox[]>;
+    /** Comment bodies keyed by their editor-local id, for the hover popup. */
+    commentsById: Accessor<Record<string, EditorComment>>;
+}
+/**
+ * Renders the highlight rectangles over commented text and, on hover/click of a
+ * highlight, a small popup with the comment's author/date/text (mirroring the
+ * track-changes `RevisionOverlay`). Hit-testing happens on the overlay divs
+ * themselves (`pointer-events: auto`), so no canvas hit-test plumbing is needed.
+ */
+export declare function CommentHighlightOverlay(props: CommentHighlightOverlayProps): import("solid-js").JSX.Element;

package/dist/ui/components/Dialogs/ImageCaptionDialog.d.ts

@@ -0,0 +1,8 @@
+interface ImageCaptionDialogProps {
+    isOpen: boolean;
+    initialCaption: string;
+    onClose: () => void;
+    onConfirm: (caption: string) => void;
+}
+export declare function ImageCaptionDialog(props: ImageCaptionDialogProps): import("solid-js").JSX.Element;
+export {};

package/dist/ui/components/Menubar/builtinMenuIds.d.ts

@@ -15,6 +15,7 @@ export declare const OASIS_MENU_ITEMS: {
     readonly viewParagraphMarks: "view_paragraph_marks";
     readonly viewPreciseFonts: "view_precise_fonts";
     readonly insertImage: "insert_image";
+    readonly insertImageCaption: "insert_image_caption";
     readonly insertTable: "insert_table";
     readonly insertLink: "insert_link";
     readonly insertFootnote: "insert_footnote";

package/dist/ui/components/Toolbar/presets/builtinToolbarIds.d.ts

@@ -23,6 +23,7 @@ export declare const OASIS_TOOLBAR_ITEMS: {
     readonly unlink: "editor-toolbar-unlink";
     readonly footnote: "editor-toolbar-footnote";
     readonly imageAlt: "editor-toolbar-image-alt";
+    readonly imageCaption: "editor-toolbar-image-caption";
     readonly alignLeft: "editor-toolbar-align-left";
     readonly alignCenter: "editor-toolbar-align-center";
     readonly alignRight: "editor-toolbar-align-right";

package/dist/ui/editorUiTypes.d.ts

@@ -48,6 +48,14 @@ export interface RevisionBox {
     left: number;
     top: number;
 }
+/** One highlight rectangle over a commented text range, tagged with its id. */
+export interface CommentHighlightBox {
+    commentId: string;
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+}
 /**
  * State and actions backing the Word-style "Layout Options" popup for the
  * selected image or text box.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oasis-editor",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "type": "module",
   "repository": {
     "type": "git",