@ansonlai/docx-redline-js 0.7.2 → 0.8.1

package/services/standalone-operation-runner.d.ts

@@ -37,8 +37,15 @@ export interface LocalizedReplacement {
   occurrence?: number;
 }
 
+/** A header/footer part path from `inspect().headersFooters`, or a selector. */
+export type HeaderFooterPartSelector =
+  | string
+  | { kind: 'header' | 'footer'; type?: 'default' | 'first' | 'even'; section?: number };
+
 export interface DocumentOperationBase {
   operationId?: string;
+  /** Target a header or footer instead of the body. Comments are not supported there. */
+  part?: HeaderFooterPartSelector;
   captureKey?: string;
   target?: string | ParagraphTargetDescriptor;
   targetRef?: number | string | null;
@@ -121,6 +128,14 @@ export interface CommentReplyDocumentOperation {
   date?: string;
 }
 
+/** Resolves (or with `resolved: false`, reopens) the whole thread containing `commentId`. Body-only. */
+export interface CommentResolveDocumentOperation {
+  type: 'comment_resolve';
+  operationId?: string;
+  commentId: number | string;
+  resolved?: boolean;
+}
+
 export interface CharacterFormatProperties {
   bold?: boolean;
   italic?: boolean;
@@ -165,6 +180,7 @@ export type DocumentOperation =
   | DeleteDocumentOperation
   | CommentDocumentOperation
   | CommentReplyDocumentOperation
+  | CommentResolveDocumentOperation
   | HighlightDocumentOperation
   | CharacterFormatDocumentOperation
   | ParagraphFormatDocumentOperation;
@@ -272,7 +288,7 @@ export interface DocumentOperationResult {
   warnings?: string[];
   status?: RedlineStatus;
   error?: RedlineError;
-  operationType: 'redline' | 'comment' | 'comment_reply' | 'highlight' | 'format' | 'paragraph-format';
+  operationType: 'redline' | 'comment' | 'comment_reply' | 'comment_resolve' | 'highlight' | 'format' | 'paragraph-format';
   authorUsed: string;
   resolvedBy?: string;
   resolvedTarget?: ResolvedDocumentTarget;
@@ -284,7 +300,7 @@ export interface DocumentOperationResult {
 export interface BatchOperationItemResult {
   index: number;
   type: string;
-  operationType: 'redline' | 'comment' | 'comment_reply' | 'highlight' | 'format' | 'paragraph-format';
+  operationType: 'redline' | 'comment' | 'comment_reply' | 'comment_resolve' | 'highlight' | 'format' | 'paragraph-format';
   status: 'applied' | 'no_change' | 'error';
   authorUsed: string;
   resolvedBy?: string;
@@ -329,7 +345,7 @@ export interface MutationRetryPlan {
 export interface OperationPreflightItemResult {
   index: number;
   type: string;
-  operationType: 'redline' | 'comment' | 'comment_reply' | 'highlight' | 'format' | 'paragraph-format';
+  operationType: 'redline' | 'comment' | 'comment_reply' | 'comment_resolve' | 'highlight' | 'format' | 'paragraph-format';
   status: 'ready' | 'deferred' | 'error';
   authorUsed: string;
   resolvedBy?: string;