@pptx-editor.dev/core/automation

createAutomationHostfunctionSource ↗

Build a host over a port.

declare function createAutomationHost(composition: AutomationHostComposition): AutomationHost;

createServerAutomationHostfunctionSource ↗

Open .pptx bytes as a headless host. Never throws for a malformed file.

declare function createServerAutomationHost(bytes: Uint8Array, options?: ServerAutomationOptions): {
    readonly ok: true;
    readonly host: AutomationHost;
} | {
    readonly ok: false;
    readonly error: ServerAutomationRejection;
};

createStoreAutomationHostfunctionSource ↗

A host over a store: the server host's composition, and the base of the editor's.

declare function createStoreAutomationHost(store: PptxDocumentStore, options?: StoreAutomationOptions): AutomationHost;

storeAutomationPortfunctionSource ↗

A port over a store this host owns or shares. New part names never reuse a name the store has held, so a name in the history always means one part.

declare function storeAutomationPort(store: PptxDocumentStore, options?: StoreAutomationOptions): AutomationDocumentPort;

AutomationAdjustmentsReadinterfaceSource ↗

The adjust values of a preset geometry (a:prstGeom/a:avLst, ECMA-376 Part 1, 20.1.9.5), in the order the preset defines them. A length is a fraction of the shape size (the guide value / 100 000); an angle is in degrees (the guide value / 60 000).

interface AutomationAdjustmentsRead

AutomationBackgroundFillReadinterfaceSource ↗

The fill of a background (p:bg, ECMA-376 Part 1, 19.3.1.1): the own one of the part, or the one it shows from the layout or master. Colors are #RRGGBB; transparency is 0 to 1.

interface AutomationBackgroundFillRead

AutomationBackgroundReadinterfaceSource ↗

The background of a slide, a layout, or a master.

interface AutomationBackgroundRead

AutomationBatchRequestinterfaceSource ↗

One ordered batch, and the revision it was planned against.

interface AutomationBatchRequest

AutomationBatchResponseinterfaceSource ↗

A verdict, one result per operation in request order, and the revision afterwards.

interface AutomationBatchResponse

AutomationBindingReadinterfaceSource ↗

One binding of the host: an id that names a shape. Bindings are never file content.

interface AutomationBindingRead

AutomationBoxinterfaceSource ↗

A box in points. Each field is optional on writes.

interface AutomationBox

AutomationCapabilitiesinterfaceSource ↗

What a host supports, fixed at construction and frozen.

A headless host reports selection false: it has no reader to select for, and refuses the selection operations rather than inventing a selection.

interface AutomationCapabilities

AutomationCellAddressinterfaceSource ↗

A table cell whose text body a text operation addresses instead of the shape's own: the cell at this grid position, or the anchor of the merged block that covers it.

interface AutomationCellAddress

AutomationCellMarginsWriteinterfaceSource ↗

Cell margins a write sets, in points. Null removes one, back to its default.

interface AutomationCellMarginsWrite

AutomationChangeEventinterfaceSource ↗

The presentation moved. Coarse on purpose: a consumer reads again what it needs.

interface AutomationChangeEvent

AutomationCustomPropertyReadinterfaceSource ↗

One custom document property (docProps/custom.xml, ECMA-376 Part 1, 22.3). A Date is an ISO 8601 text in UTC.

interface AutomationCustomPropertyRead

AutomationCustomXmlPartReadinterfaceSource ↗

One custom XML part (ECMA-376 Part 1, 22.5): its item id and the namespace of its root.

interface AutomationCustomXmlPartRead

AutomationDocumentPortinterfaceSource ↗

What a host needs from the document it acts on.

interface AutomationDocumentPort

AutomationErrorinterfaceSource ↗

One refused operation. Plain data, not an Error: it crosses transports.

code is the stable part. detail is for logs and for the object model's diagnostic code; the object model never copies it into a message, because a store rejection reason would become documented API the moment somebody matched on it.

interface AutomationError

AutomationFillReadinterfaceSource ↗

