@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/watermark/serialize.d.ts

@@ -0,0 +1,98 @@
+import { WordDocument } from '../document/document';
+import { FeaturePackageLevelPart } from '../document/feature-package-level-part';
+import { OpcPackage, OpcRelationship, PartName } from '../../core/opc/index';
+import { ImageType as PackageImageContentType } from '../images/index';
+interface PendingMediaPart {
+    readonly partName: PartName;
+    readonly contentType: PackageImageContentType;
+    readonly data: Uint8Array;
+}
+/**
+ * Package-level pending state for watermark picture media + header image rels
+ * (adds) and post-strip GC (header image rel filters + media removals).
+ *
+ * Applied in `applyFeaturePackageParts` after HF multi-part writes header XML.
+ */
+export declare class WatermarkPackageParts implements FeaturePackageLevelPart {
+    private dirtyValue;
+    private mediaParts;
+    private headerRels;
+    private headerImageRelFilters;
+    private mediaRemovals;
+    /**
+     * @private
+     */
+    isDirty(): boolean;
+    /**
+     * @private
+   * Stage a media part (dedupe by bytes+content type externally). */
+    stageMedia(part: PendingMediaPart): void;
+    /**
+     * @private
+   * Stage a header-local image relationship. */
+    stageHeaderRel(headerPartName: PartName, relationship: OpcRelationship): void;
+    /**
+     * @private
+     * Relationship ids staged for a header part (not yet in package).
+     * GC must treat these as still referenced so filters do not drop them.
+     */
+    stagedHeaderRelIds(headerPartName: PartName): ReadonlySet<string>;
+    /**
+     * @private
+     * After rewrite, drop header-local image relationships whose ids
+     * are no longer referenced in that header's body (Removal rule 7).
+     */
+    stageHeaderImageRelFilter(headerPartName: PartName, referencedIds: ReadonlySet<string>): void;
+    /**
+     * @private
+     * Stage media part removal when package-wide unused (Removal rule 8).
+     */
+    stageMediaRemoval(name: PartName): void;
+    /**
+     * @private
+   * Clear after successful apply. */
+    clear(): void;
+    /**
+     * @private
+     */
+    applyToPackage(pkg: OpcPackage): OpcPackage;
+}
+/**
+ * Mark document dirty for watermark materialize.
+ * @private
+ */
+export declare function markWatermarkDirty(document: WordDocument): void;
+/**
+ * True when watermark materialize must rewrite headers.
+ * @private
+ */
+export declare function isWatermarkDirty(document: WordDocument): boolean;
+/**
+ * Clear dirty flag (after successful materialize or clean load).
+ * @private
+ */
+export declare function clearWatermarkDirty(document: WordDocument): void;
+/**
+ * Reset module dirty state for tests.
+ * @private
+ */
+export declare function resetWatermarkSerializeStateForTests(): void;
+/**
+ * Materialize dirty logical watermark into header parts.
+ *
+ * Called from the feature materialize handler before multi-part apply.
+ *
+ * - Assign/replace (`logical` defined): ensure scratch headers, strip recognized
+ *   watermark leaves, append canonical text/picture markup, stage image-rel/media GC.
+ * - Remove (`logical` undefined): strip recognized watermark leaves from existing
+ *   unique headers only (no new scratch headers), stage GC (Removal 1–10).
+ *
+ * @private
+ */
+export declare function materializeWatermarks(document: WordDocument): void;
+/**
+ * Load empty/clean package parts for registration.
+ * @private
+ */
+export declare function loadWatermarkPackageParts(_pkg: OpcPackage): WatermarkPackageParts;
+export {};