oasis-editor 0.0.133 → 0.0.135

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

@@ -1,2 +1,2 @@
-export declare const OASIS_BUILTIN_COMMANDS: readonly ["selectAll", "insertFootnote", "insertTableOfContents", "updateTableOfContents", "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", "setCharacterStyleId", "setUnderlineStyle", "documentStyles", "print", "copy", "exportDocx", "exportPdf", "importDocument", "insertImage", "editImageAlt", "insertImageCaption", "outdent", "indent", "togglePageBreakBefore", "toggleKeepWithNext", "setSpacingAfter", "setSpacingBefore", "setIndentLeft", "setIndentRight", "setIndentFirstLine", "setIndentHanging", "setSpecialIndent", "setParagraphShading", "applyParagraphBorders", "setLineHeight", "setListFormat", "setListStartAt", "toggleOrientation", "setOrientation", "sectionBreakNextPage", "sectionBreakContinuous", "setPageMargins", "tableContext", "tableMerge", "tableSplit", "tableInsertColumnBefore", "tableInsertColumnAfter", "tableDeleteColumn", "tableInsertRowBefore", "tableInsertRowAfter", "tableDeleteRow", "tableCellShading", "tableCellBorders", "tableCellNoBorders", "tableWidth100", "tableAlignLeft", "tableAlignCenter", "tableAlignRight", "tableSetCellWidth", "tableToggleHeaderRow", "tableToggleTotalRow", "tableToggleBandedRows", "tableToggleFirstColumn", "tableToggleLastColumn", "tableToggleBandedColumns", "setTableStyle", "tableToggleAutoFit", "tableDistributeColumns", "tableDistributeRows", "insertTable", "insertShape"];
+export declare const OASIS_BUILTIN_COMMANDS: readonly ["selectAll", "insertFootnote", "insertTableOfContents", "updateTableOfContents", "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", "setCharacterStyleId", "setUnderlineStyle", "documentStyles", "print", "copy", "exportDocx", "exportPdf", "importDocument", "insertImage", "editImageAlt", "insertImageCaption", "imageContext", "imageWidthCm", "imageHeightCm", "imageCrop", "imageCropAspect", "imageBorder", "outdent", "indent", "togglePageBreakBefore", "toggleKeepWithNext", "setSpacingAfter", "setSpacingBefore", "setIndentLeft", "setIndentRight", "setIndentFirstLine", "setIndentHanging", "setSpecialIndent", "setParagraphShading", "applyParagraphBorders", "setLineHeight", "setListFormat", "setListStartAt", "toggleOrientation", "setOrientation", "sectionBreakNextPage", "sectionBreakContinuous", "setPageMargins", "tableContext", "tableMerge", "tableSplit", "tableInsertColumnBefore", "tableInsertColumnAfter", "tableDeleteColumn", "tableInsertRowBefore", "tableInsertRowAfter", "tableDeleteRow", "tableCellShading", "tableCellBorders", "tableCellNoBorders", "tableWidth100", "tableAlignLeft", "tableAlignCenter", "tableAlignRight", "tableSetCellWidth", "tableToggleHeaderRow", "tableToggleTotalRow", "tableToggleBandedRows", "tableToggleFirstColumn", "tableToggleLastColumn", "tableToggleBandedColumns", "setTableStyle", "tableToggleAutoFit", "tableDistributeColumns", "tableDistributeRows", "insertTable", "insertShape"];
 export type OasisBuiltinCommand = (typeof OASIS_BUILTIN_COMMANDS)[number];

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

@@ -1,4 +1,4 @@
-import { EditorPosition, EditorState, EditorImageRunData } from '../model.js';
+import { EditorPosition, EditorState, EditorImageRunData, EditorImageBorder, EditorImageCrop, EditorLineDash } from '../model.js';
 import { SelectedObjectRun } from './selectedObjectRun.js';
 import { WrapPreset } from './floatingLayout.js';
 
@@ -6,6 +6,56 @@ export type SelectedImageRun = SelectedObjectRun;
 export declare function getSelectedImageRun(state: EditorState): SelectedImageRun | null;
 export declare function insertImageAtSelection(state: EditorState, image: EditorImageRunData): EditorState;
 export declare function resizeSelectedImage(state: EditorState, width: number, height: number): EditorState;
