superdoc 2.2.0 → 2.3.0

package/dist/document-api/src/header-footers/header-footers.d.ts

@@ -0,0 +1,37 @@
+import { MutationOptions } from '../write/write.js';
+import { SectionMutationResult } from '../sections/sections.types.js';
+import { HeaderFooterKind, HeaderFooterVariant, HeaderFooterSlotAddress, HeaderFooterPartAddress, HeaderFooterSlotEntry, HeaderFooterResolveResult, HeaderFootersListQuery, HeaderFootersListResult, HeaderFootersGetInput, HeaderFootersResolveInput, HeaderFootersRefsSetInput, HeaderFootersRefsClearInput, HeaderFootersRefsSetLinkedToPreviousInput, HeaderFootersPartsListQuery, HeaderFootersPartsListResult, HeaderFootersPartsCreateInput, HeaderFootersPartsDeleteInput, HeaderFooterPartsMutationResult } from './header-footers.types.js';
+export type { HeaderFooterKind, HeaderFooterVariant, HeaderFooterSlotAddress, HeaderFooterPartAddress, HeaderFooterSlotEntry, HeaderFooterResolveResult, HeaderFooterPartEntry, HeaderFootersListQuery, HeaderFootersListResult, HeaderFootersGetInput, HeaderFootersResolveInput, HeaderFootersRefsSetInput, HeaderFootersRefsClearInput, HeaderFootersRefsSetLinkedToPreviousInput, HeaderFootersPartsListQuery, HeaderFootersPartsListResult, HeaderFootersPartsCreateInput, HeaderFootersPartsDeleteInput, HeaderFooterPartsMutationResult, HeaderFooterRefsMutationResult, HeaderFooterRefsMutationSuccessResult, HeaderFooterRefsMutationFailureResult, HeaderFooterPartsMutationSuccessResult, HeaderFooterPartsMutationFailureResult, } from './header-footers.types.js';
+export interface HeaderFootersAdapter {
+    list(query?: HeaderFootersListQuery): HeaderFootersListResult;
+    get(input: HeaderFootersGetInput): HeaderFooterSlotEntry;
+    resolve(input: HeaderFootersResolveInput): HeaderFooterResolveResult;
+    refs: {
+        set(input: HeaderFootersRefsSetInput, options?: MutationOptions): SectionMutationResult;
+        clear(input: HeaderFootersRefsClearInput, options?: MutationOptions): SectionMutationResult;
+        setLinkedToPrevious(input: HeaderFootersRefsSetLinkedToPreviousInput, options?: MutationOptions): SectionMutationResult;
+    };
+    parts: {
+        list(query?: HeaderFootersPartsListQuery): HeaderFootersPartsListResult;
+        create(input: HeaderFootersPartsCreateInput, options?: MutationOptions): HeaderFooterPartsMutationResult;
+        delete(input: HeaderFootersPartsDeleteInput, options?: MutationOptions): HeaderFooterPartsMutationResult;
+    };
+}
+export type HeaderFootersApi = HeaderFootersAdapter;
+export declare function validateHeaderFooterKind(operationName: string, kind: unknown): asserts kind is HeaderFooterKind;
+export declare function validateHeaderFooterVariant(operationName: string, variant: unknown): asserts variant is HeaderFooterVariant;
+export declare function assertHeaderFooterSlotTarget(input: unknown, operationName: string): asserts input is {
+    target: HeaderFooterSlotAddress;
+};
+export declare function assertHeaderFooterPartTarget(input: unknown, operationName: string): asserts input is {
+    target: HeaderFooterPartAddress;
+};
+export declare function executeHeaderFootersList(adapter: HeaderFootersAdapter, query?: HeaderFootersListQuery): HeaderFootersListResult;
+export declare function executeHeaderFootersGet(adapter: HeaderFootersAdapter, input: HeaderFootersGetInput): HeaderFooterSlotEntry;
+export declare function executeHeaderFootersResolve(adapter: HeaderFootersAdapter, input: HeaderFootersResolveInput): HeaderFooterResolveResult;
+export declare function executeHeaderFootersRefsSet(adapter: HeaderFootersAdapter, input: HeaderFootersRefsSetInput, options?: MutationOptions): SectionMutationResult;
+export declare function executeHeaderFootersRefsClear(adapter: HeaderFootersAdapter, input: HeaderFootersRefsClearInput, options?: MutationOptions): SectionMutationResult;
+export declare function executeHeaderFootersRefsSetLinkedToPrevious(adapter: HeaderFootersAdapter, input: HeaderFootersRefsSetLinkedToPreviousInput, options?: MutationOptions): SectionMutationResult;
+export declare function executeHeaderFootersPartsList(adapter: HeaderFootersAdapter, query?: HeaderFootersPartsListQuery): HeaderFootersPartsListResult;
+export declare function executeHeaderFootersPartsCreate(adapter: HeaderFootersAdapter, input: HeaderFootersPartsCreateInput, options?: MutationOptions): HeaderFooterPartsMutationResult;
+export declare function executeHeaderFootersPartsDelete(adapter: HeaderFootersAdapter, input: HeaderFootersPartsDeleteInput, options?: MutationOptions): HeaderFooterPartsMutationResult;

