@superdoc/sdk 2.15.1-next.5 → 2.16.0-next.2

package/README.md

@@ -60,6 +60,71 @@ is not supported for Liveblocks or the standalone document host.
 
 See the [Node.js SDK guide](https://docs.superdoc.dev/agents/automation/node-sdk) for a complete workflow.
 
+## Tracked comparison with exact-file review
+
+The SDK's `diff.capture` and `diff.compare` describe a snapshot comparison. A
+blocked tracked `diff.apply` cannot turn that snapshot into a complete review
+proposal: the host must provide the exact base and target DOCX bytes, a durable
+review store, a document ID, and an authenticated actor. For a Node host using
+the V2 document runtime, `runTrackedComparisonReview` connects those steps:
+
+```js
+import { readFile } from 'node:fs/promises';
+import { createSuperDocClient, runTrackedComparisonReview } from '@superdoc/sdk';
+import {
+  createDocumentProposalManager,
+  createFileDocumentReviewStore,
+  openVersionedDocumentReviewSession,
+} from '@superdoc/docx-engine/document-runtime';
+
+const baseBytes = new Uint8Array(await readFile(basePath));
+const targetBytes = new Uint8Array(await readFile(targetPath));
+const actor = authenticatedUser.name; // Set by the host's authentication layer.
+const store = createFileDocumentReviewStore(durableReviewDirectory);
+const manager = createDocumentProposalManager(store);
+if (!(await store.read(documentId))) {
+  const initial = await manager.initialize({ documentId, bytes: baseBytes, savePolicy: 'suggest-only' });
+  if (initial.kind !== 'initialized' && initial.kind !== 'stale') throw new Error(initial.kind);
+}
+
+const session = await openVersionedDocumentReviewSession({ store, documentId, actor });
+const client = createSuperDocClient({
+  user: { name: actor },
+  requestTimeoutMs: 120_000,
+  env: { SUPERDOC_SDK_DOCUMENT_HOST_BIN: 'embedded' },
+});
+try {
+  const { diff, comparisonError, result } = await runTrackedComparisonReview({
+    client, baseBytes, targetBytes, documentId, actor,
+    currentReviewDocument: (id) => manager.current(id),
+    reviewSession: session,
+    options: { timeoutMs: 120_000 },
+  });
+  console.log(diff?.applyEligibility?.tracked, comparisonError);
+  if (result.kind === 'prepared') {
+    const preview = await session.preview(result.id);
+    // Present the whole-document proposal and its exact base/target files to a reviewer.
+    // Call session.decide(result.id, 'accept' or 'reject') after their decision.
+  } else if (result.kind !== 'native-revisions-applied') {
+    throw new Error(`Tracked review did not proceed: ${result.kind}`);
+  }
+  // manager.current(documentId) supplies export bytes; manager.history(documentId) supplies audit events.
+} finally {
+  await client.dispose();
+  await session.close();
+}
+```
+
+The helper stages private copies of the exact bytes for SDK capture and compare,
+checks the store's current base and the review session's version, document, and
+actor binding, then calls the versioned session's `applyTarget` in tracked mode.
+If SDK import or comparison is unavailable, `comparisonError` explains why
+`diff` is null and exact-file review still runs.
+That session chooses native Word revisions only after proving accept and reject
+endpoints; other supported changes become one whole-document proposal. A stale
+base or invalid DOCX returns a refusal without a partial apply. The host owns
+authorization, durable storage, reviewer presentation, and decisions.
+
 ## Agent execution evidence
 
 The core preset's `agent_apply`, `agent_verify`, and supported named actions

package/dist/generated/client.cjs

@@ -347,6 +347,7 @@ function createDocApi(runtime) {
             },
         },
         watermarks: {
+            apply: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.watermarks.apply"], params, options),
             list: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.watermarks.list"], params, options),
             insert: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.watermarks.insert"], params, options),
             replace: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.watermarks.replace"], params, options),
@@ -919,6 +920,7 @@ function createBoundDocApi(runtime) {
             },
         },
         watermarks: {
+            apply: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.watermarks.apply"], params, options),
             list: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.watermarks.list"], params, options),
             insert: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.watermarks.insert"], params, options),
             replace: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.watermarks.replace"], params, options),

package/dist/generated/client.d.ts

@@ -25743,6 +25743,112 @@ export interface DocHeaderFootersPartsDeleteParams {
         refId: string;
     };
 }