A shape fill. Colors are #RRGGBB; transparency is 0 to 1.

interface AutomationFillRead

AutomationFontReadinterfaceSource ↗

The effective font of a text range. A field the runs disagree on is null.

interface AutomationFontRead

AutomationFontWriteinterfaceSource ↗

Font properties a write sets.

interface AutomationFontWrite

AutomationHandleinterfaceSource ↗

A stable reference to one presentation object, valid for the life of its host.

interface AutomationHandle<K extends AutomationObjectKind = AutomationObjectKind>

AutomationHostinterfaceSource ↗

The protocol both hosts implement.

A batch is one revision, one undo step, and one transaction. Operations run in order, so a read sees the writes before it in the same batch. If any operation is refused, nothing is written.

interface AutomationHost

AutomationHostCompositioninterfaceSource ↗

The port and the capabilities a host claims.

interface AutomationHostComposition

AutomationHyperlinkReadinterfaceSource ↗

One hyperlink of a slide.

interface AutomationHyperlinkRead

AutomationImageRequestinterfaceSource ↗

What [AutomationHost.renderImage](AutomationHost.renderImage) draws.

interface AutomationImageRequest

AutomationImageTargetinterfaceSource ↗

What the port draws (AutomationDocumentPort.renderImage): a slide, or one shape of it.

interface AutomationImageTarget

AutomationInsertSlidesOptionsinterfaceSource ↗

Options of a slide import (Office.js InsertSlideOptions).

interface AutomationInsertSlidesOptions

AutomationLayoutReadinterfaceSource ↗

A layout or master.

interface AutomationLayoutRead

AutomationLineReadinterfaceSource ↗

A shape outline. The weight is in points.

interface AutomationLineRead

AutomationLineWriteinterfaceSource ↗

Outline properties a write sets.

interface AutomationLineWrite

AutomationParagraphReadinterfaceSource ↗

The effective paragraph format of a text range. A field the paragraphs disagree on is null.

interface AutomationParagraphRead

AutomationParagraphWriteinterfaceSource ↗

Paragraph properties a write sets.

interface AutomationParagraphWrite

AutomationPlaceholderReadinterfaceSource ↗

ST_PlaceholderType read as the object model names it.

interface AutomationPlaceholderRead

AutomationPresentationReadinterfaceSource ↗

The presentation. Lengths in points.

interface AutomationPresentationRead

AutomationPropertiesReadinterfaceSource ↗

The core and extended document properties.

interface AutomationPropertiesRead

AutomationPropertiesWriteinterfaceSource ↗

Document properties a write sets.

interface AutomationPropertiesWrite

AutomationResultRefinterfaceSource ↗

The object an earlier operation of the same batch answered with, by its index.

How one batch adds a slide and then writes to it: the slide has no handle until the add runs, so the write names the add's result instead. A reference to an operation that answered null (getSlide with orNull) makes a read answer null and a write fail with invalid-handle.

interface AutomationResultRef

AutomationSelectionPortinterfaceSource ↗

A reader's selection, as the browser host's port reports and sets it.

interface AutomationSelectionPort

AutomationSelectionReadinterfaceSource ↗

A reader's selection (browser host).

interface AutomationSelectionRead

AutomationShapeReadinterfaceSource ↗

One shape, as plain values. Lengths in points, the rotation in degrees.

interface AutomationShapeRead

AutomationShapeWriteinterfaceSource ↗

Shape properties a write sets.

interface AutomationShapeWrite extends AutomationBox

AutomationSlideReadinterfaceSource ↗

A slide.

interface AutomationSlideRead

AutomationTableCellFormatReadinterfaceSource ↗

The borders and margins of one table cell (a:tcPr, ECMA-376 Part 1, 21.1.3.17). A border reads as the cell shows it: its own line, else the table style's on a slide. Margins in points.

interface AutomationTableCellFormatRead

AutomationTableCellReadinterfaceSource ↗

One cell of a table, at its grid position.