package/dist/document-api/src/header-footers/header-footers.types.d.ts

@@ -0,0 +1,116 @@
+import { SectionAddress } from '../sections/sections.types.js';
+import { ReceiptFailure } from '../types/receipt.js';
+import { DiscoveryOutput } from '../types/discovery.js';
+export type HeaderFooterKind = 'header' | 'footer';
+export type HeaderFooterVariant = 'default' | 'first' | 'even';
+/** Targets a specific (section, kind, variant) slot. */
+export interface HeaderFooterSlotAddress {
+    kind: 'headerFooterSlot';
+    section: SectionAddress;
+    headerFooterKind: HeaderFooterKind;
+    variant: HeaderFooterVariant;
+}
+/** Targets a specific part by relationship ID. */
+export interface HeaderFooterPartAddress {
+    kind: 'headerFooterPart';
+    refId: string;
+}
+/** One section-slot entry (returned by list/get). */
+export interface HeaderFooterSlotEntry {
+    section: SectionAddress;
+    sectionIndex: number;
+    kind: HeaderFooterKind;
+    variant: HeaderFooterVariant;
+    /** The explicit refId on this section slot, or null if inherited/absent. */
+    refId: string | null;
+    /** True when the slot has a direct reference in the section's sectPr. */
+    isExplicit: boolean;
+}
+/** Resolution result (returned by resolve). */
+export type HeaderFooterResolveResult = {
+    status: 'explicit';
+    refId: string;
+    section: SectionAddress;
+} | {
+    status: 'inherited';
+    refId: string;
+    /** The section from which the ref was inherited. */
+    resolvedFromSection: SectionAddress;
+    /** The variant that actually matched (may differ from requested if fell back to 'default'). */
+    resolvedVariant: HeaderFooterVariant;
+} | {
+    status: 'none';
+};
+/** One unique part record (returned by parts.list). */
+export interface HeaderFooterPartEntry {
+    refId: string;
+    kind: HeaderFooterKind;
+    /** The OOXML part path, e.g. 'word/header1.xml'. */
+    partPath: string;
+    /** Sections that explicitly reference this part. */
+    referencedBySections: SectionAddress[];
+}
+export interface HeaderFootersListQuery {
+    /** Filter by kind. Omit to return both headers and footers. */
+    kind?: HeaderFooterKind;
+    /** Filter to a single section. Omit to return all sections. */
+    section?: SectionAddress;
+    /** Max items to return. Omit to return all. Must be > 0 if provided. */
+    limit?: number;
+    /** Zero-based offset into sorted results. Defaults to 0. Must be >= 0. */
+    offset?: number;
+}
+export type HeaderFootersListResult = DiscoveryOutput<HeaderFooterSlotEntry>;
+export interface HeaderFootersGetInput {
+    target: HeaderFooterSlotAddress;
+}
+export interface HeaderFootersResolveInput {
+    target: HeaderFooterSlotAddress;
+}
+export interface HeaderFootersRefsSetInput {
+    target: HeaderFooterSlotAddress;
+    refId: string;
+}
+export interface HeaderFootersRefsClearInput {
+    target: HeaderFooterSlotAddress;
+}
+export interface HeaderFootersRefsSetLinkedToPreviousInput {
+    target: HeaderFooterSlotAddress;
+    linked: boolean;
+}
+export interface HeaderFootersPartsListQuery {
+    kind?: HeaderFooterKind;
+    /** Max items to return. Omit to return all. Must be > 0 if provided. */
+    limit?: number;
+    /** Zero-based offset into sorted results. Defaults to 0. Must be >= 0. */
+    offset?: number;
+}
+export type HeaderFootersPartsListResult = DiscoveryOutput<HeaderFooterPartEntry>;
+/** Creates an independent part. Slot assignment happens separately via refs.set. */
+export interface HeaderFootersPartsCreateInput {
+    kind: HeaderFooterKind;
+    /** Clone content from an existing part. Omit to create empty. */
+    sourceRefId?: string;
+}
+export interface HeaderFootersPartsDeleteInput {
+    target: HeaderFooterPartAddress;
+}
+export interface HeaderFooterRefsMutationSuccessResult {
+    success: true;
+    section: SectionAddress;
+}
+export interface HeaderFooterRefsMutationFailureResult {
+    success: false;
+    failure: ReceiptFailure;
+}
+export type HeaderFooterRefsMutationResult = HeaderFooterRefsMutationSuccessResult | HeaderFooterRefsMutationFailureResult;
+export interface HeaderFooterPartsMutationSuccessResult {
+    success: true;
+    refId: string;
+    partPath: string;
+}
+export interface HeaderFooterPartsMutationFailureResult {
+    success: false;
+    failure: ReceiptFailure;
+}
+export type HeaderFooterPartsMutationResult = HeaderFooterPartsMutationSuccessResult | HeaderFooterPartsMutationFailureResult;

