@twip/web 0.0.0-canary-4e9c983 → 0.0.0-canary-8e34765

package/dist/THIRD-PARTY-NOTICES.md

@@ -3384,7 +3384,7 @@ the following restrictions:
 3. This notice may not be removed or altered from any source distribution.
 ```
 
-## C and C++ libraries, and fonts
+## C and C++ libraries, fonts and data
 
 ### Skia (BSD-3-Clause)
 
@@ -5455,3 +5455,41 @@ given a different name.
 
 $Id$
 ```
+
+### ECMA-376 preset shape definitions (LicenseRef-Ecma)
+
+In: the native library and the WebAssembly module
+
+```
+The preset shape geometries built into the engine are generated from presetShapeDefinitions.xml, an electronic insert
+of ECMA-376 Part 1, Office Open XML File Formats - Fundamentals and Markup Language Reference, 5th edition (December
+2016), https://ecma-international.org/publications-and-standards/standards/ecma-376/
+
+COPYRIGHT NOTICE
+(c) Ecma International
+By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply
+with the following terms and conditions.
+This document may be copied, published and distributed to others, and certain derivative works of it may be
+prepared, copied, published, and distributed, in whole or in part, provided that the above copyright notice and
+this Copyright License and Disclaimer are included on all such copies and derivative works. The only derivative
+works that are permissible under this Copyright License and Disclaimer are:
+(i) works which incorporate all or portion of this document for the purpose of providing commentary or
+    explanation (such as an annotated version of the document),
+(ii) works which incorporate all or portion of this document for the purpose of incorporating features that
+    provide accessibility,
+(iii) translations of this document into languages other than English and into different formats and
+(iv) works by making use of this specification in standard conformant products by implementing (e.g. by
+    copy and paste wholly or partly) the functionality therein.
+However, the content of this document itself may not be modified in any way, including by removing the
+copyright notice or references to Ecma International, except as required to translate it into languages other
+than English or into a different format.
+The official version of an Ecma International document is the English language version on the Ecma
+International website. In the event of discrepancies between a translated version and the official version, the
+official version shall govern.
+The limited permissions granted above are perpetual and will not be revoked by Ecma International or its
+successors or assigns.
+This document and the information contained herein is provided on an "AS IS" basis and ECMA
+INTERNATIONAL DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT
+THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF
+MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
+```

package/dist/commands.d.ts

@@ -2,7 +2,7 @@ import type { RichText } from './review.js';
 import type { ControlKind, ControlOptions, DataBinding } from './services/elements.js';
 import type { TabAlignment, TabLeader } from './services/ruler.js';
 import type { HighlightColor, HorizontalPosition, LineSpacing, MarkupView, ObjectWrap, RowHeight, TableWidth, UnderlineStyle, VerticalPosition, WrapSide } from './state.js';
-import type { Color, CommentId, ElementId, Points, RevisionId, StyleId } from './types.js';
+import type { Arrange, Color, CommentId, Degrees, EffectsChange, ElementId, FillValue, FlipAxis, LineChange, PictureAdjustChange, Points, RevisionId, ShapeAdjust, ShapeInsert, ShapePreset, ShapeTextChange, StyleId } from './types.js';
 /** Which elements a field command acts on: the given ids, or the selection's by default. */
 export interface FieldTargets {
     /** The fields; default: the selection's. */
@@ -254,6 +254,11 @@ export interface Commands {
     }): Promise<void>;
     /** Inserts a text box. */
     insertTextBox(): Promise<void>;
+    /**
+     * Inserts a floating shape at the caret's paragraph, in front of the text, with the theme's default style, and
+     * selects it.
+     */
+    insertShape(options: ShapeInsert): Promise<void>;
     /** Inserts a footnote. */
     insertFootnote(): Promise<void>;
     /** Inserts an endnote. */
@@ -406,6 +411,32 @@ export interface Commands {
     }): Promise<void>;
     /** Deletes the object. */
     deleteObject(): Promise<void>;