interface AutomationTableCellRead

AutomationTableReadinterfaceSource ↗

A table's grid and values. Widths and heights in points.

interface AutomationTableRead

AutomationTableStyleWriteinterfaceSource ↗

Table style options (a:tblPr flags, ECMA-376 Part 1, 21.1.3.15) and the style a write sets.

interface AutomationTableStyleWrite

AutomationTaginterfaceSource ↗

One key and value of a tag list (p:tagLst).

interface AutomationTag

AutomationTextFrameReadinterfaceSource ↗

A text body's frame. Margins in points.

interface AutomationTextFrameRead

AutomationTextFrameWriteinterfaceSource ↗

Text frame properties a write sets. Margins in points.

interface AutomationTextFrameWrite

AutomationTextRunReadinterfaceSource ↗

One run of a text body with its effective character format.

interface AutomationTextRunRead

AutomationTextSpaninterfaceSource ↗

A stretch of a shape's text: a UTF-16 start and length. Absent means the whole text.

interface AutomationTextSpan

ServerAutomationOptionsinterfaceSource ↗

Options for a host over bytes.

interface ServerAutomationOptions extends StoreAutomationOptions

StoreAutomationOptionsinterfaceSource ↗

How a store host commits and measures.

interface StoreAutomationOptions

AutomationBackgroundWritetypeSource ↗

A background write (p:cSld/p:bg, ECMA-376 Part 1, 19.3.1.1). A fill write gives the part an own p:bgPr; a field it leaves out keeps the current value, or takes the default.

type AutomationBackgroundWrite = 
/** Remove the own `p:bg`: show the background of the layout or master. */
{
    readonly kind: 'follow';
}
/** Copy the background the part shows into an own `p:bg`. */
 | {
    readonly kind: 'own';
}
/** `showMasterSp`: hide or show the shapes of the level above. */
 | {
    readonly kind: 'graphicsHidden';
    readonly hidden: boolean;
} | {
    readonly kind: 'solid';
    readonly color?: string;
    readonly transparency?: number;
}
/** The gradient shading: `linear`, or an `a:path` of `circle`, `rect`, or `shape`. */
 | {
    readonly kind: 'gradient';
    readonly gradientType?: 'linear' | 'circle' | 'rect' | 'shape';
} | {
    readonly kind: 'pattern';
    readonly pattern?: string;
    readonly foregroundColor?: string;
    readonly backgroundColor?: string;
}
/** A stretched picture from PNG, JPEG, or GIF bytes in base64, or the current picture. */
 | {
    readonly kind: 'picture';
    readonly base64?: string;
    readonly transparency?: number;
};

AutomationCellBorderSidetypeSource ↗

A line of a table cell: an edge, or a diagonal (a:lnTlToBr down, a:lnBlToTr up).

type AutomationCellBorderSide = 'left' | 'right' | 'top' | 'bottom' | 'diagonalDown' | 'diagonalUp';

AutomationCustomPropertyWritetypeSource ↗

A custom property value a write sets. A Date is an ISO 8601 text.

type AutomationCustomPropertyWrite = {
    readonly type: 'String';
    readonly value: string;
} | {
    readonly type: 'Number';
    readonly value: number;
} | {
    readonly type: 'Boolean';
    readonly value: boolean;
} | {
    readonly type: 'Date';
    readonly value: string;
};

AutomationErrorCodetypeSource ↗

Why an operation was refused, as a value to branch on.

Distinguishable on purpose: the object model maps each code to a different error, and a caller that retries stale-revision must not retry invalid-handle.

type AutomationErrorCode = 
/** Nothing was applied: `expectedRevision` did not match the host's revision. */
'stale-revision'
/** A handle this host never minted, one of another kind, or one whose object is gone. */
 | 'invalid-handle'
/** An argument outside its range: an index, an offset, a length, a size. */
 | 'invalid-argument'
/** The operation needs a capability this host reports false. */
 | 'unsupported-capability'
/** The host has been disposed. Every later call fails this way. */
 | 'disposed'