package/dist/document-api/src/history/history.d.ts

@@ -0,0 +1,38 @@
+import { HistoryState, HistoryActionResult } from './history.types.js';
+/**
+ * Engine-specific adapter for history operations.
+ */
+export interface HistoryAdapter {
+    get(): HistoryState;
+    undo(): HistoryActionResult;
+    redo(): HistoryActionResult;
+}
+/**
+ * Public API shape for the history namespace on DocumentApi.
+ */
+export interface HistoryApi {
+    get(): HistoryState;
+    undo(): HistoryActionResult;
+    redo(): HistoryActionResult;
+}
+/**
+ * Reads undo/redo history state from the underlying adapter.
+ *
+ * @param adapter - Engine-specific history adapter.
+ * @returns Current history state snapshot.
+ */
+export declare function executeHistoryGet(adapter: HistoryAdapter): HistoryState;
+/**
+ * Executes an undo action via the underlying adapter.
+ *
+ * @param adapter - Engine-specific history adapter.
+ * @returns Undo action result with noop + revision metadata.
+ */
+export declare function executeHistoryUndo(adapter: HistoryAdapter): HistoryActionResult;
+/**
+ * Executes a redo action via the underlying adapter.
+ *
+ * @param adapter - Engine-specific history adapter.
+ * @returns Redo action result with noop + revision metadata.
+ */
+export declare function executeHistoryRedo(adapter: HistoryAdapter): HistoryActionResult;

package/dist/document-api/src/history/history.types.d.ts