+/** Displayed size of the selected image, in centimetres, or `null`. */
+export declare function getSelectedImageSizeCm(state: EditorState): {
+    width: number;
+    height: number;
+} | null;
+/**
+ * Sets the displayed width from a centimetre value, scaling the height by the
+ * current aspect ratio (Word locks aspect for pictures).
+ */
+export declare function setSelectedImageWidthCm(state: EditorState, cm: number): EditorState;
+/** Sets the displayed height from a centimetre value, scaling width to match. */
+export declare function setSelectedImageHeightCm(state: EditorState, cm: number): EditorState;
+/** Crop fractions of the selected image (`a:srcRect`), or `null`. */
+export declare function getSelectedImageCrop(state: EditorState): EditorImageCrop | null;
+export interface ImageCropUpdate {
+    crop: EditorImageCrop | null;
+    /** Optional new displayed width (px) — used when cropping shrinks the box. */
+    width?: number;
+    /** Optional new displayed height (px). */
+    height?: number;
+}
+/**
+ * Applies a crop (and optionally a new displayed size) to the selected image.
+ * Passing `crop: null` clears the crop. Round-trips to DOCX `a:srcRect`.
+ */
+export declare function setSelectedImageCrop(state: EditorState, update: ImageCropUpdate): EditorState;
+/** Aspect-ratio crop preset: a numeric `width/height` ratio, or `"reset"`. */
+export type ImageCropAspectMode = number | "reset";
+/**
+ * Computes a centred crop that makes the displayed box match `mode` (a
+ * `width/height` ratio), trimming the longer axis and shrinking that box
+ * dimension so the image is not distorted. `"reset"` clears the crop.
+ */
+export declare function computeImageAspectCrop(image: EditorImageRunData, mode: ImageCropAspectMode): ImageCropUpdate;
+/** Applies an aspect-ratio crop preset to the selected image. */
+export declare function applySelectedImageCropAspect(state: EditorState, mode: ImageCropAspectMode): EditorState;
+/** Outline of the selected image (`pic:spPr/a:ln`), or `null`. */
+export declare function getSelectedImageBorder(state: EditorState): EditorImageBorder | null;
+/**
+ * A partial edit of the image outline, as dispatched by the picture-border
+ * toolbar popup. Each popup action touches one facet, so the patch merges onto
+ * whatever border the image already has. `color: null` removes the outline.
+ */
+export interface ImageBorderPatch {
+    color?: string | null;
+    widthPt?: number;
+    dash?: EditorLineDash;
+}
+/** Merges `patch` onto the selected image's outline. `color: null` clears it. */
+export declare function setSelectedImageBorder(state: EditorState, patch: ImageBorderPatch): EditorState;
 export declare function rotateSelectedImage(state: EditorState, rotation: number): EditorState;
 export declare function getSelectedImageWrapPreset(state: EditorState): WrapPreset | null;
 export declare function isSelectedImageFixedPosition(state: EditorState): boolean;

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