/** The store refused the transaction; nothing was applied. */
 | 'transaction-refused'
/** The operation is not one this protocol version defines. */
 | 'unknown-operation'
/** The target holds content this operation does not edit (a chart, a diagram, a picture). */
 | 'unsupported-content'
/** A lookup by key or index found nothing, and the caller did not ask for null. */
 | 'item-not-found'
/** The host is live but holds no presentation right now (an editor between mounts). */
 | 'document-unavailable';

AutomationFillWritetypeSource ↗

A fill write. Colors are #RRGGBB or a preset color name; transparency is 0 to 1.

type AutomationFillWrite = {
    readonly kind: 'solid';
    readonly color: string;
    readonly transparency?: number;
} | {
    readonly kind: 'clear';
}
/** Change the transparency of the current solid fill. */
 | {
    readonly kind: 'transparency';
    readonly transparency: number;
}
/** A picture fill (`a:blipFill`) from PNG, JPEG, or GIF bytes in base64, stretched. */
 | {
    readonly kind: 'image';
    readonly base64: string;
};

AutomationHandleReftypeSource ↗

An opaque host-minted name for a presentation object.

Branded so a consumer cannot invent one. Its content is meaningless outside the host that minted it: each host draws a random token when it starts and stamps it into every ref, so a ref passed to another host, even one open on the same bytes, is invalid-handle.

type AutomationHandleRef = string & {
    readonly [AUTOMATION_HANDLE_BRAND]: 'handle';
};

AutomationImageResulttypeSource ↗

A PNG picture as base64, or why it could not be drawn.

type AutomationImageResult = {
    readonly ok: true;
    readonly base64: string;
} | {
    readonly ok: false;
    readonly error: AutomationError;
};

AutomationItemKeytypeSource ↗

How a collection item is found: by position, or by the id the object model shows.

type AutomationItemKey = {
    readonly index: number;
} | {
    readonly id: string;
};

AutomationNewShapetypeSource ↗

What a new shape is.

type AutomationNewShape = 
/** A preset geometry (`ST_ShapeType`, ECMA-376 Part 1, 20.1.10.56). */
{
    readonly kind: 'geometric';
    readonly geometry: string;
}
/** A connector: `straight`, `elbow`, or `curve`. */
 | {
    readonly kind: 'line';
    readonly connector: 'straight' | 'elbow' | 'curve';
} | {
    readonly kind: 'textBox';
    readonly text: string;
} | {
    readonly kind: 'table';
    readonly rows: number;
    readonly columns: number;
    readonly values?: readonly (readonly string[])[];
};

AutomationObjectKindtypeSource ↗

What kind of presentation object a handle names.

type AutomationObjectKind = 'presentation' | 'slide' | 'slideLayout' | 'slideMaster' | 'shape';

AutomationOperationtypeSource ↗

Every operation a host understands.