@@ -0,0 +1,100 @@
+import { OperationId } from '../contract/types.js';
+import { AffectedRef, AffectedRefRemapping, ReceiptEntity, TextRangeShift } from '../types/receipt.js';
+import { StoryLocator } from '../types/story.types.js';
+/**
+ * Snapshot of the editor's undo/redo history state.
+ */
+export interface HistoryState {
+    /** Number of undo steps available. */
+    undoDepth: number;
+    /** Number of redo steps available. */
+    redoDepth: number;
+    /** Whether undo is possible (shorthand for undoDepth > 0). */
+    canUndo: boolean;
+    /** Whether redo is possible (shorthand for redoDepth > 0). */
+    canRedo: boolean;
+    /**
+     * Operation IDs that bypass PM history (out-of-band mutations).
+     * Their effects cannot be undone via history.undo.
+     */
+    historyUnsafeOperations: readonly OperationId[];
+}
+/** Machine-readable reason for a history no-op. */
+export type HistoryNoopReason = 'EMPTY_UNDO_STACK' | 'EMPTY_REDO_STACK' | 'NO_EFFECT' | 'no-undo-available' | 'no-redo-available' | 'history-entry-missing' | 'apply-rejected';
+/**
+ * Status of a history action under the collaborative undo contract
+ * Existing single-user callers may ignore this and read
+ * `noop` / `reason`; collaboration-aware callers receive a richer
+ * lifecycle classification.
+ */
+export type SDHistoryStatus = 'applied' | 'noop' | 'rejected' | 'partial' | 'repaired';
+/**
+ * Collaboration metadata attached to a `HistoryActionResult` when the
+ * undo/redo was evaluated under the collaborative undo policy. Optional;
+ * absent in non-collaborative sessions and on v1 adapters.
+ */
+export interface SDHistoryCollaborationMeta {
+    readonly mode: 'session-local' | 'single-shard' | 'journaled-multi-shard';
+    readonly undoGroupId?: string;
+    readonly opId?: string;
+    readonly affectedShards?: ReadonlyArray<string>;
+}
+/**
+ * Result of a history.undo or history.redo action.
+ * Mirrors PlanReceipt's revision shape for consistency.
+ *
+ * AIDEV-NOTE: this shape carries optional ref-effect
+ * fields. v1 callers leave them undefined; v2 (`V2HistoryAdapter`) populates
+ * them from the stored semantic delta of the undone/redone transaction so
+ * callers' held refs stay accurate across history actions. Never make any
+ * of the new fields required — v1 adapters MUST keep compiling unchanged.
+ *
+ * The shape also carries three optional collaboration fields:
+ * `status`, `diagnosticCode`, and `collaboration`. v1 leaves them
+ * undefined; collaborative v2 sessions populate them so callers can react
+ * to fail-closed inverse safety checks.
+ */
+export interface HistoryActionResult {
+    /** True if the action had no effect (empty stack). */
+    noop: boolean;
+    /** Machine-readable reason when noop is true. */
+    reason?: HistoryNoopReason;
+    /** Revision bookends matching PlanReceipt.revision shape. */
+    revision: {
+        before: string;
+        after: string;
+    };
+    /** Entities created by this history action. v2: redo of insert; v1: undefined. */
+    inserted?: ReceiptEntity[];
+    /** Entities updated by this history action. */
+    updated?: ReceiptEntity[];
+    /** Entities removed by this history action. v2: undo of insert; v1: undefined. */
+    removed?: ReceiptEntity[];
+    /** Refs the action made dead handles (e.g. comment ids that no longer exist). */
+    invalidatedRefs?: AffectedRef[];
+    /** Refs whose identity moved as a result of the action. */
+    remappedRefs?: AffectedRefRemapping[];
+    /** Stories whose revision advanced as a result of the action. */
+    affectedStories?: StoryLocator[];
+    /**
+     * Text-range shifts produced by the undone/redone action.
+     * Optional. v1 adapters leave it undefined; v2 surfaces shifts when an
+     * undone or redone transaction changed visible text.
+     */
+    textRangeShifts?: TextRangeShift[];
+    /**
+     * Collaborative undo status. v1 callers may ignore this.
+     */
+    status?: SDHistoryStatus;
+    /**
+     * Machine-readable diagnostic when status is `rejected`,
+     * `partial`, or `repaired`. Carries the `COLLAB_V2_UNDO_*` codes from the
+     * collaboration runtime.
+     */
+    diagnosticCode?: string;
+    /**
+     * Collaboration metadata for the undone/redone op.
+     * Present only for collaborative v2 sessions.
+     */
+    collaboration?: SDHistoryCollaborationMeta;
+}

package/dist/document-api/src/hyperlinks/hyperlinks.d.ts