@@ -67,6 +67,11 @@ export interface OasisCommandPayloads {
     insertImage: undefined;
     editImageAlt: undefined;
     insertImageCaption: undefined;
+    imageContext: undefined;
+    imageWidthCm: number | string | null;
+    imageHeightCm: number | string | null;
+    imageCrop: undefined;
+    imageCropAspect: string;
     outdent: undefined;
     indent: undefined;
     togglePageBreakBefore: undefined;

package/dist/core/lineDash.d.ts

@@ -0,0 +1,16 @@
+import { EditorLineDash } from './model/types/primitives.js';
+
+/**
+ * Canonical dash patterns for DrawingML `a:prstDash` presets, expressed in
+ * typographic points. This is the single source of truth shared by every
+ * renderer: the canvas scales them by `PX_PER_POINT` for `setLineDash`, the PDF
+ * exporter feeds them straight to the `d` operator, and the DOCX serializer
+ * needs no numbers at all (it writes the preset name back out verbatim).
+ *
+ * `solid` is the empty pattern — a continuous line in both backends.
+ */
+export declare const LINE_DASH_PATTERN_PT: Record<EditorLineDash, number[]>;
+/** Narrows an untrusted `a:prstDash/@val` to a supported preset. */
+export declare function parseLineDash(value: string | null | undefined): EditorLineDash | undefined;
+/** Dash pattern for a border, in points. Empty for solid/undefined. */
+export declare function lineDashPatternPt(dash: EditorLineDash | undefined): number[];

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

@@ -6,7 +6,7 @@
  * statements that pointed there continue to work via the barrel
  * re-export in `src/core/model.ts`.
  */
-export type { EditorUnderlineStyle, EditorLigatures, EditorNumberSpacing, EditorNumberForm, EditorTextLanguage, EditorBorderStyle, EditorEmphasisMark, EditorTabStop, EditorParagraphListStyle, EditorImageCrop, EditorImageFillMode, EditorImageFloatingPosition, EditorImageFloatingLayout, EditorImageRunData, EditorWrapPolygonPoint, EditorFieldData, EditorFieldChar, EditorFootnoteReferenceData, EditorEndnoteReferenceData, EditorRevision, EditorRevisionMetadata, EditorStructuralRevision, EditorPropertyRevision, EditorAsset, EditorFootnoteNumberFormat, EditorFootnoteRestart, EditorDocxWidthValue, EditorTableLayout, EditorTableRowHeightRule, EditorGradientStop, EditorTextFill, EditorTextOutline, EditorTextShadow, EditorGlow, EditorReflection, } from './types/primitives.js';
+export type { EditorUnderlineStyle, EditorLigatures, EditorNumberSpacing, EditorNumberForm, EditorTextLanguage, EditorBorderStyle, EditorEmphasisMark, EditorTabStop, EditorParagraphListStyle, EditorImageCrop, EditorImageFillMode, EditorLineDash, EditorImageBorder, EditorImageFloatingPosition, EditorImageFloatingLayout, EditorImageRunData, EditorWrapPolygonPoint, EditorFieldData, EditorFieldChar, EditorFootnoteReferenceData, EditorEndnoteReferenceData, EditorRevision, EditorRevisionMetadata, EditorStructuralRevision, EditorPropertyRevision, EditorAsset, EditorFootnoteNumberFormat, EditorFootnoteRestart, EditorDocxWidthValue, EditorTableLayout, EditorTableRowHeightRule, EditorGradientStop, EditorTextFill, EditorTextOutline, EditorTextShadow, EditorGlow, EditorReflection, } from './types/primitives.js';
 export type { EditorTextStyle, EditorParagraphStyle, EditorTableStyle, EditorTableFloatingLayout, EditorTableConditionalFormat, EditorConditionalRowStyle, EditorTableConditionalType, EditorTableConditionalFlags, EditorTableCellStyle, EditorNamedStyle, } from './types/styles.js';
 export type { EditorRunBase, EditorTextRun, EditorTextBoxShape, EditorTextBoxBody, EditorTextBoxData, EditorDropCap, EditorSdtBlockWrapper, EditorParagraphNode, EditorTableCellNode, EditorTableRowStyle, EditorTableRowNode, EditorTableNode, EditorBlockNode, } from './types/nodes.js';
 export type { RunKind, RunOfKind, RunVisitor } from './runKind.js';

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

@@ -110,6 +110,24 @@ export interface EditorImageCrop {
     bottom?: number;
 }
 export type EditorImageFillMode = "stretch" | "tile";
+/**
+ * Preset dash patterns for an outline, mapped from DrawingML `a:prstDash/@val`.
+ * The member names are the serialized OOXML tokens.
+ */
+export type EditorLineDash = "solid" | "dot" | "sysDot" | "dash" | "sysDash" | "dashDot" | "lgDash" | "lgDashDot" | "lgDashDotDot";
+/**
+ * An image outline, mapped from `pic:spPr/a:ln`. Word centers the stroke on the
+ * displayed box edge and reserves no layout space for it. An absent `border`
+ * means no outline.
+ */
+export interface EditorImageBorder {
+    /** `a:ln/a:solidFill/a:srgbClr` as `#RRGGBB`. */
+    color: string;
+    /** `a:ln/@w`, in points. Absent ⇒ 1pt. */
+    widthPt?: number;
+    /** `a:ln/a:prstDash/@val`. Absent ⇒ solid. */
+    dash?: EditorLineDash;
+}
 export interface EditorImageFloatingPosition {
     relativeFrom?: string;
     align?: string;
@@ -145,6 +163,7 @@ export interface EditorImageRunData {
     linkedSrc?: string;
     crop?: EditorImageCrop;
     fillMode?: EditorImageFillMode;
+    border?: EditorImageBorder;
     rotation?: number;
     flipH?: boolean;
     flipV?: boolean;

package/dist/core/pluginUiTypes.d.ts

@@ -1,4 +1,4 @@
-export declare const RIBBON_TABS: readonly ["file", "home", "insert", "draw", "layout", "references", "collaboration", "protection", "view", "tableDesign", "tableLayout", "plugins", "ai"];
+export declare const RIBBON_TABS: readonly ["file", "home", "insert", "draw", "layout", "references", "collaboration", "protection", "view", "tableDesign", "tableLayout", "imageFormat", "plugins", "ai"];
 export type RibbonTabId = (typeof RIBBON_TABS)[number];
 /**
  * Contextual tabs are hidden from the tab strip unless their gating command

package/dist/core/transactionMergeKeys.d.ts

@@ -7,6 +7,8 @@ export declare const MERGE_KEYS: {
     readonly link: "link";
     readonly imageAlt: "imageAlt";
     readonly imageCaption: "imageCaption";
+    readonly imageResize: "imageResize";
+    readonly imageCrop: "imageCrop";
     readonly layoutWrapPolygon: "layoutWrapPolygon";
     readonly specialIndent: "specialIndent";
     readonly paraBorders: "paraBorders";

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

@@ -1,4 +1,4 @@
-import { EditorBlockNode, EditorImageCrop, EditorImageFillMode, EditorImageFloatingLayout, EditorParagraphListStyle, EditorWrapPolygonPoint } from '../../core/model.js';
+import { EditorBlockNode, EditorImageBorder, EditorImageCrop, EditorImageFillMode, EditorImageFloatingLayout, EditorParagraphListStyle, EditorWrapPolygonPoint } from '../../core/model.js';
 import { BookmarkEventsByParagraph } from './bookmarksXml.js';
 import { CommentEventsByParagraph } from './commentsXml.js';
 
@@ -36,6 +36,7 @@ export interface DocContext {
         alt?: string;
         crop?: EditorImageCrop;
         fillMode?: EditorImageFillMode;
+        border?: EditorImageBorder;
         rotation?: number;
         flipH?: boolean;
         flipV?: boolean;

package/dist/export/docx/text/drawingContainerXml.d.ts

@@ -1,8 +1,14 @@
-import { EditorImageFloatingLayout, EditorWrapPolygonPoint } from '../../../core/model.js';
+import { EditorImageBorder, EditorImageFloatingLayout, EditorWrapPolygonPoint } from '../../../core/model.js';
 import { DocContext } from '../docxTypes.js';
 
 export declare function buildXfrmAttrs(img: DocContext["images"][number]): string;
 export declare function buildSrcRect(crop: DocContext["images"][number]["crop"]): string;
+/**
+ * The picture outline. Belongs inside `pic:spPr` right after `a:prstGeom` —
+ * `CT_ShapeProperties` sequences xfrm, geometry, fill, then `a:ln` (a picture's
+ * fill lives in `pic:blipFill`, so nothing sits between the two here).
+ */
+export declare function buildImageLnXml(border: EditorImageBorder | undefined): string;
 export declare function buildDrawingContainerXml(options: {
     cx: number;
     cy: number;

package/dist/export/pdf/draw/drawImageObject.d.ts

@@ -0,0 +1,14 @@
+import { EditorDocument, EditorImageRunData } from '../../../core/model.js';
+import { OasisPdfWriter } from '../OasisPdfWriter.js';
+
+/**
+ * Draws one image — inline or floating — onto a page: the XObject itself, then
+ * its picture outline (`pic:spPr/a:ln`) if it has one. Shared by both call
+ * sites so the two can never drift on border handling.
+ *
+ * The rect passed in is the displayed box, in points. Crop never changes it:
+ * `drawImage` already clips the (enlarged) source to this same box, so the
+ * outline hugs what the reader sees. Rotation is applied around the box centre,
+ * mirroring `paintTextBox`.
+ */
+export declare function drawImageObject(writer: OasisPdfWriter, pageIndex: number, document: EditorDocument, image: EditorImageRunData, x: number, y: number, width: number, height: number): Promise<void>;

package/dist/export/pdf/writer/PdfContentStream.d.ts

@@ -34,4 +34,12 @@ export declare class PdfContentStream {
      */
     private emitGradientTextBlock;
     drawImage(options: OasisPdfImageOptions): void;
+    /**
+     * Draws a cropped image by clipping to the displayed box and scaling the full
+     * image so only the cropped sub-region fills it — mirroring the canvas/DOCX
+     * `a:srcRect` semantics. Works with rotation by mapping box-local space to the
+     * page (rotation about the box centre), clipping in that space, then drawing
+     * the enlarged image behind the clip.
+     */
+    private drawCroppedImage;
 }

package/dist/export/pdf/writer/pdfTypes.d.ts

@@ -87,6 +87,8 @@ export interface OasisPdfRectOptions {
     fill?: string;
     stroke?: string;
     lineWidth?: number;
+    /** Stroke dash pattern, in points. Ignored without a `stroke`. */
+    dashArray?: number[];
 }
 export interface OasisPdfLineOptions {
     x1: number;
@@ -165,6 +167,16 @@ export interface OasisPdfImageOptions {
     width: number;
     height: number;
     rotation?: number;
+    /**
+     * Crop fractions (0..1 trimmed per edge, matching `a:srcRect`). When present,
+     * only the cropped sub-region is shown, scaled to fill the box.
+     */
+    crop?: {
+        left?: number;
+        top?: number;
+        right?: number;
+        bottom?: number;
+    };
 }
 export type OasisPdfFontResource = OasisPdfBase14FontResource | OasisPdfUnicodeFontResource;
 export interface OasisPdfBase14FontResource {

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

@@ -365,6 +365,7 @@ export declare const en: {
     "ribbon.tab.view": string;
     "ribbon.tab.tableDesign": string;
     "ribbon.tab.tableLayout": string;
+    "ribbon.tab.imageFormat": string;
     "ribbon.tab.plugins": string;
     "ribbon.tab.ai": string;
     "ribbon.group.clipboard": string;
@@ -387,6 +388,33 @@ export declare const en: {
     "ribbon.group.merge": string;
     "ribbon.group.cellSize": string;
     "ribbon.group.alignment": string;
+    "ribbon.group.size": string;
+    "ribbon.group.imageStyles": string;
+    "image.crop": string;
+    "image.height": string;
+    "image.width": string;
+    "image.cropReset": string;
+    "image.cropRatio.square": string;
+    "image.cropRatio.16x9": string;
+    "image.cropRatio.4x3": string;
+    "image.cropRatio.3x2": string;
+    "image.cropRatio.2x3": string;
+    "image.cropRatio.3x4": string;
+    "image.cropRatio.9x16": string;
+    "image.border": string;
+    "image.borderNone": string;
+    "image.borderMoreColors": string;
+    "image.borderWeight": string;
+    "image.borderDashes": string;
+    "image.borderDash.solid": string;
+    "image.borderDash.sysDot": string;
+    "image.borderDash.sysDash": string;
+    "image.borderDash.dot": string;
+    "image.borderDash.dash": string;
+    "image.borderDash.dashDot": string;
+    "image.borderDash.lgDash": string;
+    "image.borderDash.lgDashDot": string;
+    "image.borderDash.lgDashDotDot": string;
     "toolbar.exportDocx": string;
     "toolbar.exportPdf": string;
     "underline.style.single": string;

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

@@ -365,6 +365,7 @@ export declare const ptBR: {
     "ribbon.tab.view": string;
     "ribbon.tab.tableDesign": string;
     "ribbon.tab.tableLayout": string;
+    "ribbon.tab.imageFormat": string;
     "ribbon.tab.plugins": string;
     "ribbon.tab.ai": string;
     "ribbon.group.clipboard": string;
@@ -387,6 +388,33 @@ export declare const ptBR: {
     "ribbon.group.merge": string;
     "ribbon.group.cellSize": string;
     "ribbon.group.alignment": string;
+    "ribbon.group.size": string;
+    "ribbon.group.imageStyles": string;
+    "image.crop": string;
+    "image.height": string;
+    "image.width": string;
+    "image.cropReset": string;
+    "image.cropRatio.square": string;
+    "image.cropRatio.16x9": string;
+    "image.cropRatio.4x3": string;
+    "image.cropRatio.3x2": string;
+    "image.cropRatio.2x3": string;
+    "image.cropRatio.3x4": string;
+    "image.cropRatio.9x16": string;
+    "image.border": string;
+    "image.borderNone": string;
+    "image.borderMoreColors": string;
+    "image.borderWeight": string;
+    "image.borderDashes": string;
+    "image.borderDash.solid": string;
+    "image.borderDash.sysDot": string;
+    "image.borderDash.sysDash": string;
+    "image.borderDash.dot": string;
+    "image.borderDash.dash": string;
+    "image.borderDash.dashDot": string;
+    "image.borderDash.lgDash": string;
+    "image.borderDash.lgDashDot": string;
+    "image.borderDash.lgDashDotDot": string;
     "toolbar.exportDocx": string;
     "toolbar.exportPdf": string;
     "underline.style.single": string;