type AutomationOperation = {
    readonly op: 'getPresentation';
} | {
    readonly op: 'readPresentation';
} | {
    readonly op: 'setPageSetup';
    readonly slideWidth?: number;
    readonly slideHeight?: number;
} | {
    readonly op: 'getProperties';
} | {
    readonly op: 'setProperties';
    readonly properties: AutomationPropertiesWrite;
} | {
    readonly op: 'readCustomProperties';
    readonly owner: AutomationRef;
} | {
    readonly op: 'setCustomProperty';
    readonly owner: AutomationRef;
    readonly key: string;
    readonly value: AutomationCustomPropertyWrite;
} | {
    readonly op: 'deleteCustomProperty';
    readonly owner: AutomationRef;
    readonly key: string;
} | {
    readonly op: 'deleteCustomProperties';
    readonly owner: AutomationRef;
} | {
    readonly op: 'listCustomXmlParts';
    readonly owner: AutomationRef;
    readonly namespaceUri?: string;
} | {
    readonly op: 'readCustomXml';
    readonly owner: AutomationRef;
    readonly id: string;
} | {
    readonly op: 'addCustomXmlPart';
    readonly owner: AutomationRef;
    readonly xml: string;
    readonly id?: string;
} | {
    readonly op: 'setCustomXml';
    readonly owner: AutomationRef;
    readonly id: string;
    readonly xml: string;
} | {
    readonly op: 'deleteCustomXmlPart';
    readonly owner: AutomationRef;
    readonly id: string;
} | {
    readonly op: 'listSlides';
} | {
    readonly op: 'getSlide';
    readonly key: AutomationItemKey;
    readonly orNull?: boolean;
} | {
    readonly op: 'readSlide';
    readonly slide: AutomationRef;
} | {
    readonly op: 'addSlide';
    readonly index?: number;
    readonly layout?: AutomationRef;
    readonly master?: AutomationRef;
    readonly layoutId?: string;
    readonly masterId?: string;
} | {
    readonly op: 'getSlideLayout';
    readonly slide: AutomationRef;
} | {
    readonly op: 'getSlideMaster';
    readonly owner: AutomationRef;
} | {
    readonly op: 'deleteSlide';
    readonly slide: AutomationRef;
} | {
    readonly op: 'moveSlide';
    readonly slide: AutomationRef;
    readonly index: number;
} | {
    readonly op: 'applyLayout';
    readonly slide: AutomationRef;
    readonly layout: AutomationRef;
} | {
    readonly op: 'exportSlides';
    readonly slides: readonly AutomationRef[];
} | {
    readonly op: 'prepareImage';
    readonly target: AutomationRef;
    readonly width?: number;
    readonly height?: number;
} | {
    readonly op: 'insertSlides';
    readonly base64: string;
    readonly options?: AutomationInsertSlidesOptions;
} | {
    readonly op: 'listHyperlinks';
    readonly slide: AutomationRef;
} | {
    readonly op: 'listBindings';
    readonly owner: AutomationRef;
} | {
    readonly op: 'addBinding';
    readonly owner: AutomationRef;
    readonly shape: AutomationRef;
    readonly id: string;
} | {
    readonly op: 'addBindingFromSelection';
    readonly owner: AutomationRef;
    readonly id: string;
} | {
    readonly op: 'deleteBinding';
    readonly owner: AutomationRef;
    readonly id: string;
} | {
    readonly op: 'getBindingShape';
    readonly owner: AutomationRef;
    readonly id: string;
} | {
    readonly op: 'listMasters';
} | {
    readonly op: 'getMaster';
    readonly key: AutomationItemKey;
    readonly orNull?: boolean;
} | {
    readonly op: 'readMaster';
    readonly master: AutomationRef;
} | {
    readonly op: 'listLayouts';
    readonly master: AutomationRef;
} | {
    readonly op: 'getLayout';
    readonly master: AutomationRef;
    readonly key: AutomationItemKey;
    readonly orNull?: boolean;
} | {
    readonly op: 'readLayout';
    readonly layout: AutomationRef;
} | {
    readonly op: 'listShapes';
    readonly container: AutomationRef;
    readonly orNull?: boolean;
} | {
    readonly op: 'getShape';
    readonly container: AutomationRef;
    readonly key: AutomationItemKey;
    readonly orNull?: boolean;
} | {
    readonly op: 'readShape';
    readonly shape: AutomationRef;
    readonly group?: boolean;
    readonly orNull?: boolean;
} | {
    readonly op: 'addShape';
    readonly container: AutomationRef;
    readonly shape: AutomationNewShape;
    readonly box?: AutomationBox;
} | {
    readonly op: 'deleteShape';
    readonly shape: AutomationRef;
} | {
    readonly op: 'setShape';
    readonly shape: AutomationRef;
    readonly props: AutomationShapeWrite;
} | {
    readonly op: 'setZOrder';
    readonly shape: AutomationRef;
    readonly position: AutomationZOrder;
} | {
    readonly op: 'group';
    readonly shapes: readonly AutomationRef[];
} | {
    readonly op: 'ungroup';
    readonly group: AutomationRef;
} | {
    readonly op: 'getParentGroup';
    readonly shape: AutomationRef;
    readonly orNull?: boolean;
} | {
    readonly op: 'setShapeHyperlink';
    readonly shape: AutomationRef;
    readonly address: string | null;
    readonly screenTip?: string;
} | {
    readonly op: 'parentOf';
    readonly shape: AutomationRef;
    readonly kind: 'slide' | 'slideLayout' | 'slideMaster';
    readonly orNull?: boolean;
} | {
    readonly op: 'readFill';
    readonly shape: AutomationRef;
    readonly cell?: AutomationCellAddress;
} | {
    readonly op: 'setFill';
    readonly shape: AutomationRef;
    readonly fill: AutomationFillWrite;
    readonly cell?: AutomationCellAddress;
} | {
    readonly op: 'readBackground';
    readonly owner: AutomationRef;
} | {
    readonly op: 'setBackground';
    readonly owner: AutomationRef;
    readonly background: AutomationBackgroundWrite;
}
/** A color of the theme's `a:clrScheme`: `dk1`, `lt1`, … `accent6`, `hlink`, `folHlink`. */
 | {
    readonly op: 'readThemeColor';
    readonly owner: AutomationRef;
    readonly slot: string;
} | {
    readonly op: 'setThemeColor';
    readonly owner: AutomationRef;
    readonly slot: string;
    readonly color: string;
} | {
    readonly op: 'readLine';
    readonly shape: AutomationRef;
} | {
    readonly op: 'setLine';
    readonly shape: AutomationRef;
    readonly line: AutomationLineWrite;
} | {
    readonly op: 'readTextFrame';
    readonly shape: AutomationRef;
    readonly orNull?: boolean;
} | {
    readonly op: 'setTextFrame';
    readonly shape: AutomationRef;
    readonly props: AutomationTextFrameWrite;
} | {
    readonly op: 'readText';
    readonly shape: AutomationRef;
    readonly span?: AutomationTextSpan;
    readonly cell?: AutomationCellAddress;
    readonly orNull?: boolean;
} | {
    readonly op: 'setText';
    readonly shape: AutomationRef;
    readonly span?: AutomationTextSpan;
    readonly text: string;
    readonly cell?: AutomationCellAddress;
} | {
    readonly op: 'readFont';
    readonly shape: AutomationRef;
    readonly span?: AutomationTextSpan;
    readonly cell?: AutomationCellAddress;
    readonly orNull?: boolean;
} | {
    readonly op: 'readTextRuns';
    readonly shape: AutomationRef;
    readonly cell?: AutomationCellAddress;
} | {
    readonly op: 'setFont';
    readonly shape: AutomationRef;
    readonly span?: AutomationTextSpan;
    readonly font: AutomationFontWrite;
    readonly cell?: AutomationCellAddress;
} | {
    readonly op: 'readParagraph';
    readonly shape: AutomationRef;
    readonly span?: AutomationTextSpan;
    readonly cell?: AutomationCellAddress;
    readonly orNull?: boolean;
} | {
    readonly op: 'setParagraph';
    readonly shape: AutomationRef;
    readonly span?: AutomationTextSpan;
    readonly paragraph: AutomationParagraphWrite;
    readonly cell?: AutomationCellAddress;
} | {
    readonly op: 'setHyperlink';
    readonly shape: AutomationRef;
    readonly span?: AutomationTextSpan;
    readonly address: string | null;
    readonly screenTip?: string;
} | {
    readonly op: 'listTextHyperlinks';
    readonly shape: AutomationRef;
    readonly span?: AutomationTextSpan;
} | {
    readonly op: 'readTags';
    readonly owner: AutomationRef;
} | {
    readonly op: 'setTag';
    readonly owner: AutomationRef;
    readonly key: string;
    readonly value: string;
} | {
    readonly op: 'deleteTag';
    readonly owner: AutomationRef;
    readonly key: string;
} | {
    readonly op: 'readTable';
    readonly shape: AutomationRef;
} | {
    readonly op: 'readTableCell';
    readonly shape: AutomationRef;
    readonly row: number;
    readonly column: number;
} | {
    readonly op: 'setTableCell';
    readonly shape: AutomationRef;
    readonly row: number;
    readonly column: number;
    readonly text: string;
} | {
    readonly op: 'insertTableRows';
    readonly shape: AutomationRef;
    readonly index?: number;
    readonly count: number;
} | {
    readonly op: 'insertTableColumns';
    readonly shape: AutomationRef;
    readonly index?: number;
    readonly count: number;
} | {
    readonly op: 'deleteTableRows';
    readonly shape: AutomationRef;
    readonly index: number;
    readonly count: number;
} | {
    readonly op: 'deleteTableColumns';
    readonly shape: AutomationRef;
    readonly index: number;
    readonly count: number;
} | {
    readonly op: 'mergeTableCells';
    readonly shape: AutomationRef;
    readonly row: number;
    readonly column: number;
    readonly rowCount: number;
    readonly columnCount: number;
} | {
    readonly op: 'setTableCellAnchor';
    readonly shape: AutomationRef;
    readonly row: number;
    readonly column: number;
    readonly anchor: string;
    readonly anchorCenter: boolean;
} | {
    readonly op: 'splitTableCell';
    readonly shape: AutomationRef;
    readonly row: number;
    readonly column: number;
    readonly rowCount: number;
    readonly columnCount: number;
} | {
    readonly op: 'resizeTableCell';
    readonly shape: AutomationRef;
    readonly row: number;
    readonly column: number;
    readonly rowCount: number;
    readonly columnCount: number;
} | {
    readonly op: 'clearTable';
    readonly shape: AutomationRef;
    readonly text: boolean;
    readonly format: boolean;
} | {
    readonly op: 'readTableCellFormat';
    readonly shape: AutomationRef;
    readonly cell: AutomationCellAddress;
} | {
    readonly op: 'setTableCellBorder';
    readonly shape: AutomationRef;
    readonly cell: AutomationCellAddress;
    readonly side: AutomationCellBorderSide;
    readonly line: AutomationLineWrite;
} | {
    readonly op: 'setTableCellMargins';
    readonly shape: AutomationRef;
    readonly cell: AutomationCellAddress;
    readonly margins: AutomationCellMarginsWrite;
} | {
    readonly op: 'setTableStyle';
    readonly shape: AutomationRef;
    readonly style: AutomationTableStyleWrite;
} | {
    readonly op: 'readAdjustments';
    readonly shape: AutomationRef;
} | {
    readonly op: 'setAdjustment';
    readonly shape: AutomationRef;
    readonly index: number;
    readonly value: number;
} | {
    readonly op: 'setTableSize';
    readonly shape: AutomationRef;
    readonly target: 'row' | 'column';
    readonly index: number;
    readonly size: number;
} | {
    readonly op: 'readSelection';
} | {
    readonly op: 'selectSlides';
    readonly slides: readonly AutomationRef[];
} | {
    readonly op: 'selectShapes';
    readonly shapes: readonly AutomationRef[];
} | {
    readonly op: 'selectText';
    readonly shape: AutomationRef;
    readonly span?: AutomationTextSpan;
};

