@twip/web 0.0.0-canary-84c6597 → 0.0.0-canary-8a13ac8

package/dist/commands.d.ts

@@ -1,5 +1,5 @@
 import type { RichText } from './review.js';
-import type { ControlKind, ControlOptions, DataBinding, ReferenceRule } from './services/elements.js';
+import type { ControlKind, ControlOptions, DataBinding, PlaceholderImage, ReferenceRule } from './services/elements.js';
 import type { TabAlignment, TabLeader, TabSelector } from './services/ruler.js';
 import type { ViewOptions } from './services/view.js';
 import type { AutoCorrectChange, HighlightColor, HorizontalPosition, LineSpacing, MarkupView, ObjectWrap, RowHeight, TablePosition, TableWidth, UnderlineStyle, VerticalPosition, WrapSide } from './state.js';
@@ -9,26 +9,6 @@ export interface FieldTargets {
     /** The fields; default: the selection's. */
     ids?: ElementId[];
 }
-/** How a picture placeholder looks before it is filled. */
-export interface PlaceholderLook {
-    /** Which placeholders: one, those with a tag or a key prefix, or the default for the rest. */
-    match: {
-        id: ElementId;
-    } | {
-        tag: string;
-    } | {
-        prefix: string;
-    } | 'default';
-    /** A fill, label and icon, or an image. */
-    look: {
-        fill?: Color;
-        label?: string;
-        iconSvg?: string;
-    } | {
-        image: Uint8Array;
-        mime: string;
-    };
-}
 /**
  * Every edit, one method per command. Each resolves after its change commits, with `getState()` already at that
  * revision, and rejects with `EditorError`. Commands act on the selection at the time they run. Each is one undo
@@ -539,11 +519,20 @@ export interface Commands {
         placeholder?: string;
         binding?: DataBinding;
         options?: ControlOptions;
+        /**
+         * A picture control's placeholder picture (PNG, JPEG, GIF, BMP or SVG): what the editor, the saved DOCX and a
+         * PDF show until it is filled. An SVG is drawn with the picture's box as its viewport, so one with percentage
+         * geometry and no `viewBox` adapts to every size. Default: the engine's.
+         */
+        placeholderImage?: PlaceholderImage;
         wrapSelection?: boolean;
     }): Promise<{
         id: ElementId;
     }>;