+    /** Changes the shape's preset geometry; its text, fill, outline and effects stay and its adjust values reset. */
+    setShapePreset(preset: ShapePreset): Promise<void>;
+    /** Sets one of the shape's adjust values. */
+    setShapeAdjust(options: ShapeAdjust): Promise<void>;
+    /** Sets the selected objects' fill; `fromStyle` gives them the style reference's again. */
+    setShapeFill(fill: FillValue): Promise<void>;
+    /** Sets the selected objects' outline; unset fields keep their value. */
+    setShapeLine(change: LineChange): Promise<void>;
+    /** Sets the selected objects' shadows, glow, soft edge and blur; unset fields keep their value, `null` removes. */
+    setShapeEffects(change: EffectsChange): Promise<void>;
+    /** Sets the shape's text insets, anchor, autofit, wrapping and direction; unset fields keep their value. */
+    setShapeText(change: ShapeTextChange): Promise<void>;
+    /** Sets the picture's transparency, greyscale, brightness and contrast; unset fields keep their value. */
+    setPictureAdjust(change: PictureAdjustChange): Promise<void>;
+    /** Sets the selected objects' rotation, 0 to 360 degrees clockwise. */
+    setObjectRotation(degrees: Degrees): Promise<void>;
+    /** Flips the selected objects. */
+    flipObject(axis: FlipAxis): Promise<void>;
+    /** Moves the floating object in the paint order, or behind or in front of the text. */
+    arrangeObject(where: Arrange): Promise<void>;
+    /** Groups the selected floating objects: two or more, in one story. The group is selected. */
+    groupObjects(): Promise<void>;
+    /** Ungroups the selected group. Its children are selected. */
+    ungroupObjects(): Promise<void>;
+    /** Selects the next or previous child of the selected group. View. */
+    selectGroupChild(direction: 'next' | 'previous'): Promise<void>;
     /** Changes a field's code or display. */
     setField(options: {
         id: ElementId;
@@ -597,13 +628,13 @@ export interface Commands {
 /** A command id: the method name, the batch op's `type`, the catalog id and the key in `state.commands`. */
 export type CommandId = keyof Commands;
 /**
- * An op's fields besides `type`. A single argument (a primitive, {@link RichText}, bytes, an array, or a union with a
- * primitive) goes in `value`; an options object, and a tagged value such as {@link LineSpacing} or
- * {@link TableWidth}, is spread into the op.
+ * An op's fields besides `type`. A single argument (a primitive, {@link RichText}, bytes, an array, a
+ * {@link FillValue}, whose `type` would clash with the op's, or a union with a primitive) goes in `value`; an options
+ * object, and a tagged value such as {@link LineSpacing} or {@link TableWidth}, is spread into the op.
  */
 export type OpArgs<K extends CommandId> = Parameters<Commands[K]> extends [] ? {} : [Exclude<Parameters<Commands[K]>[0], undefined>] extends [string | number | boolean | null] ? {
     value: Exclude<Parameters<Commands[K]>[0], undefined>;
-} : [Exclude<Parameters<Commands[K]>[0], undefined>] extends [RichText | Uint8Array | readonly unknown[]] ? {
+} : [Exclude<Parameters<Commands[K]>[0], undefined>] extends [RichText | Uint8Array | FillValue | readonly unknown[]] ? {
     value: Exclude<Parameters<Commands[K]>[0], undefined>;
 } : [Exclude<Parameters<Commands[K]>[0], undefined>] extends [object] ? Exclude<Parameters<Commands[K]>[0], undefined> : {
     value: Exclude<Parameters<Commands[K]>[0], undefined>;

package/dist/commands.js

@@ -79,6 +79,7 @@ const encodings = {
     insertTable: 'spread',
     insertPicture: 'spread',
     insertTextBox: 'none',
+    insertShape: 'spread',
     insertFootnote: 'none',
     insertEndnote: 'none',
     insertHyperlink: 'spread',
@@ -121,6 +122,19 @@ const encodings = {
     setObjectWrapOptions: 'spread',
     setAltText: 'spread',
     deleteObject: 'none',
+    setShapePreset: 'value',
+    setShapeAdjust: 'spread',
+    setShapeFill: 'value',
+    setShapeLine: 'spread',
+    setShapeEffects: 'spread',
+    setShapeText: 'spread',
+    setPictureAdjust: 'spread',
+    setObjectRotation: 'value',
+    flipObject: 'value',
+    arrangeObject: 'value',
+    groupObjects: 'none',
+    ungroupObjects: 'none',
+    selectGroupChild: 'value',
     setField: 'spread',
     setFieldResults: 'spread',
     updateFields: 'spread',

package/dist/editor.d.ts

@@ -13,7 +13,7 @@ import { type Dictionary, type Spelling } from './services/spelling.js';
 import { type Gestures, type View } from './services/view.js';
 import type { EditorState } from './state.js';
 import { type FrameInfo, Method, type Input, type Message, type Transport } from './transport/protocol.js';
-import type { Author, Color, OverlayColors, Warning, WordCount } from './types.js';
+import type { Author, Color, OverlayColors, ShapeGalleryGroup, Warning, WordCount } from './types.js';
 /** Options for a new session. */
 export interface SessionOptions {
     /** Start read only. Default false. */
@@ -95,6 +95,7 @@ export declare class Session {
     readonly id: number;
     state: EditorState;
     readonly catalog: readonly CommandInfo[];
+    readonly shapeGallery: readonly ShapeGalleryGroup[];
     destroyed: boolean;
     /** Mounted hosts listen for frame and host requests here. */
     readonly hostListeners: Set<(message: Message) => void>;
@@ -130,6 +131,8 @@ export declare class HeadlessEditor {
     readonly commands: Commands;
     /** Every command's id, label, group, shortcuts and undo grouping. */
     readonly catalog: readonly CommandInfo[];
+    /** Word's Insert \> Shapes gallery: its groups and their presets, in order. */
+    readonly shapeGallery: readonly ShapeGalleryGroup[];
     /** The context menu. */
     readonly menus: Menus;
     /** The dialogs. */

package/dist/editor.js

@@ -40,19 +40,31 @@ export function toWire(value) {
     return value;
 }
 function deepFreeze(value) {
-    if (value && typeof value === 'object' && !Object.isFrozen(value)) {
+    // Bytes can't be frozen.
+    if (value && typeof value === 'object' && !ArrayBuffer.isView(value) && !Object.isFrozen(value)) {
         Object.freeze(value);
         for (const v of Object.values(value))
             deepFreeze(v);
     }
     return value;
 }
+/** The state in the SDK's shape: a picture fill's image, base64 as the engine sends it, as bytes. */
+function fromWireState(state) {
+    const shape = state.selection.object?.shape;
+    for (const fill of shape ? [Object.values(shape.fill)[0], Object.values(shape.line)[0]?.fill] : []) {
+        if (fill?.type === 'picture' && typeof fill.image === 'string') {
+            fill.image = Uint8Array.from(atob(fill.image), (c) => c.charCodeAt(0));
+        }
+    }
+    return state;
+}
 /** One editor's session over a transport: the state cache, the listeners and the calls. Internal. */
 export class Session {
     transport;
     id;
     state;
     catalog;
+    shapeGallery;
     destroyed = false;
     #subscribers = new Set();
     #listeners = new Map();
@@ -67,11 +79,12 @@ export class Session {
     #fault;
     /** Commits waiting for the state cache to reach their revision. */
     #waiting = [];
-    constructor(transport, id, state, catalog) {
+    constructor(transport, id, state, catalog, shapeGallery) {
         this.transport = transport;
         this.id = id;
-        this.state = deepFreeze(state);
+        this.state = deepFreeze(fromWireState(state));
         this.catalog = deepFreeze(catalog);
+        this.shapeGallery = deepFreeze(shapeGallery);
         this.disposers.push(transport.listen(id, (m) => this.#receive(m)));
     }
     /** Creates a session on the page's engine: on this thread, or in the page's engine worker. */
@@ -88,7 +101,8 @@ export class Session {
                     return [];
                 throw e;
             }));
-            const session = new Session(transport, id, state, catalog);
+            const shapeGallery = (await transport.call(id, Method.ShapeGallery));
+            const session = new Session(transport, id, state, catalog, shapeGallery);
             for (const dictionary of options.dictionaries ?? [])
                 await session.call(Method.SpellingAddDictionary, dictionary);
             return session;
@@ -185,7 +199,7 @@ export class Session {
             return;
         switch (message.kind) {
             case Kind.State: {
-                this.state = deepFreeze(message.payload);
+                this.state = deepFreeze(fromWireState(message.payload));
                 const revision = this.state.revision;
                 for (const w of this.#waiting)
                     if (w.revision <= revision)
@@ -236,6 +250,8 @@ export class HeadlessEditor {
     commands;
     /** Every command's id, label, group, shortcuts and undo grouping. */
     catalog;
+    /** Word's Insert \> Shapes gallery: its groups and their presets, in order. */
+    shapeGallery;
     /** The context menu. */
     menus;
     /** The dialogs. */
@@ -269,6 +285,7 @@ export class HeadlessEditor {
         sessions.set(this, session);
         this.commands = createCommands((op) => session.run(op));
         this.catalog = session.catalog;
+        this.shapeGallery = session.shapeGallery;
         this.menus = createMenus(session);
         this.dialogs = createDialogs(session);
         this.find = createFind(session);

package/dist/index.d.ts

@@ -24,4 +24,4 @@ export type { Heading, Navigation, StyleInfo, Styles } from './services/navigati
 export type { Ruler, RulerModel, RulerModelSource, RulerUnit, RulerView, TabAlignment, TabLeader, TabSelector, } from './services/ruler.js';
 export type { GestureAction, GestureBinding, GestureEvent, GestureId, Gestures, View } from './services/view.js';
 export { cm, inches, mm, pt } from './types.js';
-export type { Author, ClientPoint, ClientRect, Color, CommentId, ContentPoint, ElementId, FrameStats, HeadingId, OverlayColors, MatchId, Points, RevisionId, StyleId, Warning, WordCount, } from './types.js';
+export type { Arrange, ArrowKind, Arrowhead, ArrowSize, Author, ClientPoint, ClientRect, Color, ColourTransform, ColourValue, CommentId, Compound, ContentPoint, Degrees, EffectsChange, EffectsValue, ElementId, FillState, FillValue, FlipAxis, FrameStats, Glow, GradientShape, GradientStop, HeadingId, LineCap, LineChange, LineEnds, LineJoin, LineState, LineValue, OverlayColors, MatchId, PictureAdjustChange, Points, RevisionId, Shadow, ShapeAdjust, ShapeGalleryGroup, ShapeInsert, ShapePreset, ShapeState, ShapeTextChange, ShapeTextState, StyleId, TextAnchor, TextAutofit, TextDirection, ThemeColour, TransformKind, Warning, WordCount, } from './types.js';

package/dist/state.d.ts

@@ -2,7 +2,7 @@ import type { CommandId } from './commands.js';
 import type { DialogKind } from './services/dialogs.js';
 import type { ControlKind } from './services/elements.js';
 import type { RulerModel, RulerUnit, TabSelector } from './services/ruler.js';
-import type { Color, CommentId, ElementId, Points, RevisionId, StyleId } from './types.js';
+import type { Color, CommentId, Degrees, ElementId, Points, RevisionId, ShapeState, StyleId } from './types.js';
 /** An on/off value over the selection: `'mixed'` where it differs, `null` where it doesn't apply. */
 export type Tri = boolean | 'mixed' | null;
 /** A value over the selection: `'mixed'` where it differs, `null` where it doesn't apply. */
@@ -72,6 +72,11 @@ export interface EditorState {
     ruler: RulerModel;
     /** Whether formatting is held for `pasteFormatting`. */
     formatPainter: boolean;
+    /**
+     * The document's 12 theme colours, in `ThemeColour` order (text1, background1, text2, background2, accent1 to
+     * accent6, hyperlink, followedHyperlink), for an application's colour picker.
+     */
+    themeColours: Color[];
 }
 /** The value each command reports in state, for the commands that report one. */
 export interface CommandValues {
@@ -291,10 +296,10 @@ export type TableWidth = {
     kind: 'percent';
     value: number;
 };
-/** The selected picture or text box. */
+/** The selected object. */
 export interface ObjectSelection {
-    /** A picture or a text box. */
-    kind: 'picture' | 'textBox';
+    /** A picture, a text box, a shape, a line or connector (a shape with no filled path), or a group. */
+    kind: 'picture' | 'textBox' | 'shape' | 'line' | 'group';
     /** How text wraps around it. */
     wrap: ObjectWrap;
     /** The width. */
@@ -309,6 +314,18 @@ export interface ObjectSelection {
     anchorLocked: boolean | null;
     /** Where a floating object is and how text keeps from it; `null` when inline. */
     placement: ObjectPlacement | null;
+    /** The shape's properties as written; `null` for objects without shape properties (frames) and kept graphics. */
+    shape: ShapeState | null;
+    /** Its rotation, clockwise. */
+    rotation: Degrees;
+    /** Flipped left to right. */
+    flipH: boolean;
+    /** Flipped top to bottom. */
+    flipV: boolean;
+    /** The selected child's place in its group; empty unless a group child is selected. */
+    childPath: number[];
+    /** How many objects are selected: 2 or more for a multi-selection, the other fields describing the first. */
+    count: number;
 }
 /** How text wraps around an object. */
 export type ObjectWrap = 'inline' | 'square' | 'tight' | 'through' | 'topAndBottom' | 'behindText' | 'inFrontOfText';

package/dist/transport/protocol.d.ts

@@ -80,6 +80,7 @@ export declare const Method: {
     readonly HostSetOverlayPalette: 73;
     readonly HostSetPaintBudget: 74;
     readonly HostSetLeaders: 75;
+    readonly ShapeGallery: 76;
 };
 /** A structured call number. */
 export type Method = (typeof Method)[keyof typeof Method];

package/dist/transport/protocol.js

@@ -79,6 +79,7 @@ export const Method = {
     HostSetOverlayPalette: 73,
     HostSetPaintBudget: 74,
     HostSetLeaders: 75,
+    ShapeGallery: 76,
 };
 /** What the engine sends: callback kinds of the C ABI. */
 export const Kind = {

package/dist/types.d.ts

@@ -105,7 +105,7 @@ export interface Author {
 /** A recoverable fidelity issue found while reading or writing a document. Aggregated per code and part. */
 export interface Warning {
     /** What kind of issue it is. */
-    code: 'unsupported-element' | 'image-undecodable' | 'font-unresolved' | 'font-substituted' | 'rewritten-content' | 'pdf-font-fallback' | 'revision-id-missing' | 'range-unpaired' | 'author-missing' | 'comment-unanchored' | 'comment-reference-orphan';
+    code: 'unsupported-element' | 'image-undecodable' | 'font-unresolved' | 'font-substituted' | 'rewritten-content' | 'pdf-font-fallback' | 'revision-id-missing' | 'range-unpaired' | 'author-missing' | 'comment-unanchored' | 'comment-reference-orphan' | 'unknown-preset';
     /** A readable description. */
     message: string;
     /** How many times it occurred. */
@@ -131,4 +131,277 @@ export interface WordCount {
     /** Pages. */
     pages: number;
 }
+/** An angle in degrees, clockwise. */
+export type Degrees = number;
+/** A preset geometry by its ECMA-376 name (`'wedgeRectCallout'`): the 187 presets, in alphabetical order. */
+export type ShapePreset = 'accentBorderCallout1' | 'accentBorderCallout2' | 'accentBorderCallout3' | 'accentCallout1' | 'accentCallout2' | 'accentCallout3' | 'actionButtonBackPrevious' | 'actionButtonBeginning' | 'actionButtonBlank' | 'actionButtonDocument' | 'actionButtonEnd' | 'actionButtonForwardNext' | 'actionButtonHelp' | 'actionButtonHome' | 'actionButtonInformation' | 'actionButtonMovie' | 'actionButtonReturn' | 'actionButtonSound' | 'arc' | 'bentArrow' | 'bentConnector2' | 'bentConnector3' | 'bentConnector4' | 'bentConnector5' | 'bentUpArrow' | 'bevel' | 'blockArc' | 'borderCallout1' | 'borderCallout2' | 'borderCallout3' | 'bracePair' | 'bracketPair' | 'callout1' | 'callout2' | 'callout3' | 'can' | 'chartPlus' | 'chartStar' | 'chartX' | 'chevron' | 'chord' | 'circularArrow' | 'cloud' | 'cloudCallout' | 'corner' | 'cornerTabs' | 'cube' | 'curvedConnector2' | 'curvedConnector3' | 'curvedConnector4' | 'curvedConnector5' | 'curvedDownArrow' | 'curvedLeftArrow' | 'curvedRightArrow' | 'curvedUpArrow' | 'decagon' | 'diagStripe' | 'diamond' | 'dodecagon' | 'donut' | 'doubleWave' | 'downArrow' | 'downArrowCallout' | 'ellipse' | 'ellipseRibbon' | 'ellipseRibbon2' | 'flowChartAlternateProcess' | 'flowChartCollate' | 'flowChartConnector' | 'flowChartDecision' | 'flowChartDelay' | 'flowChartDisplay' | 'flowChartDocument' | 'flowChartExtract' | 'flowChartInputOutput' | 'flowChartInternalStorage' | 'flowChartMagneticDisk' | 'flowChartMagneticDrum' | 'flowChartMagneticTape' | 'flowChartManualInput' | 'flowChartManualOperation' | 'flowChartMerge' | 'flowChartMultidocument' | 'flowChartOfflineStorage' | 'flowChartOffpageConnector' | 'flowChartOnlineStorage' | 'flowChartOr' | 'flowChartPredefinedProcess' | 'flowChartPreparation' | 'flowChartProcess' | 'flowChartPunchedCard' | 'flowChartPunchedTape' | 'flowChartSort' | 'flowChartSummingJunction' | 'flowChartTerminator' | 'foldedCorner' | 'frame' | 'funnel' | 'gear6' | 'gear9' | 'halfFrame' | 'heart' | 'heptagon' | 'hexagon' | 'homePlate' | 'horizontalScroll' | 'irregularSeal1' | 'irregularSeal2' | 'leftArrow' | 'leftArrowCallout' | 'leftBrace' | 'leftBracket' | 'leftCircularArrow' | 'leftRightArrow' | 'leftRightArrowCallout' | 'leftRightCircularArrow' | 'leftRightRibbon' | 'leftRightUpArrow' | 'leftUpArrow' | 'lightningBolt' | 'line' | 'lineInv' | 'mathDivide' | 'mathEqual' | 'mathMinus' | 'mathMultiply' | 'mathNotEqual' | 'mathPlus' | 'moon' | 'noSmoking' | 'nonIsoscelesTrapezoid' | 'notchedRightArrow' | 'octagon' | 'parallelogram' | 'pentagon' | 'pie' | 'pieWedge' | 'plaque' | 'plaqueTabs' | 'plus' | 'quadArrow' | 'quadArrowCallout' | 'rect' | 'ribbon' | 'ribbon2' | 'rightArrow' | 'rightArrowCallout' | 'rightBrace' | 'rightBracket' | 'round1Rect' | 'round2DiagRect' | 'round2SameRect' | 'roundRect' | 'rtTriangle' | 'smileyFace' | 'snip1Rect' | 'snip2DiagRect' | 'snip2SameRect' | 'snipRoundRect' | 'squareTabs' | 'star10' | 'star12' | 'star16' | 'star24' | 'star32' | 'star4' | 'star5' | 'star6' | 'star7' | 'star8' | 'straightConnector1' | 'stripedRightArrow' | 'sun' | 'swooshArrow' | 'teardrop' | 'trapezoid' | 'triangle' | 'upArrow' | 'upArrowCallout' | 'upDownArrow' | 'upDownArrowCallout' | 'uturnArrow' | 'verticalScroll' | 'wave' | 'wedgeEllipseCallout' | 'wedgeRectCallout' | 'wedgeRoundRectCallout';
+/** A theme colour, in the theme's order. */
+export type ThemeColour = 'text1' | 'background1' | 'text2' | 'background2' | 'accent1' | 'accent2' | 'accent3' | 'accent4' | 'accent5' | 'accent6' | 'hyperlink' | 'followedHyperlink';
+/**
+ * What a colour transform does: `tint` and `shade` go towards white and black by `1 - value`; `lumMod`, `satMod`,
+ * `hueMod` and `alphaMod` multiply the luminance, saturation, hue and opacity by `value`; `lumOff`, `satOff` and
+ * `hueOff` add `value` (degrees for `hueOff`); `alpha` sets the opacity.
+ */
+export type TransformKind = 'tint' | 'shade' | 'lumMod' | 'lumOff' | 'satMod' | 'satOff' | 'hueMod' | 'hueOff' | 'alpha' | 'alphaMod';
+/** One colour transform. */
+export interface ColourTransform {
+    /** What it does. */
+    kind: TransformKind;
+    /** How much: a fraction (0.75), degrees for `hueOff`. */
+    value: number;
+}
+/** A colour as written: exactly one base (a theme colour, an RGB value or a preset colour name), then its transforms. */
+export interface ColourValue {
+    /** A theme colour. */
+    theme?: ThemeColour;
+    /** An RGB colour. */
+    rgb?: Color;
+    /** A preset colour by its CSS name (`'cornflowerBlue'`). */
+    preset?: string;
+    /** The transforms, applied in order. */
+    transforms?: ColourTransform[];
+}
+/** A gradient's shape: along a direction, circles or rectangles from the centre, or following the shape's outline. */
+export type GradientShape = 'linear' | 'radial' | 'rectangular' | 'path';
+/** A gradient stop. */
+export interface GradientStop {
+    /** 0 to 1 along the gradient. */
+    position: number;
+    /** The colour there. */
+    colour: ColourValue;
+}
+/**
+ * A fill: none, one colour, a gradient of two or more stops (a linear one's `angle`, 0 left to right), a two-colour
+ * pattern by its ECMA-376 name (`'pct50'`, `'dkDnDiag'`), a picture (PNG, JPEG, GIF, BMP; tiled at its own size, or
+ * stretched), or `fromStyle`: the style reference's fill, no explicit one.
+ */
+export type FillValue = {
+    type: 'none';
+} | {
+    type: 'solid';
+    colour: ColourValue;
+} | {
+    type: 'gradient';
+    kind: GradientShape;
+    angle?: Degrees;
+    stops: GradientStop[];
+} | {
+    type: 'pattern';
+    preset: string;
+    foreground: ColourValue;
+    background: ColourValue;
+} | {
+    type: 'picture';
+    image: Uint8Array;
+    tile?: boolean;
+} | {
+    type: 'fromStyle';
+};
+/** How a line is drawn along its length: one line, two equal ones, thick then thin, thin then thick, or three. */
+export type Compound = 'single' | 'double' | 'thickThin' | 'thinThick' | 'triple';
+/** A line's ends: square at the end, rounded, or square half the width past the end. */
+export type LineCap = 'flat' | 'round' | 'square';
+/** How a line's segments join: rounded, cut off, or pointed. */
+export type LineJoin = 'round' | 'bevel' | 'miter';
+/** An arrowhead's shape: a filled triangle, a notched triangle, a diamond, an oval or an open V. */
+export type ArrowKind = 'triangle' | 'stealth' | 'diamond' | 'oval' | 'arrow';
+/** An arrowhead's width or length. */
+export type ArrowSize = 'small' | 'medium' | 'large';
+/** An arrowhead. */
+export interface Arrowhead {
+    /** Its shape. */
+    kind: ArrowKind;
+    /** Its width; default `'medium'`. */
+    width?: ArrowSize;
+    /** Its length; default `'medium'`. */
+    length?: ArrowSize;
+}
+/** A line's arrowheads. */
+export interface LineEnds {
+    /** At the start. */
+    head?: Arrowhead;
+    /** At the end. */
+    tail?: Arrowhead;
+}
+/** An outline as written. */
+export interface LineValue {
+    /** The width (0.75 when the document gives none). */
+    width: Points;
+    /** `none`, `solid` or `gradient`. */
+    fill: FillValue;
+    /** The ECMA-376 dash name (`'solid'`, `'dash'`, `'sysDot'`…); `'custom'` for a custom dash. */
+    dash: string;
+    /** Single or several lines. */
+    compound: Compound;
+    /** The ends. */
+    cap: LineCap;
+    /** The joins. */
+    join: LineJoin;
+    /** The arrowheads. */
+    ends: LineEnds;
+}
+/** `setShapeLine`'s change; what isn't given is kept. */
+export interface LineChange {
+    /** The width, 0 to 1584. */
+    width?: Points;
+    /** `none`, `solid` or `gradient`; `fromStyle` removes the whole explicit outline. */
+    fill?: FillValue;
+    /** The ECMA-376 dash name. */
+    dash?: string;
+    /** Single or several lines. */
+    compound?: Compound;
+    /** The ends. */
+    cap?: LineCap;
+    /** The joins. */
+    join?: LineJoin;
+    /** The arrowheads: both ends are replaced, and an end not given is removed. */
+    ends?: LineEnds;
+}
+/** A shadow. */
+export interface Shadow {
+    /** Its colour, with its transparency as an `alpha` transform. */
+    colour: ColourValue;
+    /** How far it blurs. */
+    blur: Points;
+    /** How far from the shape. */
+    distance: Points;
+    /** Which way, clockwise from the right. */
+    direction: Degrees;
+}
+/** A glow. */
+export interface Glow {
+    /** Its colour. */
+    colour: ColourValue;
+    /** How far it reaches. */
+    radius: Points;
+}
+/** A shape's effects. */
+export interface EffectsValue {
+    /** A shadow outside the shape. */
+    outerShadow?: Shadow;
+    /** A shadow inside the shape. */
+    innerShadow?: Shadow;
+    /** A glow around the shape. */
+    glow?: Glow;
+    /** Edges faded over this distance. */
+    softEdge?: Points;
+    /** The whole shape blurred by this radius. */
+    blur?: Points;
+}
+/** `setShapeEffects`'s change: each effect given replaces that effect, `null` removes it, what isn't given is kept. */
+export interface EffectsChange {
+    /** A shadow outside the shape. */
+    outerShadow?: Shadow | null;
+    /** A shadow inside the shape. */
+    innerShadow?: Shadow | null;
+    /** A glow around the shape. */
+    glow?: Glow | null;
+    /** Edges faded over this distance. */
+    softEdge?: Points | null;
+    /** The whole shape blurred by this radius. */
+    blur?: Points | null;
+}
+/** Where text sits in a shape vertically. */
+export type TextAnchor = 'top' | 'middle' | 'bottom';
+/** How a shape fits its text: it keeps its size, or its height follows the text. */
+export type TextAutofit = 'none' | 'shape';
+/**
+ * Which way a shape's text runs: left to right; turned 90° or 270° clockwise; East Asian vertical (CJK upright,
+ * other text turned); Mongolian vertical; letters stacked one per line, or stacked right to left.
+ */
+export type TextDirection = 'horizontal' | 'vertical' | 'vertical270' | 'eastAsianVertical' | 'mongolianVertical' | 'stacked' | 'stackedRightToLeft';
+/** A shape's text body as written. */
+export interface ShapeTextState {
+    /** Left, top, right, bottom. */
+    insets: [Points, Points, Points, Points];
+    /** Where the text sits. */
+    anchor: TextAnchor;
+    /** How the shape fits it. */
+    autofit: TextAutofit;
+    /** Lines wrap at the shape's width. */
+    wrapText: boolean;
+    /** Which way it runs. */
+    direction: TextDirection;
+}
+/** `setShapeText`'s change; what isn't given is kept. */
+export interface ShapeTextChange {
+    /** Left, top, right, bottom, 0 to 1584. */
+    insets?: [Points, Points, Points, Points];
+    /** Where the text sits. */
+    anchor?: TextAnchor;
+    /** How the shape fits it. */
+    autofit?: TextAutofit;
+    /** Lines wrap at the shape's width. */
+    wrapText?: boolean;
+    /** Which way it runs. */
+    direction?: TextDirection;
+}
+/** `setPictureAdjust`'s change; what isn't given is kept. */
+export interface PictureAdjustChange {
+    /** How see-through the picture is: 0 opaque to 1 invisible. */
+    transparency?: number;
+    /** Shown in shades of grey. */
+    grayscale?: boolean;
+    /** Lighter (positive) or darker, −1 to 1. */
+    brightness?: number;
+    /** More (positive) or less contrast, −1 to 1. */
+    contrast?: number;
+}
+/** `insertShape`'s options. */
+export interface ShapeInsert {
+    /** The preset geometry. */
+    preset: ShapePreset;
+    /** The width; default 72. */
+    width?: Points;
+    /** The height; default 72, 0 for lines. */
+    height?: Points;
+}
+/** `setShapeAdjust`'s options. */
+export interface ShapeAdjust {
+    /** The adjust value's index, in the preset's order. */
+    index: number;
+    /** Its new value, in the preset's units (usually 100000ths). */
+    value: number;
+}
+/** Which way to flip: left to right, or top to bottom. */
+export type FlipAxis = 'horizontal' | 'vertical';
+/**
+ * Where an object goes in the paint order: over the next object above it, under the next one below it, over or
+ * under every object, or in front of or behind the text.
+ */
+export type Arrange = 'forward' | 'backward' | 'toFront' | 'toBack' | 'inFrontOfText' | 'behindText';
+/** A fill as written: the shape's own, or its style reference's (the theme's, with the reference's colour). */
+export type FillState = {
+    explicit: FillValue;
+} | {
+    fromStyle: FillValue;
+};
+/** An outline as written: the shape's own, or its style reference's. */
+export type LineState = {
+    explicit: LineValue;
+} | {
+    fromStyle: LineValue;
+};
+/** The selected shape's properties, as written: theme colours stay theme colours with their transforms. */
+export interface ShapeState {
+    /** The preset geometry; `null` for a custom geometry. */
+    preset: ShapePreset | null;
+    /** The adjust values in effect, in the preset's order. */
+    adjust: number[];
+    /** The fill. */
+    fill: FillState;
+    /** The outline. */
+    line: LineState;
+    /** The effects. */
+    effects: EffectsValue;
+    /** The text body; `null` for pictures and groups. */
+    text: ShapeTextState | null;
+}
+/** A group of Word's Insert \> Shapes gallery. */
+export interface ShapeGalleryGroup {
+    /** Its label (`'Basic Shapes'`). */
+    label: string;
+    /** Its presets, in Word's order. */
+    presets: ShapePreset[];
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@twip/web",
-  "version": "0.0.0-canary-4e9c983",
+  "version": "0.0.0-canary-8e34765",
   "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",