AutomationOperationResulttypeSource ↗

One operation's outcome.

skipped is what makes an atomic batch honest. When a batch fails, every operation other than the failing one reports skipped, including reads and the operations before it: reporting those as ok would describe a state that was never published.

type AutomationOperationResult = {
    readonly status: 'ok';
    readonly value: AutomationValue;
} | {
    readonly status: 'error';
    readonly error: AutomationError;
} | {
    readonly status: 'skipped';
};

AutomationReftypeSource ↗

A handle, or the handle an earlier operation of the batch answered with.

type AutomationRef = AutomationHandle | AutomationResultRef;

AutomationSaveResulttypeSource ↗

.pptx bytes, or why they could not be produced.

type AutomationSaveResult = {
    readonly ok: true;
    readonly bytes: Uint8Array;
} | {
    readonly ok: false;
    readonly error: AutomationError;
};

AutomationUnsubscribetypeSource ↗

What a subscription returns. Calling it twice is safe.

type AutomationUnsubscribe = () => void;

AutomationValuetypeSource ↗

What an operation answered with.

type AutomationValue = {
    readonly kind: 'handle';
    readonly handle: AutomationHandle;
} | {
    readonly kind: 'handles';
    readonly handles: readonly AutomationHandle[];
}
/** A lookup that found nothing, asked for with `orNull`. */
 | {
    readonly kind: 'null';
} | {
    readonly kind: 'text';
    readonly text: string;
} | {
    readonly kind: 'number';
    readonly value: number;
} | {
    readonly kind: 'flag';
    readonly value: boolean;
}
/** `.pptx` bytes as base64: an exported slide. */
 | {
    readonly kind: 'base64';
    readonly base64: string;
} | {
    readonly kind: 'presentation';
    readonly presentation: AutomationPresentationRead;
} | {
    readonly kind: 'slide';
    readonly slide: AutomationSlideRead;
} | {
    readonly kind: 'layout';
    readonly layout: AutomationLayoutRead;
} | {
    readonly kind: 'shape';
    readonly shape: AutomationShapeRead;
} | {
    readonly kind: 'fill';
    readonly fill: AutomationFillRead;
} | {
    readonly kind: 'background';
    readonly background: AutomationBackgroundRead;
} | {
    readonly kind: 'line';
    readonly line: AutomationLineRead;
} | {
    readonly kind: 'textFrame';
    readonly textFrame: AutomationTextFrameRead;
} | {
    readonly kind: 'font';
    readonly font: AutomationFontRead;
} | {
    readonly kind: 'textRuns';
    readonly runs: readonly AutomationTextRunRead[];
} | {
    readonly kind: 'paragraph';
    readonly paragraph: AutomationParagraphRead;
} | {
    readonly kind: 'tags';
    readonly tags: readonly AutomationTag[];
} | {
    readonly kind: 'properties';
    readonly properties: AutomationPropertiesRead;
} | {
    readonly kind: 'customProperties';
    readonly properties: readonly AutomationCustomPropertyRead[];
} | {
    readonly kind: 'customXmlParts';
    readonly parts: readonly AutomationCustomXmlPartRead[];
} | {
    readonly kind: 'table';
    readonly table: AutomationTableRead;
} | {
    readonly kind: 'tableCell';
    readonly cell: AutomationTableCellRead;
} | {
    readonly kind: 'tableCellFormat';
    readonly format: AutomationTableCellFormatRead;
} | {
    readonly kind: 'adjustments';
    readonly adjustments: AutomationAdjustmentsRead;
} | {
    readonly kind: 'hyperlinks';
    readonly hyperlinks: readonly AutomationHyperlinkRead[];
} | {
    readonly kind: 'bindings';
    readonly bindings: readonly AutomationBindingRead[];
} | {
    readonly kind: 'selection';
    readonly selection: AutomationSelectionRead;
}
/** A command that committed. The effect is the response's revision. */
 | {
    readonly kind: 'applied';
};

AutomationZOrdertypeSource ↗

ShapeZOrder moves.

type AutomationZOrder = 'bringForward' | 'bringToFront' | 'sendBackward' | 'sendToBack';

ServerAutomationRejectiontypeSource ↗

Why bytes could not be opened.

type ServerAutomationRejection = PackageRejection | {
    readonly reason: 'empty';
};

AUTOMATION_COMMANDSconstSource ↗

The operations that write. Every other operation only reads.

AUTOMATION_COMMANDS: ReadonlySet<AutomationOperation['op']>

MAX_BATCH_OPERATIONSconstSource ↗

The most operations one batch may carry.

MAX_BATCH_OPERATIONS = 10000