+export interface DocWatermarksApplyParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: string;
+    changeMode?: string;
+    dryRun?: boolean;
+    target: ({
+        kind: "document";
+    }) | ({
+        kind: "headerFooterSlots";
+        slots: Array<{
+            kind: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header";
+            variant: "default" | "first" | "even";
+        }>;
+    });
+    action: string;
+    watermark?: ({
+        kind: "text";
+        text: string;
+        fontFamily?: string;
+        fontSizePt?: "auto" | number;
+        bold?: boolean;
+        italic?: boolean;
+        color?: string;
+        opacity?: number;
+        orientation?: "horizontal" | "diagonal";
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+    }) | ({
+        kind: "picture";
+        src: string;
+        scalePercent?: "auto" | 50 | 100 | 150 | 200 | 500;
+        widthPt?: number;
+        heightPt?: number;
+        lockAspectRatio?: boolean;
+        washout?: boolean;
+        opacity?: number;
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+    }) | ({
+        kind: "picture";
+        src?: unknown;
+        scalePercent?: "auto" | 50 | 100 | 150 | 200 | 500;
+        widthPt?: number;
+        heightPt?: number;
+        lockAspectRatio?: boolean;
+        washout?: boolean;
+        opacity?: number;
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+        source: {
+            kind: "existing";
+            watermarkId: string;
+        };
+    });
+    watermarkIds?: string[];
+}
 export interface DocWatermarksListParams {
     doc?: string;
     sessionId?: string;
@@ -100717,8 +100823,9 @@ export type DocTrackChangesListResult = {
             format?: string;
         };
         revisionGroupId?: string;
-        reviewGroup?: {
+        reviewGroup?: ({
             kind: "text-rewrite";
+            groupOrigin: "authored-operation";
             role: "parent" | "child";
             parentId?: string;
             childChangeIds: Array<string>;
@@ -100733,7 +100840,24 @@ export type DocTrackChangesListResult = {
                     rsids?: Array<string>;
                 };
             }>;
-        };
+        }) | ({
+            kind: "comparison-hunk";
+            groupOrigin: "comparison-hunk";
+            role: "parent" | "child";
+            parentId?: string;
+            childChangeIds: Array<string>;
+            members: Array<{
+                id: string;
+                type: "insertion" | "deletion" | "replacement" | "formatting" | "move" | "structural" | "insert" | "delete" | "format";
+                subtype: string;
+                sourceIds: {
+                    wordIdInsert?: string;
+                    wordIdDelete?: string;
+                    wordIdOther?: Array<string>;
+                    rsids?: Array<string>;
+                };
+            }>;
+        });
         author?: string;
         authorEmail?: string;
         authorImage?: string;
@@ -101023,8 +101147,9 @@ export type DocTrackChangesGetResult = {
         format?: string;
     };
     revisionGroupId?: string;