-    /** Changes a content control; a `null` binding removes it. */
+    /**
+     * Changes a content control; a `null` binding removes it. `placeholderImage` replaces a picture control's
+     * placeholder picture while it shows it (else it rejects with `unavailable`).
+     */
     setControl(options: {
         id: ElementId;
         tag?: string;
@@ -552,6 +541,7 @@ export interface Commands {
         placeholder?: string;
         binding?: DataBinding | null;
         options?: ControlOptions;
+        placeholderImage?: PlaceholderImage;
     }): Promise<void>;
     /** Removes a content control, optionally keeping its content. */
     removeControl(options: {
@@ -598,11 +588,6 @@ export interface Commands {
         }[];
         clear?: boolean;
     }): Promise<void>;
-    /** Sets how picture placeholders look. View. */
-    setPlaceholderLooks(options: {
-        looks: PlaceholderLook[];
-        merge?: boolean;
-    }): Promise<void>;
     /** Fills the selected placeholder, or every unfilled one with `key`: each becomes a plain picture, its content control removed. */
     fillPlaceholder(options: {
         key?: string;

package/dist/commands.js

@@ -161,7 +161,6 @@ const encodings = {
     removeElement: 'value',
     replaceInElements: 'spread',
     markElements: 'spread',
-    setPlaceholderLooks: 'spread',
     fillPlaceholder: 'spread',
     writeDataPart: 'spread',
     removeDataPart: 'spread',

package/dist/index.d.ts

@@ -7,7 +7,7 @@
 export { Editor, HeadlessEditor } from './editor.js';
 export { configure } from './transport/module.js';
 export type { ExportOptions, ExportResult, MountOptions, PdfOptions, SessionOptions } from './editor.js';
-export type { CommandEntry, CommandId, CommandInfo, Commands, FieldTargets, NoArgumentCommandId, Op, OpArgs, PlaceholderLook, } from './commands.js';
+export type { CommandEntry, CommandId, CommandInfo, Commands, FieldTargets, NoArgumentCommandId, Op, OpArgs, } from './commands.js';
 export type { AutoCorrectChange, AutoCorrectEntry, AutoCorrectOptions, CharacterFormatting, CommandState, CommandValues, EditingTarget, EditorState, ElementContext, HighlightColor, HorizontalPosition, HorizontalReference, LineSpacing, MarkupView, Mixed, ObjectHorizontalAlignment, ObjectPlacement, ObjectSelection, ObjectVerticalAlignment, ObjectWrap, PageFormatting, ParagraphFormatting, ReviewState, RowHeight, SelectionSummary, TablePosition, TableSelection, TableStyleOptions, TableWidth, TextDistance, Tri, UnderlineStyle, VerticalPosition, VerticalReference, ViewState, WrapSide, } from './state.js';
 export type { HostCommand, Tooltip, TransactionRecord, TwipEvents } from './events.js';
 export { EditorError } from './errors.js';
@@ -19,7 +19,7 @@ export type { ContextMenu, ContextMenuEvent, MenuAction, MenuItem, MenuTarget, M
 export type { AccessibilityDialogSession, DialogKind, DialogSession, DialogSessionOf, DialogValues, Dialogs, FieldInfo, } from './services/dialogs.js';
 export type { Find, FindMatch, FindQuery, FindResult } from './services/find.js';
 export type { Dictionary, Spelling } from './services/spelling.js';
-export type { Block, ControlKind, ControlOptions, DataBinding, DataParts, ElementDetail, ElementInfo, Elements, MountedElements, PlaceholderInfo, ReferenceResolution, ReferenceRule, SubTemplateInfo, SubTemplateReference, SubTemplates, } from './services/elements.js';
+export type { Block, ControlKind, ControlOptions, PlaceholderImage, DataBinding, DataParts, ElementDetail, ElementInfo, Elements, MountedElements, PlaceholderInfo, ReferenceResolution, ReferenceRule, SubTemplateInfo, SubTemplateReference, SubTemplates, } from './services/elements.js';
 export type { Accessibility, AccessibleId, AccessibleNode, AnnouncementKind, CellPlace, ListPosition, Shortcuts } from './services/accessibility.js';
 export type { Heading, Navigation, StyleInfo, Styles } from './services/navigation.js';
 export type { Ruler, RulerModel, RulerModelSource, RulerUnit, RulerView, TabAlignment, TabLeader, TabSelector, } from './services/ruler.js';

package/dist/services/elements.d.ts

@@ -76,6 +76,11 @@ export interface ElementInfo {
     locked: boolean;
     /** A sub-template reference field's sub-template. */
     reference?: SubTemplateReference;
+    /** A picture control's picture size (inline or floating). */
+    size?: {
+        width: Points;
+        height: Points;
+    };
 }
 /**
  * One sub-template reference rule (`setSubTemplateRules`): a field of type `fieldType` names, in argument `argument`,
@@ -126,6 +131,13 @@ export interface DataBinding {
     /** The XPath's namespace prefixes. */
     prefixMappings?: string;
 }
+/** A picture control's placeholder picture: PNG, JPEG, GIF, BMP or SVG (`image/svg+xml`). */
+export interface PlaceholderImage {
+    /** The picture's bytes. */
+    data: Uint8Array;
+    /** Its MIME type; the data must be one. */
+    mime: string;
+}
 /**
  * A content control's options, by kind: checkbox, date, list, plain text, or picture. A picture's size (1…1584 pt) is
  * its placeholder's, and the picture's once filled (fitted to it); `setControl` keeps a side not given.

package/dist/state.d.ts

@@ -426,6 +426,11 @@ export interface ElementContext {
     tag?: string;
     /** A control's title. */
     title?: string;
+    /** A picture control's picture size (inline or floating). */
+    size?: {
+        width: Points;
+        height: Points;
+    };
 }
 /** The selection's character formatting. */
 export interface CharacterFormatting {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@twip/web",
-  "version": "0.0.0-canary-84c6597",
+  "version": "0.0.0-canary-8a13ac8",
   "description": "The Twip DOCX editor for the browser and Node: a managed, framework-independent editor over the WebAssembly engine.",
   "type": "module",
   "license": "Apache-2.0",