@@ -0,0 +1,17 @@
+import { MutationOptions } from '../write/write.js';
+import { HyperlinksListQuery, HyperlinksListResult, HyperlinksGetInput, HyperlinkInfo, HyperlinksWrapInput, HyperlinkMutationResult, HyperlinksInsertInput, HyperlinksPatchInput, HyperlinksRemoveInput } from './hyperlinks.types.js';
+export interface HyperlinksApi {
+    list(query?: HyperlinksListQuery): HyperlinksListResult;
+    get(input: HyperlinksGetInput): HyperlinkInfo;
+    wrap(input: HyperlinksWrapInput, options?: MutationOptions): HyperlinkMutationResult;
+    insert(input: HyperlinksInsertInput, options?: MutationOptions): HyperlinkMutationResult;
+    patch(input: HyperlinksPatchInput, options?: MutationOptions): HyperlinkMutationResult;
+    remove(input: HyperlinksRemoveInput, options?: MutationOptions): HyperlinkMutationResult;
+}
+export type HyperlinksAdapter = HyperlinksApi;
+export declare function executeHyperlinksList(adapter: HyperlinksAdapter, query?: HyperlinksListQuery): HyperlinksListResult;
+export declare function executeHyperlinksGet(adapter: HyperlinksAdapter, input: HyperlinksGetInput): HyperlinkInfo;
+export declare function executeHyperlinksWrap(adapter: HyperlinksAdapter, input: HyperlinksWrapInput, options?: MutationOptions): HyperlinkMutationResult;
+export declare function executeHyperlinksInsert(adapter: HyperlinksAdapter, input: HyperlinksInsertInput, options?: MutationOptions): HyperlinkMutationResult;
+export declare function executeHyperlinksPatch(adapter: HyperlinksAdapter, input: HyperlinksPatchInput, options?: MutationOptions): HyperlinkMutationResult;
+export declare function executeHyperlinksRemove(adapter: HyperlinksAdapter, input: HyperlinksRemoveInput, options?: MutationOptions): HyperlinkMutationResult;

package/dist/document-api/src/hyperlinks/hyperlinks.types.d.ts

@@ -0,0 +1,112 @@
+import { BlockNodeAddress, InlineNodeAddress } from '../types/base.js';
+import { TextAddress } from '../types/address.js';
+import { DiscoveryOutput } from '../types/discovery.js';
+import { ReceiptFailure } from '../types/receipt.js';
+/** Narrowed inline address for hyperlink targets. */
+export type HyperlinkTarget = InlineNodeAddress & {
+    nodeType: 'hyperlink';
+};
+/**
+ * Canonical hyperlink destination specification for write operations.
+ *
+ * Destination mode rules (enforced on write: wrap/insert/patch):
+ * - External mode: `href` is set and non-empty
+ * - Internal mode: `anchor` is set and non-empty
+ * - Mixed mode: both `href` and `anchor` may be set (OOXML allows this -
+ *   anchor is used when href target is the same document, href is fallback)
+ * - Invalid: neither `href` nor `anchor` is set
+ *
+ * Read operations (list/get) faithfully report whatever the document contains,
+ * including documents where both href and anchor are present.
+ */
+export interface HyperlinkDestination {
+    /** External/mailto/file URL. Sanitized via @superdoc/url-validation on write. */
+    href?: string;
+    /** OOXML bookmark target name (w:anchor). */
+    anchor?: string;
+    /** Location within target document (w:docLocation). */
+    docLocation?: string;
+}
+/** Full hyperlink specification for write operations (wrap/insert). */
+export interface HyperlinkSpec {
+    destination: HyperlinkDestination;
+    /** Tooltip text (w:tooltip). */
+    tooltip?: string;
+    /** Link target frame (_blank, _self, etc.). */
+    target?: string;
+    /** Relationship attribute string. */
+    rel?: string;
+}
+/**
+ * Patch payload for hyperlinks.patch: metadata only, no text mutation.
+ *
+ * Set a field to `null` to explicitly clear it.
+ * Omit a field to leave it unchanged.
+ */
+export interface HyperlinkPatch {
+    href?: string | null;
+    anchor?: string | null;
+    docLocation?: string | null;
+    tooltip?: string | null;
+    target?: string | null;
+    rel?: string | null;
+}
+/** All readable hyperlink properties: faithfully reports document state. */
+export interface HyperlinkReadProperties {
+    href?: string;
+    anchor?: string;
+    docLocation?: string;
+    tooltip?: string;
+    target?: string;
+    rel?: string;
+}
+/** Domain payload for discovery items in hyperlinks.list. */
+export interface HyperlinkDomain {
+    address: HyperlinkTarget;
+    properties: HyperlinkReadProperties;
+    text?: string;
+}
+/** Full info for a single hyperlink via hyperlinks.get. */
+export interface HyperlinkInfo {
+    address: HyperlinkTarget;
+    properties: HyperlinkReadProperties;
+    text?: string;
+}
+export interface HyperlinkMutationSuccess {
+    success: true;
+    hyperlink: HyperlinkTarget;
+}
+export interface HyperlinkMutationFailure {
+    success: false;
+    failure: ReceiptFailure;
+}
+export type HyperlinkMutationResult = HyperlinkMutationSuccess | HyperlinkMutationFailure;
+export type HyperlinksListResult = DiscoveryOutput<HyperlinkDomain>;
+export interface HyperlinksListQuery {
+    within?: BlockNodeAddress;
+    hrefPattern?: string;
+    anchor?: string;
+    textPattern?: string;
+    limit?: number;
+    offset?: number;
+}
+export interface HyperlinksGetInput {
+    target: HyperlinkTarget;
+}
+export interface HyperlinksWrapInput {
+    target: TextAddress;
+    link: HyperlinkSpec;
+}
+export interface HyperlinksInsertInput {
+    target?: TextAddress;
+    text: string;
+    link: HyperlinkSpec;
+}
+export interface HyperlinksPatchInput {
+    target: HyperlinkTarget;
+    patch: HyperlinkPatch;
+}
+export interface HyperlinksRemoveInput {
+    target: HyperlinkTarget;
+    mode?: 'unwrap' | 'deleteText';
+}