-    reviewGroup?: {
+    reviewGroup?: ({
         kind: "text-rewrite";
+        groupOrigin: "authored-operation";
         role: "parent" | "child";
         parentId?: string;
         childChangeIds: Array<string>;
@@ -101039,7 +101164,24 @@ export type DocTrackChangesGetResult = {
                 rsids?: Array<string>;
             };
         }>;
-    };
+    }) | ({
+        kind: "comparison-hunk";
+        groupOrigin: "comparison-hunk";
+        role: "parent" | "child";
+        parentId?: string;
+        childChangeIds: Array<string>;
+        members: Array<{
+            id: string;
+            type: "insertion" | "deletion" | "replacement" | "formatting" | "move" | "structural" | "insert" | "delete" | "format";
+            subtype: string;
+            sourceIds: {
+                wordIdInsert?: string;
+                wordIdDelete?: string;
+                wordIdOther?: Array<string>;
+                rsids?: Array<string>;
+            };
+        }>;
+    });
     splitFromId?: string | null;
     replacement?: {
         inserted: ({
@@ -105251,6 +105393,12 @@ export type DocCapabilitiesGetResult = {
             dryRun: boolean;
             reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE" | "TARGET_CONTEXT_REQUIRED" | "TARGET_UNSUPPORTED">;
         };
+        "watermarks.apply": {
+            available: boolean;
+            tracked: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE" | "TARGET_CONTEXT_REQUIRED" | "TARGET_UNSUPPORTED">;
+        };
         "watermarks.list": {
             available: boolean;
             tracked: boolean;
@@ -108279,7 +108427,7 @@ export type DocCapabilitiesCheckResult = ({
     };
 });
 export type DocCapabilitiesResolveResult = {
-    operationId: "get" | "find" | "getNode" | "getNodeById" | "getText" | "getMarkdown" | "getHtml" | "projectMarkdown" | "projectHtml" | "markdownToFragment" | "htmlToFragment" | "info" | "extract" | "clearContent" | "insert" | "replace" | "delete" | "formatRange" | "blocks.findText" | "blocks.list" | "blocks.delete" | "blocks.deleteRange" | "blocks.split" | "blocks.merge" | "blocks.move" | "format.apply" | "format.bold" | "format.italic" | "format.strike" | "format.underline" | "format.highlight" | "format.color" | "format.fontSize" | "format.fontFamily" | "format.letterSpacing" | "format.vertAlign" | "format.position" | "format.dstrike" | "format.smallCaps" | "format.caps" | "format.shading" | "format.border" | "format.outline" | "format.shadow" | "format.emboss" | "format.imprint" | "format.charScale" | "format.kerning" | "format.vanish" | "format.webHidden" | "format.specVanish" | "format.rtl" | "format.cs" | "format.bCs" | "format.iCs" | "format.eastAsianLayout" | "format.em" | "format.fitText" | "format.snapToGrid" | "format.lang" | "format.oMath" | "format.rStyle" | "format.rFonts" | "format.fontSizeCs" | "format.ligatures" | "format.numForm" | "format.numSpacing" | "format.stylisticSets" | "format.contextualAlternates" | "styles.apply" | "styles.getCatalog" | "templates.apply" | "create.paragraph" | "create.heading" | "create.sectionBreak" | "sections.list" | "sections.get" | "sections.setBreakType" | "sections.setPageMargins" | "sections.setHeaderFooterMargins" | "sections.setPageSetup" | "sections.setColumns" | "sections.setLineNumbering" | "sections.setPageNumbering" | "sections.setTitlePage" | "sections.setOddEvenHeadersFooters" | "sections.setVerticalAlign" | "sections.setSectionDirection" | "sections.setHeaderFooterRef" | "sections.clearHeaderFooterRef" | "sections.setLinkToPrevious" | "sections.setPageBorders" | "sections.clearPageBorders" | "styles.paragraph.setStyle" | "styles.paragraph.setStyleRef" | "styles.paragraph.clearStyle" | "format.paragraph.resetDirectFormatting" | "format.paragraph.setAlignment" | "format.paragraph.clearAlignment" | "format.paragraph.setIndentation" | "format.paragraph.clearIndentation" | "format.paragraph.setSpacing" | "format.paragraph.clearSpacing" | "format.paragraph.setKeepOptions" | "format.paragraph.setOutlineLevel" | "format.paragraph.setFlowOptions" | "format.paragraph.setTabStop" | "format.paragraph.clearTabStop" | "format.paragraph.clearAllTabStops" | "format.paragraph.setBorder" | "format.paragraph.clearBorder" | "format.paragraph.setShading" | "format.paragraph.clearShading" | "format.paragraph.setMarkRunProps" | "format.paragraph.setDirection" | "format.paragraph.clearDirection" | "format.paragraph.setNumbering" | "lists.list" | "lists.get" | "lists.insert" | "lists.create" | "lists.attach" | "lists.detach" | "lists.delete" | "lists.indent" | "lists.outdent" | "lists.join" | "lists.canJoin" | "lists.separate" | "lists.merge" | "lists.split" | "lists.setLevel" | "lists.setValue" | "lists.continuePrevious" | "lists.canContinuePrevious" | "lists.setLevelRestart" | "lists.convertToText" | "lists.applyTemplate" | "lists.applyPreset" | "lists.setType" | "lists.captureTemplate" | "lists.setLevelNumbering" | "lists.setLevelBullet" | "lists.setLevelPictureBullet" | "lists.setLevelAlignment" | "lists.setLevelIndents" | "lists.setLevelTrailingCharacter" | "lists.setLevelMarkerFont" | "lists.clearLevelOverrides" | "lists.getStyle" | "lists.applyStyle" | "lists.restartAt" | "lists.setLevelNumberStyle" | "lists.setLevelText" | "lists.setLevelStart" | "lists.setLevelLayout" | "lists.getState" | "lists.apply" | "lists.continue" | "lists.restart" | "lists.remove" | "comments.create" | "comments.patch" | "comments.delete" | "comments.get" | "comments.list" | "trackChanges.list" | "trackChanges.get" | "trackChanges.decide" | "query.match" | "ranges.resolve" | "selection.current" | "mutations.preview" | "mutations.apply" | "plan.execute" | "capabilities.get" | "capabilities.check" | "capabilities.resolve" | "create.table" | "tables.convertFromText" | "tables.delete" | "tables.clearContents" | "tables.move" | "tables.split" | "tables.convertToText" | "tables.setLayout" | "tables.insertRow" | "tables.deleteRow" | "tables.moveRow" | "tables.setRowHeight" | "tables.distributeRows" | "tables.setRowOptions" | "tables.insertColumn" | "tables.deleteColumn" | "tables.moveColumn" | "tables.setColumnWidth" | "tables.distributeColumns" | "tables.insertCell" | "tables.deleteCell" | "tables.mergeCells" | "tables.unmergeCells" | "tables.splitCell" | "tables.setCellProperties" | "tables.setCellText" | "tables.sort" | "tables.setAltText" | "tables.setStyle" | "tables.clearStyle" | "tables.setStyleOption" | "tables.setBorder" | "tables.clearBorder" | "tables.applyBorderPreset" | "tables.setShading" | "tables.clearShading" | "tables.setTablePadding" | "tables.setCellPadding" | "tables.setCellSpacing" | "tables.clearCellSpacing" | "tables.applyStyle" | "tables.setBorders" | "tables.setTableOptions" | "tables.applyPreset" | "tables.get" | "tables.getCells" | "tables.getProperties" | "tables.getStyles" | "tables.setDefaultStyle" | "tables.clearDefaultStyle" | "create.tableOfContents" | "toc.list" | "toc.get" | "toc.configure" | "toc.update" | "toc.remove" | "toc.markEntry" | "toc.unmarkEntry" | "toc.listEntries" | "toc.getEntry" | "toc.editEntry" | "history.get" | "history.undo" | "history.redo" | "create.image" | "images.list" | "images.get" | "images.delete" | "images.move" | "images.convertToInline" | "images.convertToFloating" | "images.setSize" | "images.setWrapType" | "images.setWrapSide" | "images.setWrapDistances" | "images.setPosition" | "images.setAnchorOptions" | "images.setZOrder" | "images.scale" | "images.setLockAspectRatio" | "images.rotate" | "images.flip" | "images.crop" | "images.resetCrop" | "images.replaceSource" | "images.setAltText" | "images.setDecorative" | "images.setName" | "images.setHyperlink" | "images.insertCaption" | "images.updateCaption" | "images.removeCaption" | "hyperlinks.list" | "hyperlinks.get" | "hyperlinks.wrap" | "hyperlinks.insert" | "hyperlinks.patch" | "hyperlinks.remove" | "headerFooters.list" | "headerFooters.get" | "headerFooters.resolve" | "headerFooters.refs.set" | "headerFooters.refs.clear" | "headerFooters.refs.setLinkedToPrevious" | "headerFooters.parts.list" | "headerFooters.parts.create" | "headerFooters.parts.delete" | "watermarks.list" | "watermarks.insert" | "watermarks.replace" | "watermarks.remove" | "create.contentControl" | "contentControls.list" | "contentControls.get" | "contentControls.listInRange" | "contentControls.selectByTag" | "contentControls.selectByTitle" | "contentControls.listChildren" | "contentControls.getParent" | "contentControls.wrap" | "contentControls.unwrap" | "contentControls.delete" | "contentControls.copy" | "contentControls.move" | "contentControls.patch" | "contentControls.setLockMode" | "contentControls.setType" | "contentControls.getContent" | "contentControls.replaceContent" | "contentControls.clearContent" | "contentControls.appendContent" | "contentControls.prependContent" | "contentControls.insertBefore" | "contentControls.insertAfter" | "contentControls.getBinding" | "contentControls.setBinding" | "contentControls.clearBinding" | "contentControls.getRawProperties" | "contentControls.patchRawProperties" | "contentControls.validateWordCompatibility" | "contentControls.normalizeWordCompatibility" | "contentControls.normalizeTagPayload" | "contentControls.text.setMultiline" | "contentControls.text.setValue" | "contentControls.text.clearValue" | "contentControls.date.setValue" | "contentControls.date.clearValue" | "contentControls.date.setDisplayFormat" | "contentControls.date.setDisplayLocale" | "contentControls.date.setStorageFormat" | "contentControls.date.setCalendar" | "contentControls.checkbox.getState" | "contentControls.checkbox.setState" | "contentControls.checkbox.toggle" | "contentControls.checkbox.setSymbolPair" | "contentControls.choiceList.getItems" | "contentControls.choiceList.setItems" | "contentControls.choiceList.setSelected" | "contentControls.repeatingSection.listItems" | "contentControls.repeatingSection.insertItemBefore" | "contentControls.repeatingSection.insertItemAfter" | "contentControls.repeatingSection.cloneItem" | "contentControls.repeatingSection.deleteItem" | "contentControls.repeatingSection.setAllowInsertDelete" | "contentControls.group.wrap" | "contentControls.group.ungroup" | "bookmarks.list" | "bookmarks.get" | "bookmarks.insert" | "bookmarks.rename" | "bookmarks.remove" | "footnotes.list" | "footnotes.get" | "footnotes.insert" | "footnotes.update" | "footnotes.remove" | "footnotes.configure" | "clipboard.parse" | "clipboard.insert" | "clipboard.serializeSelection" | "crossRefs.list" | "crossRefs.get" | "crossRefs.insert" | "crossRefs.rebuild" | "crossRefs.remove" | "index.list" | "index.get" | "index.insert" | "index.configure" | "index.rebuild" | "index.remove" | "index.entries.list" | "index.entries.get" | "index.entries.insert" | "index.entries.update" | "index.entries.remove" | "captions.list" | "captions.get" | "captions.insert" | "captions.update" | "captions.remove" | "captions.configure" | "fields.list" | "fields.get" | "fields.insert" | "fields.rebuild" | "fields.remove" | "citations.list" | "citations.get" | "citations.insert" | "citations.update" | "citations.remove" | "citations.sources.list" | "citations.sources.get" | "citations.sources.insert" | "citations.sources.update" | "citations.sources.remove" | "citations.bibliography.get" | "citations.bibliography.insert" | "citations.bibliography.rebuild" | "citations.bibliography.configure" | "citations.bibliography.remove" | "authorities.list" | "authorities.get" | "authorities.insert" | "authorities.configure" | "authorities.rebuild" | "authorities.remove" | "authorities.entries.list" | "authorities.entries.get" | "authorities.entries.insert" | "authorities.entries.update" | "authorities.entries.remove" | "diff.capture" | "diff.compare" | "diff.apply" | "export.toDocx" | "protection.get" | "protection.setEditingRestriction" | "protection.clearEditingRestriction" | "permissionRanges.list" | "permissionRanges.get" | "permissionRanges.create" | "permissionRanges.remove" | "permissionRanges.updatePrincipal" | "customXml.parts.list" | "customXml.parts.get" | "customXml.parts.create" | "customXml.parts.patch" | "customXml.parts.remove" | "metadata.attach" | "metadata.list" | "metadata.get" | "metadata.update" | "metadata.remove" | "metadata.resolve";
+    operationId: "get" | "find" | "getNode" | "getNodeById" | "getText" | "getMarkdown" | "getHtml" | "projectMarkdown" | "projectHtml" | "markdownToFragment" | "htmlToFragment" | "info" | "extract" | "clearContent" | "insert" | "replace" | "delete" | "formatRange" | "blocks.findText" | "blocks.list" | "blocks.delete" | "blocks.deleteRange" | "blocks.split" | "blocks.merge" | "blocks.move" | "format.apply" | "format.bold" | "format.italic" | "format.strike" | "format.underline" | "format.highlight" | "format.color" | "format.fontSize" | "format.fontFamily" | "format.letterSpacing" | "format.vertAlign" | "format.position" | "format.dstrike" | "format.smallCaps" | "format.caps" | "format.shading" | "format.border" | "format.outline" | "format.shadow" | "format.emboss" | "format.imprint" | "format.charScale" | "format.kerning" | "format.vanish" | "format.webHidden" | "format.specVanish" | "format.rtl" | "format.cs" | "format.bCs" | "format.iCs" | "format.eastAsianLayout" | "format.em" | "format.fitText" | "format.snapToGrid" | "format.lang" | "format.oMath" | "format.rStyle" | "format.rFonts" | "format.fontSizeCs" | "format.ligatures" | "format.numForm" | "format.numSpacing" | "format.stylisticSets" | "format.contextualAlternates" | "styles.apply" | "styles.getCatalog" | "templates.apply" | "create.paragraph" | "create.heading" | "create.sectionBreak" | "sections.list" | "sections.get" | "sections.setBreakType" | "sections.setPageMargins" | "sections.setHeaderFooterMargins" | "sections.setPageSetup" | "sections.setColumns" | "sections.setLineNumbering" | "sections.setPageNumbering" | "sections.setTitlePage" | "sections.setOddEvenHeadersFooters" | "sections.setVerticalAlign" | "sections.setSectionDirection" | "sections.setHeaderFooterRef" | "sections.clearHeaderFooterRef" | "sections.setLinkToPrevious" | "sections.setPageBorders" | "sections.clearPageBorders" | "styles.paragraph.setStyle" | "styles.paragraph.setStyleRef" | "styles.paragraph.clearStyle" | "format.paragraph.resetDirectFormatting" | "format.paragraph.setAlignment" | "format.paragraph.clearAlignment" | "format.paragraph.setIndentation" | "format.paragraph.clearIndentation" | "format.paragraph.setSpacing" | "format.paragraph.clearSpacing" | "format.paragraph.setKeepOptions" | "format.paragraph.setOutlineLevel" | "format.paragraph.setFlowOptions" | "format.paragraph.setTabStop" | "format.paragraph.clearTabStop" | "format.paragraph.clearAllTabStops" | "format.paragraph.setBorder" | "format.paragraph.clearBorder" | "format.paragraph.setShading" | "format.paragraph.clearShading" | "format.paragraph.setMarkRunProps" | "format.paragraph.setDirection" | "format.paragraph.clearDirection" | "format.paragraph.setNumbering" | "lists.list" | "lists.get" | "lists.insert" | "lists.create" | "lists.attach" | "lists.detach" | "lists.delete" | "lists.indent" | "lists.outdent" | "lists.join" | "lists.canJoin" | "lists.separate" | "lists.merge" | "lists.split" | "lists.setLevel" | "lists.setValue" | "lists.continuePrevious" | "lists.canContinuePrevious" | "lists.setLevelRestart" | "lists.convertToText" | "lists.applyTemplate" | "lists.applyPreset" | "lists.setType" | "lists.captureTemplate" | "lists.setLevelNumbering" | "lists.setLevelBullet" | "lists.setLevelPictureBullet" | "lists.setLevelAlignment" | "lists.setLevelIndents" | "lists.setLevelTrailingCharacter" | "lists.setLevelMarkerFont" | "lists.clearLevelOverrides" | "lists.getStyle" | "lists.applyStyle" | "lists.restartAt" | "lists.setLevelNumberStyle" | "lists.setLevelText" | "lists.setLevelStart" | "lists.setLevelLayout" | "lists.getState" | "lists.apply" | "lists.continue" | "lists.restart" | "lists.remove" | "comments.create" | "comments.patch" | "comments.delete" | "comments.get" | "comments.list" | "trackChanges.list" | "trackChanges.get" | "trackChanges.decide" | "query.match" | "ranges.resolve" | "selection.current" | "mutations.preview" | "mutations.apply" | "plan.execute" | "capabilities.get" | "capabilities.check" | "capabilities.resolve" | "create.table" | "tables.convertFromText" | "tables.delete" | "tables.clearContents" | "tables.move" | "tables.split" | "tables.convertToText" | "tables.setLayout" | "tables.insertRow" | "tables.deleteRow" | "tables.moveRow" | "tables.setRowHeight" | "tables.distributeRows" | "tables.setRowOptions" | "tables.insertColumn" | "tables.deleteColumn" | "tables.moveColumn" | "tables.setColumnWidth" | "tables.distributeColumns" | "tables.insertCell" | "tables.deleteCell" | "tables.mergeCells" | "tables.unmergeCells" | "tables.splitCell" | "tables.setCellProperties" | "tables.setCellText" | "tables.sort" | "tables.setAltText" | "tables.setStyle" | "tables.clearStyle" | "tables.setStyleOption" | "tables.setBorder" | "tables.clearBorder" | "tables.applyBorderPreset" | "tables.setShading" | "tables.clearShading" | "tables.setTablePadding" | "tables.setCellPadding" | "tables.setCellSpacing" | "tables.clearCellSpacing" | "tables.applyStyle" | "tables.setBorders" | "tables.setTableOptions" | "tables.applyPreset" | "tables.get" | "tables.getCells" | "tables.getProperties" | "tables.getStyles" | "tables.setDefaultStyle" | "tables.clearDefaultStyle" | "create.tableOfContents" | "toc.list" | "toc.get" | "toc.configure" | "toc.update" | "toc.remove" | "toc.markEntry" | "toc.unmarkEntry" | "toc.listEntries" | "toc.getEntry" | "toc.editEntry" | "history.get" | "history.undo" | "history.redo" | "create.image" | "images.list" | "images.get" | "images.delete" | "images.move" | "images.convertToInline" | "images.convertToFloating" | "images.setSize" | "images.setWrapType" | "images.setWrapSide" | "images.setWrapDistances" | "images.setPosition" | "images.setAnchorOptions" | "images.setZOrder" | "images.scale" | "images.setLockAspectRatio" | "images.rotate" | "images.flip" | "images.crop" | "images.resetCrop" | "images.replaceSource" | "images.setAltText" | "images.setDecorative" | "images.setName" | "images.setHyperlink" | "images.insertCaption" | "images.updateCaption" | "images.removeCaption" | "hyperlinks.list" | "hyperlinks.get" | "hyperlinks.wrap" | "hyperlinks.insert" | "hyperlinks.patch" | "hyperlinks.remove" | "headerFooters.list" | "headerFooters.get" | "headerFooters.resolve" | "headerFooters.refs.set" | "headerFooters.refs.clear" | "headerFooters.refs.setLinkedToPrevious" | "headerFooters.parts.list" | "headerFooters.parts.create" | "headerFooters.parts.delete" | "watermarks.apply" | "watermarks.list" | "watermarks.insert" | "watermarks.replace" | "watermarks.remove" | "create.contentControl" | "contentControls.list" | "contentControls.get" | "contentControls.listInRange" | "contentControls.selectByTag" | "contentControls.selectByTitle" | "contentControls.listChildren" | "contentControls.getParent" | "contentControls.wrap" | "contentControls.unwrap" | "contentControls.delete" | "contentControls.copy" | "contentControls.move" | "contentControls.patch" | "contentControls.setLockMode" | "contentControls.setType" | "contentControls.getContent" | "contentControls.replaceContent" | "contentControls.clearContent" | "contentControls.appendContent" | "contentControls.prependContent" | "contentControls.insertBefore" | "contentControls.insertAfter" | "contentControls.getBinding" | "contentControls.setBinding" | "contentControls.clearBinding" | "contentControls.getRawProperties" | "contentControls.patchRawProperties" | "contentControls.validateWordCompatibility" | "contentControls.normalizeWordCompatibility" | "contentControls.normalizeTagPayload" | "contentControls.text.setMultiline" | "contentControls.text.setValue" | "contentControls.text.clearValue" | "contentControls.date.setValue" | "contentControls.date.clearValue" | "contentControls.date.setDisplayFormat" | "contentControls.date.setDisplayLocale" | "contentControls.date.setStorageFormat" | "contentControls.date.setCalendar" | "contentControls.checkbox.getState" | "contentControls.checkbox.setState" | "contentControls.checkbox.toggle" | "contentControls.checkbox.setSymbolPair" | "contentControls.choiceList.getItems" | "contentControls.choiceList.setItems" | "contentControls.choiceList.setSelected" | "contentControls.repeatingSection.listItems" | "contentControls.repeatingSection.insertItemBefore" | "contentControls.repeatingSection.insertItemAfter" | "contentControls.repeatingSection.cloneItem" | "contentControls.repeatingSection.deleteItem" | "contentControls.repeatingSection.setAllowInsertDelete" | "contentControls.group.wrap" | "contentControls.group.ungroup" | "bookmarks.list" | "bookmarks.get" | "bookmarks.insert" | "bookmarks.rename" | "bookmarks.remove" | "footnotes.list" | "footnotes.get" | "footnotes.insert" | "footnotes.update" | "footnotes.remove" | "footnotes.configure" | "clipboard.parse" | "clipboard.insert" | "clipboard.serializeSelection" | "crossRefs.list" | "crossRefs.get" | "crossRefs.insert" | "crossRefs.rebuild" | "crossRefs.remove" | "index.list" | "index.get" | "index.insert" | "index.configure" | "index.rebuild" | "index.remove" | "index.entries.list" | "index.entries.get" | "index.entries.insert" | "index.entries.update" | "index.entries.remove" | "captions.list" | "captions.get" | "captions.insert" | "captions.update" | "captions.remove" | "captions.configure" | "fields.list" | "fields.get" | "fields.insert" | "fields.rebuild" | "fields.remove" | "citations.list" | "citations.get" | "citations.insert" | "citations.update" | "citations.remove" | "citations.sources.list" | "citations.sources.get" | "citations.sources.insert" | "citations.sources.update" | "citations.sources.remove" | "citations.bibliography.get" | "citations.bibliography.insert" | "citations.bibliography.rebuild" | "citations.bibliography.configure" | "citations.bibliography.remove" | "authorities.list" | "authorities.get" | "authorities.insert" | "authorities.configure" | "authorities.rebuild" | "authorities.remove" | "authorities.entries.list" | "authorities.entries.get" | "authorities.entries.insert" | "authorities.entries.update" | "authorities.entries.remove" | "diff.capture" | "diff.compare" | "diff.apply" | "export.toDocx" | "protection.get" | "protection.setEditingRestriction" | "protection.clearEditingRestriction" | "permissionRanges.list" | "permissionRanges.get" | "permissionRanges.create" | "permissionRanges.remove" | "permissionRanges.updatePrincipal" | "customXml.parts.list" | "customXml.parts.get" | "customXml.parts.create" | "customXml.parts.patch" | "customXml.parts.remove" | "metadata.attach" | "metadata.list" | "metadata.get" | "metadata.update" | "metadata.remove" | "metadata.resolve";
     available: ({
         kind: "supported";
     }) | ({
@@ -112175,6 +112323,98 @@ export type DocHeaderFootersPartsDeleteResult = {
     refId: string;
     partPath: string;
 };
+export type DocWatermarksApplyResult = {
+    success: true;
+    watermarks: Array<{
+        watermarkId: string;
+        owner: {
+            refId: string;
+            partPath: string;
+        };
+        effectiveIn: Array<{
+            kind: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header";
+            variant: "default" | "first" | "even";
+        }>;
+        watermark: ({
+            kind: "text";
+            text: string;
+            fontFamily?: string;
+            fontSizePt?: "auto" | number;
+            bold?: boolean;
+            italic?: boolean;
+            color?: string;
+            opacity?: number;
+            orientation?: "horizontal" | "diagonal";
+            placement?: {
+                widthPt?: number;
+                heightPt?: number;
+                rotationDegrees?: number;
+                behindText?: boolean;
+                horizontal?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "left" | "center" | "right";
+                    offsetPt?: number;
+                };
+                vertical?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "top" | "center" | "bottom";
+                    offsetPt?: number;
+                };
+            };
+        }) | ({
+            kind: "picture";
+            mediaPartPath: string;
+            contentType: string;
+            scalePercent: "auto" | 50 | 100 | 150 | 200 | 500;
+            widthPt: number;
+            heightPt: number;
+            lockAspectRatio: boolean;
+            washout: boolean;
+            opacity: number;
+            placement: {
+                widthPt?: number;
+                heightPt?: number;
+                rotationDegrees?: number;
+                behindText?: boolean;
+                horizontal?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "left" | "center" | "right";
+                    offsetPt?: number;
+                };
+                vertical?: {
+                    relativeFrom: "page" | "margin";
+                    alignment?: "top" | "center" | "bottom";
+                    offsetPt?: number;
+                };
+            };
+        });
+    }>;
+    affectedSlots: Array<{
+        kind: "headerFooterSlot";
+        section: {
+            kind: "section";
+            sectionId: string;
+        };
+        headerFooterKind: "header";
+        variant: "default" | "first" | "even";
+    }>;
+    preservedSlots: Array<{
+        kind: "headerFooterSlot";
+        section: {
+            kind: "section";
+            sectionId: string;
+        };
+        headerFooterKind: "header";
+        variant: "default" | "first" | "even";
+    }>;
+    evaluatedRevision: string;
+    dryRun?: true;
+};
 export type DocWatermarksListResult = {
     evaluatedRevision: string;
     total: number;
@@ -147381,6 +147621,110 @@ export interface DocHeaderFootersPartsDeleteBoundParams {
         refId: string;
     };
 }
+export interface DocWatermarksApplyBoundParams {
+    out?: string;
+    force?: boolean;
+    expectedRevision?: string;
+    changeMode?: string;
+    dryRun?: boolean;
+    target: ({
+        kind: "document";
+    }) | ({
+        kind: "headerFooterSlots";
+        slots: Array<{
+            kind: "headerFooterSlot";
+            section: {
+                kind: "section";
+                sectionId: string;
+            };
+            headerFooterKind: "header";
+            variant: "default" | "first" | "even";
+        }>;
+    });
+    action: string;
+    watermark?: ({
+        kind: "text";
+        text: string;
+        fontFamily?: string;
+        fontSizePt?: "auto" | number;
+        bold?: boolean;
+        italic?: boolean;
+        color?: string;
+        opacity?: number;
+        orientation?: "horizontal" | "diagonal";
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+    }) | ({
+        kind: "picture";
+        src: string;
+        scalePercent?: "auto" | 50 | 100 | 150 | 200 | 500;
+        widthPt?: number;
+        heightPt?: number;
+        lockAspectRatio?: boolean;
+        washout?: boolean;
+        opacity?: number;
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+    }) | ({
+        kind: "picture";
+        src?: unknown;
+        scalePercent?: "auto" | 50 | 100 | 150 | 200 | 500;
+        widthPt?: number;
+        heightPt?: number;
+        lockAspectRatio?: boolean;
+        washout?: boolean;
+        opacity?: number;
+        placement?: {
+            widthPt?: number;
+            heightPt?: number;
+            rotationDegrees?: number;
+            behindText?: boolean;
+            horizontal?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "left" | "center" | "right";
+                offsetPt?: number;
+            };
+            vertical?: {
+                relativeFrom: "page" | "margin";
+                alignment?: "top" | "center" | "bottom";
+                offsetPt?: number;
+            };
+        };
+        source: {
+            kind: "existing";
+            watermarkId: string;
+        };
+    });
+    watermarkIds?: string[];
+}
 export interface DocWatermarksListBoundParams {
     target?: ({
         kind: "document";
@@ -153027,6 +153371,7 @@ export declare function createDocApi(runtime: RuntimeInvoker): {
         };
     };
     watermarks: {
+        apply: (params: DocWatermarksApplyParams, options?: InvokeOptions) => Promise<DocWatermarksApplyResult>;
         list: (params?: DocWatermarksListParams, options?: InvokeOptions) => Promise<DocWatermarksListResult>;
         insert: (params: DocWatermarksInsertParams, options?: InvokeOptions) => Promise<DocWatermarksInsertResult>;
         replace: (params: DocWatermarksReplaceParams, options?: InvokeOptions) => Promise<DocWatermarksReplaceResult>;
@@ -153595,6 +153940,7 @@ export declare function createBoundDocApi(runtime: RuntimeInvoker): {
         };
     };
     watermarks: {
+        apply: (params: DocWatermarksApplyBoundParams, options?: InvokeOptions) => Promise<DocWatermarksApplyResult>;
         list: (params?: DocWatermarksListBoundParams, options?: InvokeOptions) => Promise<DocWatermarksListResult>;
         insert: (params: DocWatermarksInsertBoundParams, options?: InvokeOptions) => Promise<DocWatermarksInsertResult>;
         replace: (params: DocWatermarksReplaceBoundParams, options?: InvokeOptions) => Promise<DocWatermarksReplaceResult>;

package/dist/generated/client.js

@@ -344,6 +344,7 @@ export function createDocApi(runtime) {
             },
         },
         watermarks: {
+            apply: (params, options) => runtime.invoke(CONTRACT.operations["doc.watermarks.apply"], params, options),
             list: (params = {}, options) => runtime.invoke(CONTRACT.operations["doc.watermarks.list"], params, options),
             insert: (params, options) => runtime.invoke(CONTRACT.operations["doc.watermarks.insert"], params, options),
             replace: (params, options) => runtime.invoke(CONTRACT.operations["doc.watermarks.replace"], params, options),
@@ -916,6 +917,7 @@ export function createBoundDocApi(runtime) {
             },
         },
         watermarks: {
+            apply: (params, options) => runtime.invoke(CONTRACT.operations["doc.watermarks.apply"], params, options),
             list: (params = {}, options) => runtime.invoke(CONTRACT.operations["doc.watermarks.list"], params, options),
             insert: (params, options) => runtime.invoke(CONTRACT.operations["doc.watermarks.insert"], params, options),
             replace: (params, options) => runtime.invoke(CONTRACT.operations["doc.watermarks.replace"], params, options),