package/dist/document-api/src/images/images.d.ts

@@ -0,0 +1,63 @@
+import { MutationOptions } from '../types/index.js';
+import { CreateImageInput, CreateImageResult, ImagesListInput, ImagesListResult, ImagesGetInput, ImageSummary, ImagesDeleteInput, ImagesMutationResult, MoveImageInput, ConvertToInlineInput, ConvertToFloatingInput, SetSizeInput, SetWrapTypeInput, SetWrapSideInput, SetWrapDistancesInput, SetPositionInput, SetAnchorOptionsInput, SetZOrderInput, ScaleInput, SetLockAspectRatioInput, RotateInput, FlipInput, CropInput, ResetCropInput, ReplaceSourceInput, SetAltTextInput, SetDecorativeInput, SetNameInput, SetHyperlinkInput, InsertCaptionInput, UpdateCaptionInput, RemoveCaptionInput } from './images.types.js';
+export interface ImagesAdapter {
+    list(input?: ImagesListInput): ImagesListResult;
+    get(input: ImagesGetInput): ImageSummary;
+    delete(input: ImagesDeleteInput, options?: MutationOptions): ImagesMutationResult;
+    move(input: MoveImageInput, options?: MutationOptions): ImagesMutationResult;
+    convertToInline(input: ConvertToInlineInput, options?: MutationOptions): ImagesMutationResult;
+    convertToFloating(input: ConvertToFloatingInput, options?: MutationOptions): ImagesMutationResult;
+    setSize(input: SetSizeInput, options?: MutationOptions): ImagesMutationResult;
+    setWrapType(input: SetWrapTypeInput, options?: MutationOptions): ImagesMutationResult;
+    setWrapSide(input: SetWrapSideInput, options?: MutationOptions): ImagesMutationResult;
+    setWrapDistances(input: SetWrapDistancesInput, options?: MutationOptions): ImagesMutationResult;
+    setPosition(input: SetPositionInput, options?: MutationOptions): ImagesMutationResult;
+    setAnchorOptions(input: SetAnchorOptionsInput, options?: MutationOptions): ImagesMutationResult;
+    setZOrder(input: SetZOrderInput, options?: MutationOptions): ImagesMutationResult;
+    scale(input: ScaleInput, options?: MutationOptions): ImagesMutationResult;
+    setLockAspectRatio(input: SetLockAspectRatioInput, options?: MutationOptions): ImagesMutationResult;
+    rotate(input: RotateInput, options?: MutationOptions): ImagesMutationResult;
+    flip(input: FlipInput, options?: MutationOptions): ImagesMutationResult;
+    crop(input: CropInput, options?: MutationOptions): ImagesMutationResult;
+    resetCrop(input: ResetCropInput, options?: MutationOptions): ImagesMutationResult;
+    replaceSource(input: ReplaceSourceInput, options?: MutationOptions): ImagesMutationResult;
+    setAltText(input: SetAltTextInput, options?: MutationOptions): ImagesMutationResult;
+    setDecorative(input: SetDecorativeInput, options?: MutationOptions): ImagesMutationResult;
+    setName(input: SetNameInput, options?: MutationOptions): ImagesMutationResult;
+    setHyperlink(input: SetHyperlinkInput, options?: MutationOptions): ImagesMutationResult;
+    insertCaption(input: InsertCaptionInput, options?: MutationOptions): ImagesMutationResult;
+    updateCaption(input: UpdateCaptionInput, options?: MutationOptions): ImagesMutationResult;
+    removeCaption(input: RemoveCaptionInput, options?: MutationOptions): ImagesMutationResult;
+}
+export type ImagesApi = ImagesAdapter;
+export declare function executeImagesList(adapter: ImagesAdapter, input?: ImagesListInput): ImagesListResult;
+export declare function executeImagesGet(adapter: ImagesAdapter, input: ImagesGetInput): ImageSummary;
+export declare function executeImagesDelete(adapter: ImagesAdapter, input: ImagesDeleteInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesMove(adapter: ImagesAdapter, input: MoveImageInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesConvertToInline(adapter: ImagesAdapter, input: ConvertToInlineInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesConvertToFloating(adapter: ImagesAdapter, input: ConvertToFloatingInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesSetSize(adapter: ImagesAdapter, input: SetSizeInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesSetWrapType(adapter: ImagesAdapter, input: SetWrapTypeInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesSetWrapSide(adapter: ImagesAdapter, input: SetWrapSideInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesSetWrapDistances(adapter: ImagesAdapter, input: SetWrapDistancesInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesSetPosition(adapter: ImagesAdapter, input: SetPositionInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesSetAnchorOptions(adapter: ImagesAdapter, input: SetAnchorOptionsInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesSetZOrder(adapter: ImagesAdapter, input: SetZOrderInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesScale(adapter: ImagesAdapter, input: ScaleInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesSetLockAspectRatio(adapter: ImagesAdapter, input: SetLockAspectRatioInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesRotate(adapter: ImagesAdapter, input: RotateInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesFlip(adapter: ImagesAdapter, input: FlipInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesCrop(adapter: ImagesAdapter, input: CropInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesResetCrop(adapter: ImagesAdapter, input: ResetCropInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesReplaceSource(adapter: ImagesAdapter, input: ReplaceSourceInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesSetAltText(adapter: ImagesAdapter, input: SetAltTextInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesSetDecorative(adapter: ImagesAdapter, input: SetDecorativeInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesSetName(adapter: ImagesAdapter, input: SetNameInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesSetHyperlink(adapter: ImagesAdapter, input: SetHyperlinkInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesInsertCaption(adapter: ImagesAdapter, input: InsertCaptionInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesUpdateCaption(adapter: ImagesAdapter, input: UpdateCaptionInput, options?: MutationOptions): ImagesMutationResult;
+export declare function executeImagesRemoveCaption(adapter: ImagesAdapter, input: RemoveCaptionInput, options?: MutationOptions): ImagesMutationResult;
+export interface CreateImageAdapter {
+    image(input: CreateImageInput, options?: MutationOptions): CreateImageResult;
+}
+export declare function executeCreateImage(adapter: CreateImageAdapter, input: CreateImageInput, options?: MutationOptions): CreateImageResult;